xref: /freebsd/lib/libgssapi/gss_inquire_mechs_for_name.3 (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
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.\"	$FreeBSD$
28.\"
29.\" The following commands are required for all man pages.
30.Dd January 26, 2010
31.Dt GSS_INQUIRE_MECHS_FOR_NAME 3 PRM
32.Os
33.Sh NAME
34.Nm gss_inquire_mechs_for_name
35.Nd List mechanisms that support the specified name-type
36.\" This next command is for sections 2 and 3 only.
37.\" .Sh LIBRARY
38.Sh SYNOPSIS
39.In "gssapi/gssapi.h"
40.Ft OM_uint32
41.Fo gss_inquire_mechs_for_name
42.Fa "OM_uint32 *minor_status"
43.Fa "const gss_name_t input_name"
44.Fa "gss_OID_set *mech_types"
45.Fc
46.Sh DESCRIPTION
47Returns the set of mechanisms supported by the GSS-API implementation
48that may be able to process the specified name.
49.Pp
50Each mechanism returned will recognize at least one element within the
51name.
52It is permissible for this routine to be implemented within a
53mechanism-independent GSS-API layer,
54using the type information contained within the presented name,
55and based on registration information provided by individual mechanism
56implementations.
57This means that the returned
58.Fa mech_types
59set may indicate that a particular mechanism will understand the name
60when in fact it would refuse to accept the name as input to
61.Fn gss_canonicalize_name ,
62.Fn gss_init_sec_context ,
63.Fn gss_acquire_cred
64or
65.Fn gss_add_cred
66(due to some property of the specific name, as opposed to the name
67type).
68Thus this routine should be used only as a pre-filter for a call to a
69subsequent mechanism-specific routine.
70.Sh PARAMETERS
71.Bl -tag -width ".It minor_status"
72.It minor_status
73Mechanism specific status code.
74.It input_name
75The name to which the inquiry relates.
76.It mech_types
77Set of mechanisms that may support the specified name.
78The returned OID set must be freed by the caller after use with a call
79to
80.Fn gss_release_oid_set .
81.El
82.Sh RETURN VALUES
83.Bl -tag -width ".It GSS_S_COMPLETE"
84.It GSS_S_COMPLETE
85Successful completion
86.It GSS_S_BAD_NAME
87The
88.Fa input_name
89parameter was ill-formed
90.El
91.Sh SEE ALSO
92.Xr gss_release_oid_set 3
93.Sh STANDARDS
94.Bl -tag -width ".It RFC 2743"
95.It RFC 2743
96Generic Security Service Application Program Interface Version 2, Update 1
97.It RFC 2744
98Generic Security Service API Version 2 : C-bindings
99.El
100.Sh HISTORY
101The
102.Nm
103function first appeared in
104.Fx 7.0 .
105.Sh AUTHORS
106John Wray, Iris Associates
107.Sh COPYRIGHT
108Copyright (C) The Internet Society (2000).  All Rights Reserved.
109.Pp
110This document and translations of it may be copied and furnished to
111others, and derivative works that comment on or otherwise explain it
112or assist in its implementation may be prepared, copied, published
113and distributed, in whole or in part, without restriction of any
114kind, provided that the above copyright notice and this paragraph are
115included on all such copies and derivative works.  However, this
116document itself may not be modified in any way, such as by removing
117the copyright notice or references to the Internet Society or other
118Internet organizations, except as needed for the purpose of
119developing Internet standards in which case the procedures for
120copyrights defined in the Internet Standards process must be
121followed, or as required to translate it into languages other than
122English.
123.Pp
124The limited permissions granted above are perpetual and will not be
125revoked by the Internet Society or its successors or assigns.
126.Pp
127This document and the information contained herein is provided on an
128"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
129TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
130BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
131HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
132MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
133