1 ;;; ldap.el --- client interface to LDAP for Emacs
3 ;; Copyright (C) 1998, 1999, 2000, 2002, 2004 Free Software Foundation, Inc.
5 ;; Author: Oscar Figueiredo <oscar@cpe.fr>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
29 ;; This package provides basic functionality to perform searches on LDAP
30 ;; servers. It requires a command line utility generally named
31 ;; `ldapsearch' to actually perform the searches. That program can be
32 ;; found in all LDAP developer kits such as:
33 ;; - UM-LDAP 3.3 (http://www.umich.edu/~dirsvcs/ldap/)
34 ;; - OpenLDAP (http://www.openldap.org/)
39 (eval-when-compile (require 'cl
))
42 "Lightweight Directory Access Protocol."
46 (defcustom ldap-default-host nil
47 "*Default LDAP server.
48 A TCP port number can be appended to that name using a colon as
50 :type
'(choice (string :tag
"Host name")
51 (const :tag
"Use library default" nil
))
54 (defcustom ldap-default-port nil
55 "*Default TCP port for LDAP connections.
56 Initialized from the LDAP library at build time. Default value is 389."
57 :type
'(choice (const :tag
"Use library default" nil
)
58 (integer :tag
"Port number"))
61 (defcustom ldap-default-base nil
62 "*Default base for LDAP searches.
63 This is a string using the syntax of RFC 1779.
64 For instance, \"o=ACME, c=US\" limits the search to the
65 Acme organization in the United States."
66 :type
'(choice (const :tag
"Use library default" nil
)
67 (string :tag
"Search base"))
71 (defcustom ldap-host-parameters-alist nil
72 "*Alist of host-specific options for LDAP transactions.
73 The format of each list element is (HOST PROP1 VAL1 PROP2 VAL2 ...).
74 HOST is the hostname of an LDAP server (with an optional TCP port number
75 appended to it using a colon as a separator).
76 PROPn and VALn are property/value pairs describing parameters for the server.
77 Valid properties include:
78 `binddn' is the distinguished name of the user to bind as
80 `passwd' is the password to use for simple authentication.
81 `auth' is the authentication method to use.
82 Possible values are: `simple', `krbv41' and `krbv42'.
83 `base' is the base for the search as described in RFC 1779.
84 `scope' is one of the three symbols `subtree', `base' or `onelevel'.
85 `deref' is one of the symbols `never', `always', `search' or `find'.
86 `timelimit' is the timeout limit for the connection in seconds.
87 `sizelimit' is the maximum number of matches to return."
88 :type
'(repeat :menu-tag
"Host parameters"
89 :tag
"Host parameters"
90 (list :menu-tag
"Host parameters"
91 :tag
"Host parameters"
93 (string :tag
"Host name")
99 (const :tag
"Search Base" base
)
104 (const :tag
"Binding DN" binddn
)
109 (const :tag
"Password" passwd
)
112 :tag
"Authentication Method"
114 (const :tag
"Authentication Method" auth
)
116 (const :menu-tag
"None" :tag
"None" nil
)
117 (const :menu-tag
"Simple" :tag
"Simple" simple
)
118 (const :menu-tag
"Kerberos 4.1" :tag
"Kerberos 4.1" krbv41
)
119 (const :menu-tag
"Kerberos 4.2" :tag
"Kerberos 4.2" krbv42
)))
123 (const :tag
"Search Scope" scope
)
125 (const :menu-tag
"Default" :tag
"Default" nil
)
126 (const :menu-tag
"Subtree" :tag
"Subtree" subtree
)
127 (const :menu-tag
"Base" :tag
"Base" base
)
128 (const :menu-tag
"One Level" :tag
"One Level" onelevel
)))
132 (const :tag
"Dereferencing" deref
)
134 (const :menu-tag
"Default" :tag
"Default" nil
)
135 (const :menu-tag
"Never" :tag
"Never" never
)
136 (const :menu-tag
"Always" :tag
"Always" always
)
137 (const :menu-tag
"When searching" :tag
"When searching" search
)
138 (const :menu-tag
"When locating base" :tag
"When locating base" find
)))
142 (const :tag
"Time Limit" timelimit
)
143 (integer :tag
"(in seconds)"))
147 (const :tag
"Size Limit" sizelimit
)
148 (integer :tag
"(number of records)")))))
151 (defcustom ldap-ldapsearch-prog
"ldapsearch"
152 "*The name of the ldapsearch command line program."
153 :type
'(string :tag
"`ldapsearch' Program")
156 (defcustom ldap-ldapsearch-args
'("-LL" "-tt" "-x")
157 "*A list of additional arguments to pass to `ldapsearch'."
158 :type
'(repeat :tag
"`ldapsearch' Arguments"
159 (string :tag
"Argument"))
162 (defcustom ldap-ignore-attribute-codings nil
163 "*If non-nil, do not encode/decode LDAP attribute values."
167 (defcustom ldap-default-attribute-decoder nil
168 "*Decoder function to use for attributes whose syntax is unknown."
172 (defcustom ldap-coding-system
'utf-8
173 "*Coding system of LDAP string values.
174 LDAP v3 specifies the coding system of strings to be UTF-8."
178 (defvar ldap-attribute-syntax-encoders
180 nil
; 2 Access Point Y
181 nil
; 3 Attribute Type Description Y
185 ldap-encode-boolean
; 7 Boolean Y
186 nil
; 8 Certificate N
187 nil
; 9 Certificate List N
188 nil
; 10 Certificate Pair N
189 ldap-encode-country-string
; 11 Country String Y
190 ldap-encode-string
; 12 DN Y
191 nil
; 13 Data Quality Syntax Y
192 nil
; 14 Delivery Method Y
193 ldap-encode-string
; 15 Directory String Y
194 nil
; 16 DIT Content Rule Description Y
195 nil
; 17 DIT Structure Rule Description Y
196 nil
; 18 DL Submit Permission Y
197 nil
; 19 DSA Quality Syntax Y
199 nil
; 21 Enhanced Guide Y
200 nil
; 22 Facsimile Telephone Number Y
202 nil
; 24 Generalized Time Y
204 nil
; 26 IA5 String Y
205 number-to-string
; 27 INTEGER Y
207 nil
; 29 Master And Shadow Access Points Y
208 nil
; 30 Matching Rule Description Y
209 nil
; 31 Matching Rule Use Description Y
210 nil
; 32 Mail Preference Y
211 nil
; 33 MHS OR Address Y
212 nil
; 34 Name And Optional UID Y
213 nil
; 35 Name Form Description Y
214 nil
; 36 Numeric String Y
215 nil
; 37 Object Class Description Y
217 nil
; 39 Other Mailbox Y
218 nil
; 40 Octet String Y
219 ldap-encode-address
; 41 Postal Address Y
220 nil
; 42 Protocol Information Y
221 nil
; 43 Presentation Address Y
222 ldap-encode-string
; 44 Printable String Y
223 nil
; 45 Subtree Specification Y
224 nil
; 46 Supplier Information Y
225 nil
; 47 Supplier Or Consumer Y
226 nil
; 48 Supplier And Consumer Y
227 nil
; 49 Supported Algorithm N
228 nil
; 50 Telephone Number Y
229 nil
; 51 Teletex Terminal Identifier Y
230 nil
; 52 Telex Number Y
232 nil
; 54 LDAP Syntax Description Y
233 nil
; 55 Modify Rights Y
234 nil
; 56 LDAP Schema Definition Y
235 nil
; 57 LDAP Schema Description Y
236 nil
; 58 Substring Assertion Y
238 "A vector of functions used to encode LDAP attribute values.
239 The sequence of functions corresponds to the sequence of LDAP attribute syntax
240 object identifiers of the form 1.3.6.1.4.1.1466.1115.121.1.* as defined in
241 RFC2252 section 4.3.2")
243 (defvar ldap-attribute-syntax-decoders
245 nil
; 2 Access Point Y
246 nil
; 3 Attribute Type Description Y
250 ldap-decode-boolean
; 7 Boolean Y
251 nil
; 8 Certificate N
252 nil
; 9 Certificate List N
253 nil
; 10 Certificate Pair N
254 ldap-decode-string
; 11 Country String Y
255 ldap-decode-string
; 12 DN Y
256 nil
; 13 Data Quality Syntax Y
257 nil
; 14 Delivery Method Y
258 ldap-decode-string
; 15 Directory String Y
259 nil
; 16 DIT Content Rule Description Y
260 nil
; 17 DIT Structure Rule Description Y
261 nil
; 18 DL Submit Permission Y
262 nil
; 19 DSA Quality Syntax Y
264 nil
; 21 Enhanced Guide Y
265 nil
; 22 Facsimile Telephone Number Y
267 nil
; 24 Generalized Time Y
269 nil
; 26 IA5 String Y
270 string-to-number
; 27 INTEGER Y
272 nil
; 29 Master And Shadow Access Points Y
273 nil
; 30 Matching Rule Description Y
274 nil
; 31 Matching Rule Use Description Y
275 nil
; 32 Mail Preference Y
276 nil
; 33 MHS OR Address Y
277 nil
; 34 Name And Optional UID Y
278 nil
; 35 Name Form Description Y
279 nil
; 36 Numeric String Y
280 nil
; 37 Object Class Description Y
282 nil
; 39 Other Mailbox Y
283 nil
; 40 Octet String Y
284 ldap-decode-address
; 41 Postal Address Y
285 nil
; 42 Protocol Information Y
286 nil
; 43 Presentation Address Y
287 ldap-decode-string
; 44 Printable String Y
288 nil
; 45 Subtree Specification Y
289 nil
; 46 Supplier Information Y
290 nil
; 47 Supplier Or Consumer Y
291 nil
; 48 Supplier And Consumer Y
292 nil
; 49 Supported Algorithm N
293 nil
; 50 Telephone Number Y
294 nil
; 51 Teletex Terminal Identifier Y
295 nil
; 52 Telex Number Y
297 nil
; 54 LDAP Syntax Description Y
298 nil
; 55 Modify Rights Y
299 nil
; 56 LDAP Schema Definition Y
300 nil
; 57 LDAP Schema Description Y
301 nil
; 58 Substring Assertion Y
303 "A vector of functions used to decode LDAP attribute values.
304 The sequence of functions corresponds to the sequence of LDAP attribute syntax
305 object identifiers of the form 1.3.6.1.4.1.1466.1115.121.1.* as defined in
306 RFC2252 section 4.3.2")
309 (defvar ldap-attribute-syntaxes-alist
310 '((createtimestamp .
24)
311 (modifytimestamp .
24)
314 (subschemasubentry .
12)
318 (matchingruleuse .
31)
319 (namingcontexts .
12)
321 (supportedextension .
38)
322 (supportedcontrol .
38)
323 (supportedsaslmechanisms .
15)
324 (supportedldapversion .
27)
326 (ditstructurerules .
17)
328 (ditcontentrules .
16)
330 (aliasedobjectname .
12)
343 (businesscategory .
15)
347 (physicaldeliveryofficename .
15)
348 (telephonenumber .
50)
350 (telexterminalidentifier .
51)
351 (facsimiletelephonenumber .
22)
353 (internationalisdnnumber .
36)
354 (registeredaddress .
41)
355 (destinationindicator .
44)
356 (preferreddeliverymethod .
14)
357 (presentationaddress .
43)
358 (supportedapplicationcontext .
38)
364 (usercertificate .
8)
366 (authorityrevocationlist .
9)
367 (certificaterevocationlist .
9)
368 (crosscertificatepair .
10)
372 (generationqualifier .
15)
373 (x500uniqueidentifier .
6)
375 (enhancedsearchguide .
21)
376 (protocolinformation .
42)
377 (distinguishedname .
12)
379 (houseidentifier .
15)
380 (supportedalgorithms .
49)
381 (deltarevocationlist .
9)
383 "A map of LDAP attribute names to their type object id minor number.
384 This table is built from RFC2252 Section 5 and RFC2256 Section 5")
387 ;; Coding/decoding functions
389 (defun ldap-encode-boolean (bool)
394 (defun ldap-decode-boolean (str)
396 ((string-equal str
"TRUE")
398 ((string-equal str
"FALSE")
401 (error "Wrong LDAP boolean string: %s" str
))))
403 (defun ldap-encode-country-string (str)
404 ;; We should do something useful here...
405 (if (not (= 2 (length str
)))
406 (error "Invalid country string: %s" str
)))
408 (defun ldap-decode-string (str)
409 (decode-coding-string str ldap-coding-system
))
411 (defun ldap-encode-string (str)
412 (encode-coding-string str ldap-coding-system
))
414 (defun ldap-decode-address (str)
415 (mapconcat 'ldap-decode-string
416 (split-string str
"\\$")
419 (defun ldap-encode-address (str)
420 (mapconcat 'ldap-encode-string
421 (split-string str
"\n")
425 ;; LDAP protocol functions
427 (defun ldap-get-host-parameter (host parameter
)
428 "Get the value of PARAMETER for HOST in `ldap-host-parameters-alist'."
429 (plist-get (cdr (assoc host ldap-host-parameters-alist
))
432 (defun ldap-decode-attribute (attr)
433 "Decode the attribute/value pair ATTR according to LDAP rules.
434 The attribute name is looked up in `ldap-attribute-syntaxes-alist'
435 and the corresponding decoder is then retrieved from
436 `ldap-attribute-syntax-decoders' and applied on the value(s)."
437 (let* ((name (car attr
))
439 (syntax-id (cdr (assq (intern (downcase name
))
440 ldap-attribute-syntaxes-alist
)))
443 (setq decoder
(aref ldap-attribute-syntax-decoders
445 (setq decoder ldap-default-attribute-decoder
))
447 (cons name
(mapcar decoder values
))
450 (defun ldap-search (filter &optional host attributes attrsonly withdn
)
451 "Perform an LDAP search.
452 FILTER is the search filter in RFC1558 syntax.
453 HOST is the LDAP host on which to perform the search.
454 ATTRIBUTES are the specific attributes to retrieve, nil means
456 ATTRSONLY, if non-nil, retrieves the attributes only, without
457 the associated values.
458 If WITHDN is non-nil, each entry in the result will be prepended with
459 its distinguished name WITHDN.
460 Additional search parameters can be specified through
461 `ldap-host-parameters-alist', which see."
462 (interactive "sFilter:")
464 (setq host ldap-default-host
)
465 (error "No LDAP host specified"))
466 (let ((host-plist (cdr (assoc host ldap-host-parameters-alist
)))
468 (setq result
(ldap-search-internal (list* 'host host
470 'attributes attributes
474 (if ldap-ignore-attribute-codings
476 (mapcar (lambda (record)
477 (mapcar 'ldap-decode-attribute record
))
481 (defun ldap-search-internal (search-plist)
482 "Perform a search on a LDAP server.
483 SEARCH-PLIST is a property list describing the search request.
484 Valid keys in that list are:
485 `host' is a string naming one or more (blank-separated) LDAP servers to
486 to try to connect to. Each host name may optionally be of the form HOST:PORT.
487 `filter' is a filter string for the search as described in RFC 1558.
488 `attributes' is a list of strings indicating which attributes to retrieve
489 for each matching entry. If nil, return all available attributes.
490 `attrsonly', if non-nil, indicates that only attributes are retrieved,
491 not their associated values.
492 `base' is the base for the search as described in RFC 1779.
493 `scope' is one of the three symbols `sub', `base' or `one'.
494 `binddn' is the distinguished name of the user to bind as (in RFC 1779 syntax).
495 `passwd' is the password to use for simple authentication.
496 `deref' is one of the symbols `never', `always', `search' or `find'.
497 `timelimit' is the timeout limit for the connection in seconds.
498 `sizelimit' is the maximum number of matches to return.
499 `withdn' if non-nil each entry in the result will be prepended with
500 its distinguished name DN.
501 The function returns a list of matching entries. Each entry is itself
502 an alist of attribute/value pairs."
503 (let ((buf (get-buffer-create " *ldap-search*"))
504 (bufval (get-buffer-create " *ldap-value*"))
505 (host (or (plist-get search-plist
'host
)
507 (filter (plist-get search-plist
'filter
))
508 (attributes (plist-get search-plist
'attributes
))
509 (attrsonly (plist-get search-plist
'attrsonly
))
510 (base (or (plist-get search-plist
'base
)
512 (scope (plist-get search-plist
'scope
))
513 (binddn (plist-get search-plist
'binddn
))
514 (passwd (plist-get search-plist
'passwd
))
515 (deref (plist-get search-plist
'deref
))
516 (timelimit (plist-get search-plist
'timelimit
))
517 (sizelimit (plist-get search-plist
'sizelimit
))
518 (withdn (plist-get search-plist
'withdn
))
520 arglist dn name value record result
)
521 (if (or (null filter
)
523 (error "No search filter"))
524 (setq filter
(cons filter attributes
))
529 (not (equal "" host
)))
530 (setq arglist
(nconc arglist
(list (format "-h%s" host
)))))
532 (not (equal "" attrsonly
)))
533 (setq arglist
(nconc arglist
(list "-A"))))
535 (not (equal "" base
)))
536 (setq arglist
(nconc arglist
(list (format "-b%s" base
)))))
538 (not (equal "" scope
)))
539 (setq arglist
(nconc arglist
(list (format "-s%s" scope
)))))
541 (not (equal "" binddn
)))
542 (setq arglist
(nconc arglist
(list (format "-D%s" binddn
)))))
544 (not (equal "" passwd
)))
545 (setq arglist
(nconc arglist
(list (format "-w%s" passwd
)))))
547 (not (equal "" deref
)))
548 (setq arglist
(nconc arglist
(list (format "-a%s" deref
)))))
550 (not (equal "" timelimit
)))
551 (setq arglist
(nconc arglist
(list (format "-l%s" timelimit
)))))
553 (not (equal "" sizelimit
)))
554 (setq arglist
(nconc arglist
(list (format "-z%s" sizelimit
)))))
555 (eval `(call-process ldap-ldapsearch-prog
560 ,@ldap-ldapsearch-args
563 (goto-char (point-min))
565 (while (re-search-forward "[\t\n\f]+ " nil t
)
566 (replace-match "" nil nil
))
567 (goto-char (point-min))
569 (if (looking-at "usage")
570 (error "Incorrect ldapsearch invocation")
571 (message "Parsing results... ")
572 ;; Skip error message when retrieving attribute list
573 (if (looking-at "Size limit exceeded")
576 (skip-chars-forward " \t\n")
578 (setq dn
(buffer-substring (point) (save-excursion
582 (while (looking-at "^\\(\\w*\\)\\(;\\w*\\)?[=:\t ]+\\(<[\t ]*file://\\)?\\(.*\\)$")
583 (setq name
(match-string 1)
584 value
(match-string 4))
585 ;; Need to handle file:///D:/... as generated by OpenLDAP
586 ;; on DOS/Windows as local files.
587 (if (and (memq system-type
'(windows-nt ms-dos
))
588 (eq (string-match "/\\(.:.*\\)$" value
) 0))
589 (setq value
(match-string 1 value
)))
590 ;; Do not try to open non-existent files
596 (set-buffer-multibyte nil
)
597 (insert-file-contents-literally value
)
599 (setq value
(buffer-string))))
600 (setq record
(cons (list name value
)
603 (setq result
(cons (if withdn
604 (cons dn
(nreverse record
))
605 (nreverse record
)) result
))
607 (skip-chars-forward " \t\n")
608 (message "Parsing results... %d" numres
)
610 (message "Parsing results... done")
611 (nreverse result
)))))
615 ;;; arch-tag: 47913a76-6155-42e6-ac58-6d28b5d50eb0
616 ;;; ldap.el ends here