usr/src/man/man3gss/gss_export_name.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_EXPORT_NAME 3GSS "Jan 14, 2003"
   7 .SH NAME
   8 gss_export_name \- convert a mechanism name to export form
   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_export_name\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
  16      \fBconst gss_name_t\fR \fIinput_name\fR,\fBgss_buffer_t\fR \fIexported_name\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBgss_export_name()\fR function allows a \fBGSS-API\fR internal name to be
  23 converted into a mechanism-specific name. The function produces a canonical
  24 contiguous string representation of a mechanism name, suitable for direct
  25 comparison, with \fBmemory\fR(3C), or for use in authorization functions,
  26 matching entries in an access-control list.  The \fIinput_name\fR parameter
  27 must specify a valid mechanism name, that is, an internal name generated by
  28 \fBgss_accept_sec_context\fR(3GSS) or by \fBgss_canonicalize_name\fR(3GSS).
  29 .SH PARAMETERS
  30 .sp
  31 .LP
  32 The parameter descriptions for \fBgss_export_name()\fR follow:
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIminor_status\fR\fR
  37 .ad
  38 .RS 17n
  39 A mechanism-specific status code.
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fIinput_name\fR\fR
  46 .ad
  47 .RS 17n
  48 The mechanism name to be exported.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fIexported_name\fR\fR
  55 .ad
  56 .RS 17n
  57 The canonical contiguous string form of \fIinput_name\fR. Storage associated
  58 with this string must freed by the application after use with
  59 \fBgss_release_buffer\fR(3GSS).
  60 .RE
  61
  62 .SH ERRORS
  63 .sp
  64 .LP
  65 The \fBgss_export_name()\fR function may return the following status codes:
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBGSS_S_COMPLETE\fR\fR
  70 .ad
  71 .RS 21n
  72 Successful completion.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBGSS_S_NAME_NOT_MN\fR\fR
  79 .ad
  80 .RS 21n
  81 The provided internal name was not a mechanism name.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBGSS_S_FAILURE\fR\fR
  88 .ad
  89 .RS 21n
  90 The underlying mechanism detected an error for which no specific \fBGSS\fR
  91 status code is defined.  The mechanism-specific status code reported by means
  92 of the \fIminor_status\fR parameter details the error condition.
  93 .RE
  94
  95 .SH ATTRIBUTES
  96 .sp
  97 .LP
  98 See \fBattributes\fR(5)  for descriptions of the following attributes:
  99 .sp
 100
 101 .sp
 102 .TS
 103 box;
 104 c | c
 105 l | l .
 106 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 107 _
 108 MT-Level        Safe
 109 .TE
 110
 111 .SH SEE ALSO
 112 .sp
 113 .LP
 114 \fBgss_accept_sec_context\fR(3GSS), \fBgss_canonicalize_name\fR(3GSS),
 115 \fBgss_release_buffer\fR(3GSS)\fBmemory\fR(3C), \fBattributes\fR(5)
 116 .sp
 117 .LP
 118 \fISolaris Security for Developers Guide\fR