Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

gss_inquire_cred_by_mech (3gss)

Name

gss_inquire_cred_by_mech - 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);

Description

Generic Security Services API 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 cre-
                             dential usage for this mechanism is  GSS_C_INITI-
                             ATE,  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  informa-
       tion 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 mecha-
                                     nism type.


ATTRIBUTES
       See attributes(7)  for descriptions of the following attributes:




       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE         |      ATTRIBUTE VALUE        |
       +-----------------------------+-----------------------------+
       |MT-Level                     |Safe                         |
       +-----------------------------+-----------------------------+


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------------+
       |ATTRIBUTE TYPE |    ATTRIBUTE VALUE     |
       +---------------+------------------------+
       |Availability   | security/kerberos-5    |
       +---------------+------------------------+
       |Stability      | Pass-through committed |
       +---------------+------------------------+

SEE ALSO
       gss_release_name(3GSS), attributes(7)


NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source      was      downloaded      from       http://web.mit.edu/ker-
       beros/dist/krb5/1.18/krb5-1.18.4.tar.gz.

       Further information about this software can be found on the open source
       community website at http://web.mit.edu/kerberos/.



Solaris 11.4                      22 Aug 2011
                                                gss_inquire_cred_by_mech(3gss)