Initial revision
git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@17692 ec53bebd-3082-4978-b11e-865c3cabbd6b
This commit is contained in:
136
lib/gssapi/mech/gss_process_context_token.3
Normal file
136
lib/gssapi/mech/gss_process_context_token.3
Normal file
@@ -0,0 +1,136 @@
|
||||
.\" -*- nroff -*-
|
||||
.\"
|
||||
.\" Copyright (c) 2005 Doug Rabson
|
||||
.\" All rights reserved.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\" $FreeBSD: src/lib/libgssapi/gss_process_context_token.3,v 1.2 2006/01/25 10:06:28 dfr Exp $
|
||||
.\"
|
||||
.\" The following commands are required for all man pages.
|
||||
.Dd November 12, 2005
|
||||
.Os
|
||||
.Dt GSS_PROCESS_CONTEXT_TOKEN 3 PRM
|
||||
.Sh NAME
|
||||
.Nm gss_process_context_token
|
||||
.Nd Process a token on a security context from a peer application
|
||||
.\" This next command is for sections 2 and 3 only.
|
||||
.\" .Sh LIBRARY
|
||||
.Sh SYNOPSIS
|
||||
.In "gssapi/gssapi.h"
|
||||
.Ft OM_uint32
|
||||
.Fo gss_process_context_token
|
||||
.Fa "OM_uint32 *minor_status"
|
||||
.Fa "const gss_ctx_id_t context_handle"
|
||||
.Fa "const gss_buffer_t token_buffer"
|
||||
.Fc
|
||||
.Sh DESCRIPTION
|
||||
Provides a way to pass an asynchronous token to the security service.
|
||||
Most context-level tokens are emitted and processed synchronously by
|
||||
.Fn gss_init_sec_context
|
||||
and
|
||||
.Fn gss_accept_sec_context ,
|
||||
and the application is informed as to whether further tokens are
|
||||
expected by the
|
||||
.Dv GSS_C_CONTINUE_NEEDED
|
||||
major status bit.
|
||||
Occasionally,
|
||||
a mechanism may need to emit a context-level token at a point when the
|
||||
peer entity is not expecting a token.
|
||||
For example,
|
||||
the initiator's final call to
|
||||
.Fn gss_init_sec_context
|
||||
may emit a token and return a status of
|
||||
.Dv GSS_S_COMPLETE ,
|
||||
but the acceptor's call to
|
||||
.Fn gss_accept_sec_context
|
||||
may fail.
|
||||
The acceptor's mechanism may wish to send a token containing an error
|
||||
indication to the initiator,
|
||||
but the initiator is not expecting a token at this point,
|
||||
believing that the context is fully established.
|
||||
.Fn gss_process_context_token
|
||||
provides a way to pass such a token to the mechanism at any time.
|
||||
.Sh PARAMETERS
|
||||
.Bl -tag
|
||||
.It minor_status
|
||||
Mechanism specific status code.
|
||||
.It context_handle
|
||||
Context handle of context on which token is to be processed.
|
||||
.It token_buffer
|
||||
Token to process.
|
||||
.El
|
||||
.Sh RETURN VALUES
|
||||
.Bl -tag
|
||||
.It GSS_S_COMPLETE
|
||||
Successful completion
|
||||
.It GSS_S_DEFECTIVE_TOKEN
|
||||
Indicates that consistency checks performed on the token failed
|
||||
.It GSS_S_NO_CONTEXT
|
||||
The
|
||||
.Fa context_handle
|
||||
did not refer to a valid context
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr gss_init_sec_context 3 ,
|
||||
.Xr gss_accept_sec_context 3
|
||||
.Sh STANDARDS
|
||||
.Bl -tag
|
||||
.It RFC 2743
|
||||
Generic Security Service Application Program Interface Version 2, Update 1
|
||||
.It RFC 2744
|
||||
Generic Security Service API Version 2 : C-bindings
|
||||
.\" .Sh HISTORY
|
||||
.El
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
manual page example first appeared in
|
||||
.Fx 7.0 .
|
||||
.Sh AUTHORS
|
||||
John Wray, Iris Associates
|
||||
.Sh COPYRIGHT
|
||||
Copyright (C) The Internet Society (2000). All Rights Reserved.
|
||||
.Pp
|
||||
This document and translations of it may be copied and furnished to
|
||||
others, and derivative works that comment on or otherwise explain it
|
||||
or assist in its implementation may be prepared, copied, published
|
||||
and distributed, in whole or in part, without restriction of any
|
||||
kind, provided that the above copyright notice and this paragraph are
|
||||
included on all such copies and derivative works. However, this
|
||||
document itself may not be modified in any way, such as by removing
|
||||
the copyright notice or references to the Internet Society or other
|
||||
Internet organizations, except as needed for the purpose of
|
||||
developing Internet standards in which case the procedures for
|
||||
copyrights defined in the Internet Standards process must be
|
||||
followed, or as required to translate it into languages other than
|
||||
English.
|
||||
.Pp
|
||||
The limited permissions granted above are perpetual and will not be
|
||||
revoked by the Internet Society or its successors or assigns.
|
||||
.Pp
|
||||
This document and the information contained herein is provided on an
|
||||
"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
|
||||
TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
|
||||
BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
|
||||
HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
|
Reference in New Issue
Block a user