The cl-gss Reference Manual

4.1.1 cl-gss/cl-gss.asd

Source

cl-gss.asd.

Parent Component

cl-gss (system).

ASDF Systems

cl-gss.

Packages

cl-gss-system.

---

4.1.2 cl-gss/src/package.lisp

Source

cl-gss.asd.

Parent Component

src (module).

Packages

cl-gss.

---

4.1.3 cl-gss/src/gss-grovel.lisp

Dependency

package.lisp (file).

Source

cl-gss.asd.

Parent Component

src (module).

---

4.1.4 cl-gss/src/gss-mech-krb5-grovel.lisp

Dependency

gss-grovel.lisp (file).

Source

cl-gss.asd.

Parent Component

src (module).

---

4.1.5 cl-gss/src/functions.lisp

Dependency

gss-mech-krb5-grovel.lisp (file).

Source

cl-gss.asd.

Parent Component

src (module).

Internals

• %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).

---

4.1.6 cl-gss/src/functions-mech-krb5.lisp

Dependency

functions.lisp (file).

Source

cl-gss.asd.

Parent Component

src (module).

Internals

• %krb5-register-acceptor-identity (function).
• %var-accessor-gss-mech-krb5 (function).
• (setf %var-accessor-gss-mech-krb5) (function).
• gss-mech-krb5 (symbol macro).

---

4.1.7 cl-gss/src/conditions.lisp

Dependency

functions-mech-krb5.lisp (file).

Source

cl-gss.asd.

Parent Component

src (module).

Public Interface

• 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).

Internals

• 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).

---

4.1.8 cl-gss/src/cl-gss.lisp

Dependency

conditions.lisp (file).

Source

cl-gss.asd.

Parent Component

src (module).

Public Interface

• 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).

Internals

• *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).

---

4.1.9 cl-gss/src/cl-gss-ext.lisp

Dependency

cl-gss.lisp (file).

Source

cl-gss.asd.

Parent Component

src (module).

Public Interface

• acquire-cred (function).
• acquire-cred-password (function).
• inquire-cred (function).
• mech-list (function).
• oid-to-string (function).
• string-to-oid (function).

Internals

• conv-usage-to-foreign (function).
• generate-mech-list (function).
• make-mech (function).
• parse-usage-from-foreign (function).
• with-oid-buffer (macro).

---

6.1.1 Ordinary functions

Function: accept-sec (buffer &key context cred) ¶

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

Package

cl-gss.

Source

cl-gss.lisp.

Function: acquire-cred (desired-name &key time-req usage) ¶

Acquire a credential handle. This function corresponds to the GSSAPI function ‘gss_acquire_cred’.

Package

cl-gss.

Source

cl-gss-ext.lisp.

Function: acquire-cred-password (desired-name password &key time-req usage) ¶

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.

Package

cl-gss.

Source

cl-gss-ext.lisp.

Function: compare-name (name1 name2) ¶

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’.

Package

cl-gss.

Source

cl-gss.lisp.

Function: context-time (context) ¶

Return time that the context will be valid, in seconds.
This function implements the functionality of the GSSAPI function ‘gss_context_time’.

Package

cl-gss.

Source

cl-gss.lisp.

Function: init-sec (target &key flags time-req context input-token cred) ¶

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

Package

cl-gss.

Source

cl-gss.lisp.

Function: inquire-cred (cred) ¶

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.

Package

cl-gss.

Source

cl-gss-ext.lisp.

Function: krb5-register-acceptor-identity (file) ¶

Register a server’s identity. FILE is a keytab file containing the credentials to be used.

Package

cl-gss.

Source

cl-gss.lisp.

Function: make-name (name-string &key type) ¶

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’.

Package

cl-gss.

Source

cl-gss.lisp.

Function: mech-list () ¶

Return a list of all suported mechanisms. Each entry is an OID describing each mechanism.

Package

cl-gss.

Source

cl-gss-ext.lisp.

Function: name-to-string (name) ¶

Return the string representation of NAME.

Package

cl-gss.

Source

cl-gss.lisp.

Function: oid-to-string (oid) ¶

Return a string representation for the given OID.

Package

cl-gss.

Source

cl-gss-ext.lisp.

Function: string-to-oid (string) ¶

Convert a string representation of an OID to a byte array.

Package

cl-gss.

Source

cl-gss-ext.lisp.

Function: unwrap (context buffer) ¶

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.

Package

cl-gss.

Source

cl-gss.lisp.

Function: wrap (context buffer &key conf) ¶

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.

Package

cl-gss.

Source

cl-gss.lisp.

---

6.1.2 Generic functions

Generic Reader: gss-error-major (condition) ¶

Package

cl-gss.

Methods

Reader Method: gss-error-major ((condition gss-error)) ¶

Source

conditions.lisp.

Target Slot

major.

Generic Reader: gss-error-major-messages (condition) ¶

Package

cl-gss.

Methods

Reader Method: gss-error-major-messages ((condition gss-error)) ¶

Source

conditions.lisp.

Target Slot

major-errors.

Generic Reader: gss-error-minor (condition) ¶

Package

