xref: /freebsd/lib/libgssapi/gss_inquire_mechs_for_name.3 (revision cbb3ec25236ba72f91cbdf23f8b78b9d1af0cedf)
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
45Returns the set of mechanisms supported by the GSS-API implementation
46that may be able to process the specified name.
47.Pp
48Each mechanism returned will recognize at least one element within the
49name.
50It is permissible for this routine to be implemented within a
51mechanism-independent GSS-API layer,
52using the type information contained within the presented name,
53and based on registration information provided by individual mechanism
54implementations.
55This means that the returned
56.Fa mech_types
57set may indicate that a particular mechanism will understand the name
58when 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
62or
63.Fn gss_add_cred
64(due to some property of the specific name, as opposed to the name
65type).
66Thus this routine should be used only as a pre-filter for a call to a
67subsequent mechanism-specific routine.
68.Sh PARAMETERS
69.Bl -tag -width ".It minor_status"
70.It minor_status
71Mechanism specific status code.
72.It input_name
73The name to which the inquiry relates.
74.It mech_types
75Set of mechanisms that may support the specified name.
76The returned OID set must be freed by the caller after use with a call
77to
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
83Successful completion
84.It GSS_S_BAD_NAME
85The
86.Fa input_name
87parameter 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
94Generic Security Service Application Program Interface Version 2, Update 1
95.It RFC 2744
96Generic Security Service API Version 2 : C-bindings
97.El
98.Sh HISTORY
99The
100.Nm
101function first appeared in
102.Fx 7.0 .
103.Sh AUTHORS
104John Wray, Iris Associates
105.Sh COPYRIGHT
106Copyright (C) The Internet Society (2000).  All Rights Reserved.
107.Pp
108This document and translations of it may be copied and furnished to
109others, and derivative works that comment on or otherwise explain it
110or assist in its implementation may be prepared, copied, published
111and distributed, in whole or in part, without restriction of any
112kind, provided that the above copyright notice and this paragraph are
113included on all such copies and derivative works.  However, this
114document itself may not be modified in any way, such as by removing
115the copyright notice or references to the Internet Society or other
116Internet organizations, except as needed for the purpose of
117developing Internet standards in which case the procedures for
118copyrights defined in the Internet Standards process must be
119followed, or as required to translate it into languages other than
120English.
121.Pp
122The limited permissions granted above are perpetual and will not be
123revoked by the Internet Society or its successors or assigns.
124.Pp
125This document and the information contained herein is provided on an
126"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
127TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
128BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
129HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
130MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
131