Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

gss_display_name (3gss)

Name

gss_display_name - form name to text

Synopsis

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

OM_uint32 gss_display_name(OM_uint32 *minor_status,
const gss_name_t input_name, gss_buffer_t output_name_buffer,
gss_OID *output_name_type);

Description

Generic Security Services API Library Functions         gss_display_name(3gss)



NAME
       gss_display_name - convert internal-form name to text

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

       OM_uint32 gss_display_name(OM_uint32 *minor_status,
            const gss_name_t input_name, gss_buffer_t output_name_buffer,
            gss_OID *output_name_type);


DESCRIPTION
       The  gss_display_name() function allows an application to obtain a tex-
       tual representation of an opaque internal-form  name for  display  pur-
       poses.


       If  input_name  denotes an anonymous principal, the GSS-API returns the
       gss_OID value GSS_C_NT_ANONYMOUS as the output_name_type, and a textual
       name  that is syntactically distinct from all valid supported printable
       names in output_name_buffer.


       If input_name was created by a call to gss_import_name(3GSS),  specify-
       ing  GSS_C_NO_OID as the name-type, the GSS-API returns GSS_C_NO_OID by
       means of the output_name_type parameter.

PARAMETERS
       The parameter descriptions for gss_display_name() follow:

       minor_status          Mechanism-specific status code.


       input_name            Name in internal form.


       output_name_buffer    Buffer to receive textual name string. The appli-
                             cation  must  free  storage  associated with this
                             name after use with a  call  to  gss_release_buf-
                             fer(3GSS).


       output_name_type      The  type  of  the  returned  name.  The returned
                             gss_OID will be a pointer into static storage and
                             should  be treated as read-only by the caller. In
                             particular, the application should not attempt to
                             free  it.  Specify  NULL if this parameter is not
                             required.


ERRORS
       The gss_display_name() function may return the following status codes:

       GSS_S_COMPLETE    Successful completion.


       GSS_S_BAD_NAME    The input_name was ill-formed.


       GSS_S_FAILURE     The underlying mechanism detected an error for  which
                         no  specific  GSS status code is defined.  The mecha-
                         nism-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_import_name(3GSS), gss_release_buffer(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_display_name(3gss)