man pages section 3: Networking Library Functions

gss_inquire_cred_by_mech(3GSS)

Name

gss_inquire_cred_by_mech– obtain per-mechanism information about a credential

Synopsis

cc [ flag... ] file... -lgss  [ library... ] 
#include <gssapi/gssapi.h>

OM_uint32 gss_inquire_cred_by_mech(OM_uint32 *minor_status,
     const gss_cred_id_t cred_handle,const gss_OID mech_type,
     gss_name_t *name, OM_uint32 *initiator_lifetime,
     OM_uint32 *acceptor_lifetime, gss_cred_usage_t *cred_usage);

Parameters

acceptor_lifetime: The number of seconds that the credential is capable of accepting security contexts under the specified mechanism. If the credential can no longer be used to accept contexts, or if the credential usage for this mechanism is GSS_C_INITIATE, this parameter will be set to 0. Specify NULL if this parameter is not required.
cred_handle: A handle that refers to the target credential. Specify GSS_C_NO_CREDENTIAL to inquire about the default initiator principal.
cred_usage: How the credential may be used with the specified mechanism. The cred_usage parameter may contain one of the following values: GSS_C_INITIATE, GSS_C_ACCEPT, or GSS_C_BOTH. Specify NULL if this parameter is not required.
initiator_lifetime: The number of seconds that the credential is capable of initiating security contexts under the specified mechanism. If the credential can no longer be used to initiate contexts, or if the credential usage for this mechanism is GSS_C_ACCEPT, this parameter will be set to 0. Specify NULL if this parameter is not required.
mech_type: The mechanism for which the information should be returned.
minor_status: A mechanism specific status code.
name: The name whose identity the credential asserts. Any storage associated with this name must be freed by the application after use by a call to gss_release_name(3GSS).

Description

The gss_inquire_cred_by_mech() function obtains per-mechanism information about a credential.

Errors

The gss_inquire_cred_by_mech() function can return the following status codes:

GSS_S_COMPLETE: Successful completion.
GSS_S_CREDENTIALS_EXPIRED: The credentials cannot be added because they have expired.
GSS_S_DEFECTIVE_CREDENTIAL: The referenced credentials are invalid.
GSS_S_FAILURE: The underlying mechanism detected an error for which no specific GSS status code is defined. The mechanism-specific status code reported by means of the minor_status parameter details the error condition.
GSS_S_NO_CRED: The referenced credentials cannot be accessed.
GSS_S_UNAVAILABLE: The gss_inquire_cred_by_mech() function is not available for the specified mechanism type.

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWgss (32–bit)
	SUNWgssx (64–bit)
MT-Level	Safe