This is the cl-gss Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 04:04:15 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-gss
Common Lisp interface to GSSAPI
Elias Martenson <lokedhs@gmail.com>
BSD
cffi
(system).
cffi-grovel
(system).
trivial-garbage
(system).
trivial-utf-8
(system).
src
(module).
Modules are listed depth-first from the system components tree.
cl-gss/src
cl-gss
(system).
package.lisp
(file).
gss-grovel.lisp
(file).
gss-mech-krb5-grovel.lisp
(file).
functions.lisp
(file).
functions-mech-krb5.lisp
(file).
conditions.lisp
(file).
cl-gss.lisp
(file).
cl-gss-ext.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-gss/cl-gss.asd
cl-gss/src/package.lisp
cl-gss/src/gss-grovel.lisp
cl-gss/src/gss-mech-krb5-grovel.lisp
cl-gss/src/functions.lisp
cl-gss/src/functions-mech-krb5.lisp
cl-gss/src/conditions.lisp
cl-gss/src/cl-gss.lisp
cl-gss/src/cl-gss-ext.lisp
cl-gss/src/gss-grovel.lisp
package.lisp
(file).
src
(module).
cl-gss/src/gss-mech-krb5-grovel.lisp
gss-grovel.lisp
(file).
src
(module).
cl-gss/src/functions.lisp
gss-mech-krb5-grovel.lisp
(file).
src
(module).
%var-accessor-*gss-c-nt-hostbased-service*
(function).
(setf %var-accessor-*gss-c-nt-hostbased-service*)
(function).
%var-accessor-*gss-c-nt-machine-uid-name*
(function).
(setf %var-accessor-*gss-c-nt-machine-uid-name*)
(function).
%var-accessor-*gss-c-nt-string-uid-name*
(function).
(setf %var-accessor-*gss-c-nt-string-uid-name*)
(function).
%var-accessor-*gss-c-nt-user-name*
(function).
(setf %var-accessor-*gss-c-nt-user-name*)
(function).
*gss-c-no-oid*
(special variable).
*gss-c-nt-hostbased-service*
(symbol macro).
*gss-c-nt-machine-uid-name*
(symbol macro).
*gss-c-nt-string-uid-name*
(symbol macro).
*gss-c-nt-user-name*
(symbol macro).
buffer-desc-length
(macro).
buffer-desc-value
(macro).
gss-accept-sec-context
(function).
gss-acquire-cred
(function).
gss-acquire-cred-with-password
(function).
gss-compare-name
(function).
gss-context-time
(function).
gss-delete-sec-context
(function).
gss-display-name
(function).
gss-display-status
(function).
gss-export-name
(function).
gss-import-name
(function).
gss-indicate-mechs
(function).
gss-init-sec-context
(function).
gss-inquire-cred
(function).
gss-oid-to-str
(function).
gss-release-buffer
(function).
gss-release-cred
(function).
gss-release-name
(function).
gss-release-oid
(function).
gss-release-oid-set
(function).
gss-str-to-oid
(function).
gss-unwrap
(function).
gss-wrap
(function).
cl-gss/src/functions-mech-krb5.lisp
functions.lisp
(file).
src
(module).
%krb5-register-acceptor-identity
(function).
%var-accessor-gss-mech-krb5
(function).
(setf %var-accessor-gss-mech-krb5)
(function).
gss-mech-krb5
(symbol macro).
cl-gss/src/conditions.lisp
functions-mech-krb5.lisp
(file).
src
(module).
gss-error
(condition).
gss-error-major
(reader method).
gss-error-major-messages
(reader method).
gss-error-minor
(reader method).
gss-error-minor-messages
(reader method).
calling-error-p
(function).
continue-needed-p
(function).
error-p
(function).
errors-as-string
(function).
extract-error-message
(function).
raise-error
(function).
routine-error-p
(function).
supplementary-info-p
(function).
cl-gss/src/cl-gss.lisp
conditions.lisp
(file).
src
(module).
accept-sec
(function).
compare-name
(function).
context
(class).
context-time
(function).
cred
(class).
init-sec
(function).
initialize-instance
(method).
initialize-instance
(method).
initialize-instance
(method).
krb5-register-acceptor-identity
(function).
make-name
(function).
name
(class).
name-to-string
(function).
unwrap
(function).
wrap
(function).
*register-ffi-functions*
(special variable).
array-to-foreign-char-array
(function).
convert-to-bytes
(function).
get-or-allocate-context
(function).
gss-call
(macro).
gss-memory-mixin
(class).
gss-memory-mixin-ptr
(reader method).
make-flags
(function).
make-flags-list
(function).
parse-identifier-to-name
(function).
token->array
(function).
with-buffer-desc
(macro).
with-foreign-buffer-from-byte-array
(macro).
cl-gss/src/cl-gss-ext.lisp
cl-gss.lisp
(file).
src
(module).
acquire-cred
(function).
acquire-cred-password
(function).
inquire-cred
(function).
mech-list
(function).
oid-to-string
(function).
string-to-oid
(function).
conv-usage-to-foreign
(function).
generate-mech-list
(function).
make-mech
(function).
parse-usage-from-foreign
(function).
with-oid-buffer
(macro).
Packages are listed by definition order.
cl-gss-system
private: ASDF system package for cl-gss
asdf/interface
.
common-lisp
.
cl-gss
Common Lisp interface to GSSAPI.
common-lisp
.
accept-sec
(function).
acquire-cred
(function).
acquire-cred-password
(function).
compare-name
(function).
context
(class).
context-time
(function).
cred
(class).
gss-error
(condition).
gss-error-major
(generic reader).
gss-error-major-messages
(generic reader).
gss-error-minor
(generic reader).
gss-error-minor-messages
(generic reader).
init-sec
(function).
inquire-cred
(function).
krb5-register-acceptor-identity
(function).
make-name
(function).
mech-list
(function).
name
(class).
name-to-string
(function).
oid-to-string
(function).
string-to-oid
(function).
unwrap
(function).
wrap
(function).
%krb5-register-acceptor-identity
(function).
%var-accessor-*gss-c-nt-hostbased-service*
(function).
(setf %var-accessor-*gss-c-nt-hostbased-service*)
(function).
%var-accessor-*gss-c-nt-machine-uid-name*
(function).
(setf %var-accessor-*gss-c-nt-machine-uid-name*)
(function).
%var-accessor-*gss-c-nt-string-uid-name*
(function).
(setf %var-accessor-*gss-c-nt-string-uid-name*)
(function).
%var-accessor-*gss-c-nt-user-name*
(function).
(setf %var-accessor-*gss-c-nt-user-name*)
(function).
%var-accessor-gss-mech-krb5
(function).
(setf %var-accessor-gss-mech-krb5)
(function).
*gss-c-no-oid*
(special variable).
*gss-c-nt-hostbased-service*
(symbol macro).
*gss-c-nt-machine-uid-name*
(symbol macro).
*gss-c-nt-string-uid-name*
(symbol macro).
*gss-c-nt-user-name*
(symbol macro).
*register-ffi-functions*
(special variable).
array-to-foreign-char-array
(function).
buffer-desc-length
(macro).
buffer-desc-value
(macro).
calling-error-p
(function).
continue-needed-p
(function).
conv-usage-to-foreign
(function).
convert-to-bytes
(function).
error-p
(function).
errors-as-string
(function).
extract-error-message
(function).
generate-mech-list
(function).
get-or-allocate-context
(function).
gss-accept-sec-context
(function).
gss-acquire-cred
(function).
gss-acquire-cred-with-password
(function).
gss-call
(macro).
gss-compare-name
(function).
gss-context-time
(function).
gss-delete-sec-context
(function).
gss-display-name
(function).
gss-display-status
(function).
gss-export-name
(function).
gss-import-name
(function).
gss-indicate-mechs
(function).
gss-init-sec-context
(function).
gss-inquire-cred
(function).
gss-mech-krb5
(symbol macro).
gss-memory-mixin
(class).
gss-memory-mixin-ptr
(generic reader).
gss-oid-to-str
(function).
gss-release-buffer
(function).
gss-release-cred
(function).
gss-release-name
(function).
gss-release-oid
(function).
gss-release-oid-set
(function).
gss-str-to-oid
(function).
gss-unwrap
(function).
gss-wrap
(function).
make-flags
(function).
make-flags-list
(function).
make-mech
(function).
parse-identifier-to-name
(function).
parse-usage-from-foreign
(function).
raise-error
(function).
routine-error-p
(function).
supplementary-info-p
(function).
token->array
(function).
with-buffer-desc
(macro).
with-foreign-buffer-from-byte-array
(macro).
with-oid-buffer
(macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Accept a security context from a remote client. This function implements the
functionality of the GSSAPI function ‘gss_accept_sec_context’.
Return values are:
CONTINUE-NEEDED - if non-NIL, this value indicates that another message is expected
before the context is ready
CONTEXT - the context that is used to refer to this specific session
NAME - the name of the remote principal
BUFFER - the buffer that should be sent to the remote service, or NIL if there is
no need to send more messages
FLAGS - a list of flags that describe various properties of the session.
possible flags: :DELEG, :MUTUAL, :REPLAY, :SEQUENCE, :CONF, :INTEG, :ANON
TIME-REC - The length of time that the context will be valid.
DELEGATED-CRED-HANDLE - If the FLAGS value contains :DELEG, this value contains
the delegated credentials, an instance of CRED
Acquire a credential handle. This function corresponds to the GSSAPI function ‘gss_acquire_cred’.
Acquire a credential handle. DESIRED-NAME is the name of the
principal and is either a string (in which it’s interpreted as a
service name) or an instance of NAME (created using MAKE-NAME).
PASSWORD is the password that should be used for authenticating the
principal. This function corresponds to the GSSAPI function
‘gss_acquire_cred_with_password’.
Note that this is specified as an extension function in GSSAPI and as such may not be available on all systems.
Compares two name objects. This function returns non-NIL if the two name objects refers to the same entity. This function implements the functionality of the GSSAPI function ‘gss_compare_name’.
Return time that the context will be valid, in seconds.
This function implements the functionality of the GSSAPI function ‘gss_context_time’.
Initialise a GSS security context. This function implements the functionality of
the GSSAPI function ‘gss_init_sec_context’.
This function returns the following values:
CONTINUE-NEEDED - non-NIL if the context needs a reply form the remote
service before it can be used
CONTEXT - the context that is used to refer to this specific session
BUFFER - the buffer that should be sent to the remote service
FLAGS - a list of flags that describe various properties of the session.
possible flags: :DELEG, :MUTUAL, :REPLAY, :SEQUENCE, :CONF, :INTEG, :ANON
Inquire information about a credential. This function returns four values:
NAME - The name of the identity that is asserted by the credential
TIME - The number of seconds that the credential remains valid
USAGE - A value indicating how the credential is used, one of
:INITIATE, :ACCEPT, :BOTH
MECHANISMS - A list of mech OID values describing the mechanisms that are
supported.
Register a server’s identity. FILE is a keytab file containing the credentials to be used.
Create a new name object representing the given name.
The TYPE parameter indicates the requested usage type, its
value is one of :USER-NAME, :MACHINE-UID-NAME, :STRING-UID-NAME,
:HOSTBASED-SERVICE.
This function implements the functionality of the GSSAPI
function ‘gss_import_name’.
Return a list of all suported mechanisms. Each entry is an OID describing each mechanism.
Return the string representation of NAME.
Return a string representation for the given OID.
Convert a string representation of an OID to a byte array.
Convert a wrapped buffer into usable form. CONTEXT is the security context to use, BUFFER is the protected byte array. This function returns the unwrapped buffer, as well as a boolean indicating whether the original message was encrypted.
Wrap a the byte array in BUFFER in a cryptographic wrapper, using the specified CONTEXT. The buffer will be encrypted if CONF is non-NIL. This function returns the encrypted data as a byte array, and a second boolean return value that incidates whether the message was encrypted or not.
Error that is raised when a GSSAPI function returns an error
error
.
Major status
:major
This slot is read-only.
List of major error messages
:major-errors
This slot is read-only.
Minor status
:minor
This slot is read-only.
List of minor error messages
:minor-errors
This slot is read-only.
Wrapper class for instances of gss-ctx-id-t
Wrapper class for instances of gss-cred-t
Wrapper class for instances of gss-name-t
Convert BUFFER to a native byte array, and bind it to SYM and evaluate the body as an implicit progn.
Given a usage keyword, return the corresponding native value.
Given a native usage value, return the corresponding keyword.
gss-memory-mixin
)) ¶The wrapped pointer
ptr
.
Mixin class for types that wraps a pointer that
needs to be released after the instance is no longer referenced. The
actual registration of the object is handled by the subclass.
The wrapped pointer
:ptr
This slot is read-only.
Jump to: | %
(
A B C E F G I K M N O P R S T U W |
---|
Jump to: | %
(
A B C E F G I K M N O P R S T U W |
---|
Jump to: | *
G M P S |
---|
Jump to: | *
G M P S |
---|
Jump to: | C F G M N P S |
---|
Jump to: | C F G M N P S |
---|