xref: /freebsd/lib/librpcsec_gss/rpc_gss_qop_to_num.3 (revision dd41de95a84d979615a2ef11df6850622bf6184e)
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.\"
26.\" $FreeBSD$
27.Dd January 26, 2010
28.Dt RPC_GSS_QOP_TO_NUM 3
29.Os
30.Sh NAME
31.Nm rpc_gss_qop_to_num
32.Nd "Convert a quality of protection name to number"
33.Sh LIBRARY
34.Lb librpcsec_gss
35.Sh SYNOPSIS
36.In rpc/rpcsec_gss.h
37.Ft bool_t
38.Fn rpc_gss_qop_to_num "const char *qop" "const char *mech" "u_int *num_ret"
39.Sh DESCRIPTION
40This function looks up a quality of protection by name by reading the file
41/etc/gss/qop.
42.Sh PARAMETERS
43.Bl -tag -width ".It number_ret"
44.It qop
45The quality of protection to search for
46.It mech
47The mechanism name to search for
48.It number_ret
49If the quality of protection is found, the corresponding number is
50returned in
51.Fa *num_ret
52.El
53.Sh RETURN VALUES
54If the value is found,
55.Dv TRUE
56is returned, otherwise
57.Dv FALSE .
58.Sh SEE ALSO
59.Xr gssapi 3 ,
60.Xr rpc 3 ,
61.Xr rpcset_gss 3
62.Sh HISTORY
63The
64.Nm
65function first appeared in
66.Fx 8.0 .
67.Sh AUTHORS
68This
69manual page was written by
70.An Doug Rabson Aq Mt dfr@FreeBSD.org .
71