]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - lib/libgssapi/gss_inquire_mechs_for_name.3
zfs: merge openzfs/zfs@887a3c533
[FreeBSD/FreeBSD.git] / lib / libgssapi / gss_inquire_mechs_for_name.3
1 .\" -*- nroff -*-
2 .\"
3 .\" Copyright (c) 2005 Doug Rabson
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" SUCH DAMAGE.
26 .\"
27 .\" The following commands are required for all man pages.
28 .Dd January 26, 2010
29 .Dt GSS_INQUIRE_MECHS_FOR_NAME 3 PRM
30 .Os
31 .Sh NAME
32 .Nm gss_inquire_mechs_for_name
33 .Nd List mechanisms that support the specified name-type
34 .\" This next command is for sections 2 and 3 only.
35 .\" .Sh LIBRARY
36 .Sh SYNOPSIS
37 .In "gssapi/gssapi.h"
38 .Ft OM_uint32
39 .Fo gss_inquire_mechs_for_name
40 .Fa "OM_uint32 *minor_status"
41 .Fa "const gss_name_t input_name"
42 .Fa "gss_OID_set *mech_types"
43 .Fc
44 .Sh DESCRIPTION
45 Returns the set of mechanisms supported by the GSS-API implementation
46 that may be able to process the specified name.
47 .Pp
48 Each mechanism returned will recognize at least one element within the
49 name.
50 It is permissible for this routine to be implemented within a
51 mechanism-independent GSS-API layer,
52 using the type information contained within the presented name,
53 and based on registration information provided by individual mechanism
54 implementations.
55 This means that the returned
56 .Fa mech_types
57 set may indicate that a particular mechanism will understand the name
58 when in fact it would refuse to accept the name as input to
59 .Fn gss_canonicalize_name ,
60 .Fn gss_init_sec_context ,
61 .Fn gss_acquire_cred
62 or
63 .Fn gss_add_cred
64 (due to some property of the specific name, as opposed to the name
65 type).
66 Thus this routine should be used only as a pre-filter for a call to a
67 subsequent mechanism-specific routine.
68 .Sh PARAMETERS
69 .Bl -tag -width ".It minor_status"
70 .It minor_status
71 Mechanism specific status code.
72 .It input_name
73 The name to which the inquiry relates.
74 .It mech_types
75 Set of mechanisms that may support the specified name.
76 The returned OID set must be freed by the caller after use with a call
77 to
78 .Fn gss_release_oid_set .
79 .El
80 .Sh RETURN VALUES
81 .Bl -tag -width ".It GSS_S_COMPLETE"
82 .It GSS_S_COMPLETE
83 Successful completion
84 .It GSS_S_BAD_NAME
85 The
86 .Fa input_name
87 parameter was ill-formed
88 .El
89 .Sh SEE ALSO
90 .Xr gss_release_oid_set 3
91 .Sh STANDARDS
92 .Bl -tag -width ".It RFC 2743"
93 .It RFC 2743
94 Generic Security Service Application Program Interface Version 2, Update 1
95 .It RFC 2744
96 Generic Security Service API Version 2 : C-bindings
97 .El
98 .Sh HISTORY
99 The
100 .Nm
101 function first appeared in
102 .Fx 7.0 .
103 .Sh AUTHORS
104 John Wray, Iris Associates
105 .Sh COPYRIGHT
106 Copyright (C) The Internet Society (2000).  All Rights Reserved.
107 .Pp
108 This document and translations of it may be copied and furnished to
109 others, and derivative works that comment on or otherwise explain it
110 or assist in its implementation may be prepared, copied, published
111 and distributed, in whole or in part, without restriction of any
112 kind, provided that the above copyright notice and this paragraph are
113 included on all such copies and derivative works.  However, this
114 document itself may not be modified in any way, such as by removing
115 the copyright notice or references to the Internet Society or other
116 Internet organizations, except as needed for the purpose of
117 developing Internet standards in which case the procedures for
118 copyrights defined in the Internet Standards process must be
119 followed, or as required to translate it into languages other than
120 English.
121 .Pp
122 The limited permissions granted above are perpetual and will not be
123 revoked by the Internet Society or its successors or assigns.
124 .Pp
125 This document and the information contained herein is provided on an
126 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
127 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
128 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
129 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
130 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.