Ruby/LDAP -- ruby extension library for LDAP
Copyright (C) 2000 Takaaki Tateishi <ttate@jaist.ac.jp>
DESCRIPTION
'Ruby/LDAP' is a ruby extension library which provides the interface to
LDAP API described in RFC1823.
REQUIREMENT
- Ruby 1.6.0 or later
- OpenLDAP or NetscapeSDK or Michigan LDAP
PORTS
- FreeBSD
("Akinori -Aki- MUSHA" <knu@idaemons.org>)
- Debian
(Akira Yamada <akira@ruby-lang.org>)
BUILDING
# ruby extconf.rb
# make
you will get "ldap.so", copy it to somewhere you like or do 'make install'.
If you'd like to specify ldap library and include paths, run extconf.rb script
with "--help" option.
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.err2string(errcode)
LDAP.dn2ufn(dn)
LDAP.mod(mod_op, mod_type, mod_vals) (= LDAP::Mod.new)
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){ ... }
LDAP::Conn#bind(dn = nil, password = nil,
method = LDAP::LDAP_AUTH_SIMPLE){ ... }
LDAP::Conn#unbind
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){|msg| ... }
: errcode (raise LDAP::InvalidEntryError)
LDAP::Conn#add(dn, ldap_mods) : errcode
LDAP::Conn#modify(dn, ldap_mods) : errcode
LDAP::Conn#modrdn(olddn, newdn, delete) : errcode
LDAP::Conn#delete(dn) : errcode
LDAP::Conn#set_option(opt, data) : errcode [experimental]
LDAP::Conn#get_option(opt) : data [experimental]
LDAP::Mod.new(mod_op, mod_type, mod_vals) : ldap_mod
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 (= vals)
LDAP::Entry#attrs (= get_attributes)
LDAP::Entry#to_hash : Hash
REFERENCES
- T. Howes, M. Smith (University of Michigan):
RFC1823, The LDAP Application Program Interface, August 1995
- The OpenLDAP Project: OpenLDAP 2.0 Administrator's Guide,
September 2000
- T. Howes (University of Michigan):
RFC1960, A String Representation of LDAP Search Filters,
June 1996
- M. Wahl, Critical Angle Inc, T. Hows, Netscape Communications
Gorp., S. Kille, Isode Limited:
Lightweight Directory Access Protocol (v3), December 1997
- M. Wahl, Critical Angle Inc., A. Coulbeck, Isode Inc., T. Howes,
Netscape Communications Corp., S. Kille, Isode Limited:
December 1997
- M .Wahl, Critical Angle Inc., S. Kille, Isode Ltd., T. Howes,
Netscape Communications Corp.:
Lightweight Directory Access Protocol (v3):
UTF-8 String Representation of Distinguished Names, December 1997
- T. Howes, Netscape Communications Gorp.:
The String Representation of LDAP Search Filters, December 1997
- F. Yergeau (Alis Technologies):
RFC2279, UTF-8, a transformation format of ISO 10646,
October 1998
- Netscape Communications Corp.: Netscape Directory SDK
- Luiz Ernesto Pinheiro Malere: LDAP Linux HOWTO, February 2000
- Tim Howes, Mark Smith: Understanding and Deploying LDAP Directory
Servers
Here are the URLs that contain usefull informations about LDAP: