Blame man/rpc_gss_qop_to_num.3t

Packit Service 4f68e0
.\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/
Packit Service 4f68e0
.\" Authors: Doug Rabson <dfr@rabson.org>
Packit Service 4f68e0
.\" Developed with Red Inc: Alfred Perlstein <alfred@FreeBSD.org>
Packit Service 4f68e0
.\"
Packit Service 4f68e0
.\" Redistribution and use in source and binary forms, with or without
Packit Service 4f68e0
.\" modification, are permitted provided that the following conditions
Packit Service 4f68e0
.\" are met:
Packit Service 4f68e0
.\" 1. Redistributions of source code must retain the above copyright
Packit Service 4f68e0
.\"    notice, this list of conditions and the following disclaimer.
Packit Service 4f68e0
.\" 2. Redistributions in binary form must reproduce the above copyright
Packit Service 4f68e0
.\"    notice, this list of conditions and the following disclaimer in the
Packit Service 4f68e0
.\"    documentation and/or other materials provided with the distribution.
Packit Service 4f68e0
.\"
Packit Service 4f68e0
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
Packit Service 4f68e0
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Packit Service 4f68e0
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
Packit Service 4f68e0
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
Packit Service 4f68e0
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Packit Service 4f68e0
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
Packit Service 4f68e0
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
Packit Service 4f68e0
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
Packit Service 4f68e0
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
Packit Service 4f68e0
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
Packit Service 4f68e0
.\" SUCH DAMAGE.
Packit Service 4f68e0
.\"
Packit Service 4f68e0
.\" $FreeBSD$
Packit Service 4f68e0
.Dd January 26, 2010
Packit Service 4f68e0
.Dt RPC_GSS_QOP_TO_NUM 3
Packit Service 4f68e0
.Os
Packit Service 4f68e0
.Sh NAME
Packit Service 4f68e0
.Nm rpc_gss_qop_to_num
Packit Service 4f68e0
.Nd "Convert a Quality of Protection name to number"
Packit Service 4f68e0
.Sh SYNOPSIS
Packit Service 4f68e0
.In rpc/rpcsec_gss.h
Packit Service 4f68e0
.Ft bool_t
Packit Service 4f68e0
.Fn rpc_gss_qop_to_num "const char *qop" "const char *mech" "u_int *num_ret"
Packit Service 4f68e0
.Sh DESCRIPTION
Packit Service 4f68e0
This function returns the numeric QOP value associated with the
Packit Service 4f68e0
GSS_API QOP "qop" and mechanism "mech."
Packit Service 4f68e0
.Sh PARAMETERS
Packit Service 4f68e0
.Bl -tag -width ".It number_ret"
Packit Service 4f68e0
.It qop
Packit Service 4f68e0
The name of Quality of Protection associated with the
Packit Service 4f68e0
GSS_API mechanism "mech".
Packit Service 4f68e0
"GSS_C_QOP_DEFAULT" is currently the only supported QOP.
Packit Service 4f68e0
.It mech
Packit Service 4f68e0
The name of a GSS_API mechanism.
Packit Service 4f68e0
"kerberos_v5" is currently the only supported mechanism.
Packit Service 4f68e0
.It number_ret
Packit Service 4f68e0
Buffer in which to place the returned QOP number
Packit Service 4f68e0
.El
Packit Service 4f68e0
.Sh RETURN VALUES
Packit Service 4f68e0
If the QOP and mechanism names are recognized,
Packit Service 4f68e0
.Dv TRUE
Packit Service 4f68e0
is returned.
Packit Service 4f68e0
The corresponding QOP number is returned in
Packit Service 4f68e0
.Fa *num_ret .
Packit Service 4f68e0
Otherwise
Packit Service 4f68e0
.Dv FALSE
Packit Service 4f68e0
is returned and
Packit Service 4f68e0
.It number_ret
Packit Service 4f68e0
is left untouched.
Packit Service 4f68e0
.Sh AVAILABILITY
Packit Service 4f68e0
The
Packit Service 4f68e0
.Fn rpc_gss_qop_to_num
Packit Service 4f68e0
function is part of libtirpc.
Packit Service 4f68e0
.Sh SEE ALSO
Packit Service 4f68e0
.Xr rpc 3 ,
Packit Service 4f68e0
.Xr gssapi 3 ,
Packit Service 4f68e0
.Xr rpcsec_gss 3
Packit Service 4f68e0
.Sh AUTHORS
Packit Service 4f68e0
This
Packit Service 4f68e0
manual page was written by
Packit Service 4f68e0
.An Doug Rabson Aq dfr@FreeBSD.org .