usr/src/man/man3gss/gss_process_context_token.3gss

   1 '\" te
   2 .\" Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH GSS_PROCESS_CONTEXT_TOKEN 3GSS "Jan 15, 2003"
   7 .SH NAME
   8 gss_process_context_token \- pass asynchronous token to security service
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lgss\fR  [ \fIlibrary\fR... ]
  13 #include <gssapi/gssapi.h>
  14
  15 \fBOM_uint32\fR \fBgss_process_context_token\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
  16      \fBconst gss_ctx_id_t\fR \fIcontext_handle\fR,\fBconst gss_buffer_t\fR \fItoken_buffer\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBgss_process_context_token()\fR function provides a way to pass an
  23 asynchronous token to the security service. Most context-level tokens are
  24 emitted and processed synchronously by \fBgss_init_sec_context()\fR and
  25 \fBgss_accept_sec_context()\fR, and the application is informed as to whether
  26 further tokens are expected by the \fBGSS_C_CONTINUE_NEEDED\fR major status
  27 bit. Occasionally, a mechanism might need to emit a context-level token at a
  28 point when the peer entity is not expecting a token. For example, the
  29 initiator's final call to \fBgss_init_sec_context()\fR may emit a token and
  30 return a status of \fBGSS_S_COMPLETE\fR, but the acceptor's call to
  31 \fBgss_accept_sec_context()\fR might fail. The acceptor's mechanism might want
  32 to send a token containing an error indication to the initiator, but the
  33 initiator is not expecting a token at this point, believing that the context is
  34 fully established. \fBgss_process_context_token()\fR provides a way to pass
  35 such a token to the mechanism at any time.
  36 .sp
  37 .LP
  38 This function is provided for compatibility with the \fBGSS-API\fR version 1.
  39 Because \fBgss_delete_sec_context()\fR no longer returns a valid
  40 \fIoutput_token\fR to be sent to \fBgss_process_context_token()\fR,
  41 applications using a newer version of the \fBGSS-API\fR do not need to rely on
  42 this function.
  43 .SH PARAMETERS
  44 .sp
  45 .LP
  46 The parameter descriptions for \fBgss_process_context_token()\fR are as
  47 follows:
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fIminor_status\fR\fR
  52 .ad
  53 .RS 18n
  54 A mechanism-specific status code.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fIcontext_handle\fR\fR
  61 .ad
  62 .RS 18n
  63 Context handle of context on which token is to be processed.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fItoken_buffer\fR\fR
  70 .ad
  71 .RS 18n
  72 Token to process.
  73 .RE
  74
  75 .SH ERRORS
  76 .sp
  77 .LP
  78 \fBgss_process_context_token()\fR returns one of the following status codes:
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBGSS_S_COMPLETE\fR\fR
  83 .ad
  84 .RS 25n
  85 Successful completion.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBGSS_S_DEFECTIVE_TOKEN\fR\fR
  92 .ad
  93 .RS 25n
  94 Indicates that consistency checks performed on the token failed.
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fBGSS_S_NO_CONTEXT\fR\fR
 101 .ad
 102 .RS 25n
 103 The \fIcontext_handle\fR did not refer to a valid context.
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBGSS_S_FAILURE\fR\fR
 110 .ad
 111 .RS 25n
 112 The underlying mechanism detected an error for which no specific \fBGSS\fR
 113 status code is defined.  The mechanism-specific status code reported by means
 114 of the \fIminor_status\fR parameter details the error condition.
 115 .RE
 116
 117 .SH ATTRIBUTES
 118 .sp
 119 .LP
 120 See \fBattributes\fR(5) for descriptions of the following attributes:
 121 .sp
 122
 123 .sp
 124 .TS
 125 box;
 126 c | c
 127 l | l .
 128 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 129 _
 130 MT Level        Safe
 131 .TE
 132
 133 .SH SEE ALSO
 134 .sp
 135 .LP
 136 \fBgss_accept_sec_context\fR(3GSS), \fBgss_delete_sec_context\fR(3GSS),
 137 \fBgss_init_sec_context\fR(3GSS), \fBattributes\fR(5)
 138 .sp
 139 .LP
 140 \fISolaris Security for Developers Guide\fR