File: README.html

package info (click to toggle)
libldap-ruby 0.6.1-2
  • links: PTS
  • area: main
  • in suites: woody
  • size: 484 kB
  • ctags: 343
  • sloc: ansic: 2,298; ruby: 613; sh: 125; makefile: 59
file content (216 lines) | stat: -rw-r--r-- 7,006 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
<html>
<head>
</head>
<body>

<center>
 <h1>
  Ruby/LDAP -- ruby extension library for LDAP
 </h1>
 <font size=+2>
  Copyright (C) 2000,2001,2002 Takaaki Tateishi &lt;ttate@kt.jaist.ac.jp&gt;
 </font>
</center>


<hr>
<h2>
 DESCRIPTION
</h2>
'Ruby/LDAP' is a ruby extension library which provides the interface to
LDAP API described in RFC1823.

<hr>
<h2>
 REQUIREMENT
</h2>

<ul>
 <li>Ruby 1.6.0 or later</li>
 <li>OpenLDAP, NetscapeSDK, Windows2000(or ADSI)</li>
</ul>

<hr>
<h2>PORTS</h2>
<ul>
 <li><a href="http://www.freebsd.org/">FreeBSD</a>
     ("Akinori -Aki- MUSHA" &lt;knu@idaemons.org&gt;)
 <li><a href="http://www.debian.org/">Debian</a>
     (Akira Yamada &lt;akira@ruby-lang.org&gt;)
</ul>

<hr>
<h2>
 BUILDING
</h2>

extconf.rb try to use OpenLDAP2 or NetscapeSDK libraries, and guess
paths to some header files and libraries from the position of 'ldap.h'.
If you'd like to see available options for extconf.rb, run it with
'--help' option.
<blockquote>
<pre>
$ ruby extconf.rb [--with-openldap1|--with-openldap2|--with-netscape|--with-wldap32]
$ make
</pre>
</blockquote>
you will get 'ldap.so', and copy it to somewhere you like or do
'make install'.
<p>
If you has a binary distribution, execute install.rb as follows:
<blockquote>
<pre>
$ ruby install.rb
</pre>
</blockquote>

<hr>
<h2>LICENSE</h2>

At present, I don't consider what license I apply to this module.
But I will not claim the payment forever.

<hr>
<h2>
 AVAILABLE CLASSES and METHODS
</h2>

<blockquote>
 LDAP::LDAP_VERSION<br>
 LDAP::LDAP_MAX_VERSION<br>
 LDAP::VERSION<br>
 LDAP::MAJOR_VERSION<br>
 LDAP::MINOR_VERSION<br>
 LDAP::LDAP_PORT<br>
 LDAP::LDAPS_PORT<br>
 LDAP::LDAP_API_INFO_VERSION<br>
 LDAP::LDAP_VENDOR_NAME<br>
 LDAP::LDAP_VENDOR_VERSION<br>
 LDAP::LDAP_API_VERSION<br>
 LDAP.err2string(errcode)<br>
 LDAP.dn2ufn(dn)<br>
 LDAP.mod(mod_op, mod_type, mod_vals) (= LDAP::Mod.new)<br>
 LDAP.hash2mods(mod_op, hash)<br>
 LDAP.entry2hash(entry) (= entry.to_hash)<br>
 LDAP::Conn.new(host = "localhost", port = LDAP::LDAP_PORT) : conn
 (raise LDAP::Error)<br>
 LDAP::Conn.open(host = "localhost", port = LDAP::LDAP_PORT) : conn
 (raise LDAP::Error)<br>
 LDAP::Conn#simple_bind(dn = nil, password = nil){ ... } : conn
 (raise LDAP::ResultError)<br>
 LDAP::Conn#bind(dn = nil, password = nil,
                 method = LDAP::LDAP_AUTH_SIMPLE){|conn| ... }
		 (raise LDAP::ResultError)<br>
 LDAP::Conn#bind(dn = nil, password = nil,
                 method = LDAP::LDAP_AUTH_SIMPLE) : conn
		 (raise LDAP::ResultError)<br>
 LDAP::Conn#unbind (raise LDAP::ResultError)<br>
 LDAP::Conn#perror(str)<br>
 LDAP::Conn#result2error(ldap_msg) : errcode<br>
 LDAP::Conn#err2string(errcode) : errmsg<br>
 LDAP::Conn#get_errno : errcode [if available]<br>
 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)<br>
 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)<br>
 LDAP::Conn#add(dn, ldap_mods) : self (raise LDAP::ResultError)<br>
 LDAP::Conn#modify(dn, ldap_mods) : self (raise LDAP::ResultError)<br>
 LDAP::Conn#modrdn(olddn, newdn, delete) : self (raise LDAP::ResultError)<br>
 LDAP::Conn#delete(dn) : self (raise LDAP::ResultError)<br>
 LDAP::Conn#set_option(opt, data) : self [experimental]
 (raise LDAP::ResultError)<br>
 LDAP::Conn#get_option(opt) : data [experimental]
 (raise LDAP::ResultError)<br>
 LDAP::Mod.new(mod_op, mod_type, mod_vals) : ldap_mod<br>
 LDAP::Mod#mod_op : mod_op<br>
 LDAP::Mod#mod_type : mod_type<br>
 LDAP::Mod#mod_vals : mod_vals<br>
 LDAP::Mod#mod_op=(mod_op)<br>
 LDAP::Mod#mod_type=(mod_type)<br>
 LDAP::Mod#mod_vals=(mod_vals)<br>
 LDAP::Entry#get_dn : dn<br>
 LDAP::Entry#get_values : vals<br>
 LDAP::Entry#get_attributes : attrs<br>
 LDAP::Entry#dn (= get_dn)<br>
 LDAP::Entry#vals (= vals)<br>
 LDAP::Entry#attrs (= get_attributes)<br>
 LDAP::Entry#to_hash : Hash<br>
