Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

gss_canonicalize_name (3gss)

Name

gss_canonicalize_name - convert an internal name to a mechanism name

Synopsis

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

OM_uint32 gss_canonicalize_name(OM_uint32 *minor_status,
const gss_name_t input_name,const gss_OID mech_type,
gss_name_t *output_name);

Description

Generic Security Services API Library Functions
                                                   gss_canonicalize_name(3gss)



NAME
       gss_canonicalize_name - convert an internal name to a mechanism name

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

       OM_uint32 gss_canonicalize_name(OM_uint32 *minor_status,
            const gss_name_t input_name,const gss_OID mech_type,
            gss_name_t *output_name);


DESCRIPTION
       The  gss_canonicalize_name()  function  generates a canonical mechanism
       name from an arbitrary internal name.  The mechanism name is  the  name
       that  would be returned to a context acceptor on successful authentica-
       tion of a context where the initiator used the input_name in a success-
       ful  call  to  gss_acquire_cred(3GSS), specifying an OID set containing
       mech_type as its only member, followed by a call  to  gss_init_sec_con-
       text(3GSS), specifying mech_type as the authentication mechanism.

PARAMETERS
       The parameter descriptions for gss_canonicalize_name() follow:

       minor_status    Mechanism-specific status code.


       input_name      The name for which a canonical form is desired.


       mech_type       The  authentication  mechanism  for which the canonical
                       form of the name is  desired.   The  desired  mechanism
                       must be specified explicitly; no default is provided.


       output_name     The  resultant canonical name.  Storage associated with
                       this name must be freed by the  application  after  use
                       with a call to gss_release_name(3GSS).


ERRORS
       The gss_canonicalize_name() function may return the status codes:

       GSS_S_COMPLETE        Successful completion.


       GSS_S_BAD_MECH        The identified mechanism is not supported.


       GSS_S_BAD_NAMETYPE    The  provided  internal name contains no elements
                             that could be processed by the  specified  mecha-
                             nism.


       GSS_S_BAD_NAME        The provided internal name was ill-formed.


       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.


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_acquire_cred(3GSS),                     gss_init_sec_context(3GSS),
       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_canonicalize_name(3gss)