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