xref: /freebsd/lib/libgssapi/gss_import_sec_context.3 (revision c0b9f4fe659b6839541970eb5675e57f4d814969)
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_IMPORT_SEC_CONTEXT 3 PRM
59.Sh NAME
60.Nm gss_import_sec_context
61.Nd Import a transferred context
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_import_sec_context
68.Fa "OM_uint32 *minor_status"
69.Fa "const gss_buffer_t interprocess_token"
70.Fa "gss_ctx_id_t *context_handle"
71.Fc
72.Sh DESCRIPTION
73Allows a process to import a security context established by another
74process.
75A given interprocess token may be imported only once.
76See
77.Fn gss_export_sec_context .
78.Sh PARAMETERS
79.Bl -tag
80.It minor_status
81Mechanism specific status code.
82.It interprocess_token
83Token received from exporting process.
84.It context_handle
85Context handle of newly reactivated context.
86Resources associated with this context handle must be released by the
87application after use with a call to
88.Fn gss_delete_sec_context .
89.El
90.Sh RETURN VALUES
91.Bl -tag
92.It GSS_S_COMPLETE
93Successful completion
94.It GSS_S_NO_CONTEXT
95The token did not contain a valid context reference
96.It GSS_S_DEFECTIVE_TOKEN
97The token was invalid
98.It GSS_S_UNAVAILABLE
99The operation is unavailable
100.It GSS_S_UNAUTHORIZED
101Local policy prevents the import of this context by the current process
102.El
103.Sh SEE ALSO
104.Xr gss_export_sec_context 3 ,
105.Xr gss_delete_sec_context 3
106.Sh STANDARDS
107.Bl -tag
108.It RFC 2743
109Generic Security Service Application Program Interface Version 2, Update 1
110.It RFC 2744
111Generic Security Service API Version 2 : C-bindings
112.\" .Sh HISTORY
113.El
114.Sh HISTORY
115The
116.Nm
117manual page example first appeared in
118.Fx 7.0 .
119.Sh AUTHORS
120John Wray, Iris Associates
121