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