Ruby/LDAP -- A Ruby extension library for LDAP
DESCRIPTION
REQUIREMENT
PORTS
BUILDING
extconf.rb will try to use the OpenLDAP 2 or Netscape SDK libraries and guess paths to some header files and libraries from the position of ldap.h. If you'd like to see the available options for extconf.rb, run it with '--help' option.
$ ruby extconf.rb [--with-openldap1|--with-openldap2|--with-netscape|--with-wldap32]
$ make
This will create ldap.so, which you can either manually copy into place or install with:
$ make install
LICENSE
AVAILABLE CLASSES and METHODS
LDAP::LDAP_VERSION
LDAP::LDAP_MAX_VERSION
LDAP::VERSION
LDAP::MAJOR_VERSION
LDAP::MINOR_VERSION
LDAP::LDAP_PORT
LDAP::LDAPS_PORT
LDAP::LDAP_API_INFO_VERSION
LDAP::LDAP_VENDOR_NAME
LDAP::LDAP_VENDOR_VERSION
LDAP::LDAP_API_VERSION
LDAP.err2string(errcode)
LDAP.dn2ufn(dn)
LDAP.mod(mod_op, mod_type, mod_vals) (= LDAP::Mod.new)
LDAP.hash2mods(mod_op, hash)
LDAP.entry2hash(entry) (= entry.to_hash)
LDAP::Conn.new(host = "localhost", port = LDAP::LDAP_PORT)
: conn (raise LDAP::Error)
LDAP::Conn.open(host = "localhost", port = LDAP::LDAP_PORT)
: conn (raise LDAP::Error)
LDAP::Conn#simple_bind(dn = nil, password = nil) { ... }
: conn (raise LDAP::ResultError)
LDAP::Conn#bind(dn = nil, password = nil,
method = LDAP::LDAP_AUTH_SIMPLE) {|conn| ... }
(raise LDAP::ResultError)
LDAP::Conn#bind(dn = nil, password = nil,
method = LDAP::LDAP_AUTH_SIMPLE) : conn
(raise LDAP::ResultError)
LDAP::Conn#sasl_bind(dn = nil, mech = nil, cred = nil,
sctrls=nil, cctrls=nil) {|conn| ... }
(raise LDAP::ResultError)
LDAP::Conn#sasl_bind(dn = nil, mech = nil, cred = nil,
sctrls=nil, cctrls=nil) : conn
(raise LDAP::ResultError)
LDAP::Conn#bound? : true || false
LDAP::Conn#unbind() (raise LDAP::ResultError)
LDAP::Conn#start_tls
LDAP::Conn#perror(str)
LDAP::Conn#result2error(ldap_msg) : errcode
LDAP::Conn#err2string(errcode) : errmsg
LDAP::Conn#get_errno : errcode [if available]
LDAP::Conn#search(basedn, scope, filter, attrs = nil, attrsonly = false,
sec = 0, usec = 0,
s_attr = nil, s_proc = nil) {|entry| ... }
: conn (raise LDAP::ResultError)
LDAP::Conn#search2(basedn, scope, filter, attrs = nil, attrsonly = false,
sec = 0, usec = 0,
s_attr = nil, s_proc = nil) {|entry_as_hash| ... }
: conn (if a block is given) /
Array of Hash (if no block is given)
(raise LDAP::ResultError)
LDAP::Conn#search_ext(basedn, scope, filter, attrs = nil,
attrsonly = false, serverctrls, clientctrls,
sec = 0, usec = 0,
s_attr = nil, s_proc = nil) {|entry| ... }
: conn (raise LDAP::ResultError)
LDAP::Conn#search_ext2(basedn, scope, filter, attrs = nil,
attrsonly = false,
serverctrls, clientctrls, sec = 0, usec = 0,
s_attr = nil, s_proc = nil) {|entry_as_hash| ... }
: conn (if a block is given) /
Array of Hash (if no block is given)
(raise LDAP::ResultError)
LDAP::Conn#add(dn, ldap_mods) : self (raise LDAP::ResultError)
LDAP::Conn#add_ext(dn, ldap_mods, serverctrls, clientctrls)
: self (raise LDAP::ResultError)
LDAP::Conn#modify(dn, ldap_mods) : self (raise LDAP::ResultError)
LDAP::Conn#modify_ext(dn, ldap_mods, serverctrls, clientctrls)
: self (raise LDAP::ResultError)
LDAP::Conn#modrdn(olddn, newdn, delete) : self (raise LDAP::ResultError)
LDAP::Conn#delete(dn) : self (raise LDAP::ResultError)
LDAP::Conn#delete(dn, serverctrls, clientctrls) : self
(raise LDAP::ResultError)
LDAP::Conn#compare(dn, attr, val) : self
LDAP::Conn#compare_ext(dn, attr, val, serverctrls, clientctrls) : self
LDAP::Conn#set_option(opt, data) : self (raise LDAP::ResultError)
LDAP::Conn#get_option(opt) : data (raise LDAP::ResultError)
LDAP::Conn#schema(base = nil, attrs = nil,
sec = 0, usec = 0) : LDAP::Schema
LDAP::Conn#root_dse(attrs = nil, sec = 0, usec = 0) : Array of Hash
LDAP::SSLConn.new(host = 'localhost', port = LDAP_PORT,
start_tls = false, sctrls=nil, cctrls=nil)
: conn (raise LDAP::Error)
LDAP::Mod.new(mod_op, mod_type, mod_vals) : ldap_mod
LDAP::Mod#inspect : String
LDAP::Mod#mod_op : mod_op
LDAP::Mod#mod_type : mod_type
LDAP::Mod#mod_vals : mod_vals
LDAP::Mod#mod_op=(mod_op)
LDAP::Mod#mod_type=(mod_type)
LDAP::Mod#mod_vals=(mod_vals)
LDAP::Entry#get_dn : dn
LDAP::Entry#get_values : vals
LDAP::Entry#get_attributes : attrs
LDAP::Entry#dn (= get_dn)
LDAP::Entry#vals (= get_values)
LDAP::Entry#[] (= get_values)
LDAP::Entry#attrs (= get_attributes)
LDAP::Entry#to_hash : Hash
LDAP::Entry#inspect : String
LDAP::Control.new : LDAP::Control
LDAP::Control#oid : String
LDAP::Control#oid=(oid) : oid
LDAP::Control#critical : true || false
LDAP::Control#critical? : true || false
LDAP::Control#critical=(crit) : crit
LDAP::Control#value : String
LDAP::Control#value=(val) : val
LDAP::Control#inspect : String
SSLConn is a subclass of Conn, so its objects have access to the same methods as Conn objects.
In ldap/schema.rb:
LDAP::Conn#schema(attrs = nil, sec = 0, usec = 0) : schema
LDAP::Schema#must(oc) : attributes
LDAP::Schema#may(oc) : attributes
LDAP::Schema#names(attr) : names
LDAP::Schema#sup(oc) : object class
In ldap/control.rb:
LDAP::Control.encode(array) : String
LDAP::Control#decode : Array
In ldap/ldif.rb:
LDAP::Entry#to_ldif : LDAP::LDIF::Entry
LDAP::Entry#to_s : Alias of LDAP::Entry#to_ldif
LDAP::Mod#to_ldif(dn) : LDAP::LDIF::Mod
LDAP::Mod#to_s(dn) : Alias of LDAP::Mod#to_ldif
LDAP::Record.new(dn, change_type, attrs, mods=nil, ctrls=nil)
LDAP::Record#send(conn) : self
LDAP::Record#clean : self
LDAP::LDIF.mods_to_ldif( dn, *mods )
LDAP::LDIF.parse_entry(lines) : LDAP::Record (raise LDAP::LDIFError)
LDAP::LDIF.parse_file(file, sort=false)
: self (if a block is given) /
Array (if no block is given)
REFERENCES
Here are some URLs that contain useful information about LDAP:
THANKS
This list maybe not correct. If you notice mistakes of this list, please point out.
FAQs
Unknown package
We found that ruby-ldap demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers uncover how threat actors weaponize Out-of-Band Application Security Testing (OAST) techniques across the npm, PyPI, and RubyGems ecosystems to exfiltrate sensitive data.
Security News
Research
A malicious npm campaign is targeting Ethereum developers by impersonating Hardhat plugins and the Nomic Foundation, stealing sensitive data like private keys.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.