Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

gss_delete_sec_context (3gss)

Name

gss_delete_sec_context - API security context

Synopsis

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

OM_uint32 gss_delete_sec_context(OM_uint32 *minor_status,
gss_ctx_id_t *context_handle,gss_buffer_t output_token);

Description

Generic Security Services API Library Functions
                                                  gss_delete_sec_context(3gss)



NAME
       gss_delete_sec_context - delete a GSS-API security context

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

       OM_uint32 gss_delete_sec_context(OM_uint32 *minor_status,
            gss_ctx_id_t *context_handle,gss_buffer_t output_token);


DESCRIPTION
       Use the gss_delete_sec_context() function to delete a security context.
       The gss_delete_sec_context() function will delete the local data struc-
       tures  associated  with  the  specified  security context.  You may not
       obtain further security services that use the context specified by con-
       text_handle.


       In    addition    to    deleting    established    security   contexts,
       gss_delete_sec_context() will delete any half-built  security  contexts
       that  result  from  incomplete  sequences of calls to gss_init_sec_con-
       text(3GSS) and  gss_accept_sec_context(3GSS).


       The Solaris implementation of  the  GSS-API  retains  the  output_token
       parameter  for  compatibility with version 1 of the GSS-API.  Both peer
       applications should invoke gss_delete_sec_context(), passing the  value
       GSS_C_NO_BUFFER  to  the output_token parameter; this indicates that no
       token is required.   If  the  application  passes  a  valid  buffer  to
       gss_delete_sec_context(),  it will return a zero-length token, indicat-
       ing that no token should be transferred by the application.

PARAMETERS
       The parameter descriptions for gss_delete_sec_context() follow:

       minor_status      A mechanism specific status code.


       context_handle    Context  handle  identifying  specific   context   to
                         delete.  After deleting the context, the GSS-API will
                         set context_handle to  GSS_C_NO_CONTEXT.


       output_token      A token  to  be  sent  to  remote  applications  that
                         instructs them to delete the context.


ERRORS
       gss_delete_sec_context() may return the following status codes:

       GSS_S_COMPLETE      Successful completion.


       GSS_S_NO_CONTEXT    No valid context was supplied.


       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 condi-
                           tion.


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_accept_sec_context(3GSS), gss_init_sec_context(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_delete_sec_context(3gss)