cl-gss.

Methods

Reader Method: gss-error-minor ((condition gss-error)) ¶

Source

conditions.lisp.

Target Slot

minor.

Generic Reader: gss-error-minor-messages (condition) ¶

Package

cl-gss.

Methods

Reader Method: gss-error-minor-messages ((condition gss-error)) ¶

Source

conditions.lisp.

Target Slot

minor-errors.

---

6.1.3 Standalone methods

Method: initialize-instance :after ((obj context) &key &allow-other-keys) ¶

Source

cl-gss.lisp.

Method: initialize-instance :after ((obj name) &key &allow-other-keys) ¶

Source

cl-gss.lisp.

Method: initialize-instance :after ((obj cred) &key &allow-other-keys) ¶

Source

cl-gss.lisp.

---

6.1.4 Conditions

Condition: gss-error ¶

Error that is raised when a GSSAPI function returns an error

Package

cl-gss.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods

• gss-error-major.
• gss-error-major-messages.
• gss-error-minor.
• gss-error-minor-messages.

Direct slots

Slot: major ¶

Major status

Initargs

:major

Readers

gss-error-major.

Writers

This slot is read-only.

Slot: major-errors ¶

List of major error messages

Initargs

:major-errors

Readers

gss-error-major-messages.

Writers

This slot is read-only.

Slot: minor ¶

Minor status

Initargs

:minor

Readers

gss-error-minor.

Writers

This slot is read-only.

Slot: minor-errors ¶

List of minor error messages

Initargs

:minor-errors

Readers

gss-error-minor-messages.

Writers

This slot is read-only.

---

6.1.5 Classes

Class: context ¶

Wrapper class for instances of gss-ctx-id-t

Package

cl-gss.

Source

cl-gss.lisp.

Direct superclasses

gss-memory-mixin.

Direct methods

initialize-instance.

Class: cred ¶

Wrapper class for instances of gss-cred-t

Package

cl-gss.

Source

cl-gss.lisp.

Direct superclasses

gss-memory-mixin.

Direct methods

initialize-instance.

Class: name ¶

Wrapper class for instances of gss-name-t

Package

cl-gss.

Source

cl-gss.lisp.

Direct superclasses

gss-memory-mixin.

Direct methods

initialize-instance.

---

6.2.1 Special variables

Special Variable: *gss-c-no-oid* ¶

Package

cl-gss.

Source

functions.lisp.

Special Variable: *register-ffi-functions* ¶

Package

cl-gss.

Source

cl-gss.lisp.

---

6.2.2 Symbol macros

Symbol Macro: *gss-c-nt-hostbased-service* ¶

Package

cl-gss.

Source

functions.lisp.

Symbol Macro: *gss-c-nt-machine-uid-name* ¶

Package

cl-gss.

Source

functions.lisp.

Symbol Macro: *gss-c-nt-string-uid-name* ¶

Package

cl-gss.

Source

functions.lisp.

Symbol Macro: *gss-c-nt-user-name* ¶

Package

cl-gss.

Source

functions.lisp.

Symbol Macro: gss-mech-krb5 ¶

Package

cl-gss.

Source

functions-mech-krb5.lisp.

---

6.2.3 Macros

Macro: buffer-desc-length (buf) ¶

Package

cl-gss.

Source

functions.lisp.

Macro: buffer-desc-value (buf) ¶

Package

cl-gss.

Source

functions.lisp.

Macro: gss-call (minor-sym form) ¶

Package

cl-gss.

Source

cl-gss.lisp.

Macro: with-buffer-desc ((sym buffer) &body body) ¶

Convert BUFFER to a native byte array, and bind it to SYM and evaluate the body as an implicit progn.

Package

cl-gss.

Source

cl-gss.lisp.

Macro: with-foreign-buffer-from-byte-array ((sym buffer) &body body) ¶

Package

cl-gss.

Source

cl-gss.lisp.

Macro: with-oid-buffer ((sym oid) &body body) ¶

Package

cl-gss.

Source

cl-gss-ext.lisp.

---

6.2.4 Ordinary functions

Function: %krb5-register-acceptor-identity (file) ¶

Package

cl-gss.

Source

functions-mech-krb5.lisp.

Function: %var-accessor-*gss-c-nt-hostbased-service* () ¶

Package

cl-gss.

Source

functions.lisp.

Function: (setf %var-accessor-*gss-c-nt-hostbased-service*) () ¶

Package

cl-gss.

Source

functions.lisp.

Function: %var-accessor-*gss-c-nt-machine-uid-name* () ¶

Package

cl-gss.

Source

functions.lisp.

Function: (setf %var-accessor-*gss-c-nt-machine-uid-name*) () ¶

Package

cl-gss.

Source

functions.lisp.

Function: %var-accessor-*gss-c-nt-string-uid-name* () ¶

Package

cl-gss.

Source

functions.lisp.

Function: (setf %var-accessor-*gss-c-nt-string-uid-name*) () ¶

Package

cl-gss.

Source

functions.lisp.

Function: %var-accessor-*gss-c-nt-user-name* () ¶

Package

cl-gss.

Source

