This is the trivial-ldap Reference Manual, version 0.94, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:56:26 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
trivial-ldapTRIVIAL-LDAP is a one file, all Common Lisp client implementation of parts of RFC 2261.
Raymond Wiker <rwiker@gmail.com>
Kevin Montuori
Clarified Artistic License
0.94
usocket (system).
cl+ssl (system).
yacc (system).
package.lisp (file).
trivial-ldap.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
trivial-ldap/trivial-ldap.lisppackage.lisp (file).
trivial-ldap (system).
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 (reader method).
(setf attrs) (writer method).
base (reader method).
(setf base) (writer method).
bind (method).
change-rdn (method).
compare (method).
compare (method).
compare (method).
debugflag (reader method).
(setf debugflag) (writer method).
del-attr (method).
delete (method).
delete (method).
delete (method).
dn (method).
dn (reader method).
dn (reader method).
(setf dn) (writer method).
dosearch (macro).
entry (class).
escape-string (function).
host (reader method).
host (reader method).
(setf host) (writer method).
initialize-instance (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 (reader method).
(setf pass) (writer method).
port (reader method).
port (reader method).
(setf port) (writer method).
probably-binary-field-error (condition).
rdn (reader method).
(setf rdn) (writer method).
replace-attr (method).
response (reader method).
(setf response) (writer method).
results-pending-p (reader method).
(setf results-pending-p) (writer method).
reuse-connection (reader method).
(setf reuse-connection) (writer method).
search (method).
sslflag (reader method).
(setf sslflag) (writer method).
unbind (method).
unescape-string (function).
user (reader method).
(setf user) (writer method).
*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 (reader method).
code-sym (reader 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 (reader method).
(setf entry-buffer) (writer method).
filter (reader method).
get-stream (method).
gss-context (reader method).
(setf gss-context) (writer method).
handle-extended-response (method).
incoming-buffer (reader method).
(setf incoming-buffer) (writer method).
incoming-buffer-pos (reader method).
(setf incoming-buffer-pos) (writer 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 (reader method).
(setf ldapsock) (writer method).
ldapstream (reader method).
(setf ldapstream) (writer method).
list-entries-to-string (function).
make-response-vec (function).
mesg (reader method).
mesg (reader method).
(setf mesg) (writer method).
mesg-incf (method).
msg (reader 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 (reader method).
(setf paging-cookie) (writer method).
parse-ldap-message (method).
peek-byte (method).
pop-byte (method).
possibly-reopen-and-rebind (method).
probably-binary-field-error-key (reader 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 (reader method).
(setf response-vec/ptr) (writer method).
response-vec/vec (reader method).
(setf response-vec/vec) (writer method).
sasl (reader method).
(setf sasl) (writer method).
search-fn (reader method).
(setf search-fn) (writer 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 (reader method).
(setf timeout) (writer method).
url (reader method).
(setf url) (writer method).
valid-ldap-response-p (function).
wrap-packets (reader method).
(setf wrap-packets) (writer method).
write-with-length (function).
Packages are listed by definition order.
trivial-ldapldap
common-lisp.
abandon (generic function).
add (generic function).
add-attr (generic function).
attr-list (generic function).
attr-value (generic function).
attribute-binary-p (function).
(setf attribute-binary-p) (function).
attrs (generic reader).
(setf attrs) (generic writer).
base (generic reader).
(setf base) (generic writer).
bind (generic function).
change-rdn (generic function).
compare (generic function).
debugflag (generic reader).
(setf debugflag) (generic writer).
del-attr (generic function).
delete (generic function).
dn (generic function).
(setf dn) (generic writer).
dosearch (macro).
entry (class).
escape-string (function).
host (generic reader).
(setf host) (generic writer).
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-search (macro).
listify-filter (function).
moddn (generic function).
modify (generic function).
new-entry (function).
new-entry-from-list (function).
new-ldap (function).
next-search-result (generic function).
pass (generic reader).
(setf pass) (generic writer).
port (generic reader).
(setf port) (generic writer).
probably-binary-field-error (condition).
rdn (generic reader).
(setf rdn) (generic writer).
replace-attr (generic function).
response (generic reader).
(setf response) (generic writer).
results-pending-p (generic reader).
(setf results-pending-p) (generic writer).
reuse-connection (generic reader).
(setf reuse-connection) (generic writer).
search (generic function).
sslflag (generic reader).
(setf sslflag) (generic writer).
unbind (generic function).
unescape-string (function).
user (generic reader).
(setf user) (generic writer).
*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).
char-code-list->string (function).
char-code-vec->string (function).
check-message-number (function).
close-stream (generic function).
code (generic reader).
code-sym (generic reader).
copy-response-vec (function).
create-sasl-message (function).
debug-mesg (macro).
decrypt-stream (function).
define-constant (macro).
discard-bytes (generic function).
encrypt-message (function).
entry-buffer (generic reader).
(setf entry-buffer) (generic writer).
filter (generic reader).
get-stream (generic function).
gss-context (generic reader).
(setf gss-context) (generic writer).
handle-extended-response (generic function).
incoming-buffer (generic reader).
(setf incoming-buffer) (generic writer).
incoming-buffer-pos (generic reader).
(setf incoming-buffer-pos) (generic writer).
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 reader).
(setf ldapsock) (generic writer).
ldapstream (generic reader).
(setf ldapstream) (generic writer).
list-entries-to-string (function).
make-response-vec (function).
mesg (generic reader).
(setf mesg) (generic writer).
mesg-incf (generic function).
msg (generic reader).
msg-abandon (generic function).
msg-add (generic function).
msg-bind (generic function).
msg-compare (function).
msg-delete (function).
msg-moddn (function).
msg-modify (function).
msg-search (function).
msg-unbind (generic function).
new-referrer (function).
octet-list->int (function).
octet-vec->int (function).
paging-cookie (generic reader).
(setf paging-cookie) (generic writer).
parse-ldap-message (generic function).
peek-byte (generic function).
pop-byte (generic function).
possibly-reopen-and-rebind (generic function).
probably-binary-field-error-key (generic reader).
process-message (generic function).
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).
referrer (class).
response-vec (class).
response-vec/ptr (generic reader).
(setf response-vec/ptr) (generic writer).
response-vec/vec (generic reader).
(setf response-vec/vec) (generic writer).
sasl (generic reader).
(setf sasl) (generic writer).
search-fn (generic reader).
(setf search-fn) (generic writer).
send-message (generic function).
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 reader).
(setf timeout) (generic writer).
url (generic reader).
(setf url) (generic writer).
valid-ldap-response-p (function).
wrap-packets (generic reader).
(setf wrap-packets) (generic writer).
write-with-length (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Instantiate a new entry object.
Create an entry object from the list return by search.
Instantiate a new ldap object.
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...
string) (ldap ldap) attribute value) ¶Compare entry’s att/val; calle by both entry/compare methods.
entry) (ldap ldap) attribute value) ¶Assert an entry has an att=val; return t or nil, or throw error.
string) (ldap ldap)) ¶Delete an entry from LDAP; error unless successful.
entry) (ldap ldap)) ¶Delete an entry object from ldap; error unless successful.
string) (ldap ldap) new-rdn &key delete-old new-sup) ¶Modify the RDN of an LDAP entry.
entry) (ldap ldap) new-rdn &key delete-old new-sup) ¶Modify the RDN of an LDAP entry; update the entry object as well.
error.
mesg.
Condition that is signalled when a binary field is being parsed as a string
error.
The name of the key which has binary content
:key
This slot is read-only.
add.
add.
add-attr.
attr-list.
attr-value.
attr-value.
(setf attrs).
attrs.
change-rdn.
compare.
del-attr.
delete.
(setf dn).
dn.
ldif.
moddn.
modify.
msg-add.
(setf rdn).
rdn.
replace-attr.
cons
:attrs
abandon.
add.
add.
(setf base).
base.
bind.
close-stream.
compare.
compare.
compare.
(setf debugflag).
debugflag.
delete.
delete.
delete.
(setf entry-buffer).
entry-buffer.
get-stream.
(setf gss-context).
gss-context.
handle-extended-response.
(setf host).
host.
(setf incoming-buffer).
incoming-buffer.
(setf incoming-buffer-pos).
incoming-buffer-pos.
initialize-instance.
(setf ldapsock).
ldapsock.
(setf ldapstream).
ldapstream.
(setf mesg).
mesg.
mesg-incf.
moddn.
moddn.
moddn.
modify.
modify.
msg-abandon.
msg-bind.
next-search-result.
(setf paging-cookie).
paging-cookie.
parse-ldap-message.
(setf pass).
pass.
(setf port).
port.
possibly-reopen-and-rebind.
process-message.
receive-message.
(setf response).
response.
(setf results-pending-p).
results-pending-p.
(setf reuse-connection).
reuse-connection.
(setf sasl).
sasl.
search.
(setf search-fn).
search-fn.
send-message.
(setf sslflag).
sslflag.
(setf timeout).
timeout.
unbind.
(setf user).
user.
(setf wrap-packets).
wrap-packets.
integer
trivial-ldap::+ldap-port-no-ssl+
:port
port.
symbol
:sslflag
(or null stream)
:ldapstream
:ldapsock
nil, t, or rebind
symbol
t
:reuse-connection
(or null (integer 0))
:timeout
NIL means no wrapping. :CONF
indicates encryption. Other values means plain wrapping.
symbol
:debugflag
:response
:entry-buffer
(boolean)
:results-pending-p
string
""
Flag indicating more tag number bytes follow
Flag indicating tag number requires > 1 byte
OID of the paging control.
OID of the unsolicited disconnection reponse.
Default LDAP Port.
Default LDAPS Port.
LDAP version 3.
As defined by the LDAP RFC.
Format directive to print a list of line wrapped hex numbers.
If debugging in T, print a message.
Return representation of an integer as a list of base 256 ’digits’.
Given a list of base 256 ’digits’ return an integer.
Return the bits to construct a BER tag of type class.
Given a sequence or integer, return a BER length.
Given a BER tag and a sequence of data, return a message
Return the bit to construct a BER tag of class primitive or constructed.
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.
Construct the bits that kicks off a BER tag byte.
Convert a list of bytes into a string.
Convert a vector of bytes into a string.
Determine if the message number of a BER response is correct. Returns BER response if it is correct or NIL otherwise.
Return 2s comp. representation of INT.
Given a symbol naming an ldap command, return the command number.
Given an application number, return the command name as symbol.
Given a deref symbol return the enumeration int.
Given a comparison character, return its integer enum value.
Given a modify type, return the enumeration int.
Given a scope symbol return the enumeration int.
Given a substring type, return its integer choice value.
Return the sequence of bytes representing a compare message.
Return the sequence of bytes representing a delete message.
Return the sequence of bytes representing a moddn message.
Return the sequence of bytes representing a modify message.
Return the sequence of bytes representing a search message.
Instantiate a new referrer object.
Convert sequence of twos-complement octets into an integer.
Given a DN, return its RDN and a cons of (att . val)
Given an application tag, return which ldap app number it represents.
Decode a BER encoded response (minus initial byte & length) from LDAP.
Read an int from the message.
Given message starting with length marker.
Read message number from the seq, return t or nil.
Read an octet vector from the message.
Read a string from the message.
Read length of LDAP message from stream, return length & the bytes read.
BER encode an attribute and set of values (for use in modify).
BER encode an entry object’s attribute alist (for use in add).
BER encode an ldap attribute assertion (for use in compare).
BER encode a list of attributes (for use in search).
BER encode an ldap attribute value assertion (for use in filters).
BER encode a boolean value.
BER encode a context-specific, constructed choice.
BER encode an enumeration value.
BER encode an integer value.
BER encode a NULL
BER encode an octet string value.
BER encode a context-specific choice.
BER encode a string/symbol for use in a primitive context.
BER encode a sequence of TLVs.
BER encode a set of TLVs.
Given a search value with *s in it, return a BER encoded list.
Split a substring filter value into a list, retaining the * separators.
Convert a string into a list of bytes.
Return T if this is the valid initial tag byte for an LDAP response.
response-vec)) ¶ldap-response-error)) ¶code.
ldap-bind-error)) ¶response-vec) n) ¶ldap-filter-error)) ¶ldap-response-error)) ¶msg.
response-vec)) ¶response-vec)) ¶ldap) &optional absolutely-no-bind) ¶Take appropriate reopen or rebind actions based on the reuse-connection attr. If the attribute is nil, do nothing; if t, reopen; and, if bind, rebind. This function exists to help the poor saps (read: me) with very fast idletimeout settings on their LDAP servers.
probably-binary-field-error)) ¶key.
response-vec)) ¶automatically generated reader method
ptr.
response-vec)) ¶automatically generated writer method
ptr.
response-vec)) ¶automatically generated reader method
vec.
response-vec)) ¶automatically generated writer method
vec.
| Jump to: | (
A B C D E F G H I L M N O P R S T U V W |
|---|
| Jump to: | (
A B C D E F G H I L M N O P R S T U V W |
|---|
| Jump to: | *
+
A B C D E F G H I K L M N P R S T U V W |
|---|
| Jump to: | *
+
A B C D E F G H I K L M N P R S T U V W |
|---|
| Jump to: | C E F L P R S T |
|---|
| Jump to: | C E F L P R S T |
|---|