Mercurial > emacs
annotate lisp/net/ldap.el @ 76260:3823acfb56c7
Comment fix.
author | Vinicius Jose Latorre <viniciusjl@ig.com.br> |
---|---|
date | Thu, 01 Mar 2007 20:02:32 +0000 |
parents | e3694f1cb928 |
children | 84cf1e2214c5 95d0cdf160ea |
rev | line source |
---|---|
38422
7a94f1c588c4
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
33930
diff
changeset
|
1 ;;; ldap.el --- client interface to LDAP for Emacs |
27313 | 2 |
74509 | 3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, |
75347 | 4 ;; 2005, 2006, 2007 Free Software Foundation, Inc. |
27313 | 5 |
42607
033986c328d5
New maintainer. New e-mail address of the author.
Pavel Janík <Pavel@Janik.cz>
parents:
42579
diff
changeset
|
6 ;; Author: Oscar Figueiredo <oscar@cpe.fr> |
59941 | 7 ;; Maintainer: FSF |
27313 | 8 ;; Created: April 1998 |
9 ;; Keywords: comm | |
10 | |
11 ;; This file is part of GNU Emacs. | |
12 | |
13 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
14 ;; it under the terms of the GNU General Public License as published by | |
15 ;; the Free Software Foundation; either version 2, or (at your option) | |
16 ;; any later version. | |
17 | |
18 ;; GNU Emacs is distributed in the hope that it will be useful, | |
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 ;; GNU General Public License for more details. | |
22 | |
23 ;; You should have received a copy of the GNU General Public License | |
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
64085 | 25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
26 ;; Boston, MA 02110-1301, USA. | |
27313 | 27 |
28 ;;; Commentary: | |
29 | |
30 ;; This package provides basic functionality to perform searches on LDAP | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
31 ;; servers. It requires a command line utility generally named |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
32 ;; `ldapsearch' to actually perform the searches. That program can be |
27313 | 33 ;; found in all LDAP developer kits such as: |
34 ;; - UM-LDAP 3.3 (http://www.umich.edu/~dirsvcs/ldap/) | |
35 ;; - OpenLDAP (http://www.openldap.org/) | |
36 | |
37 ;;; Code: | |
38 | |
39 (require 'custom) | |
54805
37581abcf761
(ldap-search): Use list*.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54359
diff
changeset
|
40 (eval-when-compile (require 'cl)) |
27313 | 41 |
42 (defgroup ldap nil | |
43 "Lightweight Directory Access Protocol." | |
33930 | 44 :version "21.1" |
27313 | 45 :group 'comm) |
46 | |
47 (defcustom ldap-default-host nil | |
48 "*Default LDAP server. | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
49 A TCP port number can be appended to that name using a colon as |
27313 | 50 a separator." |
51 :type '(choice (string :tag "Host name") | |
52 (const :tag "Use library default" nil)) | |
53 :group 'ldap) | |
54 | |
55 (defcustom ldap-default-port nil | |
56 "*Default TCP port for LDAP connections. | |
57 Initialized from the LDAP library at build time. Default value is 389." | |
58 :type '(choice (const :tag "Use library default" nil) | |
59 (integer :tag "Port number")) | |
60 :group 'ldap) | |
61 | |
62 (defcustom ldap-default-base nil | |
63 "*Default base for LDAP searches. | |
64 This is a string using the syntax of RFC 1779. | |
65 For instance, \"o=ACME, c=US\" limits the search to the | |
66 Acme organization in the United States." | |
67 :type '(choice (const :tag "Use library default" nil) | |
68 (string :tag "Search base")) | |
69 :group 'ldap) | |
70 | |
71 | |
72 (defcustom ldap-host-parameters-alist nil | |
73 "*Alist of host-specific options for LDAP transactions. | |
74 The format of each list element is (HOST PROP1 VAL1 PROP2 VAL2 ...). | |
42573 | 75 HOST is the hostname of an LDAP server (with an optional TCP port number |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
76 appended to it using a colon as a separator). |
27313 | 77 PROPn and VALn are property/value pairs describing parameters for the server. |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
78 Valid properties include: |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
79 `binddn' is the distinguished name of the user to bind as |
27313 | 80 (in RFC 1779 syntax). |
81 `passwd' is the password to use for simple authentication. | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
82 `auth' is the authentication method to use. |
27313 | 83 Possible values are: `simple', `krbv41' and `krbv42'. |
84 `base' is the base for the search as described in RFC 1779. | |
85 `scope' is one of the three symbols `subtree', `base' or `onelevel'. | |
86 `deref' is one of the symbols `never', `always', `search' or `find'. | |
87 `timelimit' is the timeout limit for the connection in seconds. | |
88 `sizelimit' is the maximum number of matches to return." | |
89 :type '(repeat :menu-tag "Host parameters" | |
90 :tag "Host parameters" | |
91 (list :menu-tag "Host parameters" | |
92 :tag "Host parameters" | |
93 :value nil | |
94 (string :tag "Host name") | |
95 (checklist :inline t | |
96 :greedy t | |
97 (list | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
98 :tag "Search Base" |
27313 | 99 :inline t |
100 (const :tag "Search Base" base) | |
101 string) | |
102 (list | |
103 :tag "Binding DN" | |
104 :inline t | |
105 (const :tag "Binding DN" binddn) | |
106 string) | |
107 (list | |
108 :tag "Password" | |
109 :inline t | |
110 (const :tag "Password" passwd) | |
111 string) | |
112 (list | |
113 :tag "Authentication Method" | |
114 :inline t | |
115 (const :tag "Authentication Method" auth) | |
116 (choice | |
117 (const :menu-tag "None" :tag "None" nil) | |
118 (const :menu-tag "Simple" :tag "Simple" simple) | |
119 (const :menu-tag "Kerberos 4.1" :tag "Kerberos 4.1" krbv41) | |
120 (const :menu-tag "Kerberos 4.2" :tag "Kerberos 4.2" krbv42))) | |
121 (list | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
122 :tag "Search Scope" |
27313 | 123 :inline t |
124 (const :tag "Search Scope" scope) | |
125 (choice | |
126 (const :menu-tag "Default" :tag "Default" nil) | |
127 (const :menu-tag "Subtree" :tag "Subtree" subtree) | |
128 (const :menu-tag "Base" :tag "Base" base) | |
129 (const :menu-tag "One Level" :tag "One Level" onelevel))) | |
130 (list | |
131 :tag "Dereferencing" | |
132 :inline t | |
133 (const :tag "Dereferencing" deref) | |
134 (choice | |
135 (const :menu-tag "Default" :tag "Default" nil) | |
136 (const :menu-tag "Never" :tag "Never" never) | |
137 (const :menu-tag "Always" :tag "Always" always) | |
138 (const :menu-tag "When searching" :tag "When searching" search) | |
139 (const :menu-tag "When locating base" :tag "When locating base" find))) | |
140 (list | |
141 :tag "Time Limit" | |
142 :inline t | |
143 (const :tag "Time Limit" timelimit) | |
144 (integer :tag "(in seconds)")) | |
145 (list | |
146 :tag "Size Limit" | |
147 :inline t | |
148 (const :tag "Size Limit" sizelimit) | |
149 (integer :tag "(number of records)"))))) | |
150 :group 'ldap) | |
151 | |
152 (defcustom ldap-ldapsearch-prog "ldapsearch" | |
153 "*The name of the ldapsearch command line program." | |
154 :type '(string :tag "`ldapsearch' Program") | |
155 :group 'ldap) | |
156 | |
71331
f4495654b2ad
2006-06-13 Martin J. Reed <mjreed@essex.ac.uk> (tiny change)
Chong Yidong <cyd@stupidchicken.com>
parents:
68648
diff
changeset
|
157 (defcustom ldap-ldapsearch-args '("-LL" "-tt") |
42783
c1bb3d3c9621
(ldap-ldapsearch-prog): Default to OpenLDAP version 2 ldapsearch.
Pavel Janík <Pavel@Janik.cz>
parents:
42607
diff
changeset
|
158 "*A list of additional arguments to pass to `ldapsearch'." |
27313 | 159 :type '(repeat :tag "`ldapsearch' Arguments" |
160 (string :tag "Argument")) | |
161 :group 'ldap) | |
162 | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
163 (defcustom ldap-ignore-attribute-codings nil |
27313 | 164 "*If non-nil, do not encode/decode LDAP attribute values." |
165 :type 'boolean | |
166 :group 'ldap) | |
167 | |
168 (defcustom ldap-default-attribute-decoder nil | |
169 "*Decoder function to use for attributes whose syntax is unknown." | |
170 :type 'symbol | |
171 :group 'ldap) | |
172 | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
173 (defcustom ldap-coding-system 'utf-8 |
27313 | 174 "*Coding system of LDAP string values. |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
175 LDAP v3 specifies the coding system of strings to be UTF-8." |
27313 | 176 :type 'symbol |
177 :group 'ldap) | |
178 | |
179 (defvar ldap-attribute-syntax-encoders | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
180 [nil ; 1 ACI Item N |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
181 nil ; 2 Access Point Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
182 nil ; 3 Attribute Type Description Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
183 nil ; 4 Audio N |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
184 nil ; 5 Binary N |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
185 nil ; 6 Bit String Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
186 ldap-encode-boolean ; 7 Boolean Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
187 nil ; 8 Certificate N |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
188 nil ; 9 Certificate List N |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
189 nil ; 10 Certificate Pair N |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
190 ldap-encode-country-string ; 11 Country String Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
191 ldap-encode-string ; 12 DN Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
192 nil ; 13 Data Quality Syntax Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
193 nil ; 14 Delivery Method Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
194 ldap-encode-string ; 15 Directory String Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
195 nil ; 16 DIT Content Rule Description Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
196 nil ; 17 DIT Structure Rule Description Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
197 nil ; 18 DL Submit Permission Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
198 nil ; 19 DSA Quality Syntax Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
199 nil ; 20 DSE Type Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
200 nil ; 21 Enhanced Guide Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
201 nil ; 22 Facsimile Telephone Number Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
202 nil ; 23 Fax N |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
203 nil ; 24 Generalized Time Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
204 nil ; 25 Guide Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
205 nil ; 26 IA5 String Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
206 number-to-string ; 27 INTEGER Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
207 nil ; 28 JPEG N |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
208 nil ; 29 Master And Shadow Access Points Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
209 nil ; 30 Matching Rule Description Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
210 nil ; 31 Matching Rule Use Description Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
211 nil ; 32 Mail Preference Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
212 nil ; 33 MHS OR Address Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
213 nil ; 34 Name And Optional UID Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
214 nil ; 35 Name Form Description Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
215 nil ; 36 Numeric String Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
216 nil ; 37 Object Class Description Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
217 nil ; 38 OID Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
218 nil ; 39 Other Mailbox Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
219 nil ; 40 Octet String Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
220 ldap-encode-address ; 41 Postal Address Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
221 nil ; 42 Protocol Information Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
222 nil ; 43 Presentation Address Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
223 ldap-encode-string ; 44 Printable String Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
224 nil ; 45 Subtree Specification Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
225 nil ; 46 Supplier Information Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
226 nil ; 47 Supplier Or Consumer Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
227 nil ; 48 Supplier And Consumer Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
228 nil ; 49 Supported Algorithm N |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
229 nil ; 50 Telephone Number Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
230 nil ; 51 Teletex Terminal Identifier Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
231 nil ; 52 Telex Number Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
232 nil ; 53 UTC Time Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
233 nil ; 54 LDAP Syntax Description Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
234 nil ; 55 Modify Rights Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
235 nil ; 56 LDAP Schema Definition Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
236 nil ; 57 LDAP Schema Description Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
237 nil ; 58 Substring Assertion Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
238 ] |
27313 | 239 "A vector of functions used to encode LDAP attribute values. |
240 The sequence of functions corresponds to the sequence of LDAP attribute syntax | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
241 object identifiers of the form 1.3.6.1.4.1.1466.1115.121.1.* as defined in |
27313 | 242 RFC2252 section 4.3.2") |
243 | |
244 (defvar ldap-attribute-syntax-decoders | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
245 [nil ; 1 ACI Item N |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
246 nil ; 2 Access Point Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
247 nil ; 3 Attribute Type Description Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
248 nil ; 4 Audio N |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
249 nil ; 5 Binary N |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
250 nil ; 6 Bit String Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
251 ldap-decode-boolean ; 7 Boolean Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
252 nil ; 8 Certificate N |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
253 nil ; 9 Certificate List N |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
254 nil ; 10 Certificate Pair N |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
255 ldap-decode-string ; 11 Country String Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
256 ldap-decode-string ; 12 DN Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
257 nil ; 13 Data Quality Syntax Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
258 nil ; 14 Delivery Method Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
259 ldap-decode-string ; 15 Directory String Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
260 nil ; 16 DIT Content Rule Description Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
261 nil ; 17 DIT Structure Rule Description Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
262 nil ; 18 DL Submit Permission Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
263 nil ; 19 DSA Quality Syntax Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
264 nil ; 20 DSE Type Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
265 nil ; 21 Enhanced Guide Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
266 nil ; 22 Facsimile Telephone Number Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
267 nil ; 23 Fax N |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
268 nil ; 24 Generalized Time Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
269 nil ; 25 Guide Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
270 nil ; 26 IA5 String Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
271 string-to-number ; 27 INTEGER Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
272 nil ; 28 JPEG N |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
273 nil ; 29 Master And Shadow Access Points Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
274 nil ; 30 Matching Rule Description Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
275 nil ; 31 Matching Rule Use Description Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
276 nil ; 32 Mail Preference Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
277 nil ; 33 MHS OR Address Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
278 nil ; 34 Name And Optional UID Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
279 nil ; 35 Name Form Description Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
280 nil ; 36 Numeric String Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
281 nil ; 37 Object Class Description Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
282 nil ; 38 OID Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
283 nil ; 39 Other Mailbox Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
284 nil ; 40 Octet String Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
285 ldap-decode-address ; 41 Postal Address Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
286 nil ; 42 Protocol Information Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
287 nil ; 43 Presentation Address Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
288 ldap-decode-string ; 44 Printable String Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
289 nil ; 45 Subtree Specification Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
290 nil ; 46 Supplier Information Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
291 nil ; 47 Supplier Or Consumer Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
292 nil ; 48 Supplier And Consumer Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
293 nil ; 49 Supported Algorithm N |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
294 nil ; 50 Telephone Number Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
295 nil ; 51 Teletex Terminal Identifier Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
296 nil ; 52 Telex Number Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
297 nil ; 53 UTC Time Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
298 nil ; 54 LDAP Syntax Description Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
299 nil ; 55 Modify Rights Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
300 nil ; 56 LDAP Schema Definition Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
301 nil ; 57 LDAP Schema Description Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
302 nil ; 58 Substring Assertion Y |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
303 ] |
27313 | 304 "A vector of functions used to decode LDAP attribute values. |
305 The sequence of functions corresponds to the sequence of LDAP attribute syntax | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
306 object identifiers of the form 1.3.6.1.4.1.1466.1115.121.1.* as defined in |
27313 | 307 RFC2252 section 4.3.2") |
308 | |
309 | |
310 (defvar ldap-attribute-syntaxes-alist | |
311 '((createtimestamp . 24) | |
312 (modifytimestamp . 24) | |
313 (creatorsname . 12) | |
314 (modifiersname . 12) | |
315 (subschemasubentry . 12) | |
316 (attributetypes . 3) | |
317 (objectclasses . 37) | |
318 (matchingrules . 30) | |
319 (matchingruleuse . 31) | |
320 (namingcontexts . 12) | |
321 (altserver . 26) | |
322 (supportedextension . 38) | |
323 (supportedcontrol . 38) | |
324 (supportedsaslmechanisms . 15) | |
325 (supportedldapversion . 27) | |
326 (ldapsyntaxes . 16) | |
327 (ditstructurerules . 17) | |
328 (nameforms . 35) | |
329 (ditcontentrules . 16) | |
330 (objectclass . 38) | |
331 (aliasedobjectname . 12) | |
332 (cn . 15) | |
333 (sn . 15) | |
334 (serialnumber . 44) | |
335 (c . 15) | |
336 (l . 15) | |
337 (st . 15) | |
338 (street . 15) | |
339 (o . 15) | |
340 (ou . 15) | |
341 (title . 15) | |
342 (description . 15) | |
343 (searchguide . 25) | |
344 (businesscategory . 15) | |
345 (postaladdress . 41) | |
346 (postalcode . 15) | |
347 (postofficebox . 15) | |
348 (physicaldeliveryofficename . 15) | |
349 (telephonenumber . 50) | |
350 (telexnumber . 52) | |
351 (telexterminalidentifier . 51) | |
352 (facsimiletelephonenumber . 22) | |
353 (x121address . 36) | |
354 (internationalisdnnumber . 36) | |
355 (registeredaddress . 41) | |
356 (destinationindicator . 44) | |
357 (preferreddeliverymethod . 14) | |
358 (presentationaddress . 43) | |
359 (supportedapplicationcontext . 38) | |
360 (member . 12) | |
361 (owner . 12) | |
362 (roleoccupant . 12) | |
363 (seealso . 12) | |
364 (userpassword . 40) | |
365 (usercertificate . 8) | |
366 (cacertificate . 8) | |
367 (authorityrevocationlist . 9) | |
368 (certificaterevocationlist . 9) | |
369 (crosscertificatepair . 10) | |
370 (name . 15) | |
371 (givenname . 15) | |
372 (initials . 15) | |
373 (generationqualifier . 15) | |
374 (x500uniqueidentifier . 6) | |
375 (dnqualifier . 44) | |
376 (enhancedsearchguide . 21) | |
377 (protocolinformation . 42) | |
378 (distinguishedname . 12) | |
379 (uniquemember . 34) | |
380 (houseidentifier . 15) | |
381 (supportedalgorithms . 49) | |
382 (deltarevocationlist . 9) | |
383 (dmdname . 15)) | |
384 "A map of LDAP attribute names to their type object id minor number. | |
385 This table is built from RFC2252 Section 5 and RFC2256 Section 5") | |
386 | |
387 | |
388 ;; Coding/decoding functions | |
389 | |
390 (defun ldap-encode-boolean (bool) | |
391 (if bool | |
392 "TRUE" | |
393 "FALSE")) | |
394 | |
395 (defun ldap-decode-boolean (str) | |
396 (cond | |
397 ((string-equal str "TRUE") | |
398 t) | |
399 ((string-equal str "FALSE") | |
400 nil) | |
401 (t | |
402 (error "Wrong LDAP boolean string: %s" str)))) | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
403 |
27313 | 404 (defun ldap-encode-country-string (str) |
405 ;; We should do something useful here... | |
406 (if (not (= 2 (length str))) | |
407 (error "Invalid country string: %s" str))) | |
408 | |
409 (defun ldap-decode-string (str) | |
410 (decode-coding-string str ldap-coding-system)) | |
411 | |
412 (defun ldap-encode-string (str) | |
413 (encode-coding-string str ldap-coding-system)) | |
414 | |
415 (defun ldap-decode-address (str) | |
416 (mapconcat 'ldap-decode-string | |
417 (split-string str "\\$") | |
418 "\n")) | |
419 | |
420 (defun ldap-encode-address (str) | |
421 (mapconcat 'ldap-encode-string | |
422 (split-string str "\n") | |
423 "$")) | |
424 | |
425 | |
426 ;; LDAP protocol functions | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
427 |
27313 | 428 (defun ldap-get-host-parameter (host parameter) |
429 "Get the value of PARAMETER for HOST in `ldap-host-parameters-alist'." | |
430 (plist-get (cdr (assoc host ldap-host-parameters-alist)) | |
431 parameter)) | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
432 |
27313 | 433 (defun ldap-decode-attribute (attr) |
434 "Decode the attribute/value pair ATTR according to LDAP rules. | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
435 The attribute name is looked up in `ldap-attribute-syntaxes-alist' |
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
436 and the corresponding decoder is then retrieved from |
27313 | 437 `ldap-attribute-syntax-decoders' and applied on the value(s)." |
438 (let* ((name (car attr)) | |
439 (values (cdr attr)) | |
440 (syntax-id (cdr (assq (intern (downcase name)) | |
441 ldap-attribute-syntaxes-alist))) | |
442 decoder) | |
443 (if syntax-id | |
444 (setq decoder (aref ldap-attribute-syntax-decoders | |
445 (1- syntax-id))) | |
446 (setq decoder ldap-default-attribute-decoder)) | |
447 (if decoder | |
448 (cons name (mapcar decoder values)) | |
449 attr))) | |
450 | |
451 (defun ldap-search (filter &optional host attributes attrsonly withdn) | |
452 "Perform an LDAP search. | |
453 FILTER is the search filter in RFC1558 syntax. | |
454 HOST is the LDAP host on which to perform the search. | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
455 ATTRIBUTES are the specific attributes to retrieve, nil means |
27313 | 456 retrieve all. |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
457 ATTRSONLY, if non-nil, retrieves the attributes only, without |
27313 | 458 the associated values. |
459 If WITHDN is non-nil, each entry in the result will be prepended with | |
460 its distinguished name WITHDN. | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
461 Additional search parameters can be specified through |
27313 | 462 `ldap-host-parameters-alist', which see." |
463 (interactive "sFilter:") | |
464 (or host | |
465 (setq host ldap-default-host) | |
466 (error "No LDAP host specified")) | |
467 (let ((host-plist (cdr (assoc host ldap-host-parameters-alist))) | |
468 result) | |
54805
37581abcf761
(ldap-search): Use list*.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54359
diff
changeset
|
469 (setq result (ldap-search-internal (list* 'host host |
37581abcf761
(ldap-search): Use list*.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54359
diff
changeset
|
470 'filter filter |
37581abcf761
(ldap-search): Use list*.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54359
diff
changeset
|
471 'attributes attributes |
37581abcf761
(ldap-search): Use list*.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54359
diff
changeset
|
472 'attrsonly attrsonly |
37581abcf761
(ldap-search): Use list*.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54359
diff
changeset
|
473 'withdn withdn |
37581abcf761
(ldap-search): Use list*.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54359
diff
changeset
|
474 host-plist))) |
27313 | 475 (if ldap-ignore-attribute-codings |
476 result | |
54805
37581abcf761
(ldap-search): Use list*.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54359
diff
changeset
|
477 (mapcar (lambda (record) |
37581abcf761
(ldap-search): Use list*.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54359
diff
changeset
|
478 (mapcar 'ldap-decode-attribute record)) |
27313 | 479 result)))) |
480 | |
481 | |
482 (defun ldap-search-internal (search-plist) | |
483 "Perform a search on a LDAP server. | |
484 SEARCH-PLIST is a property list describing the search request. | |
485 Valid keys in that list are: | |
486 `host' is a string naming one or more (blank-separated) LDAP servers to | |
487 to try to connect to. Each host name may optionally be of the form HOST:PORT. | |
488 `filter' is a filter string for the search as described in RFC 1558. | |
489 `attributes' is a list of strings indicating which attributes to retrieve | |
490 for each matching entry. If nil, return all available attributes. | |
491 `attrsonly', if non-nil, indicates that only attributes are retrieved, | |
492 not their associated values. | |
72701
891321627212
* net/ldap.el (ldap-search-internal): Handle `auth' key.
Chong Yidong <cyd@stupidchicken.com>
parents:
71331
diff
changeset
|
493 `auth' is one of the symbols `simple', `krbv41' or `krbv42'. |
27313 | 494 `base' is the base for the search as described in RFC 1779. |
495 `scope' is one of the three symbols `sub', `base' or `one'. | |
496 `binddn' is the distinguished name of the user to bind as (in RFC 1779 syntax). | |
72752
f9449f64d4b8
(ldap-search-internal): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents:
72701
diff
changeset
|
497 `auth' is one of the symbols `simple', `krbv41' or `krbv42' |
27313 | 498 `passwd' is the password to use for simple authentication. |
499 `deref' is one of the symbols `never', `always', `search' or `find'. | |
500 `timelimit' is the timeout limit for the connection in seconds. | |
501 `sizelimit' is the maximum number of matches to return. | |
502 `withdn' if non-nil each entry in the result will be prepended with | |
503 its distinguished name DN. | |
504 The function returns a list of matching entries. Each entry is itself | |
505 an alist of attribute/value pairs." | |
506 (let ((buf (get-buffer-create " *ldap-search*")) | |
507 (bufval (get-buffer-create " *ldap-value*")) | |
508 (host (or (plist-get search-plist 'host) | |
509 ldap-default-host)) | |
510 (filter (plist-get search-plist 'filter)) | |
511 (attributes (plist-get search-plist 'attributes)) | |
512 (attrsonly (plist-get search-plist 'attrsonly)) | |
513 (base (or (plist-get search-plist 'base) | |
514 ldap-default-base)) | |
515 (scope (plist-get search-plist 'scope)) | |
516 (binddn (plist-get search-plist 'binddn)) | |
72701
891321627212
* net/ldap.el (ldap-search-internal): Handle `auth' key.
Chong Yidong <cyd@stupidchicken.com>
parents:
71331
diff
changeset
|
517 (auth (plist-get search-plist 'auth)) |
27313 | 518 (passwd (plist-get search-plist 'passwd)) |
519 (deref (plist-get search-plist 'deref)) | |
520 (timelimit (plist-get search-plist 'timelimit)) | |
521 (sizelimit (plist-get search-plist 'sizelimit)) | |
522 (withdn (plist-get search-plist 'withdn)) | |
523 (numres 0) | |
524 arglist dn name value record result) | |
525 (if (or (null filter) | |
526 (equal "" filter)) | |
527 (error "No search filter")) | |
528 (setq filter (cons filter attributes)) | |
529 (save-excursion | |
530 (set-buffer buf) | |
531 (erase-buffer) | |
532 (if (and host | |
533 (not (equal "" host))) | |
534 (setq arglist (nconc arglist (list (format "-h%s" host))))) | |
535 (if (and attrsonly | |
536 (not (equal "" attrsonly))) | |
537 (setq arglist (nconc arglist (list "-A")))) | |
538 (if (and base | |
539 (not (equal "" base))) | |
540 (setq arglist (nconc arglist (list (format "-b%s" base))))) | |
541 (if (and scope | |
542 (not (equal "" scope))) | |
543 (setq arglist (nconc arglist (list (format "-s%s" scope))))) | |
544 (if (and binddn | |
545 (not (equal "" binddn))) | |
546 (setq arglist (nconc arglist (list (format "-D%s" binddn))))) | |
72701
891321627212
* net/ldap.el (ldap-search-internal): Handle `auth' key.
Chong Yidong <cyd@stupidchicken.com>
parents:
71331
diff
changeset
|
547 (if (and auth |
891321627212
* net/ldap.el (ldap-search-internal): Handle `auth' key.
Chong Yidong <cyd@stupidchicken.com>
parents:
71331
diff
changeset
|
548 (equal 'simple auth)) |
891321627212
* net/ldap.el (ldap-search-internal): Handle `auth' key.
Chong Yidong <cyd@stupidchicken.com>
parents:
71331
diff
changeset
|
549 (setq arglist (nconc arglist (list "-x")))) |
27313 | 550 (if (and passwd |
551 (not (equal "" passwd))) | |
552 (setq arglist (nconc arglist (list (format "-w%s" passwd))))) | |
553 (if (and deref | |
554 (not (equal "" deref))) | |
555 (setq arglist (nconc arglist (list (format "-a%s" deref))))) | |
556 (if (and timelimit | |
557 (not (equal "" timelimit))) | |
558 (setq arglist (nconc arglist (list (format "-l%s" timelimit))))) | |
559 (if (and sizelimit | |
560 (not (equal "" sizelimit))) | |
561 (setq arglist (nconc arglist (list (format "-z%s" sizelimit))))) | |
562 (eval `(call-process ldap-ldapsearch-prog | |
563 nil | |
71331
f4495654b2ad
2006-06-13 Martin J. Reed <mjreed@essex.ac.uk> (tiny change)
Chong Yidong <cyd@stupidchicken.com>
parents:
68648
diff
changeset
|
564 buf |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
565 nil |
27313 | 566 ,@arglist |
567 ,@ldap-ldapsearch-args | |
568 ,@filter)) | |
569 (insert "\n") | |
570 (goto-char (point-min)) | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
571 |
45247
6baa96917e56
(ldap-search-internal): Unfold folded lines before parsing.
Pavel Janík <Pavel@Janik.cz>
parents:
42783
diff
changeset
|
572 (while (re-search-forward "[\t\n\f]+ " nil t) |
6baa96917e56
(ldap-search-internal): Unfold folded lines before parsing.
Pavel Janík <Pavel@Janik.cz>
parents:
42783
diff
changeset
|
573 (replace-match "" nil nil)) |
6baa96917e56
(ldap-search-internal): Unfold folded lines before parsing.
Pavel Janík <Pavel@Janik.cz>
parents:
42783
diff
changeset
|
574 (goto-char (point-min)) |
6baa96917e56
(ldap-search-internal): Unfold folded lines before parsing.
Pavel Janík <Pavel@Janik.cz>
parents:
42783
diff
changeset
|
575 |
27313 | 576 (if (looking-at "usage") |
577 (error "Incorrect ldapsearch invocation") | |
578 (message "Parsing results... ") | |
42579
c914fba3811b
(ldap-search-internal): Skip error message from ldapsearch. Allow listing
Pavel Janík <Pavel@Janik.cz>
parents:
42573
diff
changeset
|
579 ;; Skip error message when retrieving attribute list |
c914fba3811b
(ldap-search-internal): Skip error message from ldapsearch. Allow listing
Pavel Janík <Pavel@Janik.cz>
parents:
42573
diff
changeset
|
580 (if (looking-at "Size limit exceeded") |
c914fba3811b
(ldap-search-internal): Skip error message from ldapsearch. Allow listing
Pavel Janík <Pavel@Janik.cz>
parents:
42573
diff
changeset
|
581 (forward-line 1)) |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
582 (while (progn |
27313 | 583 (skip-chars-forward " \t\n") |
584 (not (eobp))) | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
585 (setq dn (buffer-substring (point) (save-excursion |
27313 | 586 (end-of-line) |
587 (point)))) | |
588 (forward-line 1) | |
71331
f4495654b2ad
2006-06-13 Martin J. Reed <mjreed@essex.ac.uk> (tiny change)
Chong Yidong <cyd@stupidchicken.com>
parents:
68648
diff
changeset
|
589 (while (looking-at "^\\(\\w*\\)\\(;\\w*\\)?[=:\t ]+\\(<[\t ]*file://\\)\\(.*\\)$") |
27313 | 590 (setq name (match-string 1) |
59935
ccb26cb917af
(ldap-search-internal): Support attributes with
Eli Zaretskii <eliz@gnu.org>
parents:
55698
diff
changeset
|
591 value (match-string 4)) |
54359
e63d620f8988
(ldap-search-internal): Handle file URLs with drive
Jason Rumney <jasonr@gnu.org>
parents:
52401
diff
changeset
|
592 ;; Need to handle file:///D:/... as generated by OpenLDAP |
e63d620f8988
(ldap-search-internal): Handle file URLs with drive
Jason Rumney <jasonr@gnu.org>
parents:
52401
diff
changeset
|
593 ;; on DOS/Windows as local files. |
e63d620f8988
(ldap-search-internal): Handle file URLs with drive
Jason Rumney <jasonr@gnu.org>
parents:
52401
diff
changeset
|
594 (if (and (memq system-type '(windows-nt ms-dos)) |
e63d620f8988
(ldap-search-internal): Handle file URLs with drive
Jason Rumney <jasonr@gnu.org>
parents:
52401
diff
changeset
|
595 (eq (string-match "/\\(.:.*\\)$" value) 0)) |
e63d620f8988
(ldap-search-internal): Handle file URLs with drive
Jason Rumney <jasonr@gnu.org>
parents:
52401
diff
changeset
|
596 (setq value (match-string 1 value))) |
42579
c914fba3811b
(ldap-search-internal): Skip error message from ldapsearch. Allow listing
Pavel Janík <Pavel@Janik.cz>
parents:
42573
diff
changeset
|
597 ;; Do not try to open non-existent files |
c914fba3811b
(ldap-search-internal): Skip error message from ldapsearch. Allow listing
Pavel Janík <Pavel@Janik.cz>
parents:
42573
diff
changeset
|
598 (if (equal value "") |
c914fba3811b
(ldap-search-internal): Skip error message from ldapsearch. Allow listing
Pavel Janík <Pavel@Janik.cz>
parents:
42573
diff
changeset
|
599 (setq value " ") |
c914fba3811b
(ldap-search-internal): Skip error message from ldapsearch. Allow listing
Pavel Janík <Pavel@Janik.cz>
parents:
42573
diff
changeset
|
600 (save-excursion |
c914fba3811b
(ldap-search-internal): Skip error message from ldapsearch. Allow listing
Pavel Janík <Pavel@Janik.cz>
parents:
42573
diff
changeset
|
601 (set-buffer bufval) |
c914fba3811b
(ldap-search-internal): Skip error message from ldapsearch. Allow listing
Pavel Janík <Pavel@Janik.cz>
parents:
42573
diff
changeset
|
602 (erase-buffer) |
c914fba3811b
(ldap-search-internal): Skip error message from ldapsearch. Allow listing
Pavel Janík <Pavel@Janik.cz>
parents:
42573
diff
changeset
|
603 (set-buffer-multibyte nil) |
c914fba3811b
(ldap-search-internal): Skip error message from ldapsearch. Allow listing
Pavel Janík <Pavel@Janik.cz>
parents:
42573
diff
changeset
|
604 (insert-file-contents-literally value) |
c914fba3811b
(ldap-search-internal): Skip error message from ldapsearch. Allow listing
Pavel Janík <Pavel@Janik.cz>
parents:
42573
diff
changeset
|
605 (delete-file value) |
c914fba3811b
(ldap-search-internal): Skip error message from ldapsearch. Allow listing
Pavel Janík <Pavel@Janik.cz>
parents:
42573
diff
changeset
|
606 (setq value (buffer-string)))) |
27313 | 607 (setq record (cons (list name value) |
608 record)) | |
609 (forward-line 1)) | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
610 (setq result (cons (if withdn |
27313 | 611 (cons dn (nreverse record)) |
612 (nreverse record)) result)) | |
613 (setq record nil) | |
42517
400e6bda5a0d
(ldap-host-parameters-alist): Remove duplicated entry.
Pavel Janík <Pavel@Janik.cz>
parents:
42368
diff
changeset
|
614 (skip-chars-forward " \t\n") |
27313 | 615 (message "Parsing results... %d" numres) |
616 (1+ numres)) | |
617 (message "Parsing results... done") | |
618 (nreverse result))))) | |
619 | |
620 (provide 'ldap) | |
621 | |
52401 | 622 ;;; arch-tag: 47913a76-6155-42e6-ac58-6d28b5d50eb0 |
27313 | 623 ;;; ldap.el ends here |