The trivial-ldap Reference Manual

Table of Contents

The trivial-ldap Reference Manual

This is the trivial-ldap Reference Manual, version 0.94, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 15:19:34 2020 GMT+0.

1 Introduction

Introduction

One-two, one-two... is this thing working?

This is Kevin Montuori's trivial-ldap, with a few modifications.

A few years back, I needed some mechanism for querying AD servers, as part of a custom content connector for the FAST ESP search engine. I found trivial-ldap, and was soon using it to good effect.

After having used trivial-ldap for a while, I made some modifications, and asked Kevin to review them, and integrate them if he felt that they added value. Unfortunately, Kevin is too busy to spend time on trivial-ldap, so he graciously let me publish whatever changes I had.

Changes

LDAP Filter Parser

The LDAP filter parser has been rewritten from scratch, using cl-yacc. This makes filter parsing somewhat faster, and should also make it easier to maintain. The downside is one more dependency.

Attribute Naming

The original code used symbols in the current package to name LDAP attributes. This has changed, and all attribute names are now interned in the keyword package. So, something like

(ldap:attr-value *entry* 'cname)

should now be

(ldap:attr-value *entry* :cname)

and so on. Note: this is probably only important when working with an LDAP entry, as that is the only place where we use symbol identity for matching.

Binary Attributes

There was a tacit assumption in the trivial-ldap code that all attributes are UTF-8 encoded strings, while in reality they can be 7-bit ASCII (USASCII), UTF-8 or even binary. There is now a mechanism in place for giving hints to trivial-ldap that certain attributes should be treated as binary values --- such attributes will be returned as lists of (unsigned-byte 8), instead of as unicode strings.

The interface to this mechanism is

(ldap:attribute-binary-p <attribute-name>) => <generalized-boolean>

and

(setf (ldap:attribute-binary-p <attribute-name>) <generalized-boolean>)

Note: Elias Mårtenson has supplied some handy restarts that can be used when it turns out that an attribute cannot be converted to UTF-8 (which, in turn, probably means that it should be treated as binary). See handle-as-binary and handle-as-binary-and-add-known in trivial-ldap.lisp .

List Equivalents

Search filters and values can be specified as lists instead of as strings. This has two advantages:

• Binary values can be specified (lists of octet values will not be treated as UTF-8 sequences).

• It is not necessary to build string representations of a filter just to have the filter parser deconstruct it back to the representation that should be natural for Lisp.

• Values can be specified as octet lists, strings or symbols -- when a symbol is specified, the actual value used is whatever (symbol-name <symbol>) returns.

• The function #'listify-filter can be used to turn a string filter into an equivalent list representation; this should be useful for experimenting with the list format.

Examples:

(ldap:search *ldap* '(and (= objectclass person) (= cname "rayw")))

(let ((name "rayw"))
    (ldap:search *ldap* `(and (= objectclass person) (= cname ,name))))

Paging Through Results

Support for the LDAP Control Extension "Simple Paged Results" (rfc2696) has been added. It is invoked by setting the :size-limit search parameter to 0 (zero), and setting :paging-size to a positive integer. Note that the server imposes its own restrictions here, so the actual number of results in a batch may be lower than specified.

Apart from setting these two required parameters, the operation of the paging mechanism is wholly transparent: batches are fetched automatically whenever the #'next-search-result method has exhausted all entries in the current batch (assuming that the appropriate parameters have been specified, and that there are actually more results to be fetched.)

Examples:

(and (ldap:search *ldap* '(& (substring samaccountname "ra*") (= objectclass person))
                  :attributes '("1.1") :size-limit 0 :paging-size 500)
     (loop for entry = (ldap:next-search-result *ldap*)
           while entry
           count entry))

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 trivial-ldap

Maintainer

Raymond Wiker <rwiker@gmail.com>

Author

Kevin Montuori

License

Clarified Artistic License

Description

TRIVIAL-LDAP is a one file, all Common Lisp client implementation of parts of RFC 2261.

Version

0.94

Dependencies

• usocket
• cl+ssl
• yacc

Source

trivial-ldap.asd (file)

Components

• package.lisp (file)
• trivial-ldap.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 trivial-ldap.asd

Location

trivial-ldap.asd

Systems

trivial-ldap (system)

3.1.2 trivial-ldap/package.lisp

Parent

trivial-ldap (system)

Location

package.lisp

Packages

trivial-ldap

3.1.3 trivial-ldap/trivial-ldap.lisp

Dependency

package.lisp (file)

Parent

trivial-ldap (system)

Location

trivial-ldap.lisp

Exported Definitions

• abandon (method)
• add (method)
• add (method)
• add-attr (method)
• attr-list (method)
• attr-value (method)
• attr-value (method)
• attribute-binary-p (function)
• (setf attribute-binary-p) (function)
• attrs (method)
• (setf attrs) (method)
• base (method)
• (setf base) (method)
• bind (method)
• change-rdn (method)
• compare (method)
• compare (method)
• compare (method)
• debugflag (method)
• (setf debugflag) (method)
• del-attr (method)
• delete (method)
• delete (method)
• delete (method)
• dn (method)
• dn (method)
• dn (method)
• (setf dn) (method)
• dosearch (macro)
• entry (class)
• escape-string (function)
• host (method)
• host (method)
• (setf host) (method)
• ldap (class)
• ldap-bind-error (condition)
• ldap-connection-error (condition)
• ldap-error (condition)
• ldap-filter-error (condition)
• ldap-referral-error (condition)
• ldap-response-error (condition)
• ldap-size-limit-exceeded-error (condition)
• ldif (method)
• ldif-search (macro)
• listify-filter (function)
• moddn (method)
• moddn (method)
• moddn (method)
• modify (method)
• modify (method)
• new-entry (function)
• new-entry-from-list (function)
• new-ldap (function)
• next-search-result (method)
• pass (method)
• (setf pass) (method)
• port (method)
• port (method)
• (setf port) (method)
• probably-binary-field-error (condition)
• rdn (method)
• (setf rdn) (method)
• replace-attr (method)
• response (method)
• (setf response) (method)
• results-pending-p (method)
• (setf results-pending-p) (method)
• reuse-connection (method)
• (setf reuse-connection) (method)
• search (method)
• sslflag (method)
• (setf sslflag) (method)
• unbind (method)
• unescape-string (function)
• user (method)
• (setf user) (method)

Internal Definitions

• *binary-attributes* (special variable)
• *hex-print* (special variable)
• *init-sec-fn* (special variable)
• *ldap-filter-parser* (special variable)
• *unwrap-fn* (special variable)
• *wrap-fn* (special variable)
• +ber-abandon-tag+ (constant)
• +ber-add-tag+ (constant)
• +ber-app-const-base+ (constant)
• +ber-bind-tag+ (constant)
• +ber-class-id+ (constant)
• +ber-comp-tag+ (constant)
• +ber-controls-tag+ (constant)
• +ber-del-tag+ (constant)
• +ber-long-length-marker+ (constant)
• +ber-moddn-tag+ (constant)
• +ber-modify-tag+ (constant)
• +ber-multibyte-tag-number+ (constant)
• +ber-p/c-bit+ (constant)
• +ber-search-tag+ (constant)
• +ber-tag-bool+ (constant)
• +ber-tag-controls+ (constant)
• +ber-tag-enum+ (constant)
• +ber-tag-ext-name+ (constant)
• +ber-tag-ext-val+ (constant)
• +ber-tag-extendedresponse+ (constant)
• +ber-tag-int+ (constant)
• +ber-tag-referral+ (constant)
• +ber-tag-sasl-res-creds+ (constant)
• +ber-tag-seq+ (constant)
• +ber-tag-set+ (constant)
• +ber-tag-str+ (constant)
• +ber-unbind-tag+ (constant)
• +ldap-application-names+ (constant)
• +ldap-control-extension-paging+ (constant)
• +ldap-deref+ (constant)
• +ldap-disconnection-response+ (constant)
• +ldap-filter-comparison-char+ (constant)
• +ldap-modify-type+ (constant)
• +ldap-port-no-ssl+ (constant)
• +ldap-port-ssl+ (constant)
• +ldap-result-codes+ (constant)
• +ldap-scope+ (constant)
• +ldap-substring+ (constant)
• +ldap-version+ (constant)
• +max-int+ (constant)
• attrs-from-list (function)
• base10->base256 (function)
• base256->base10 (function)
• base256-vec->base10 (function)
• ber-class-id (function)
• ber-length (function)
• ber-msg (function)
• ber-p/c-bit (function)
• ber-tag (function)
• ber-tag-type (function)
• bind-gss (function)
• bind-gss-spnego (function)
• bytes-remaining (method)
• char-code-list->string (function)
• char-code-vec->string (function)
• check-message-number (function)
• close-stream (method)
• code (method)
• code-sym (method)
• copy-response-vec (function)
• create-sasl-message (function)
• debug-mesg (macro)
• decrypt-stream (function)
• define-constant (macro)
• discard-bytes (method)
• encrypt-message (function)
• entry-buffer (method)
• (setf entry-buffer) (method)
• filter (method)
• get-stream (method)
• gss-context (method)
• (setf gss-context) (method)
• handle-extended-response (method)
• incoming-buffer (method)
• (setf incoming-buffer) (method)
• incoming-buffer-pos (method)
• (setf incoming-buffer-pos) (method)
• int->octet-list (function)
• ldap-command (function)
• ldap-command-sym (function)
• ldap-deref (function)
• ldap-filter-comparison-char (function)
• ldap-filter-lexer (function)
• ldap-modify-type (function)
• ldap-result-code-string (function)
• ldap-result-code-symbol (function)
• ldap-scope (function)
• ldap-substring (function)
• ldapsock (method)
• (setf ldapsock) (method)
• ldapstream (method)
• (setf ldapstream) (method)
• list-entries-to-string (function)
• make-response-vec (function)
• mesg (method)
• mesg (method)
• (setf mesg) (method)
• mesg-incf (method)
• msg (method)
• msg-abandon (method)
• msg-add (method)
• msg-bind (method)
• msg-compare (function)
• msg-delete (function)
• msg-moddn (function)
• msg-modify (function)
• msg-search (function)
• msg-unbind (method)
• new-referrer (function)
• octet-list->int (function)
• octet-vec->int (function)
• paging-cookie (method)
• (setf paging-cookie) (method)
• parse-ldap-message (method)
• peek-byte (method)
• pop-byte (method)
• possibly-reopen-and-rebind (method)
• probably-binary-field-error-key (method)
• process-message (method)
• process-response-controls (function)
• rdn-from-dn (function)
• read-app-number (function)
• read-controls (function)
• read-decoder (function)
• read-generic (function)
• read-integer (function)
• read-length (function)
• read-message-number (function)
• read-octets (function)
• read-string (function)
• read-with-length (function)
• read-wrapped-byte (function)
• receive-length (function)
• receive-message (method)
• referrer (class)
• response-vec (class)
• response-vec/ptr (method)
• (setf response-vec/ptr) (method)
• response-vec/vec (method)
• (setf response-vec/vec) (method)
• sasl (method)
• (setf sasl) (method)
• search-fn (method)
• (setf search-fn) (method)
• send-message (method)
• send-sasl (function)
• send-sasl-auth-res (function)
• seq-att-and-values (function)
• seq-attribute-alist (function)
• seq-attribute-assertion (function)
• seq-attribute-list (function)
• seq-attribute-value-assertion (function)
• seq-boolean (function)
• seq-constructed-choice (function)
• seq-enumerated (function)
• seq-filter (function)
• seq-integer (function)
• seq-null (function)
• seq-octet-string (function)
• seq-primitive-choice (function)
• seq-primitive-string (function)
• seq-sequence (function)
• seq-set (function)
• seq-substrings (function)
• split-substring (function)
• string->char-code-list (function)
• timeout (method)
• (setf timeout) (method)
• url (method)
• (setf url) (method)
• valid-ldap-response-p (function)
• wrap-packets (method)
• (setf wrap-packets) (method)
• write-with-length (function)

4 Packages

Packages are listed by definition order.

4.1 trivial-ldap

Source

package.lisp (file)

Nickname

ldap

Use List

common-lisp

Exported Definitions

• abandon (generic function)
• abandon (method)
• add (generic function)
• add (method)
• add (method)
• add-attr (generic function)
• add-attr (method)
• attr-list (generic function)
• attr-list (method)
• attr-value (generic function)
• attr-value (method)
• attr-value (method)
• attribute-binary-p (function)
• (setf attribute-binary-p) (function)
• attrs (generic function)
• attrs (method)
• (setf attrs) (method)
• (setf attrs) (generic function)
• base (generic function)
• base (method)
• (setf base) (method)
• (setf base) (generic function)
• bind (generic function)
• bind (method)
• change-rdn (generic function)
• change-rdn (method)
• compare (generic function)
• compare (method)
• compare (method)
• compare (method)
• debugflag (generic function)
• debugflag (method)
• (setf debugflag) (method)
• (setf debugflag) (generic function)
• del-attr (generic function)
• del-attr (method)
• delete (generic function)
• delete (method)
• delete (method)
• delete (method)
• dn (generic function)
• dn (method)
• dn (method)
• dn (method)
• (setf dn) (generic function)
• (setf dn) (method)
• dosearch (macro)
• entry (class)
• escape-string (function)
• host (generic function)
• host (method)
• host (method)
• (setf host) (generic function)
• (setf host) (method)
• ldap (class)
• ldap-bind-error (condition)
• ldap-connection-error (condition)
• ldap-error (condition)
• ldap-filter-error (condition)
• ldap-referral-error (condition)
• ldap-response-error (condition)
• ldap-size-limit-exceeded-error (condition)
• ldif (generic function)
• ldif (method)
• ldif-search (macro)
• listify-filter (function)
• moddn (generic function)
• moddn (method)
• moddn (method)
• moddn (method)
• modify (generic function)
• modify (method)
• modify (method)
• new-entry (function)
• new-entry-from-list (function)
• new-ldap (function)
• next-search-result (generic function)
• next-search-result (method)
• pass (generic function)
• pass (method)
• (setf pass) (method)
• (setf pass) (generic function)
• port (generic function)
• port (method)
• port (method)
• (setf port) (generic function)
• (setf port) (method)
• probably-binary-field-error (condition)
• rdn (generic function)
• rdn (method)
• (setf rdn) (method)
• (setf rdn) (generic function)
• replace-attr (generic function)
• replace-attr (method)
• response (generic function)
• response (method)
• (setf response) (method)
• (setf response) (generic function)
• results-pending-p (generic function)
• results-pending-p (method)
• (setf results-pending-p) (method)
• (setf results-pending-p) (generic function)
• reuse-connection (generic function)
• reuse-connection (method)
• (setf reuse-connection) (method)
• (setf reuse-connection) (generic function)
• search (generic function)
• search (method)
• sslflag (generic function)
• sslflag (method)
• (setf sslflag) (method)
• (setf sslflag) (generic function)
• unbind (generic function)
• unbind (method)
• unescape-string (function)
• user (generic function)
• user (method)
• (setf user) (method)
• (setf user) (generic function)

Internal Definitions

• *binary-attributes* (special variable)
• *hex-print* (special variable)
• *init-sec-fn* (special variable)
• *ldap-filter-parser* (special variable)
• *unwrap-fn* (special variable)
• *wrap-fn* (special variable)
• +ber-abandon-tag+ (constant)
• +ber-add-tag+ (constant)
• +ber-app-const-base+ (constant)
• +ber-bind-tag+ (constant)
• +ber-class-id+ (constant)
• +ber-comp-tag+ (constant)
• +ber-controls-tag+ (constant)
• +ber-del-tag+ (constant)
• +ber-long-length-marker+ (constant)
• +ber-moddn-tag+ (constant)
• +ber-modify-tag+ (constant)
• +ber-multibyte-tag-number+ (constant)
• +ber-p/c-bit+ (constant)
• +ber-search-tag+ (constant)
• +ber-tag-bool+ (constant)
• +ber-tag-controls+ (constant)
• +ber-tag-enum+ (constant)
• +ber-tag-ext-name+ (constant)
• +ber-tag-ext-val+ (constant)
• +ber-tag-extendedresponse+ (constant)
• +ber-tag-int+ (constant)
• +ber-tag-referral+ (constant)
• +ber-tag-sasl-res-creds+ (constant)
• +ber-tag-seq+ (constant)
• +ber-tag-set+ (constant)
• +ber-tag-str+ (constant)
• +ber-unbind-tag+ (constant)
• +ldap-application-names+ (constant)
• +ldap-control-extension-paging+ (constant)
• +ldap-deref+ (constant)
• +ldap-disconnection-response+ (constant)
• +ldap-filter-comparison-char+ (constant)
• +ldap-modify-type+ (constant)
• +ldap-port-no-ssl+ (constant)
• +ldap-port-ssl+ (constant)
• +ldap-result-codes+ (constant)
• +ldap-scope+ (constant)
• +ldap-substring+ (constant)
• +ldap-version+ (constant)
• +max-int+ (constant)
• attrs-from-list (function)
• base10->base256 (function)
• base256->base10 (function)
• base256-vec->base10 (function)
• ber-class-id (function)
• ber-length (function)
• ber-msg (function)
• ber-p/c-bit (function)
• ber-tag (function)
• ber-tag-type (function)
• bind-gss (function)
• bind-gss-spnego (function)
• bytes-remaining (generic function)
• bytes-remaining (method)
• char-code-list->string (function)
• char-code-vec->string (function)
• check-message-number (function)
• close-stream (generic function)
• close-stream (method)
• code (generic function)
• code (method)
• code-sym (generic function)
• code-sym (method)
• copy-response-vec (function)
• create-sasl-message (function)
• debug-mesg (macro)
• decrypt-stream (function)
• define-constant (macro)
• discard-bytes (generic function)
• discard-bytes (method)
• encrypt-message (function)
• entry-buffer (generic function)
• entry-buffer (method)
• (setf entry-buffer) (method)
• (setf entry-buffer) (generic function)
• filter (generic function)
• filter (method)
• get-stream (generic function)
• get-stream (method)
• gss-context (generic function)
• gss-context (method)
• (setf gss-context) (method)
• (setf gss-context) (generic function)
• handle-extended-response (generic function)
• handle-extended-response (method)
• incoming-buffer (generic function)
• incoming-buffer (method)
• (setf incoming-buffer) (method)
• (setf incoming-buffer) (generic function)
• incoming-buffer-pos (generic function)
• incoming-buffer-pos (method)
• (setf incoming-buffer-pos) (method)
• (setf incoming-buffer-pos) (generic function)
• int->octet-list (function)
• ldap-command (function)
• ldap-command-sym (function)
• ldap-deref (function)
• ldap-filter-comparison-char (function)
• ldap-filter-lexer (function)
• ldap-modify-type (function)
• ldap-result-code-string (function)
• ldap-result-code-symbol (function)
• ldap-scope (function)
• ldap-substring (function)
• ldapsock (generic function)
• ldapsock (method)
• (setf ldapsock) (method)
• (setf ldapsock) (generic function)
• ldapstream (generic function)
• ldapstream (method)
• (setf ldapstream) (method)
• (setf ldapstream) (generic function)
• list-entries-to-string (function)
• make-response-vec (function)
• mesg (generic function)
• mesg (method)
• mesg (method)
• (setf mesg) (generic function)
• (setf mesg) (method)
• mesg-incf (generic function)
• mesg-incf (method)
• msg (generic function)
• msg (method)
• msg-abandon (generic function)
• msg-abandon (method)
• msg-add (generic function)
• msg-add (method)
• msg-bind (generic function)
• msg-bind (method)
• msg-compare (function)
• msg-delete (function)
• msg-moddn (function)
• msg-modify (function)
• msg-search (function)
• msg-unbind (generic function)
• msg-unbind (method)
• new-referrer (function)
• octet-list->int (function)
• octet-vec->int (function)
• paging-cookie (generic function)
• paging-cookie (method)
• (setf paging-cookie) (method)
• (setf paging-cookie) (generic function)
• parse-ldap-message (generic function)
• parse-ldap-message (method)
• peek-byte (generic function)
• peek-byte (method)
• pop-byte (generic function)
• pop-byte (method)
• possibly-reopen-and-rebind (generic function)
• possibly-reopen-and-rebind (method)
• probably-binary-field-error-key (generic function)
• probably-binary-field-error-key (method)
• process-message (generic function)
• process-message (method)
• process-response-controls (function)
• rdn-from-dn (function)
• read-app-number (function)
• read-controls (function)
• read-decoder (function)
• read-generic (function)
• read-integer (function)
• read-length (function)
• read-message-number (function)
• read-octets (function)
• read-string (function)
• read-with-length (function)
• read-wrapped-byte (function)
• receive-length (function)
• receive-message (generic function)
• receive-message (method)
• referrer (class)
• response-vec (class)
• response-vec/ptr (generic function)
• response-vec/ptr (method)
• (setf response-vec/ptr) (method)
• (setf response-vec/ptr) (generic function)
• response-vec/vec (generic function)
• response-vec/vec (method)
• (setf response-vec/vec) (method)
• (setf response-vec/vec) (generic function)
• sasl (generic function)
• sasl (method)
• (setf sasl) (method)
• (setf sasl) (generic function)
• search-fn (generic function)
• search-fn (method)
• (setf search-fn) (method)
• (setf search-fn) (generic function)
• send-message (generic function)
• send-message (method)
• send-sasl (function)
• send-sasl-auth-res (function)
• seq-att-and-values (function)
• seq-attribute-alist (function)
• seq-attribute-assertion (function)
• seq-attribute-list (function)
• seq-attribute-value-assertion (function)
• seq-boolean (function)
• seq-constructed-choice (function)
• seq-enumerated (function)
• seq-filter (function)
• seq-integer (function)
• seq-null (function)
• seq-octet-string (function)
• seq-primitive-choice (function)
• seq-primitive-string (function)
• seq-sequence (function)
• seq-set (function)
• seq-substrings (function)
• split-substring (function)
• string->char-code-list (function)
• timeout (generic function)
• timeout (method)
• (setf timeout) (method)
• (setf timeout) (generic function)
• url (generic function)
• url (method)
• (setf url) (method)
• (setf url) (generic function)
• valid-ldap-response-p (function)
• wrap-packets (generic function)
• wrap-packets (method)
• (setf wrap-packets) (method)
• (setf wrap-packets) (generic function)
• write-with-length (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Macros

Macro: dosearch (VAR SEARCH-FORM) &body BODY

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Macro: ldif-search &rest SEARCH-PARAMETERS

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

5.1.2 Functions

Function: attribute-binary-p ATTRIBUTE-NAME

Function: (setf attribute-binary-p) VALUE ATTRIBUTE-NAME

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: escape-string STRING

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: listify-filter FILTER

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: new-entry DN &key ATTRS INFER-RDN

Instantiate a new entry object.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: new-entry-from-list LIST

Create an entry object from the list return by search.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: new-ldap &key HOST SSLFLAG PORT USER PASS BASE DEBUG SASL REUSE-CONNECTION TIMEOUT

Instantiate a new ldap object.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: unescape-string STRING

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

5.1.3 Generic functions

Generic Function: abandon LDAP

Package

trivial-ldap

Methods

Method: abandon (LDAP ldap)

Abandon the request and suck any data off the incoming stream. Because the receive-message will keep receiving messages until it gets one with the correct message number, no action needs to be taken here to clear the incoming data off the line. It’s unclear that’s the best solution, but (clear-input) doesn’t actually work and trying to read non- existent bytes blocks...

Source

trivial-ldap.lisp (file)

Generic Function: add LDAP ENTRY

Package

trivial-ldap

Methods

Method: add (ENTRY entry) (LDAP ldap)

Add an entry object to LDAP; error unless successful.

Source

trivial-ldap.lisp (file)

Method: add (LDAP ldap) (ENTRY entry)

Add an entry to the directory.

Source

trivial-ldap.lisp (file)

Generic Function: add-attr ENTRY ATTR VALS

Package

trivial-ldap

Methods

Method: add-attr (ENTRY entry) ATTR VALS

Add an attribute to entry object, do not update LDAP.

Source

trivial-ldap.lisp (file)

Generic Function: attr-list ENTRY

Package

trivial-ldap

Methods

Method: attr-list (ENTRY entry)

Given an entry object, return a list of its attributes.

Source

trivial-ldap.lisp (file)

Generic Function: attr-value ENTRY ATTR

Package

trivial-ldap

Methods

Method: attr-value (ENTRY entry) (ATTRS list)

Given an entry object and list of attr names (as symbols), return list of lists of attributes.

Source

trivial-ldap.lisp (file)

Method: attr-value (ENTRY entry) ATTR

Given an entry object and attr name (symbol), return list of values.

Source

trivial-ldap.lisp (file)

Generic Function: attrs OBJECT

Generic Function: (setf attrs) NEW-VALUE OBJECT

Package

trivial-ldap

Methods

Method: attrs (ENTRY entry)

automatically generated reader method

Source

trivial-ldap.lisp (file)

Method: (setf attrs) NEW-VALUE (ENTRY entry)

automatically generated writer method

Source

trivial-ldap.lisp (file)

Generic Function: base OBJECT

Generic Function: (setf base) NEW-VALUE OBJECT

Package

trivial-ldap

Methods

Method: base (LDAP ldap)

automatically generated reader method

Source

trivial-ldap.lisp (file)

Method: (setf base) NEW-VALUE (LDAP ldap)

automatically generated writer method

Source

trivial-ldap.lisp (file)

Generic Function: bind LDAP

Package

trivial-ldap

Methods

Method: bind (LDAP ldap)

Send a BindRequest.

Source

trivial-ldap.lisp (file)

Generic Function: change-rdn ENTRY NEW-RDN

Package

trivial-ldap

Methods

Method: change-rdn (ENTRY entry) NEW-RDN

Change the DN and RDN of the specified object, don’t touch LDAP.

Source

trivial-ldap.lisp (file)

Generic Function: compare LDAP DN-OR-ENTRY ATTRIBUTE VALUE

Package

trivial-ldap

Methods

Method: compare (DN string) (LDAP ldap) ATTRIBUTE VALUE

Compare entry’s att/val; calle by both entry/compare methods.

Source

trivial-ldap.lisp (file)

Method: compare (ENTRY entry) (LDAP ldap) ATTRIBUTE VALUE

Assert an entry has an att=val; return t or nil, or throw error.

Source

trivial-ldap.lisp (file)

Method: compare (LDAP ldap) DN-OR-ENTRY ATTRIBUTE VALUE

Assert DN has attribute with specified value.

Source

trivial-ldap.lisp (file)

Generic Function: debugflag OBJECT

Generic Function: (setf debugflag) NEW-VALUE OBJECT

Package

trivial-ldap

Methods

Method: debugflag (LDAP ldap)

automatically generated reader method

Source

trivial-ldap.lisp (file)

Method: (setf debugflag) NEW-VALUE (LDAP ldap)

automatically generated writer method

Source

trivial-ldap.lisp (file)

Generic Function: del-attr ENTRY ATTR &optional VALS

Package

trivial-ldap

Methods

Method: del-attr (ENTRY entry) ATTR &optional VALS

Delete an attribute from entry object, do not update LDAP

Source

trivial-ldap.lisp (file)

Generic Function: delete LDAP DN-OR-ENTRY

Package

trivial-ldap

Methods

Method: delete (DN string) (LDAP ldap)

Delete an entry from LDAP; error unless successful.

Source

trivial-ldap.lisp (file)

Method: delete (ENTRY entry) (LDAP ldap)

Delete an entry object from ldap; error unless successful.

Source

trivial-ldap.lisp (file)

Method: delete (LDAP ldap) DN-OR-ENTRY

Delete an entry (or DN) from the directory.

Source

trivial-ldap.lisp (file)

Generic Function: dn CONDITION

Generic Function: (setf dn) NEW-VALUE OBJECT

Package

trivial-ldap

Methods

Method: dn (DN string)

Source

trivial-ldap.lisp (file)

Method: dn (ENTRY entry)

automatically generated reader method

Source

trivial-ldap.lisp (file)

Method: dn (CONDITION ldap-response-error)

Source

trivial-ldap.lisp (file)

Method: (setf dn) NEW-VALUE (ENTRY entry)

automatically generated writer method

Source

trivial-ldap.lisp (file)

Generic Function: host CONDITION

Generic Function: (setf host) NEW-VALUE OBJECT

Package

trivial-ldap

Methods

Method: host (LDAP ldap)

automatically generated reader method

Source

trivial-ldap.lisp (file)

Method: host (CONDITION ldap-connection-error)

Source

trivial-ldap.lisp (file)

Method: (setf host) NEW-VALUE (LDAP ldap)

automatically generated writer method

Source

trivial-ldap.lisp (file)

Generic Function: ldif ENTRY

Package

trivial-ldap

Methods

Method: ldif (ENTRY entry)

Return an ldif formatted representation of entry.

Source

trivial-ldap.lisp (file)

Generic Function: moddn LDAP DN-OR-ENTRY NEW-RDN &key DELETE-OLD NEW-SUP

Package

trivial-ldap

Methods

Method: moddn (DN string) (LDAP ldap) NEW-RDN &key DELETE-OLD NEW-SUP

Modify the RDN of an LDAP entry.

Source

trivial-ldap.lisp (file)

Method: moddn (ENTRY entry) (LDAP ldap) NEW-RDN &key DELETE-OLD NEW-SUP

Modify the RDN of an LDAP entry; update the entry object as well.

Source

trivial-ldap.lisp (file)

Method: moddn (LDAP ldap) DN-OR-ENTRY NEW-RDN &key DELETE-OLD NEW-SUP

Modify an entry’s RDN.

Source

trivial-ldap.lisp (file)

Generic Function: modify LDAP DN-OR-ENTRY LIST-OF-MODS

Package

trivial-ldap

Methods

Method: modify (ENTRY entry) (LDAP ldap) LIST-OF-MODS

Modify entry attributes in ldap, update the entry object. LIST-OF-MODS is a list of (type att val) triples.

Source

trivial-ldap.lisp (file)

Method: modify (LDAP ldap) DN-OR-ENTRY LIST-OF-MODS

Modify and entry’s attributes.

Source

trivial-ldap.lisp (file)

Generic Function: next-search-result LDAP

Package

trivial-ldap

Methods

Method: next-search-result (LDAP ldap)

Return the next search result (as entry obj) or NIL if none.

Source

trivial-ldap.lisp (file)

Generic Function: pass OBJECT

Generic Function: (setf pass) NEW-VALUE OBJECT

Package

trivial-ldap

Methods

Method: pass (LDAP ldap)

automatically generated reader method

Source

trivial-ldap.lisp (file)

Method: (setf pass) NEW-VALUE (LDAP ldap)

automatically generated writer method

Source

trivial-ldap.lisp (file)

Generic Function: port CONDITION

Generic Function: (setf port) NEW-VALUE OBJECT

Package

trivial-ldap

Methods

Method: port (LDAP ldap)

automatically generated reader method

Source

trivial-ldap.lisp (file)

Method: port (CONDITION ldap-connection-error)

Source

trivial-ldap.lisp (file)

Method: (setf port) NEW-VALUE (LDAP ldap)

automatically generated writer method

Source

trivial-ldap.lisp (file)

Generic Function: rdn OBJECT

Generic Function: (setf rdn) NEW-VALUE OBJECT

Package

trivial-ldap

Methods

Method: rdn (ENTRY entry)

automatically generated reader method

Source

trivial-ldap.lisp (file)

Method: (setf rdn) NEW-VALUE (ENTRY entry)

automatically generated writer method

Source

trivial-ldap.lisp (file)

Generic Function: replace-attr ENTRY ATTR VALS

Package

trivial-ldap

Methods

Method: replace-attr (ENTRY entry) ATTR VALS

Replace attribute values from entry object, do not update LDAP

Source

trivial-ldap.lisp (file)

Generic Function: response OBJECT

Generic Function: (setf response) NEW-VALUE OBJECT

Package

trivial-ldap

Methods

Method: response (LDAP ldap)

automatically generated reader method

Source

trivial-ldap.lisp (file)

Method: (setf response) NEW-VALUE (LDAP ldap)

automatically generated writer method

Source

trivial-ldap.lisp (file)

Generic Function: results-pending-p OBJECT

Generic Function: (setf results-pending-p) NEW-VALUE OBJECT

Package

trivial-ldap

Methods

Method: results-pending-p (LDAP ldap)

automatically generated reader method

Source

trivial-ldap.lisp (file)

Method: (setf results-pending-p) NEW-VALUE (LDAP ldap)

automatically generated writer method

Source

trivial-ldap.lisp (file)

Generic Function: reuse-connection OBJECT

Generic Function: (setf reuse-connection) NEW-VALUE OBJECT

Package

trivial-ldap

Methods

Method: reuse-connection (LDAP ldap)

Method: (setf reuse-connection) NEW-VALUE (LDAP ldap)

nil, t, or rebind

Source

trivial-ldap.lisp (file)

Generic Function: search LDAP FILTER &key BASE SCOPE DEREF SIZE-LIMIT TIME-LIMIT TYPES-ONLY ATTRIBUTES PAGING-SIZE

Package

trivial-ldap

Methods

Method: search (LDAP ldap) FILTER &key BASE SCOPE DEREF SIZE-LIMIT TIME-LIMIT TYPES-ONLY ATTRIBUTES PAGING-SIZE

Search the LDAP directory.

Source

trivial-ldap.lisp (file)

Generic Function: sslflag OBJECT

Generic Function: (setf sslflag) NEW-VALUE OBJECT

Package

trivial-ldap

Methods

Method: sslflag (LDAP ldap)

automatically generated reader method

Source

trivial-ldap.lisp (file)

Method: (setf sslflag) NEW-VALUE (LDAP ldap)

automatically generated writer method

Source

trivial-ldap.lisp (file)

Generic Function: unbind LDAP

Package

trivial-ldap

Methods

Method: unbind (LDAP ldap)

Unbind and close the ldap stream.

Source

trivial-ldap.lisp (file)

Generic Function: user OBJECT

Generic Function: (setf user) NEW-VALUE OBJECT

Package

trivial-ldap

Methods

Method: user (LDAP ldap)

automatically generated reader method

Source

trivial-ldap.lisp (file)

Method: (setf user) NEW-VALUE (LDAP ldap)

automatically generated writer method

Source

trivial-ldap.lisp (file)

5.1.4 Conditions

Condition: ldap-bind-error ()

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Direct superclasses

ldap-error (condition)

Direct methods

code-sym (method)

Direct slots

Slot: code-sym

Initargs

:code-sym

Initform

(quote (error "must specify code-sym"))

Readers

code-sym (generic function)

Condition: ldap-connection-error ()

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Direct superclasses

ldap-error (condition)

Direct methods

• port (method)
• host (method)

Direct slots

Slot: host

Initargs

:host

Readers

host (generic function)

Slot: port

Initargs

:port

Readers

port (generic function)

Condition: ldap-error ()

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

• ldap-filter-error (condition)
• ldap-connection-error (condition)
• ldap-response-error (condition)
• ldap-bind-error (condition)
• ldap-referral-error (condition)
• ldap-size-limit-exceeded-error (condition)

Direct methods

mesg (method)

Direct slots

Slot: note

Initargs

:mesg

Initform

(quote "ldap transaction resulted in an error.")

Readers

mesg (generic function)

Condition: ldap-filter-error ()

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Direct superclasses

ldap-error (condition)

Direct methods

filter (method)

Direct slots

Slot: filter

Initargs

:filter

Initform

(quote "not supplied")

Readers

filter (generic function)

Condition: ldap-referral-error ()

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Direct superclasses

ldap-error (condition)

Condition: ldap-response-error ()

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Direct superclasses

ldap-error (condition)

Direct methods

• msg (method)
• code (method)
• dn (method)

Direct slots

Slot: dn

Initargs

:dn

Initform

(quote "dn not available.")

Readers

dn (generic function)

Slot: code

Initargs

:code

Initform

(quote "result code not available")

Readers

code (generic function)

Slot: msg

Initargs

:msg

Initform

(quote "n/a")

Readers

msg (generic function)

Condition: ldap-size-limit-exceeded-error ()

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Direct superclasses

ldap-error (condition)

Condition: probably-binary-field-error ()

Condition that is signalled when a binary field is being parsed as a string

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Direct superclasses

error (condition)

Direct methods

probably-binary-field-error-key (method)

Direct slots

Slot: key

The name of the key which has binary content

Initargs

:key

Readers

probably-binary-field-error-key (generic function)

5.1.5 Classes

Class: entry ()

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• msg-add (method)
• modify (method)
• compare (method)
• moddn (method)
• delete (method)
• add (method)
• add (method)
• ldif (method)
• replace-attr (method)
• del-attr (method)
• add-attr (method)
• attr-list (method)
• attr-value (method)
• attr-value (method)
• change-rdn (method)
• attrs (method)
• attrs (method)
• rdn (method)
• rdn (method)
• (setf dn) (method)
• dn (method)

Direct slots

Slot: dn

Type

string

Initargs

:dn

Readers

dn (generic function)

Writers

(setf dn) (generic function)

Slot: rdn

Type

string

Initargs

:rdn

Readers

rdn (generic function)

Writers

(setf rdn) (generic function)

Slot: attrs

Type

cons

Initargs

:attrs

Readers

attrs (generic function)

Writers

(setf attrs) (generic function)

Class: ldap ()

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• msg-abandon (method)
• msg-bind (method)
• next-search-result (method)
• search (method)
• modify (method)
• modify (method)
• compare (method)
• compare (method)
• compare (method)
• moddn (method)
• moddn (method)
• moddn (method)
• delete (method)
• delete (method)
• delete (method)
• add (method)
• add (method)
• abandon (method)
• unbind (method)
• bind (method)
• process-message (method)
• parse-ldap-message (method)
• handle-extended-response (method)
• receive-message (method)
• send-message (method)
• possibly-reopen-and-rebind (method)
• close-stream (method)
• get-stream (method)
• mesg-incf (method)
• initialize-instance (method)
• search-fn (method)
• search-fn (method)
• paging-cookie (method)
• paging-cookie (method)
• results-pending-p (method)
• results-pending-p (method)
• entry-buffer (method)
• entry-buffer (method)
• response (method)
• response (method)
• base (method)
• base (method)
• debugflag (method)
• debugflag (method)
• (setf mesg) (method)
• mesg (method)
• wrap-packets (method)
• wrap-packets (method)
• incoming-buffer-pos (method)
• incoming-buffer-pos (method)
• incoming-buffer (method)
• incoming-buffer (method)
• gss-context (method)
• gss-context (method)
• sasl (method)
• sasl (method)
• timeout (method)
• timeout (method)
• reuse-connection (method)
• reuse-connection (method)
• ldapsock (method)
• ldapsock (method)
• ldapstream (method)
• ldapstream (method)
• pass (method)
• pass (method)
• user (method)
• user (method)
• sslflag (method)
• sslflag (method)
• (setf port) (method)
• port (method)
• (setf host) (method)
• host (method)

Direct slots

Slot: host

Type

string

Initargs

:host

Initform

"localhost"

Readers

host (generic function)

Writers

(setf host) (generic function)

Slot: port

Type

integer

Initargs

:port

Initform

trivial-ldap::+ldap-port-no-ssl+

Readers

port (generic function)

Writers

(setf port) (generic function)

Slot: sslflag

Type

symbol

Initargs

:sslflag

Readers

sslflag (generic function)

Writers

(setf sslflag) (generic function)

Slot: user

Type

string

Initargs

:user

Initform

""

Readers

user (generic function)

Writers

(setf user) (generic function)

Slot: pass

Type

string

Initargs

:pass

Initform

""

Readers

pass (generic function)

Writers

(setf pass) (generic function)

Slot: ldapstream

Type

(or null stream)

Initargs

:ldapstream

Readers

ldapstream (generic function)

Writers

(setf ldapstream) (generic function)

Slot: ldapsock

Initargs

:ldapsock

Readers

ldapsock (generic function)

Writers

(setf ldapsock) (generic function)

Slot: reuse-connection

nil, t, or rebind

Type

symbol

Initargs

:reuse-connection

Initform

t

Readers

reuse-connection (generic function)

Writers

(setf reuse-connection) (generic function)

Slot: timeout

Type

(or null (integer 0))

Initargs

:timeout

Readers

timeout (generic function)

Writers

(setf timeout) (generic function)

Slot: sasl

Initargs

:sasl

Readers

sasl (generic function)

Writers

(setf sasl) (generic function)

Slot: gss-context

Readers

gss-context (generic function)

Writers

(setf gss-context) (generic function)

Slot: incoming-buffer

Readers

incoming-buffer (generic function)

Writers

(setf incoming-buffer) (generic function)

Slot: incoming-buffer-pos

Readers

incoming-buffer-pos (generic function)

Writers

(setf incoming-buffer-pos) (generic function)

Slot: wrap-packets

NIL means no wrapping. :CONF
indicates encryption. Other values means plain wrapping.

Readers

wrap-packets (generic function)

Writers

(setf wrap-packets) (generic function)

Slot: mesg

Type

integer

Initargs

:mesg

Initform

0

Readers

mesg (generic function)

Writers

(setf mesg) (generic function)

Slot: debugflag

Type

symbol

Initargs

:debugflag

Readers

debugflag (generic function)

Writers

(setf debugflag) (generic function)

Slot: base

Type

(or null string)

Initargs

:base

Readers

base (generic function)

Writers

(setf base) (generic function)

Slot: response

Initargs

:response

Readers

response (generic function)

Writers

(setf response) (generic function)

Slot: entry-buffer

Initargs

:entry-buffer

Readers

entry-buffer (generic function)

Writers

(setf entry-buffer) (generic function)

Slot: results-pending-p

Type

(boolean)

Initargs

:results-pending-p

Readers

results-pending-p (generic function)

Writers

(setf results-pending-p) (generic function)

Slot: paging-cookie

Type

string

Initform

""

Readers

paging-cookie (generic function)

Writers

(setf paging-cookie) (generic function)

Slot: search-fn

Readers

search-fn (generic function)

Writers

(setf search-fn) (generic function)

5.2 Internal definitions

5.2.1 Constants

Constant: +ber-abandon-tag+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-add-tag+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-app-const-base+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-bind-tag+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-class-id+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-comp-tag+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-controls-tag+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-del-tag+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-long-length-marker+

Flag indicating more tag number bytes follow

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-moddn-tag+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-modify-tag+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-multibyte-tag-number+

Flag indicating tag number requires > 1 byte

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-p/c-bit+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-search-tag+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-tag-bool+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-tag-controls+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-tag-enum+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-tag-ext-name+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-tag-ext-val+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-tag-extendedresponse+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-tag-int+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-tag-referral+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-tag-sasl-res-creds+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-tag-seq+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-tag-set+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-tag-str+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ber-unbind-tag+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ldap-application-names+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ldap-control-extension-paging+

OID of the paging control.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ldap-deref+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ldap-disconnection-response+

OID of the unsolicited disconnection reponse.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ldap-filter-comparison-char+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ldap-modify-type+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ldap-port-no-ssl+

Default LDAP Port.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ldap-port-ssl+

Default LDAPS Port.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ldap-result-codes+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ldap-scope+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ldap-substring+

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +ldap-version+

LDAP version 3.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Constant: +max-int+

As defined by the LDAP RFC.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

5.2.2 Special variables

Special Variable: *binary-attributes*

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Special Variable: *hex-print*

Format directive to print a list of line wrapped hex numbers.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Special Variable: *init-sec-fn*

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Special Variable: *ldap-filter-parser*

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Special Variable: *unwrap-fn*

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Special Variable: *wrap-fn*

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

5.2.3 Macros

Macro: debug-mesg LDAP MESSAGE

If debugging in T, print a message.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Macro: define-constant NAME VALUE &optional DOC

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

5.2.4 Functions

Function: attrs-from-list X

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: base10->base256 INT

Return representation of an integer as a list of base 256 ’digits’.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: base256->base10 LIST

Given a list of base 256 ’digits’ return an integer.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: base256-vec->base10 VEC &key START END

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: ber-class-id CLASS

Return the bits to construct a BER tag of type class.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: ber-length IT

Given a sequence or integer, return a BER length.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: ber-msg TAG DATA

Given a BER tag and a sequence of data, return a message

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: ber-p/c-bit P/C

Return the bit to construct a BER tag of class primitive or constructed.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: ber-tag CLASS P/C NUMBER-OR-COMMAND

Construct the list of bytes that constitute a BER tag number 0-127. CLASS should be the symbol universal, applicaiton, context, or private. P/C should be the symbol primitive or constructed.
NUMBER should be either an integer or LDAP application name as symbol.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: ber-tag-type CLASS P/C

Construct the bits that kicks off a BER tag byte.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: bind-gss LDAP

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: bind-gss-spnego LDAP

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: char-code-list->string CHAR-CODE-LIST

Convert a list of bytes into a string.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: char-code-vec->string CHAR-CODE-VEC &key START END

Convert a vector of bytes into a string.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: check-message-number RESPONSE EXPECTED-MESG-NUMBER

Determine if the message number of a BER response is correct. Returns BER response if it is correct or NIL otherwise.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: copy-response-vec VEC &key START END

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: create-sasl-message LDAP MECHANISM BUFFER

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: decrypt-stream LDAP

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: encrypt-message LDAP MESSAGE STREAM

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: int->octet-list INT

Return 2s comp. representation of INT.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: ldap-command COMMAND

Given a symbol naming an ldap command, return the command number.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: ldap-command-sym NUMBER

Given an application number, return the command name as symbol.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: ldap-deref &optional DEREF

Given a deref symbol return the enumeration int.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: ldap-filter-comparison-char COMPARISON-CHAR-AS-SYMBOL

Given a comparison character, return its integer enum value.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: ldap-filter-lexer STRING

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: ldap-modify-type TYPE

Given a modify type, return the enumeration int.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: ldap-result-code-string CODE

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: ldap-result-code-symbol CODE

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: ldap-scope &optional SCOPE

Given a scope symbol return the enumeration int.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: ldap-substring TYPE

Given a substring type, return its integer choice value.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: list-entries-to-string KEY LIST

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: make-response-vec SIZE

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: msg-compare DN-OR-ENTRY ATTRIBUTE VALUE

Return the sequence of bytes representing a compare message.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: msg-delete DN-OR-ENTRY

Return the sequence of bytes representing a delete message.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: msg-moddn DN-OR-ENTRY NEW-RDN DELETE-OLD NEW-SUP

Return the sequence of bytes representing a moddn message.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: msg-modify DN-OR-ENTRY MOD-LIST

Return the sequence of bytes representing a modify message.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: msg-search FILTER BASE SCOPE DEREF SIZE TIME TYPES ATTRS &optional PAGING-SIZE PAGING-COOKIE

Return the sequence of bytes representing a search message.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: new-referrer URL

Instantiate a new referrer object.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: octet-list->int OCTET-LIST

Convert sequence of twos-complement octets into an integer.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: octet-vec->int VEC &key START END

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: process-response-controls LDAP CONTROLS

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: rdn-from-dn DN

Given a DN, return its RDN and a cons of (att . val)

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: read-app-number TAG

Given an application tag, return which ldap app number it represents.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: read-controls MESSAGE

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: read-decoder RESPONSE

Decode a BER encoded response (minus initial byte & length) from LDAP.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: read-generic MESSAGE

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: read-integer MESSAGE

Read an int from the message.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: read-length MESSAGE

Given message starting with length marker.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: read-message-number RESPONSE EXPECTED-MESG-NUMBER

Read message number from the seq, return t or nil.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: read-octets MESSAGE

Read an octet vector from the message.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: read-string MESSAGE

Read a string from the message.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: read-with-length STREAM &key LENGTH

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: read-wrapped-byte LDAP

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: receive-length LDAP

Read length of LDAP message from stream, return length & the bytes read.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: send-sasl LDAP MECHANISM BUFFER

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: send-sasl-auth-res LDAP CONTEXT SASL-RES

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: seq-att-and-values ATT VALS

BER encode an attribute and set of values (for use in modify).

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: seq-attribute-alist ATTS

BER encode an entry object’s attribute alist (for use in add).

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: seq-attribute-assertion ATT VAL

BER encode an ldap attribute assertion (for use in compare).

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: seq-attribute-list ATT-LIST

BER encode a list of attributes (for use in search).

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: seq-attribute-value-assertion ATT VAL

BER encode an ldap attribute value assertion (for use in filters).

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: seq-boolean T/F

BER encode a boolean value.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: seq-constructed-choice INT &optional DATA

BER encode a context-specific, constructed choice.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: seq-enumerated INT

BER encode an enumeration value.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: seq-filter FILTER

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: seq-integer INT

BER encode an integer value.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: seq-null ()

BER encode a NULL

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: seq-octet-string STRING

BER encode an octet string value.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: seq-primitive-choice INT &optional DATA

BER encode a context-specific choice.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)

Function: seq-primitive-string STRING

BER encode a string/symbol for use in a primitive context.

Package

trivial-ldap

Source

trivial-ldap.lisp (file)