|
1 '\" te |
|
2 .\" Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved. |
|
3 .TH gss_inquire_mechs_for_name 3GSS "22 Aug 2011" "SunOS 5.12" "Generic Security Services API Library Functions" |
|
4 .SH NAME |
|
5 gss_inquire_mechs_for_name \- list mechanisms that support the specified name-type |
|
6 .SH SYNOPSIS |
|
7 .LP |
|
8 .nf |
|
9 \fBcc\fR [\fIflag \&.\|.\|.\fR] \fIfile\fR\&.\|.\|. \fB-lgss\fR [\fIlibrary \&.\|.\|.\fR] |
|
10 #include <gssapi/gssapi.h> |
|
11 |
|
12 \fBOM_uint32\fR \fBgss_inquire_mechs_for_name\fR(\fBOM_uint32 *\fR\fIminor_status\fR, |
|
13 \fBconst gss_name_t\fR \fIinput_name\fR,\fBgss_OID_set *\fR\fImech_types\fR); |
|
14 .fi |
|
15 |
|
16 .SH DESCRIPTION |
|
17 .sp |
|
18 .LP |
|
19 The \fBgss_inquire_mechs_for_name()\fR function returns the set of mechanisms supported by the \fBGSS-API\fR that may be able to process the specified name. Each mechanism returned will recognize at least one element within the internal name. |
|
20 .sp |
|
21 .LP |
|
22 Some implementations of the \fBGSS-API\fR may perform this test by checking nametype information contained within the passed name and registration information provided by individual mechanisms. This means that the \fImech_types\fR set returned by the function may indicate that a particular mechanism will understand the name, when in fact the mechanism would refuse to accept the name as input to \fBgss_canonicalize_name\fR(3GSS), \fBgss_init_sec_context\fR(3GSS), \fBgss_acquire_cred\fR(3GSS), or \fBgss_add_cred\fR(3GSS), due to some property of the name itself rather than the name-type. Therefore, this function should be used only as a pre-filter for a call to a subsequent mechanism-specific function. |
|
23 .SH PARAMETERS |
|
24 .sp |
|
25 .LP |
|
26 The parameter descriptions for \fBgss_inquire_mechs_for_name()\fR follow in alphabetical order: |
|
27 .sp |
|
28 .ne 2 |
|
29 .mk |
|
30 .na |
|
31 \fB\fIminor_status\fR\fR |
|
32 .ad |
|
33 .RS 16n |
|
34 .rt |
|
35 Mechanism-specific status code. |
|
36 .RE |
|
37 |
|
38 .sp |
|
39 .ne 2 |
|
40 .mk |
|
41 .na |
|
42 \fB\fIinput_name\fR\fR |
|
43 .ad |
|
44 .RS 16n |
|
45 .rt |
|
46 The name to which the inquiry relates. |
|
47 .RE |
|
48 |
|
49 .sp |
|
50 .ne 2 |
|
51 .mk |
|
52 .na |
|
53 \fB\fImech_types\fR\fR |
|
54 .ad |
|
55 .RS 16n |
|
56 .rt |
|
57 Set of mechanisms that may support the specified name. The returned \fBOID\fR set must be freed by the caller after use with a call to \fBgss_release_oid_set\fR(3GSS). |
|
58 .RE |
|
59 |
|
60 .SH ERRORS |
|
61 .sp |
|
62 .LP |
|
63 The \fBgss_inquire_mechs_for_name()\fR function may return the following status codes: |
|
64 .sp |
|
65 .ne 2 |
|
66 .mk |
|
67 .na |
|
68 \fB\fBGSS_S_COMPLETE\fR\fR |
|
69 .ad |
|
70 .RS 22n |
|
71 .rt |
|
72 Successful completion. |
|
73 .RE |
|
74 |
|
75 .sp |
|
76 .ne 2 |
|
77 .mk |
|
78 .na |
|
79 \fB\fBGSS_S_BAD_NAME\fR\fR |
|
80 .ad |
|
81 .RS 22n |
|
82 .rt |
|
83 The \fIinput_name\fR parameter was ill-formed. |
|
84 .RE |
|
85 |
|
86 .sp |
|
87 .ne 2 |
|
88 .mk |
|
89 .na |
|
90 \fB\fBGSS_S_BAD_NAMETYPE\fR\fR |
|
91 .ad |
|
92 .RS 22n |
|
93 .rt |
|
94 The \fIinput_name\fR parameter contained an invalid or unsupported type of name. |
|
95 .RE |
|
96 |
|
97 .sp |
|
98 .ne 2 |
|
99 .mk |
|
100 .na |
|
101 \fB\fBGSS_S_FAILURE\fR\fR |
|
102 .ad |
|
103 .RS 22n |
|
104 .rt |
|
105 The underlying mechanism detected an error for which no specific \fBGSS\fR status code is defined. The mechanism-specific status code reported by means of the \fIminor_status\fR parameter details the error condition. |
|
106 .RE |
|
107 |
|
108 .SH ATTRIBUTES |
|
109 .sp |
|
110 .LP |
|
111 See \fBattributes\fR(5) for descriptions of the following attributes: |
|
112 .sp |
|
113 |
|
114 .sp |
|
115 .TS |
|
116 tab() box; |
|
117 cw(2.75i) |cw(2.75i) |
|
118 lw(2.75i) |lw(2.75i) |
|
119 . |
|
120 ATTRIBUTE TYPEATTRIBUTE VALUE |
|
121 _ |
|
122 MT-LevelSafe |
|
123 .TE |
|
124 |
|
125 .SH SEE ALSO |
|
126 .sp |
|
127 .LP |
|
128 \fBgss_acquire_cred\fR(3GSS), \fBgss_add_cred\fR(3GSS), \fBgss_canonicalize_name\fR(3GSS), \fBgss_init_sec_context\fR(3GSS), \fBgss_release_oid_set\fR(3GSS), \fBattributes\fR(5) |
|
129 .sp |
|
130 .LP |
|
131 |