gss_inquire_cred_by_mech(3)

API function

Section 3 gss-man bookworm source

Description

gss_inquire_cred_by_mech

NAME

gss_inquire_cred_by_mech - API function

SYNOPSIS

#include <gss.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);

ARGUMENTS

OM_uint32 * minor_status

(Integer, modify) Mechanism specific status code.

const gss_cred_id_t cred_handle

(gss_cred_id_t, read) A handle that refers to the
target credential. Specify GSS_C_NO_CREDENTIAL to inquire about
the default initiator principal.

const gss_OID mech_type

(gss_OID, read) The mechanism for which information
should be returned.

gss_name_t * name

(gss_name_t, modify, optional) The name whose identity the
credential asserts. Storage associated with this name must be
freed by the application after use with a call to
gss_release_name(). Specify NULL if not required.

OM_uint32 * initiator_lifetime

(Integer, modify, optional) The number of
seconds for which the credential will remain 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 zero. If the implementation does not
support expiration of initiator credentials, the value
GSS_C_INDEFINITE will be returned. Specify NULL if not required.

OM_uint32 * acceptor_lifetime

(Integer, modify, optional) The number of
seconds for which the credential will remain 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 zero. If the implementation does not
support expiration of acceptor credentials, the value
GSS_C_INDEFINITE will be returned. Specify NULL if not required.

gss_cred_usage_t * cred_usage

(gss_cred_usage_t, modify, optional) How the
credential may be used with the specified mechanism. One of the
following: GSS_C_INITIATE, GSS_C_ACCEPT, GSS_C_BOTH. Specify NULL
if not required.

DESCRIPTION

Obtains per-mechanism information about a credential.

RETURN VALUE

‘GSS_S_COMPLETE‘: Successful completion.

‘GSS_S_NO_CRED‘: The referenced credentials could not be accessed.

‘GSS_S_DEFECTIVE_CREDENTIAL‘: The referenced credentials were invalid.

‘GSS_S_CREDENTIALS_EXPIRED‘: The referenced credentials have expired. If the lifetime parameter was not passed as NULL, it will be set to 0.

REPORTING BUGS

Report bugs to <bug-gss@gnu.org>. GNU Generic Security Service home page: http://www.gnu.org/software/gss/ General help using GNU software: http://www.gnu.org/gethelp/

COPYRIGHT

Copyright © 2003-2022 Simon Josefsson.
Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved.