Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

gss_oid_to_str (3gss)

Name

gss_oid_to_str - convert an OID to a string

Synopsis

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

gss_oid_to_str(OM_uint32 *minor_status, const gss_OID oid,
gss_buffer_toid_str);

Description

Generic Security Services API Library Functions           gss_oid_to_str(3gss)



NAME
       gss_oid_to_str - convert an OID to a string

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

       gss_oid_to_str(OM_uint32 *minor_status, const gss_OID oid,
            gss_buffer_toid_str);


PARAMETERS
       minor_status    Status code returned by underlying mechanism.


       oid             GSS-API OID structure to convert.


       oid_str         String to receive converted OID.


DESCRIPTION
       The  gss_oid_to_str()  function  converts  a GSS-API OID structure to a
       string. You can use the function to convert the  name  of  a  mechanism
       from  an  OID  to a simple string. This function is a convenience func-
       tion, as is its complementary function, gss_str_to_oid(3GSS).


       If an OID  must  be  created,  use  gss_create_empty_oid_set(3GSS)  and
       gss_add_oid_set_member(3GSS)  to  create  it.  OIDs created in this way
       must  be  released  with  gss_release_oid_set(3GSS).  However,  it   is
       strongly  suggested that applications use the default GSS-API mechanism
       instead of creating an OID for a specific mechanism.

ERRORS
       The gss_oid_to_str() function  returns  one  of  the  following  status
       codes:

       GSS_S_CALL_INACCESSIBLE_READ

           A required input parameter could not be read.


       GSS_S_CALL_INACCESSIBLE_WRITE

           A required output parameter could not be written.


       GSS_S_COMPLETE

           Successful completion.


       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_add_oid_set_member(3GSS),           gss_create_empty_oid_set(3GSS),
       gss_release_oid_set(3GSS), gss_str_to_oid(3GSS), attributes(7)


WARNINGS
       This  function  is  included for compatibility only with programs using
       earlier versions of the GSS-API and should not be  used  for  new  pro-
       grams.  Other  implementations  of  the  GSS-API might not support this
       function, so portable programs should not rely on  it.  Sun  might  not
       continue to support this function.



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_oid_to_str(3gss)