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