lib/libgssapi/gss_import_sec_context.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_IMPORT_SEC_CONTEXT 3 PRM
  32 .Os
  33 .Sh NAME
  34 .Nm gss_import_sec_context
  35 .Nd Import a transferred context
  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_import_sec_context
  42 .Fa "OM_uint32 *minor_status"
  43 .Fa "const gss_buffer_t interprocess_token"
  44 .Fa "gss_ctx_id_t *context_handle"
  45 .Fc
  46 .Sh DESCRIPTION
  47 Allows a process to import a security context established by another
  48 process.
  49 A given interprocess token may be imported only once.
  50 See
  51 .Fn gss_export_sec_context .
  52 .Sh PARAMETERS
  53 .Bl -tag -width ".It interprocess_token"
  54 .It minor_status
  55 Mechanism specific status code.
  56 .It interprocess_token
  57 Token received from exporting process.
  58 .It context_handle
  59 Context handle of newly reactivated context.
  60 Resources associated with this context handle must be released by the
  61 application after use with a call to
  62 .Fn gss_delete_sec_context .
  63 .El
  64 .Sh RETURN VALUES
  65 .Bl -tag -width ".It GSS_S_DEFECTIVE_TOKEN"
  66 .It GSS_S_COMPLETE
  67 Successful completion
  68 .It GSS_S_NO_CONTEXT
  69 The token did not contain a valid context reference
  70 .It GSS_S_DEFECTIVE_TOKEN
  71 The token was invalid
  72 .It GSS_S_UNAVAILABLE
  73 The operation is unavailable
  74 .It GSS_S_UNAUTHORIZED
  75 Local policy prevents the import of this context by the current process
  76 .El
  77 .Sh SEE ALSO
  78 .Xr gss_export_sec_context 3 ,
  79 .Xr gss_delete_sec_context 3
  80 .Sh STANDARDS
  81 .Bl -tag -width ".It RFC 2743"
  82 .It RFC 2743
  83 Generic Security Service Application Program Interface Version 2, Update 1
  84 .It RFC 2744
  85 Generic Security Service API Version 2 : C-bindings
  86 .El
  87 .Sh HISTORY
  88 The
  89 .Nm
  90 function first appeared in
  91 .Fx 7.0 .
  92 .Sh AUTHORS
  93 John Wray, Iris Associates
  94 .Sh COPYRIGHT
  95 Copyright (C) The Internet Society (2000).  All Rights Reserved.
  96 .Pp
  97 This document and translations of it may be copied and furnished to
  98 others, and derivative works that comment on or otherwise explain it
  99 or assist in its implementation may be prepared, copied, published
 100 and distributed, in whole or in part, without restriction of any
 101 kind, provided that the above copyright notice and this paragraph are
 102 included on all such copies and derivative works.  However, this
 103 document itself may not be modified in any way, such as by removing
 104 the copyright notice or references to the Internet Society or other
 105 Internet organizations, except as needed for the purpose of
 106 developing Internet standards in which case the procedures for
 107 copyrights defined in the Internet Standards process must be
 108 followed, or as required to translate it into languages other than
 109 English.
 110 .Pp
 111 The limited permissions granted above are perpetual and will not be
 112 revoked by the Internet Society or its successors or assigns.
 113 .Pp
 114 This document and the information contained herein is provided on an
 115 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
 116 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 117 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
 118 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
 119 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.