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 .\" Copyright (C) The Internet Society (2000).  All Rights Reserved.
  30 .\"
  31 .\" This document and translations of it may be copied and furnished to
  32 .\" others, and derivative works that comment on or otherwise explain it
  33 .\" or assist in its implementation may be prepared, copied, published
  34 .\" and distributed, in whole or in part, without restriction of any
  35 .\" kind, provided that the above copyright notice and this paragraph are
  36 .\" included on all such copies and derivative works.  However, this
  37 .\" document itself may not be modified in any way, such as by removing
  38 .\" the copyright notice or references to the Internet Society or other
  39 .\" Internet organizations, except as needed for the purpose of
  40 .\" developing Internet standards in which case the procedures for
  41 .\" copyrights defined in the Internet Standards process must be
  42 .\" followed, or as required to translate it into languages other than
  43 .\" English.
  44 .\"
  45 .\" The limited permissions granted above are perpetual and will not be
  46 .\" revoked by the Internet Society or its successors or assigns.
  47 .\"
  48 .\" This document and the information contained herein is provided on an
  49 .\" "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
  50 .\" TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
  51 .\" BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
  52 .\" HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
  53 .\" MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  54 .\"
  55 .\" The following commands are required for all man pages.
  56 .Dd November 12, 2005
  57 .Os
  58 .Dt GSS_PROCESS_CONTEXT_TOKEN 3 PRM
  59 .Sh NAME
  60 .Nm gss_process_context_token
  61 .Nd Process a token on a security context from a peer application
  62 .\" This next command is for sections 2 and 3 only.
  63 .\" .Sh LIBRARY
  64 .Sh SYNOPSIS
  65 .In "gssapi/gssapi.h"
  66 .Ft OM_uint32
  67 .Fo gss_process_context_token
  68 .Fa "OM_uint32 *minor_status"
  69 .Fa "const gss_ctx_id_t context_handle"
  70 .Fa "const gss_buffer_t token_buffer"
  71 .Fc
  72 .Sh DESCRIPTION
  73 Provides a way to pass an asynchronous token to the security service.
  74 Most context-level tokens are emitted and processed synchronously by
  75 .Fn gss_init_sec_context
  76 and
  77 .Fn gss_accept_sec_context ,
  78 and the application is informed as to whether further tokens are
  79 expected by the
  80 .Dv GSS_C_CONTINUE_NEEDED
  81 major status bit.
  82 Occasionally,
  83 a mechanism may need to emit a context-level token at a point when the
  84 peer entity is not expecting a token.
  85 For example,
  86 the initiator's final call to
  87 .Fn gss_init_sec_context
  88 may emit a token and return a status of
  89 .Dv GSS_S_COMPLETE ,
  90 but the acceptor's call to
  91 .Fn gss_accept_sec_context
  92 may fail.
  93 The acceptor's mechanism may wish to send a token containing an error
  94 indication to the initiator,
  95 but the initiator is not expecting a token at this point,
  96 believing that the context is fully established.
  97 .Fn gss_process_context_token
  98 provides a way to pass such a token to the mechanism at any time.
  99 .Sh PARAMETERS
 100 .Bl -tag
 101 .It minor_status
 102 Mechanism specific status code.
 103 .It context_handle
 104 Context handle of context on which token is to be processed.
 105 .It token_buffer
 106 Token to process.
 107 .El
 108 .Sh RETURN VALUES
 109 .Bl -tag
 110 .It GSS_S_COMPLETE
 111 Successful completion
 112 .It GSS_S_DEFECTIVE_TOKEN
 113 Indicates that consistency checks performed on the token failed
 114 .It GSS_S_NO_CONTEXT
 115 The
 116 .Fa context_handle
 117 did not refer to a valid context
 118 .El
 119 .Sh SEE ALSO
 120 .Xr gss_init_sec_context 3 ,
 121 .Xr gss_accept_sec_context 3
 122 .Sh STANDARDS
 123 .Bl -tag
 124 .It RFC 2743
 125 Generic Security Service Application Program Interface Version 2, Update 1
 126 .It RFC 2744
 127 Generic Security Service API Version 2 : C-bindings
 128 .\" .Sh HISTORY
 129 .El
 130 .Sh HISTORY
 131 The
 132 .Nm
 133 manual page example first appeared in
 134 .Fx 7.0 .
 135 .Sh AUTHORS
 136 John Wray, Iris Associates