lib/libgssapi/gss_process_context_token.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 2005 Doug Rabson
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\"     $FreeBSD$
  28 .\"
  29 .\" The following commands are required for all man pages.
  30 .Dd January 26, 2010
  31 .Dt GSS_PROCESS_CONTEXT_TOKEN 3 PRM
  32 .Os
  33 .Sh NAME
  34 .Nm gss_process_context_token
  35 .Nd Process a token on a security context from a peer application
  36 .\" This next command is for sections 2 and 3 only.
  37 .\" .Sh LIBRARY
  38 .Sh SYNOPSIS
  39 .In "gssapi/gssapi.h"
  40 .Ft OM_uint32
  41 .Fo gss_process_context_token
  42 .Fa "OM_uint32 *minor_status"
  43 .Fa "const gss_ctx_id_t context_handle"
  44 .Fa "const gss_buffer_t token_buffer"
  45 .Fc
  46 .Sh DESCRIPTION
  47 Provides a way to pass an asynchronous token to the security service.
  48 Most context-level tokens are emitted and processed synchronously by
  49 .Fn gss_init_sec_context
  50 and
  51 .Fn gss_accept_sec_context ,
  52 and the application is informed as to whether further tokens are
  53 expected by the
  54 .Dv GSS_C_CONTINUE_NEEDED
  55 major status bit.
  56 Occasionally,
  57 a mechanism may need to emit a context-level token at a point when the
  58 peer entity is not expecting a token.
  59 For example,
  60 the initiator's final call to
  61 .Fn gss_init_sec_context
  62 may emit a token and return a status of
  63 .Dv GSS_S_COMPLETE ,
  64 but the acceptor's call to
  65 .Fn gss_accept_sec_context
  66 may fail.
  67 The acceptor's mechanism may wish to send a token containing an error
  68 indication to the initiator,
  69 but the initiator is not expecting a token at this point,
  70 believing that the context is fully established.
  71 .Fn gss_process_context_token
  72 provides a way to pass such a token to the mechanism at any time.
  73 .Sh PARAMETERS
  74 .Bl -tag -width ".It context_handle"
  75 .It minor_status
  76 Mechanism specific status code.
  77 .It context_handle
  78 Context handle of context on which token is to be processed.
  79 .It token_buffer
  80 Token to process.
  81 .El
  82 .Sh RETURN VALUES
  83 .Bl -tag -width ".It GSS_S_DEFECTIVE_TOKEN"
  84 .It GSS_S_COMPLETE
  85 Successful completion
  86 .It GSS_S_DEFECTIVE_TOKEN
  87 Indicates that consistency checks performed on the token failed
  88 .It GSS_S_NO_CONTEXT
  89 The
  90 .Fa context_handle
  91 did not refer to a valid context
  92 .El
  93 .Sh SEE ALSO
  94 .Xr gss_init_sec_context 3 ,
  95 .Xr gss_accept_sec_context 3
  96 .Sh STANDARDS
  97 .Bl -tag -width ".It RFC 2743"
  98 .It RFC 2743
  99 Generic Security Service Application Program Interface Version 2, Update 1
 100 .It RFC 2744
 101 Generic Security Service API Version 2 : C-bindings
 102 .El
 103 .Sh HISTORY
 104 The
 105 .Nm
 106 function first appeared in
 107 .Fx 7.0 .
 108 .Sh AUTHORS
 109 John Wray, Iris Associates
 110 .Sh COPYRIGHT
 111 Copyright (C) The Internet Society (2000).  All Rights Reserved.
 112 .Pp
 113 This document and translations of it may be copied and furnished to
 114 others, and derivative works that comment on or otherwise explain it
 115 or assist in its implementation may be prepared, copied, published
 116 and distributed, in whole or in part, without restriction of any
 117 kind, provided that the above copyright notice and this paragraph are
 118 included on all such copies and derivative works.  However, this
 119 document itself may not be modified in any way, such as by removing
 120 the copyright notice or references to the Internet Society or other
 121 Internet organizations, except as needed for the purpose of
 122 developing Internet standards in which case the procedures for
 123 copyrights defined in the Internet Standards process must be
 124 followed, or as required to translate it into languages other than
 125 English.
 126 .Pp
 127 The limited permissions granted above are perpetual and will not be
 128 revoked by the Internet Society or its successors or assigns.
 129 .Pp
 130 This document and the information contained herein is provided on an
 131 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
 132 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 133 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
 134 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
 135 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.