share/man/man3gss/gss_display_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_DISPLAY_NAME 3GSS "Jan 14, 2003"
   7 .SH NAME
   8 gss_display_name \- convert internal-form name to text
   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_display_name\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
  16      \fBconst gss_name_t\fR \fIinput_name\fR,\ \fBgss_buffer_t\fR \fIoutput_name_buffer\fR,
  17      \fBgss_OID *\fR\fIoutput_name_type\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBgss_display_name()\fR function allows an application to obtain a textual
  24 representation of an opaque internal-form  name for display purposes.
  25 .sp
  26 .LP
  27 If \fIinput_name\fR denotes an anonymous principal, the \fBGSS-API\fR returns
  28 the \fBgss_OID\fR value \fBGSS_C_NT_ANONYMOUS\fR as the \fIoutput_name_type\fR,
  29 and a textual name that is syntactically distinct from all valid supported
  30 printable names in \fIoutput_name_buffer\fR.
  31 .sp
  32 .LP
  33 If \fIinput_name\fR was created by a call to \fBgss_import_name\fR(3GSS),
  34 specifying \fBGSS_C_NO_OID\fR as the name-type, the GSS-API returns
  35 \fBGSS_C_NO_OID\fR by means of the \fIoutput_name_type\fR parameter.
  36 .SH PARAMETERS
  37 .sp
  38 .LP
  39 The parameter descriptions for \fBgss_display_name()\fR follow:
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fIminor_status\fR\fR
  44 .ad
  45 .RS 22n
  46 Mechanism-specific status code.
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fIinput_name\fR\fR
  53 .ad
  54 .RS 22n
  55 Name in internal form.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fIoutput_name_buffer\fR\fR
  62 .ad
  63 .RS 22n
  64 Buffer to receive textual name string. The application must free storage
  65 associated with this name after use with a call to
  66 \fBgss_release_buffer\fR(3GSS).
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fIoutput_name_type\fR\fR
  73 .ad
  74 .RS 22n
  75 The type of the returned name.  The returned \fBgss_OID\fR will be a pointer
  76 into static storage and should be treated as read-only by the caller. In
  77 particular, the application should not attempt to free it. Specify \fINULL\fR
  78 if this parameter is not required.
  79 .RE
  80
  81 .SH ERRORS
  82 .sp
  83 .LP
  84 The \fBgss_display_name()\fR function may return the following status codes:
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBGSS_S_COMPLETE\fR\fR
  89 .ad
  90 .RS 18n
  91 Successful completion.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBGSS_S_BAD_NAME\fR\fR
  98 .ad
  99 .RS 18n
 100 The \fIinput_name\fR was ill-formed.
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBGSS_S_FAILURE\fR\fR
 107 .ad
 108 .RS 18n
 109 The underlying mechanism detected an error for which no specific \fBGSS\fR
 110 status code is defined.  The mechanism-specific status code reported by means
 111 of the \fIminor_status\fR parameter details the error condition.
 112 .RE
 113
 114 .SH ATTRIBUTES
 115 .sp
 116 .LP
 117 See \fBattributes\fR(5) for descriptions of the following attributes:
 118 .sp
 119
 120 .sp
 121 .TS
 122 box;
 123 c | c
 124 l | l .
 125 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 126 _
 127 MT-Level        Safe
 128 .TE
 129
 130 .SH SEE ALSO
 131 .sp
 132 .LP
 133 \fBgss_import_name\fR(3GSS), \fBgss_release_buffer\fR(3GSS),
 134 \fBattributes\fR(5)
 135 .sp
 136 .LP
 137 \fISolaris Security for Developers Guide\fR