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

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from MethodHelper

#requiredopts, #set_options, #symbolize_options

Constructor Details

#initialize(host, port, options = {}) ⇒ Connection

Returns a new instance of Connection.

Raises:



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

def initialize(host, port, options = {})
  raise Puppet::Error, _("Could not set up LDAP Connection: Missing ruby/ldap libraries") unless Puppet.features.ldap?

  @host, @port = host, port

  set_options(options)
end

Instance Attribute Details

#connection ⇒ Object (readonly)

Returns the value of attribute connection.



9
10
11
 
# File 'lib/puppet/util/ldap/connection.rb', line 9

def connection
  @connection
end

#host ⇒ Object

Returns the value of attribute host.



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

def host
  @host
end

#password ⇒ Object

Returns the value of attribute password.



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

def password
  @password
end

#port ⇒ Object

Returns the value of attribute port.



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

def port
  @port
end

#reset ⇒ Object

Returns the value of attribute reset.



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

def reset
  @reset
end

#ssl ⇒ Object

Returns the value of attribute ssl.



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

def ssl
  @ssl
end

#user ⇒ Object

Returns the value of attribute user.



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

def user
  @user
end

Class Method Details

.instance ⇒ Object

Return a default connection, using our default settings.



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

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

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

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

Instance Method Details

#close ⇒ Object 



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

def close
  connection.unbind if connection.bound?
end

#name ⇒ Object

Create a per-connection unique name.



46
47
48
 
# File 'lib/puppet/util/ldap/connection.rb', line 46

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

#reset? ⇒ Boolean

Should we reset the connection?

Returns:

  • (Boolean) 


51
52
53
 
# File 'lib/puppet/util/ldap/connection.rb', line 51

def reset?
  reset
end

#start ⇒ Object

Start our ldap connection.



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

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