functions.lisp.

Function: (setf %var-accessor-*gss-c-nt-user-name*) () ¶

Package

cl-gss.

Source

functions.lisp.

Function: %var-accessor-gss-mech-krb5 () ¶

Package

cl-gss.

Source

functions-mech-krb5.lisp.

Function: (setf %var-accessor-gss-mech-krb5) () ¶

Package

cl-gss.

Source

functions-mech-krb5.lisp.

Function: array-to-foreign-char-array (array) ¶

Package

cl-gss.

Source

cl-gss.lisp.

Function: calling-error-p (code) ¶

Package

cl-gss.

Source

conditions.lisp.

Function: continue-needed-p (result) ¶

Package

cl-gss.

Source

conditions.lisp.

Function: conv-usage-to-foreign (usage) ¶

Given a usage keyword, return the corresponding native value.

Package

cl-gss.

Source

cl-gss-ext.lisp.

Function: convert-to-bytes (array) ¶

Package

cl-gss.

Source

cl-gss.lisp.

Function: error-p (code) ¶

Package

cl-gss.

Source

conditions.lisp.

Function: errors-as-string (major-status &optional minor-status minor-mech-oid) ¶

Package

cl-gss.

Source

conditions.lisp.

Function: extract-error-message (status status-code-type mech) ¶

Package

cl-gss.

Source

conditions.lisp.

Function: generate-mech-list (mech-set) ¶

Package

cl-gss.

Source

cl-gss-ext.lisp.

Function: get-or-allocate-context (context) ¶

Package

cl-gss.

Source

cl-gss.lisp.

Function: gss-accept-sec-context (minor-status context-handle acceptor-cred-handle input-token-buffer input-chan-bindings src-name mech-type output-token ret-flags time-rec delegated-cred-handle) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-acquire-cred (minor-status desired-name time-req desired-mechs cred-usage output-cred-handle actual-mechs time-rec) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-acquire-cred-with-password (minor-status desired-name password time-req desired-mechs cred-usage output-cred-handle actual-mechs time-rec) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-compare-name (minor-status name1 name2 name-equal) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-context-time (minor-status context-handle time-rec) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-delete-sec-context (minor-status context-handle output-token) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-display-name (minor-status name output-name output-type) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-display-status (minor-status status-value-input status-type mech-type message-context status-string) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-export-name (minor-status name exported) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-import-name (minor-status input-name-buffer input-name-type output-name) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-indicate-mechs (minor-status mech-set) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-init-sec-context (minor-status initiator-cred-handle context-handle target-name mech-type req-flags time_req input-chan-bindings input-token actual-mech-type output-token ret-flags time-rec) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-inquire-cred (minor-status cred-handle name lifetime cred-usage mechs) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-oid-to-str (minor-status oid output-string) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-release-buffer (minor-status buffer) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-release-cred (minor-status cred-handle) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-release-name (minor-status name) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-release-oid (minor-status oid-set) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-release-oid-set (minor-status oid-set) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-str-to-oid (minor-status string result-buffer) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-unwrap (minor-status context-handle input-message-buffer output-message-buffer conf-state qop-state) ¶

Package

cl-gss.

Source

functions.lisp.

Function: gss-wrap (minor-status context-handle conf-req-flag qop-req input-message-buffer conf-state output-message-buffer) ¶

Package

cl-gss.

Source

functions.lisp.

Function: make-flags (flags) ¶

Package

cl-gss.

Source

cl-gss.lisp.

Function: make-flags-list (value) ¶

Package

cl-gss.

Source

cl-gss.lisp.

Function: make-mech (mech-ref) ¶

Package

cl-gss.

Source

cl-gss-ext.lisp.

Function: parse-identifier-to-name (obj) ¶

Package

cl-gss.

Source

cl-gss.lisp.

Function: parse-usage-from-foreign (usage) ¶

Given a native usage value, return the corresponding keyword.

Package

cl-gss.

Source

cl-gss-ext.lisp.

Function: raise-error (major minor minor-mech-oid) ¶

Package

cl-gss.

Source

conditions.lisp.

Function: routine-error-p (code) ¶

Package

cl-gss.

Source

conditions.lisp.

Function: supplementary-info-p (code) ¶

Package

cl-gss.

Source

conditions.lisp.

Function: token->array (token) ¶

Package

cl-gss.

Source

cl-gss.lisp.

---

6.2.5 Generic functions

Generic Reader: gss-memory-mixin-ptr (object) ¶

Package

cl-gss.

Methods

Reader Method: gss-memory-mixin-ptr ((gss-memory-mixin gss-memory-mixin)) ¶

The wrapped pointer

Source

cl-gss.lisp.

Target Slot

ptr.

---

6.2.6 Classes

Class: gss-memory-mixin ¶

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.

Package

cl-gss.

Source

cl-gss.lisp.

Direct subclasses

• context.
• cred.
• name.

Direct methods

gss-memory-mixin-ptr.

Direct slots

Slot: ptr ¶

The wrapped pointer

Initargs

:ptr

Readers

gss-memory-mixin-ptr.

Writers

This slot is read-only.

---