usr/src/man/man3gss/gss_inquire_mechs_for_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_INQUIRE_MECHS_FOR_NAME 3GSS "Jan 15, 2003"
   7 .SH NAME
   8 gss_inquire_mechs_for_name \- list mechanisms that support the specified
   9 name-type
  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_inquire_mechs_for_name\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
  17      \fBconst gss_name_t\fR \fIinput_name\fR,\fBgss_OID_set *\fR\fImech_types\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBgss_inquire_mechs_for_name()\fR function returns the set of mechanisms
  24 supported by the \fBGSS-API\fR that may be able to process the specified name.
  25 Each mechanism returned will recognize at least one element within the internal
  26 name.
  27 .sp
  28 .LP
  29 Some implementations of the \fBGSS-API\fR may perform this test by checking
  30 nametype information contained within the passed name and registration
  31 information provided by individual mechanisms.  This means that the
  32 \fImech_types\fR set returned by the function may indicate that a particular
  33 mechanism will understand the name, when in fact the mechanism would refuse to
  34 accept the name as input to \fBgss_canonicalize_name\fR(3GSS),
  35 \fBgss_init_sec_context\fR(3GSS), \fBgss_acquire_cred\fR(3GSS), or
  36 \fBgss_add_cred\fR(3GSS), due to some property of the name itself rather than
  37 the name-type. Therefore, this function should be used only as a pre-filter for
  38 a call to a subsequent mechanism-specific function.
  39 .SH PARAMETERS
  40 .sp
  41 .LP
  42 The parameter descriptions for \fBgss_inquire_mechs_for_name()\fR follow in
  43 alphabetical order:
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fIminor_status\fR\fR
  48 .ad
  49 .RS 16n
  50 Mechanism-specific status code.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fIinput_name\fR\fR
  57 .ad
  58 .RS 16n
  59 The name to which the inquiry relates.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fImech_types\fR\fR
  66 .ad
  67 .RS 16n
  68 Set of mechanisms that may support the specified name.  The returned \fBOID\fR
  69 set must be freed by the caller after use with a call to
  70 \fBgss_release_oid_set\fR(3GSS).
  71 .RE
  72
  73 .SH ERRORS
  74 .sp
  75 .LP
  76 The \fBgss_inquire_mechs_for_name()\fR function may return the following status
  77 codes:
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBGSS_S_COMPLETE\fR\fR
  82 .ad
  83 .RS 22n
  84 Successful completion.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBGSS_S_BAD_NAME\fR\fR
  91 .ad
  92 .RS 22n
  93 The \fIinput_name\fR parameter was ill-formed.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBGSS_S_BAD_NAMETYPE\fR\fR
 100 .ad
 101 .RS 22n
 102 The \fIinput_name\fR parameter contained an invalid or unsupported type of
 103 name.
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBGSS_S_FAILURE\fR\fR
 110 .ad
 111 .RS 22n
 112 The underlying mechanism detected an error for which no specific \fBGSS\fR
 113 status code is defined.  The mechanism-specific status code reported by means
 114 of the \fIminor_status\fR parameter details the error condition.
 115 .RE
 116
 117 .SH ATTRIBUTES
 118 .sp
 119 .LP
 120 See \fBattributes\fR(5) for descriptions of the following attributes:
 121 .sp
 122
 123 .sp
 124 .TS
 125 box;
 126 c | c
 127 l | l .
 128 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 129 _
 130 MT-Level        Safe
 131 .TE
 132
 133 .SH SEE ALSO
 134 .sp
 135 .LP
 136 \fBgss_acquire_cred\fR(3GSS), \fBgss_add_cred\fR(3GSS),
 137 \fBgss_canonicalize_name\fR(3GSS), \fBgss_init_sec_context\fR(3GSS),
 138 \fBgss_release_oid_set\fR(3GSS), \fBattributes\fR(5)
 139 .sp
 140 .LP
 141 \fISolaris Security for Developers Guide\fR