xref: /freebsd/lib/librpcsec_gss/rpc_gss_oid_to_mech.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1.\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/
2.\" Authors: Doug Rabson <dfr@rabson.org>
3.\" Developed with Red Inc: Alfred Perlstein <alfred@FreeBSD.org>
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.Dd January 26, 2010
26.Dt RPC_GSS_OID_TO_MECH 3
27.Os
28.Sh NAME
29.Nm rpc_gss_oid_to_mech
30.Nd "Convert a mechanism name to a GSS-API oid"
31.Sh LIBRARY
32.Lb librpcsec_gss
33.Sh SYNOPSIS
34.In rpc/rpcsec_gss.h
35.Ft bool_t
36.Fn rpc_gss_oid_to_mech "gss_OID oid" "const char **mech_ret"
37.Sh DESCRIPTION
38This function looks up a mechanism by oid by reading the file
39/etc/gss/mech.
40.Sh PARAMETERS
41.Bl -tag -width ".It mech_ret"
42.It oid
43The mechanism oid to search for
44.It mech_ret
45If the mechanism is found, the corresponding mechanism name is returned
46in
47.Fa *mech_ret
48.El
49.Sh RETURN VALUES
50If the mechanism is found,
51.Dv TRUE
52is returned, otherwise
53.Dv FALSE .
54.Sh SEE ALSO
55.Xr gssapi 3 ,
56.Xr rpc 3 ,
57.Xr rpcsec_gss 3
58.Sh HISTORY
59The
60.Nm
61function first appeared in
62.Fx 8.0 .
63.Sh AUTHORS
64This
65manual page was written by
66.An Doug Rabson Aq Mt dfr@FreeBSD.org .
67