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

   1 '\" te
   2 .\" Copyright (C) 2005, 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_NAME 3GSS "Jun 30, 2005"
   7 .SH NAME
   8 gss_import_name \- convert a contiguous string name to GSS_API internal format
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [\fIflag \&.\|.\|.\fR]  \fIfile\fR\&.\|.\|. \fB-lgss\fR [\fIlibrary \&.\|.\|.\fR]
  13 #include <gssapi/gssapi.h>
  14
  15 \fBOM_uint32\fR \fBgss_import_name\fR(\fBOM_uint32 *\fR \fIminor_status\fR,
  16      \fBconst gss_buffer_t\fR \fIinput_name_buffer\fR, \fBconst gss_OID\fR \fIinput_name_type\fR,
  17      \fBgss_name_t *\fR\fIoutput_name\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBgss_import_name()\fR function converts a contiguous string name to
  24 internal form. In general, the internal name returned by means of the
  25 \fIoutput_name\fR parameter will not be a mechanism name; the exception to this
  26 is if the \fIinput_name_type\fR indicates that the contiguous string provided
  27 by means of the \fIinput_name_buffer\fR parameter is of type
  28 \fBGSS_C_NT_EXPORT_NAME\fR, in which case, the returned internal name will be a
  29 mechanism name for the mechanism that exported the name.
  30 .SH PARAMETERS
  31 .sp
  32 .LP
  33 The parameter descriptions for \fBgss_import_name()\fR follow:
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIminor_status\fR\fR
  38 .ad
  39 .RS 21n
  40 Status code returned by the underlying mechanism.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fIinput_name_buffer\fR\fR
  47 .ad
  48 .RS 21n
  49 The \fBgss_buffer_desc\fR structure containing the name to be imported.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fIinput_name_type\fR\fR
  56 .ad
  57 .RS 21n
  58 A \fBgss_OID\fR that specifies the format that the \fIinput_name_buffer\fR is
  59 in.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fIoutput_name\fR\fR
  66 .ad
  67 .RS 21n
  68 The \fBgss_name_t\fR structure to receive the returned name in internal form.
  69 Storage associated with this name must be freed by the application after use
  70 with a call to \fBgss_release_name()\fR.
  71 .RE
  72
  73 .SH ERRORS
  74 .sp
  75 .LP
  76 The \fBgss_import_name()\fR function may return the following status codes:
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBGSS_S_COMPLETE\fR\fR
  81 .ad
  82 .RS 22n
  83 The \fBgss_import_name()\fR function completed successfully.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBGSS_S_BAD_NAMETYPE\fR\fR
  90 .ad
  91 .RS 22n
  92 The \fIinput_name_type\fR was unrecognized.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBGSS_S_BAD_NAME\fR\fR
  99 .ad
 100 .RS 22n
 101 The \fIinput_name\fR parameter could not be interpreted as a name of the
 102 specified type.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBGSS_S_BAD_MECH\fR\fR
 109 .ad
 110 .RS 22n
 111 The \fIinput_name_type\fR was \fBGSS_C_NT_EXPORT_NAME\fR, but the mechanism
 112 contained within the \fIinput_name\fR is not supported.
 113 .RE
 114
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fBGSS_S_FAILURE\fR\fR
 119 .ad
 120 .RS 22n
 121 The underlying mechanism detected an error for which no specific \fBGSS\fR
 122 status code is defined.  The mechanism-specific status code reported by means
 123 of the \fIminor_status\fR parameter details the error condition.
 124 .RE
 125
 126 .SH ATTRIBUTES
 127 .sp
 128 .LP
 129 See \fBattributes\fR(5) for descriptions of the following attributes:
 130 .sp
 131
 132 .sp
 133 .TS
 134 box;
 135 c | c
 136 l | l .
 137 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 138 _
 139 MT-Level        Safe
 140 .TE
 141
 142 .SH SEE ALSO
 143 .sp
 144 .LP
 145 \fBgss_release_buffer\fR(3GSS), \fBattributes\fR(5)
 146 .sp
 147 .LP
 148 \fISolaris Security for Developers Guide\fR