usr/src/man/man3gss/gss_compare_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_COMPARE_NAME 3GSS "Jan 14, 2003"
   7 .SH NAME
   8 gss_compare_name \- compare two internal-form names
   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_compare_name\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
  16      \fBconst gss_name_t\fR \fIname1\fR,\fBconst gss_name_t\fR \fIname2\fR,
  17      \fBint *\fR\fIname_equal\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBgss_compare_name()\fR function allows an application to compare two
  24 internal-form names to determine whether they refer to the same entity.
  25 .sp
  26 .LP
  27 If either name presented to \fBgss_compare_name()\fR denotes an anonymous
  28 principal, the routines indicate that the two names do not refer to the same
  29 identity.
  30 .SH PARAMETERS
  31 .sp
  32 .LP
  33 The parameter descriptions for \fBgss_compare_name()\fR follow:
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIminor_status\fR\fR
  38 .ad
  39 .RS 16n
  40 Mechanism-specific status code.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fIname1\fR\fR
  47 .ad
  48 .RS 16n
  49 Internal-form name.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fIname2\fR\fR
  56 .ad
  57 .RS 16n
  58 Internal-form name.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fIname_equal\fR\fR
  65 .ad
  66 .RS 16n
  67 If non-zero, the names refer to same entity. If 0, the names refer to different
  68 entities. Strictly, the names are not known to refer to the same identity.
  69 .RE
  70
  71 .SH ERRORS
  72 .sp
  73 .LP
  74 The \fBgss_compare_name()\fR function may return the following status codes:
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBGSS_S_COMPLETE\fR\fR
  79 .ad
  80 .RS 22n
  81 Successful completion.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBGSS_S_BAD_NAMETYPE\fR\fR
  88 .ad
  89 .RS 22n
  90 The two names were of incomparable types.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBGSS_S_BAD_NAME\fR\fR
  97 .ad
  98 .RS 22n
  99 One or both of \fIname1\fR or \fIname2\fR was ill-formed.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fBGSS_S_FAILURE\fR\fR
 106 .ad
 107 .RS 22n
 108 The underlying mechanism detected an error for which no specific \fBGSS\fR
 109 status code is defined.  The mechanism-specific status code reported by means
 110 of the \fIminor_status\fR parameter details the error condition.
 111 .RE
 112
 113 .SH ATTRIBUTES
 114 .sp
 115 .LP
 116 See \fBattributes\fR(5) for descriptions of the following attributes:
 117 .sp
 118
 119 .sp
 120 .TS
 121 box;
 122 c | c
 123 l | l .
 124 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 125 _
 126 MT-Level        Safe
 127 .TE
 128
 129 .SH SEE ALSO
 130 .sp
 131 .LP
 132 \fBattributes\fR(5)
 133 .sp
 134 .LP
 135 \fISolaris Security for Developers Guide\fR