</blockquote>

In ldap/schema.rb:
<blockquote>
 LDAP::Conn#schema(attrs = nil, sec = 0, usec = 0) : schema<br>
 LDAP::Schema#must(oc) : attributes<br>
 LDAP::Schema#may(oc)  : attributes<br>
 LDAP::Schema#names(attr) : names<br>
</blockquote>

see also test/*.rb for examples.


<hr>
<h2>REFERENCES</h2>

<ul>
 <li>T. Howes, M. Smith (University of Michigan):
     RFC1823, The LDAP Application Program Interface, August 1995
 <li>The OpenLDAP Project: OpenLDAP 2.0 Administrator's Guide,
     September 2000
 <li>T. Howes (University of Michigan):
     RFC1960, A String Representation of LDAP Search Filters,
     June 1996
 <li>M. Wahl, Critical Angle Inc, T. Hows, Netscape Communications
     Gorp., S. Kille, Isode Limited:
     Lightweight Directory Access Protocol (v3), December 1997
 <li>M. Wahl, Critical Angle Inc., A. Coulbeck, Isode Inc., T. Howes,
     Netscape Communications Corp., S. Kille, Isode Limited:
     December 1997
 <li>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
 <li>T. Howes, Netscape Communications Gorp.:
     The String Representation of LDAP Search Filters, December 1997
 <li>F. Yergeau (Alis Technologies):
     RFC2279, UTF-8, a transformation format of ISO 10646,
     October 1998
 <li>Netscape Communications Corp.: Netscape Directory SDK
 <li>Luiz Ernesto Pinheiro Malere: LDAP Linux HOWTO, February 2000
 <li>Tim Howes, Mark Smith: Understanding and Deploying LDAP Directory
     Servers
</ul>

Here are the URLs that contain usefull informations about LDAP:
<ul>
 <li>University of Michigan<br>
     <a href="http://www.umich.edu/~dirsvcs/ldap/">
     http://www.umich.edu/~dirsvcs/ldap/</a>
 <li>OpenLDAP Project<br>
     <a href="http://www.openldap.org/">
     http://www.openldap.org/</a>
 <li>Netscape Communications<br>
     <a href="http://developer.netscape.com/docs/manuals/communicator/ldap45.htm">
     http://developer.netscape.com/docs/manuals/communicator/ldap45.htm</a>
 <li>Netscape Directory SDK<br>
     <a href="http://www.mozilla.org/directory/">
     http://www.mozilla.org/directory/</a>
 <li>Active Directory Service Interfaces Overview<br>
     <a href="http://www.microsoft.com/windows2000/techinfo/howitworks/activedirectory/adsilinks.asp">http://www.microsoft.com/windows2000/techinfo/howitworks/activedirectory/adsilinks.asp</a>
 <li>LDAP schema repository<br>
     <a href="http://www.hklc.com/ldapschema/">
     http://www.hklc.com/ldapschema/</a><br>
     <a href="http://ldap.hklc.com/">
     http://ldap.hklc.com/</a>
 <li>Object Identifiers Registry<br>
     <a href="http://www.alvestrand.no/harald/objectid/">
     http://www.alvestrand.no/harald/objectid/</a>
</ul>

</body>
</html>