;; Author: Oscar Figueiredo <Oscar.Figueiredo@di.epfl.ch>
;; Maintainer: Oscar Figueiredo <Oscar.Figueiredo@di.epfl.ch>
;; Created: Jan 1998
-;; Version: $Revision: 1.7.2.8 $
+;; Version: $Revision: 1.7.2.9 $
;; Keywords: help comm
;; This file is part of XEmacs
;; General Public License for more details.
;; You should have received a copy of the GNU General Public License
-;; along with XEmacs; see the file COPYING. If not, write to
+;; along with XEmacs; see the file COPYING. If not, write to
;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
;;; Commentary:
;; This file provides mid-level and user-level functions to access directory
-;; servers using the LDAP protocol (RFC 1777).
+;; servers using the LDAP protocol (RFC 1777).
;;; Installation:
;; LDAP support must have been built into XEmacs.
(defcustom ldap-default-host nil
"*Default LDAP server hostname.
-A TCP port number can be appended to that name using a colon as
+A TCP port number can be appended to that name using a colon as
a separator."
:type '(choice (string :tag "Host name")
(const :tag "Use library default" nil))
The format of each list element is:
\(HOST PROP1 VAL1 PROP2 VAL2 ...)
HOST is the hostname of an LDAP server (with an optional TCP port number
-appended to it using a colon as a separator).
+appended to it using a colon as a separator).
PROPn and VALn are property/value pairs describing parameters for the server.
Valid properties include:
- `binddn' is the distinguished name of the user to bind as
+ `binddn' is the distinguished name of the user to bind as
(in RFC 1779 syntax).
`passwd' is the password to use for simple authentication.
- `auth' is the authentication method to use.
+ `auth' is the authentication method to use.
Possible values are: `simple', `krbv41' and `krbv42'.
`base' is the base for the search as described in RFC 1779.
`scope' is one of the three symbols `subtree', `base' or `onelevel'.
(checklist :inline t
:greedy t
(list
- :tag "Search Base"
+ :tag "Search Base"
:inline t
(const :tag "Search Base" base)
string)
(const :menu-tag "Kerberos 4.1" :tag "Kerberos 4.1" krbv41)
(const :menu-tag "Kerberos 4.2" :tag "Kerberos 4.2" krbv42)))
(list
- :tag "Search Scope"
+ :tag "Search Scope"
:inline t
(const :tag "Search Scope" scope)
(choice
(defcustom ldap-coding-system nil
"*Coding system of LDAP string values.
-LDAP v3 specifies the coding system of strings to be UTF-8.
+LDAP v3 specifies the coding system of strings to be UTF-8.
Mule support is needed for this."
:type 'symbol
:group 'ldap)
(defvar ldap-attribute-syntax-encoders
- [nil ; 1 ACI Item N
- nil ; 2 Access Point Y
- nil ; 3 Attribute Type Description Y
- nil ; 4 Audio N
- nil ; 5 Binary N
- nil ; 6 Bit String Y
- ldap-encode-boolean ; 7 Boolean Y
- nil ; 8 Certificate N
- nil ; 9 Certificate List N
- nil ; 10 Certificate Pair N
- ldap-encode-country-string ; 11 Country String Y
- ldap-encode-string ; 12 DN Y
- nil ; 13 Data Quality Syntax Y
- nil ; 14 Delivery Method Y
- ldap-encode-string ; 15 Directory String Y
- nil ; 16 DIT Content Rule Description Y
- nil ; 17 DIT Structure Rule Description Y
- nil ; 18 DL Submit Permission Y
- nil ; 19 DSA Quality Syntax Y
- nil ; 20 DSE Type Y
- nil ; 21 Enhanced Guide Y
- nil ; 22 Facsimile Telephone Number Y
- nil ; 23 Fax N
- nil ; 24 Generalized Time Y
- nil ; 25 Guide Y
- nil ; 26 IA5 String Y
- number-to-string ; 27 INTEGER Y
- nil ; 28 JPEG N
- nil ; 29 Master And Shadow Access Points Y
- nil ; 30 Matching Rule Description Y
- nil ; 31 Matching Rule Use Description Y
- nil ; 32 Mail Preference Y
- nil ; 33 MHS OR Address Y
- nil ; 34 Name And Optional UID Y
- nil ; 35 Name Form Description Y
- nil ; 36 Numeric String Y
- nil ; 37 Object Class Description Y
- nil ; 38 OID Y
- nil ; 39 Other Mailbox Y
- nil ; 40 Octet String Y
- ldap-encode-address ; 41 Postal Address Y
- nil ; 42 Protocol Information Y
- nil ; 43 Presentation Address Y
- ldap-encode-string ; 44 Printable String Y
- nil ; 45 Subtree Specification Y
- nil ; 46 Supplier Information Y
- nil ; 47 Supplier Or Consumer Y
- nil ; 48 Supplier And Consumer Y
- nil ; 49 Supported Algorithm N
- nil ; 50 Telephone Number Y
- nil ; 51 Teletex Terminal Identifier Y
- nil ; 52 Telex Number Y
- nil ; 53 UTC Time Y
- nil ; 54 LDAP Syntax Description Y
- nil ; 55 Modify Rights Y
- nil ; 56 LDAP Schema Definition Y
- nil ; 57 LDAP Schema Description Y
- nil ; 58 Substring Assertion Y
- ]
+ [nil ; 1 ACI Item N
+ nil ; 2 Access Point Y
+ nil ; 3 Attribute Type Description Y
+ nil ; 4 Audio N
+ nil ; 5 Binary N
+ nil ; 6 Bit String Y
+ ldap-encode-boolean ; 7 Boolean Y
+ nil ; 8 Certificate N
+ nil ; 9 Certificate List N
+ nil ; 10 Certificate Pair N
+ ldap-encode-country-string ; 11 Country String Y
+ ldap-encode-string ; 12 DN Y
+ nil ; 13 Data Quality Syntax Y
+ nil ; 14 Delivery Method Y
+ ldap-encode-string ; 15 Directory String Y
+ nil ; 16 DIT Content Rule Description Y
+ nil ; 17 DIT Structure Rule Description Y
+ nil ; 18 DL Submit Permission Y
+ nil ; 19 DSA Quality Syntax Y
+ nil ; 20 DSE Type Y
+ nil ; 21 Enhanced Guide Y
+ nil ; 22 Facsimile Telephone Number Y
+ nil ; 23 Fax N
+ nil ; 24 Generalized Time Y
+ nil ; 25 Guide Y
+ nil ; 26 IA5 String Y
+ number-to-string ; 27 INTEGER Y
+ nil ; 28 JPEG N
+ nil ; 29 Master And Shadow Access Points Y
+ nil ; 30 Matching Rule Description Y
+ nil ; 31 Matching Rule Use Description Y
+ nil ; 32 Mail Preference Y
+ nil ; 33 MHS OR Address Y
+ nil ; 34 Name And Optional UID Y
+ nil ; 35 Name Form Description Y
+ nil ; 36 Numeric String Y
+ nil ; 37 Object Class Description Y
+ nil ; 38 OID Y
+ nil ; 39 Other Mailbox Y
+ nil ; 40 Octet String Y
+ ldap-encode-address ; 41 Postal Address Y
+ nil ; 42 Protocol Information Y
+ nil ; 43 Presentation Address Y
+ ldap-encode-string ; 44 Printable String Y
+ nil ; 45 Subtree Specification Y
+ nil ; 46 Supplier Information Y
+ nil ; 47 Supplier Or Consumer Y
+ nil ; 48 Supplier And Consumer Y
+ nil ; 49 Supported Algorithm N
+ nil ; 50 Telephone Number Y
+ nil ; 51 Teletex Terminal Identifier Y
+ nil ; 52 Telex Number Y
+ nil ; 53 UTC Time Y
+ nil ; 54 LDAP Syntax Description Y
+ nil ; 55 Modify Rights Y
+ nil ; 56 LDAP Schema Definition Y
+ nil ; 57 LDAP Schema Description Y
+ nil ; 58 Substring Assertion Y
+ ]
"A vector of functions used to encode LDAP attribute values.
The sequence of functions corresponds to the sequence of LDAP attribute syntax
-object identifiers of the form 1.3.6.1.4.1.1466.1115.121.1.* as defined in
+object identifiers of the form 1.3.6.1.4.1.1466.1115.121.1.* as defined in
RFC2252 section 4.3.2")
(defvar ldap-attribute-syntax-decoders
- [nil ; 1 ACI Item N
- nil ; 2 Access Point Y
- nil ; 3 Attribute Type Description Y
- nil ; 4 Audio N
- nil ; 5 Binary N
- nil ; 6 Bit String Y
- ldap-decode-boolean ; 7 Boolean Y
- nil ; 8 Certificate N
- nil ; 9 Certificate List N
- nil ; 10 Certificate Pair N
- ldap-decode-string ; 11 Country String Y
- ldap-decode-string ; 12 DN Y
- nil ; 13 Data Quality Syntax Y
- nil ; 14 Delivery Method Y
- ldap-decode-string ; 15 Directory String Y
- nil ; 16 DIT Content Rule Description Y
- nil ; 17 DIT Structure Rule Description Y
- nil ; 18 DL Submit Permission Y
- nil ; 19 DSA Quality Syntax Y
- nil ; 20 DSE Type Y
- nil ; 21 Enhanced Guide Y
- nil ; 22 Facsimile Telephone Number Y
- nil ; 23 Fax N
- nil ; 24 Generalized Time Y
- nil ; 25 Guide Y
- nil ; 26 IA5 String Y
- string-to-number ; 27 INTEGER Y
- nil ; 28 JPEG N
- nil ; 29 Master And Shadow Access Points Y
- nil ; 30 Matching Rule Description Y
- nil ; 31 Matching Rule Use Description Y
- nil ; 32 Mail Preference Y
- nil ; 33 MHS OR Address Y
- nil ; 34 Name And Optional UID Y
- nil ; 35 Name Form Description Y
- nil ; 36 Numeric String Y
- nil ; 37 Object Class Description Y
- nil ; 38 OID Y
- nil ; 39 Other Mailbox Y
- nil ; 40 Octet String Y
- ldap-decode-address ; 41 Postal Address Y
- nil ; 42 Protocol Information Y
- nil ; 43 Presentation Address Y
- ldap-decode-string ; 44 Printable String Y
- nil ; 45 Subtree Specification Y
- nil ; 46 Supplier Information Y
- nil ; 47 Supplier Or Consumer Y
- nil ; 48 Supplier And Consumer Y
- nil ; 49 Supported Algorithm N
- nil ; 50 Telephone Number Y
- nil ; 51 Teletex Terminal Identifier Y
- nil ; 52 Telex Number Y
- nil ; 53 UTC Time Y
- nil ; 54 LDAP Syntax Description Y
- nil ; 55 Modify Rights Y
- nil ; 56 LDAP Schema Definition Y
- nil ; 57 LDAP Schema Description Y
- nil ; 58 Substring Assertion Y
- ]
+ [nil ; 1 ACI Item N
+ nil ; 2 Access Point Y
+ nil ; 3 Attribute Type Description Y
+ nil ; 4 Audio N
+ nil ; 5 Binary N
+ nil ; 6 Bit String Y
+ ldap-decode-boolean ; 7 Boolean Y
+ nil ; 8 Certificate N
+ nil ; 9 Certificate List N
+ nil ; 10 Certificate Pair N
+ ldap-decode-string ; 11 Country String Y
+ ldap-decode-string ; 12 DN Y
+ nil ; 13 Data Quality Syntax Y
+ nil ; 14 Delivery Method Y
+ ldap-decode-string ; 15 Directory String Y
+ nil ; 16 DIT Content Rule Description Y
+ nil ; 17 DIT Structure Rule Description Y
+ nil ; 18 DL Submit Permission Y
+ nil ; 19 DSA Quality Syntax Y
+ nil ; 20 DSE Type Y
+ nil ; 21 Enhanced Guide Y
+ nil ; 22 Facsimile Telephone Number Y
+ nil ; 23 Fax N
+ nil ; 24 Generalized Time Y
+ nil ; 25 Guide Y
+ nil ; 26 IA5 String Y
+ string-to-number ; 27 INTEGER Y
+ nil ; 28 JPEG N
+ nil ; 29 Master And Shadow Access Points Y
+ nil ; 30 Matching Rule Description Y
+ nil ; 31 Matching Rule Use Description Y
+ nil ; 32 Mail Preference Y
+ nil ; 33 MHS OR Address Y
+ nil ; 34 Name And Optional UID Y
+ nil ; 35 Name Form Description Y
+ nil ; 36 Numeric String Y
+ nil ; 37 Object Class Description Y
+ nil ; 38 OID Y
+ nil ; 39 Other Mailbox Y
+ nil ; 40 Octet String Y
+ ldap-decode-address ; 41 Postal Address Y
+ nil ; 42 Protocol Information Y
+ nil ; 43 Presentation Address Y
+ ldap-decode-string ; 44 Printable String Y
+ nil ; 45 Subtree Specification Y
+ nil ; 46 Supplier Information Y
+ nil ; 47 Supplier Or Consumer Y
+ nil ; 48 Supplier And Consumer Y
+ nil ; 49 Supported Algorithm N
+ nil ; 50 Telephone Number Y
+ nil ; 51 Teletex Terminal Identifier Y
+ nil ; 52 Telex Number Y
+ nil ; 53 UTC Time Y
+ nil ; 54 LDAP Syntax Description Y
+ nil ; 55 Modify Rights Y
+ nil ; 56 LDAP Schema Definition Y
+ nil ; 57 LDAP Schema Description Y
+ nil ; 58 Substring Assertion Y
+ ]
"A vector of functions used to decode LDAP attribute values.
The sequence of functions corresponds to the sequence of LDAP attribute syntax
-object identifiers of the form 1.3.6.1.4.1.1466.1115.121.1.* as defined in
+object identifiers of the form 1.3.6.1.4.1.1466.1115.121.1.* as defined in
RFC2252 section 4.3.2")
nil)
(t
(error "Wrong LDAP boolean string: %s" str))))
-
+
(defun ldap-encode-country-string (str)
;; We should do something useful here...
(if (not (= 2 (length str)))
;; LDAP protocol functions
-
+
(defun ldap-get-host-parameter (host parameter)
"Get the value of PARAMETER for HOST in `ldap-host-parameters-alist'."
(plist-get (cdr (assoc host ldap-host-parameters-alist))
parameter))
-
+
(defun ldap-decode-attribute (attr)
"Decode the attribute/value pair ATTR according to LDAP rules.
-The attribute name is looked up in `ldap-attribute-syntaxes-alist'
-and the corresponding decoder is then retrieved from
+The attribute name is looked up in `ldap-attribute-syntaxes-alist'
+and the corresponding decoder is then retrieved from
`ldap-attribute-syntax-decoders' and applied on the value(s)."
(let* ((name (car attr))
(values (cdr attr))
decoded)))
(defun ldap-search (arg1 &rest args)
- "Perform an LDAP search."
+ "Perform an LDAP search."
(apply (if (ldapp arg1)
'ldap-search-basic
'ldap-search-entries) arg1 args))
-(make-obsolete 'ldap-search
- "Use `ldap-search-entries' instead or
+(make-obsolete 'ldap-search
+ "Use `ldap-search-entries' instead or
`ldap-search-basic' for the low-level search API.")
(defun ldap-search-entries (filter &optional host attributes attrsonly withdn)
the associated values.
If WITHDN is non-nil each entry in the result will be prepennded with
its distinguished name DN.
-Additional search parameters can be specified through
+Additional search parameters can be specified through
`ldap-host-parameters-alist' which see.
The function returns a list of matching entries. Each entry is itself
an alist of attribute/value pairs optionally preceded by the DN of the
(setq ldap (ldap-open host host-plist))
(if ldap-verbose
(message "Searching with LDAP on %s..." host))
- (setq result (ldap-search ldap filter
+ (setq result (ldap-search ldap filter
(plist-get host-plist 'base)
(plist-get host-plist 'scope)
attributes attrsonly withdn
(defun ldap-add-entries (entries &optional host binddn passwd)
"Add entries to an LDAP directory.
-ENTRIES is a list of entry specifications of
+ENTRIES is a list of entry specifications of
the form (DN (ATTR . VALUE) (ATTR . VALUE) ...) where
DN is the distinguished name of an entry to add, the following
are cons cells containing attribute/value string pairs.
-HOST is the LDAP host, defaulting to `ldap-default-host'
-BINDDN is the DN to bind as to the server
-PASSWD is the corresponding password"
+HOST is the LDAP host, defaulting to `ldap-default-host'.
+BINDDN is the DN to bind as to the server.
+PASSWD is the corresponding password."
(or host
(setq host ldap-default-host)
(error "No LDAP host specified"))
(defun ldap-modify-entries (entry-mods &optional host binddn passwd)
"Modify entries of an LDAP directory.
-ENTRY_MODS is a list of entry modifications of the form
- (DN MOD-SPEC1 MOD-SPEC2 ...) where DN is the distinguished name of
-the entry to modify, the following are modification specifications.
-A modification specification is itself a list of the form
-(MOD-OP ATTR VALUE1 VALUE2 ...) MOD-OP and ATTR are mandatory,
+ENTRY_MODS is a list of entry modifications of the form
+ (DN MOD-SPEC1 MOD-SPEC2 ...) where DN is the distinguished name of
+the entry to modify, the following are modification specifications.
+A modification specification is itself a list of the form
+(MOD-OP ATTR VALUE1 VALUE2 ...) MOD-OP and ATTR are mandatory,
VALUEs are optional depending on MOD-OP.
MOD-OP is the type of modification, one of the symbols `add', `delete'
or `replace'. ATTR is the LDAP attribute type to modify.
-HOST is the LDAP host, defaulting to `ldap-default-host'
-BINDDN is the DN to bind as to the server
-PASSWD is the corresponding password"
+HOST is the LDAP host, defaulting to `ldap-default-host'.
+BINDDN is the DN to bind as to the server.
+PASSWD is the corresponding password."
(or host
(setq host ldap-default-host)
(error "No LDAP host specified"))
(defun ldap-delete-entries (dn &optional host binddn passwd)
"Delete an entry from an LDAP directory.
-DN is the distinguished name of an entry to delete or
+DN is the distinguished name of an entry to delete or
a list of those.
-HOST is the LDAP host, defaulting to `ldap-default-host'
-BINDDN is the DN to bind as to the server
+HOST is the LDAP host, defaulting to `ldap-default-host'.
+BINDDN is the DN to bind as to the server.
PASSWD is the corresponding password."
(or host
(setq host ldap-default-host)
(provide 'ldap)
-
+
;;; ldap.el ends here
projects / chise / xemacs-chise.git.1 / blobdiff