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 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757
|
;;; ldap.el --- client interface to LDAP for Emacs -*- lexical-binding: t; -*-
;; Copyright (C) 1998-2025 Free Software Foundation, Inc.
;; Author: Oscar Figueiredo <oscar@cpe.fr>
;; Maintainer: emacs-devel@gnu.org
;; Created: April 1998
;; Keywords: comm
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; This package provides basic functionality to perform searches on LDAP
;; servers. It requires a command line utility generally named
;; `ldapsearch' to actually perform the searches. That program can be
;; found in all LDAP developer kits such as:
;; - UM-LDAP 3.3 (http://www.umich.edu/~dirsvcs/ldap/)
;; - OpenLDAP (https://www.openldap.org/)
;;; Code:
(require 'password-cache)
(autoload 'auth-source-search "auth-source")
(defgroup ldap nil
"Lightweight Directory Access Protocol."
:version "21.1"
:group 'comm)
(defcustom ldap-default-host nil
"Default LDAP server.
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)))
(defcustom ldap-default-port nil
"Default TCP port for LDAP connections.
Initialized from the LDAP library at build time.
Default value is 389."
:type '(choice (const :tag "Use library default" nil)
(natnum :tag "Port number")))
(defcustom ldap-default-base nil
"Default base for LDAP searches.
This is a string using the syntax of RFC 1779.
For instance, \"o=ACME, c=US\" limits the search to the
Acme organization in the United States."
:type '(choice (const :tag "Use library default" nil)
(string :tag "Search base")))
(defcustom ldap-host-parameters-alist nil
"Alist of host-specific options for LDAP transactions.
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).
PROPn and VALn are property/value pairs describing parameters for the server.
Valid properties include:
`auth-source' specifies whether or not to look up, via the
`auth-source' library, options which are not otherwise provided
in this list. See `ldap-search-internal'.
`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.
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'.
`deref' is one of the symbols `never', `always', `search' or `find'.
`timelimit' is the timeout limit for the connection in seconds.
`sizelimit' is the maximum number of matches to return."
:type '(repeat :menu-tag "Host parameters"
:tag "Host parameters"
(list :menu-tag "Host parameters"
:tag "Host parameters"
:value nil
(string :tag "Host name")
(checklist :inline t
:greedy t
(list
:tag "Use auth-source"
:inline t
(const :tag "Use auth-source" auth-source)
boolean)
(list
:tag "Search Base"
:inline t
(const :tag "Search Base" base)
string)
(list
:tag "Binding DN"
:inline t
(const :tag "Binding DN" binddn)
string)
(list
:tag "Password"
:inline t
(const :tag "Password" passwd)
string)
(list
:tag "Authentication Method"
:inline t
(const :tag "Authentication Method" auth)
(choice
(const :menu-tag "None" :tag "None" nil)
(const :menu-tag "Simple" :tag "Simple" simple)
(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"
:inline t
(const :tag "Search Scope" scope)
(choice
(const :menu-tag "Default" :tag "Default" nil)
(const :menu-tag "Subtree" :tag "Subtree" subtree)
(const :menu-tag "Base" :tag "Base" base)
(const :menu-tag "One Level" :tag "One Level" onelevel)))
(list
:tag "Dereferencing"
:inline t
(const :tag "Dereferencing" deref)
(choice
(const :menu-tag "Default" :tag "Default" nil)
(const :menu-tag "Never" :tag "Never" never)
(const :menu-tag "Always" :tag "Always" always)
(const :menu-tag "When searching" :tag "When searching" search)
(const :menu-tag "When locating base" :tag "When locating base" find)))
(list
:tag "Time Limit"
:inline t
(const :tag "Time Limit" timelimit)
(integer :tag "(in seconds)"))
(list
:tag "Size Limit"
:inline t
(const :tag "Size Limit" sizelimit)
(integer :tag "(number of records)"))))))
(defcustom ldap-ldapsearch-prog "ldapsearch"
"The name of the ldapsearch command line program."
:type '(string :tag "`ldapsearch' Program"))
(defcustom ldap-ldapsearch-args nil
"A list of additional arguments to pass to `ldapsearch'."
:type '(repeat :tag "`ldapsearch' Arguments"
(string :tag "Argument")))
(defcustom ldap-ldapsearch-password-prompt-regexp "Enter LDAP Password: "
"Regexp used to recognize the `ldapsearch' program's password prompt."
:type 'regexp
:version "25.1")
(defcustom ldap-ignore-attribute-codings nil
"If non-nil, do not encode/decode LDAP attribute values."
:type 'boolean)
(defcustom ldap-default-attribute-decoder nil
"Decoder function to use for attributes whose syntax is unknown."
:type 'symbol)
(defcustom ldap-coding-system 'utf-8
"Coding system of LDAP string values.
LDAP v3 specifies the coding system of strings to be UTF-8."
:type 'symbol)
(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
]
"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
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
]
"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
RFC2252 section 4.3.2")
(defvar ldap-attribute-syntaxes-alist
'((createtimestamp . 24)
(modifytimestamp . 24)
(creatorsname . 12)
(modifiersname . 12)
(subschemasubentry . 12)
(attributetypes . 3)
(objectclasses . 37)
(matchingrules . 30)
(matchingruleuse . 31)
(namingcontexts . 12)
(altserver . 26)
(supportedextension . 38)
(supportedcontrol . 38)
(supportedsaslmechanisms . 15)
(supportedldapversion . 27)
(ldapsyntaxes . 16)
(ditstructurerules . 17)
(nameforms . 35)
(ditcontentrules . 16)
(objectclass . 38)
(aliasedobjectname . 12)
(cn . 15)
(sn . 15)
(serialnumber . 44)
(c . 15)
(l . 15)
(st . 15)
(street . 15)
(o . 15)
(ou . 15)
(title . 15)
(description . 15)
(searchguide . 25)
(businesscategory . 15)
(postaladdress . 41)
(postalcode . 15)
(postofficebox . 15)
(physicaldeliveryofficename . 15)
(telephonenumber . 50)
(telexnumber . 52)
(telexterminalidentifier . 51)
(facsimiletelephonenumber . 22)
(x121address . 36)
(internationalisdnnumber . 36)
(registeredaddress . 41)
(destinationindicator . 44)
(preferreddeliverymethod . 14)
(presentationaddress . 43)
(supportedapplicationcontext . 38)
(member . 12)
(owner . 12)
(roleoccupant . 12)
(seealso . 12)
(userpassword . 40)
(usercertificate . 8)
(cacertificate . 8)
(authorityrevocationlist . 9)
(certificaterevocationlist . 9)
(crosscertificatepair . 10)
(name . 15)
(givenname . 15)
(initials . 15)
(generationqualifier . 15)
(x500uniqueidentifier . 6)
(dnqualifier . 44)
(enhancedsearchguide . 21)
(protocolinformation . 42)
(distinguishedname . 12)
(uniquemember . 34)
(houseidentifier . 15)
(supportedalgorithms . 49)
(deltarevocationlist . 9)
(dmdname . 15)
(carlicense . 15)
(departmentnumber . 15)
(displayname . 15)
(employeenumber . 15)
(employeetype . 15)
(jpegphoto . 28)
(preferredlanguage . 15)
(usersmimecertificate . 5)
(userpkcs12 . 5))
"A map of LDAP attribute names to their type object id minor number.
This table is built from RFC2252 Section 5, RFC2256 Section 5 and
RFC2798 Section 9.1.1")
;; Coding/decoding functions
(defun ldap-encode-boolean (bool)
(if bool
"TRUE"
"FALSE"))
(defun ldap-decode-boolean (str)
(cond
((string-equal str "TRUE")
t)
((string-equal str "FALSE")
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)))
(error "Invalid country string: %s" str)))
(defun ldap-decode-string (str)
(decode-coding-string str ldap-coding-system))
(defun ldap-encode-string (str)
(encode-coding-string str ldap-coding-system))
(defun ldap-decode-address (str)
(mapconcat #'ldap-decode-string
(split-string str "\\$")
"\n"))
(defun ldap-encode-address (str)
(mapconcat #'ldap-encode-string
(split-string str "\n")
"$"))
;; 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
`ldap-attribute-syntax-decoders' and applied on the value(s)."
(let* ((name (car attr))
(values (cdr attr))
(syntax-id (cdr (assq (intern (downcase name))
ldap-attribute-syntaxes-alist)))
decoder)
(if syntax-id
(setq decoder (aref ldap-attribute-syntax-decoders
(1- syntax-id)))
(setq decoder ldap-default-attribute-decoder))
(if decoder
(cons name (mapcar decoder values))
attr)))
(defun ldap-search (filter &optional host attributes attrsonly withdn)
"Perform an LDAP search.
FILTER is the search filter in RFC1558 syntax.
HOST is the LDAP host on which to perform the search.
ATTRIBUTES are the specific attributes to retrieve, nil means
retrieve all.
ATTRSONLY, if non-nil, retrieves the attributes only, without
the associated values.
If WITHDN is non-nil, each entry in the result will be prepended with
its distinguished name WITHDN.
Additional search parameters can be specified through
`ldap-host-parameters-alist', which see.
See `ldap-search-internal' for the description of return value."
(interactive "sFilter:")
(or host
(setq host ldap-default-host)
(error "No LDAP host specified"))
(let* ((host-plist (cdr (assoc host ldap-host-parameters-alist)))
(result (ldap-search-internal `(host ,host
filter ,filter
attributes ,attributes
attrsonly ,attrsonly
withdn ,withdn
,@host-plist))))
(if ldap-ignore-attribute-codings
result
(mapcar (lambda (record)
(append (and withdn (list (car record)))
(mapcar #'ldap-decode-attribute
(if withdn (cdr record) record))))
result))))
(defun ldap-password-read (host)
"Read LDAP password for HOST.
If the password is cached, it is read from the cache, otherwise the user
is prompted for the password. If `password-cache' is non-nil the password
is verified and cached. The `password-cache-expiry' variable
controls for how long the password is cached.
This function can be specified for the `passwd' property in
`ldap-host-parameters-alist' when interactive password prompting
is desired for HOST."
;; Add ldap: namespace to allow empty string for default host.
(let* ((host-key (concat "ldap:" host))
(password (password-read
(format "Enter LDAP Password%s: "
(if (equal host "")
""
(format " for %s" host)))
host-key)))
(when (and password-cache
(not (password-in-cache-p host-key))
;; Confirm the password is valid before adding it to
;; the password cache. ldap-search-internal will throw
;; an error if the password is invalid.
(not (ldap-search-internal
`(host ,host
;; Specify an arbitrary filter that should
;; produce no results, since only
;; authentication success is of interest.
filter "emacs-test-password="
attributes nil
attrsonly nil
withdn nil
;; Preempt passwd ldap-password-read
;; setting in ldap-host-parameters-alist.
passwd ,password
,@(cdr
(assoc
host
ldap-host-parameters-alist))))))
(password-cache-add host-key password))
password))
(defun ldap-search-internal (search-plist)
"Perform a search on a LDAP server.
SEARCH-PLIST is a property list describing the search request.
Valid keys in that list are:
`auth-source', if non-nil, will use `auth-source-search' and
will grab the :host, :secret, :base, and (:user or :binddn)
tokens into the `host', `passwd', `base', and `binddn' parameters
respectively if they are not provided in SEARCH-PLIST. So for
instance *each* of these netrc lines has the same effect if you
ask for the host \"ldapserver:2400\":
machine ldapserver:2400 login myDN secret myPassword base myBase
machine ldapserver:2400 binddn myDN secret myPassword port ldap
login myDN secret myPassword base myBase
but if you have more than one in your netrc file, only the first
matching one will be used. Note the \"port ldap\" part is NOT
required.
`host' is a string naming one or more (blank-separated) LDAP servers
to try to connect to. Each host name may optionally be of the form HOST:PORT.
`filter' is a filter string for the search as described in RFC 1558.
`attributes' is a list of strings indicating which attributes to retrieve
for each matching entry. If nil, return all available attributes.
`attrsonly', if non-nil, indicates that only attributes are retrieved,
not their associated values.
`auth' is one of the symbols `simple', `krbv41' or `krbv42'.
`base' is the base for the search as described in RFC 1779.
`scope' is one of the three symbols `sub', `base' or `one'.
`binddn' is the distinguished name of the user to bind as (in
RFC 1779 syntax).
`passwd' is the password to use for simple authentication.
`deref' is one of the symbols `never', `always', `search' or `find'.
`timelimit' is the timeout limit for the connection in seconds.
`sizelimit' is the maximum number of matches to return.
`withdn' if non-nil each entry in the result will be prepended with
its distinguished name DN.
The function returns a list of matching entries. Each entry is
itself a list ATTRS of (ATTR VALUE) pairs; `dn' attribute is not
included.
When `withdn' is non-nil the result is instead an alist with
elements (DN . ATTRS), where DN is a string value and ATTRS is
same as above."
(let* ((buf (get-buffer-create " *ldap-search*"))
(bufval (get-buffer-create " *ldap-value*"))
(host (or (plist-get search-plist 'host)
ldap-default-host))
;; find entries with port "ldap" that match the requested host if any
(asfound (when (plist-get search-plist 'auth-source)
(nth 0 (auth-source-search :host (or host t)
:create t))))
;; if no host was requested, get it from the auth-source entry
(host (or host (plist-get asfound :host)))
;; get the password from the auth-source
(passwd (or (plist-get search-plist 'passwd)
(plist-get asfound :secret)))
;; convert the password from a function call if needed
(passwd (if (functionp passwd)
(if (eq passwd 'ldap-password-read)
(funcall passwd host)
(funcall passwd))
passwd))
;; get the binddn from the search-list or from the
;; auth-source user or binddn tokens
(binddn (or (plist-get search-plist 'binddn)
(plist-get asfound :user)
(plist-get asfound :binddn)))
(base (or (plist-get search-plist 'base)
(plist-get asfound :base)
ldap-default-base))
(filter (plist-get search-plist 'filter))
(attributes (plist-get search-plist 'attributes))
(attrsonly (plist-get search-plist 'attrsonly))
(scope (plist-get search-plist 'scope))
(auth (plist-get search-plist 'auth))
(deref (plist-get search-plist 'deref))
(timelimit (plist-get search-plist 'timelimit))
(sizelimit (plist-get search-plist 'sizelimit))
(withdn (plist-get search-plist 'withdn))
(numres 0)
(arglist (list "-LLL" "-tt"))
dn name value record result)
(if (or (null filter)
(equal "" filter))
(error "No search filter"))
(setq filter (cons filter attributes))
(with-current-buffer buf
(erase-buffer)
(if (and host
(not (equal "" host)))
(setq arglist (nconc arglist
(list (format
;; Use -H if host is a new-style LDAP URI.
(if (string-match "^[a-zA-Z]+://" host)
"-H%s"
"-h%s")
host)))))
(if (and attrsonly
(not (equal "" attrsonly)))
(setq arglist (nconc arglist (list "-A"))))
(if (and base
(not (equal "" base)))
(setq arglist (nconc arglist (list (format "-b%s" base)))))
(if (and scope
(not (equal "" scope)))
(setq arglist (nconc arglist (list (format "-s%s" scope)))))
(if (and binddn
(not (equal "" binddn)))
(setq arglist (nconc arglist (list (format "-D%s" binddn)))))
(if (and auth
(equal 'simple auth))
(setq arglist (nconc arglist (list "-x"))))
;; Allow passwd to be set to "", representing a blank password.
(if passwd
(setq arglist (nconc arglist (list "-W"))))
(if (and deref
(not (equal "" deref)))
(setq arglist (nconc arglist (list (format "-a%s" deref)))))
(if (and timelimit
(not (equal "" timelimit)))
(setq arglist (nconc arglist (list (format "-l%s" timelimit)))))
(if (and sizelimit
(not (equal "" sizelimit)))
(setq arglist (nconc arglist (list (format "-z%s" sizelimit)))))
(if passwd
;; Leave process-connection-type at its default value. See
;; discussion in Bug#33050.
(let* ((proc-args (append arglist ldap-ldapsearch-args
filter))
(proc (apply #'start-process "ldapsearch" buf
ldap-ldapsearch-prog
proc-args)))
(while (null (progn
(goto-char (point-min))
(re-search-forward
ldap-ldapsearch-password-prompt-regexp
(point-max) t)))
(accept-process-output proc 1))
(process-send-string proc passwd)
(process-send-string proc "\n")
(while (not (memq (process-status proc) '(exit signal)))
(sit-for 0.1))
(let ((status (process-exit-status proc)))
(when (not (memql status '(0 4))) ; 4 = Size limit exceeded
;; Handle invalid credentials exit status specially
;; for ldap-password-read.
(if (eq status 49)
(error (concat "Incorrect LDAP password or"
" bind distinguished name (binddn)"))
(error "Failed ldapsearch invocation: %s \"%s\""
ldap-ldapsearch-prog
(mapconcat #'identity proc-args "\" \""))))))
(apply #'call-process ldap-ldapsearch-prog
;; Ignore stderr, which can corrupt results
nil (list buf nil) nil
(append arglist ldap-ldapsearch-args filter)))
(insert "\n")
(goto-char (point-min))
(while (re-search-forward (concat "[\t\n\f]+ \\|"
ldap-ldapsearch-password-prompt-regexp)
nil t)
(replace-match ""))
(goto-char (point-min))
(if (looking-at "usage")
(error "Incorrect ldapsearch invocation")
(message "Parsing results... ")
;; Skip error message when retrieving attribute list
(if (looking-at "Size limit exceeded")
(forward-line 1))
(while (progn
(skip-chars-forward " \t\n")
(not (eobp)))
(while (looking-at "^\\([A-Za-z][-A-Za-z0-9]*\
\\|[0-9]+\\(?:\\.[0-9]+\\)*\\)\\(;[-A-Za-z0-9]+\\)*[=:\t ]+\
\\(<[\t ]*file://\\)?\\(.*\\)$")
(setq name (match-string 1)
value (match-string 4))
(when (memq system-type '(windows-nt ms-dos))
;; Need to handle file:///D:/... as generated by
;; OpenLDAP on DOS/Windows as local files.
(save-match-data
(when (eq (string-match "/\\(.:.*\\)$" value) 0)
(setq value (match-string 1 value)))))
(cond ((match-string 3) ;normal value written to a file
(with-current-buffer bufval
(erase-buffer)
(set-buffer-multibyte nil)
(insert-file-contents-literally value)
(delete-file value)
(setq value (buffer-string))))
(;; dn is output inline
(string-equal-ignore-case name "dn")
(setq dn value
name nil
value nil))
(t (setq value " ")))
(and name value
(setq record (cons (list name value)
record)))
(forward-line 1))
(when dn
(cond (withdn
(push (cons dn (nreverse record))
result))
(record
(push (nreverse record) result))))
(setq record nil
dn nil)
(message "Parsing results... %d" numres)
(setq numres (1+ numres)))
(message "Parsing results... done")
(nreverse result)))))
(provide 'ldap)
;;; ldap.el ends here
|