xref: /freebsd/lib/librpcsec_gss/rpc_gss_getcred.3 (revision 8d20be1e22095c27faf8fe8b2f0d089739cc742e)
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_GETCRED 3
29.Os
30.Sh NAME
31.Nm rpc_gss_getcred
32.Nd "Get authorization information for an RPC request"
33.Sh LIBRARY
34.Lb librpcsec_gss
35.Sh SYNOPSIS
36.In rpc/rpcsec_gss.h
37.Ft AUTH *
38.Fo rpc_gss_getcred
39.Fa "struct svc_req *req"
40.Fa "rpc_gss_rawcred_t **rcred"
41.Fa "rpc_gss_ucred_t **ucred"
42.Fa "void **cookie"
43.Fc
44.Sh DESCRIPTION
45This function returns the RPCSEC_GSS authenticated credentials
46associated with an RPC request.
47.Sh PARAMETERS
48.Bl -tag -width ".It cookie"
49.It req
50The RPC request to query
51.It rcred
52If non-null,
53.Fa *rcred
54is set to point at the raw credentials for this request
55.It ucred
56.It rcred
57If non-null,
58.Fa *ucred
59is set to point at the corresponding unix credentials
60.It cookie
61If non-null,
62.Fa *cookie
63is set to the cookie value returned by a callback function registered with
64.Fn rpc_gss_set_callback
65.El
66.Sh RETURN VALUES
67Returns
68.Dv TRUE
69if successful,
70.Dv FALSE
71otherwise.
72.Sh SEE ALSO
73.Xr rpc 3 ,
74.Xr gssapi 3 ,
75.Xr rpc_gss_set_callback 3 ,
76.Xr rpcset_gss 3
77.Sh HISTORY
78The
79.Nm
80function first appeared in
81.Fx 8.0 .
82.Sh AUTHORS
83This
84manual page was written by
85.An Doug Rabson Aq dfr@FreeBSD.org .
86