usr/src/man/man3gss/gss_import_sec_context.3gss

   1 '\" te
   2 .\" Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH GSS_IMPORT_SEC_CONTEXT 3GSS "Jan 15, 2003"
   7 .SH NAME
   8 gss_import_sec_context \- import security context established by another
   9 process
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lgss\fR  [ \fIlibrary\fR... ]
  14 #include <gssapi/gssapi.h>
  15
  16 \fBOM_uint32\fR \fBgss_import_sec_context\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
  17      \fBconst gss_buffer_t\fR \fIinterprocess_token\fR,\fBgss_ctx_id_t *\fR\fIcontext_handle\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBgss_import_sec_context()\fR function allows a process to import a
  24 security context established by another process. A given interprocess token can
  25 be imported only once. See \fBgss_export_sec_context\fR(3GSS).
  26 .SH PARAMETERS
  27 .sp
  28 .LP
  29 The parameter descriptions for \fBgss_import_sec_context()\fR are as follows:
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIminor_status\fR\fR
  34 .ad
  35 .RS 22n
  36 A mechanism-specific status code.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fIinterprocess_token\fR\fR
  43 .ad
  44 .RS 22n
  45 Token received from exporting process.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fIcontext_handle\fR\fR
  52 .ad
  53 .RS 22n
  54 Context handle of newly reactivated context. Resources associated with this
  55 context handle must be released by the application after use with a call to
  56 \fBgss_delete_sec_context\fR(3GSS).
  57 .RE
  58
  59 .SH ERRORS
  60 .sp
  61 .LP
  62 \fBgss_import_sec_context()\fR returns one of the following status codes:
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBGSS_S_COMPLETE\fR\fR
  67 .ad
  68 .RS 25n
  69 Successful completion.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBGSS_S_NO_CONTEXT\fR\fR
  76 .ad
  77 .RS 25n
  78 The token did not contain a valid context reference.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBGSS_S_DEFECTIVE_TOKEN\fR\fR
  85 .ad
  86 .RS 25n
  87 The token was invalid.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBGSS_S_UNAVAILABLE\fR\fR
  94 .ad
  95 .RS 25n
  96 The operation is unavailable.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBGSS_S_UNAUTHORIZED\fR\fR
 103 .ad
 104 .RS 25n
 105 Local policy prevents the import of this context by the current process.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBGSS_S_FAILURE\fR\fR
 112 .ad
 113 .RS 25n
 114 The underlying mechanism detected an error for which no specific \fBGSS\fR
 115 status code is defined.  The mechanism-specific status code reported by means
 116 of the \fIminor_status\fR parameter details the error condition.
 117 .RE
 118
 119 .SH ATTRIBUTES
 120 .sp
 121 .LP
 122 See \fBattributes\fR(5) for descriptions of the following attributes:
 123 .sp
 124
 125 .sp
 126 .TS
 127 box;
 128 c | c
 129 l | l .
 130 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 131 _
 132 MT Level        Safe
 133 .TE
 134
 135 .SH SEE ALSO
 136 .sp
 137 .LP
 138 \fBgss_accept_sec_context\fR(3GSS), \fBgss_context_time\fR(3GSS),
 139 \fBgss_delete_sec_context\fR(3GSS), \fBgss_export_sec_context\fR(3GSS),
 140 \fBgss_init_sec_context\fR(3GSS), \fBgss_inquire_context\fR(3GSS),
 141 \fBgss_process_context_token\fR(3GSS), \fBgss_wrap_size_limit\fR(3GSS),
 142 \fBattributes\fR(5)
 143 .sp
 144 .LP
 145 \fISolaris Security for Developers Guide\fR