Class: Puppet::Util::Ldap::Connection

Inherits:
Object
  • Object
show all
Defined in:
lib/puppet/util/ldap/connection.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(host, port, user: nil, password: nil, reset: nil, ssl: nil) ⇒ Connection

Returns a new instance of Connection

Raises:


36
37
38
39
40
41
42
43
44
45
# File 'lib/puppet/util/ldap/connection.rb', line 36

def initialize(host, port, user: nil, password: nil, reset: nil, ssl: nil)
  raise Puppet::Error, _("Could not set up LDAP Connection: Missing ruby/ldap libraries") unless Puppet.features.ldap?

  @host = host
  @port = port
  @user = user
  @password = password
  @reset = reset
  @ssl = ssl
end

Instance Attribute Details

#connectionObject (readonly)

Returns the value of attribute connection


6
7
8
# File 'lib/puppet/util/ldap/connection.rb', line 6

def connection
  @connection
end

#hostObject

Returns the value of attribute host


4
5
6
# File 'lib/puppet/util/ldap/connection.rb', line 4

def host
  @host
end

#passwordObject

Returns the value of attribute password


4
5
6
# File 'lib/puppet/util/ldap/connection.rb', line 4

def password
  @password
end

#portObject

Returns the value of attribute port


4
5
6
# File 'lib/puppet/util/ldap/connection.rb', line 4

def port
  @port
end

#resetObject

Returns the value of attribute reset


4
5
6
# File 'lib/puppet/util/ldap/connection.rb', line 4

def reset
  @reset
end

#sslObject

Returns the value of attribute ssl


4
5
6
# File 'lib/puppet/util/ldap/connection.rb', line 4

def ssl
  @ssl
end

#userObject

Returns the value of attribute user


4
5
6
# File 'lib/puppet/util/ldap/connection.rb', line 4

def user
  @user
end

Class Method Details

.instanceObject

Return a default connection, using our default settings.


9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# File 'lib/puppet/util/ldap/connection.rb', line 9

def self.instance
  ssl = if Puppet[:ldaptls]
    :tls
      elsif Puppet[:ldapssl]
        true
      else
        false
      end

  options = {}
  options[:ssl] = ssl
  user = Puppet.settings[:ldapuser]
  if user && user != ""
    options[:user] = user
    pass = Puppet.settings[:ldappassword]
    if pass && pass != ""
      options[:password] = pass
    end
  end

  new(Puppet[:ldapserver], Puppet[:ldapport], options)
end

Instance Method Details

#closeObject


32
33
34
# File 'lib/puppet/util/ldap/connection.rb', line 32

def close
  connection.unbind if connection.bound?
end

#nameObject

Create a per-connection unique name.


48
49
50
# File 'lib/puppet/util/ldap/connection.rb', line 48

def name
  [host, port, user, password, ssl].collect { |p| p.to_s }.join("/")
end

#reset?Boolean

Should we reset the connection?


53
54
55
# File 'lib/puppet/util/ldap/connection.rb', line 53

def reset?
  reset
end

#startObject

Start our ldap connection.


58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/puppet/util/ldap/connection.rb', line 58

def start
    case ssl
    when :tls
      @connection = LDAP::SSLConn.new(host, port, true)
    when true
      @connection = LDAP::SSLConn.new(host, port)
    else
      @connection = LDAP::Conn.new(host, port)
    end
    @connection.set_option(LDAP::LDAP_OPT_PROTOCOL_VERSION, 3)
    @connection.set_option(LDAP::LDAP_OPT_REFERRALS, LDAP::LDAP_OPT_ON)
    @connection.simple_bind(user, password)
rescue => detail
    raise Puppet::Error, _("Could not connect to LDAP: %{detail}") % { detail: detail }, detail.backtrace
end