xref: /freebsd/lib/libgssapi/gss_indicate_mechs.3 (revision 62cfcf62f627e5093fb37026a6d8c98e4d2ef04c)
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_INDICATE_MECHS 3 PRM
32.Os
33.Sh NAME
34.Nm gss_indicate_mechs
35.Nd Determine available underlying authentication mechanisms
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_indicate_mechs
42.Fa "OM_uint32 *minor_status"
43.Fa "gss_OID_set *mech_set"
44.Fc
45.Sh DESCRIPTION
46Allows an application to determine which underlying security
47mechanisms are available.
48.Sh PARAMETERS
49.Bl -tag -width ".It minor_status"
50.It minor_status
51Mechanism specific status code.
52.It mech_set
53Set of implementation-supported mechanisms.
54The returned
55.Fa mech_set
56value will be a dynamically-allocated OID set,
57that should be released by the caller after use with a call to
58.Fn gss_release_oid_set .
59.El
60.Sh RETURN VALUES
61.Bl -tag -width ".It GSS_S_COMPLETE"
62.It GSS_S_COMPLETE
63Successful completion
64.El
65.Sh SEE ALSO
66.Xr gss_release_oid_set 3
67.Sh STANDARDS
68.Bl -tag -width ".It RFC 2743"
69.It RFC 2743
70Generic Security Service Application Program Interface Version 2, Update 1
71.It RFC 2744
72Generic Security Service API Version 2 : C-bindings
73.El
74.Sh HISTORY
75The
76.Nm
77function first appeared in
78.Fx 7.0 .
79.Sh AUTHORS
80John Wray, Iris Associates
81.Sh COPYRIGHT
82Copyright (C) The Internet Society (2000).  All Rights Reserved.
83.Pp
84This document and translations of it may be copied and furnished to
85others, and derivative works that comment on or otherwise explain it
86or assist in its implementation may be prepared, copied, published
87and distributed, in whole or in part, without restriction of any
88kind, provided that the above copyright notice and this paragraph are
89included on all such copies and derivative works.  However, this
90document itself may not be modified in any way, such as by removing
91the copyright notice or references to the Internet Society or other
92Internet organizations, except as needed for the purpose of
93developing Internet standards in which case the procedures for
94copyrights defined in the Internet Standards process must be
95followed, or as required to translate it into languages other than
96English.
97.Pp
98The limited permissions granted above are perpetual and will not be
99revoked by the Internet Society or its successors or assigns.
100.Pp
101This document and the information contained herein is provided on an
102"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
103TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
104BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
105HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
106MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
107