xref: /freebsd/lib/librpcsec_gss/rpc_gss_set_svc_name.3 (revision 3078531de10dcae44b253a35125c949ff4235284)
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_SET_SVC_NAME 3
29.Os
30.Sh NAME
31.Nm rpc_gss_set_svc_name
32.Nd "Associate a GSS-API service principal with an RPC service"
33.Sh LIBRARY
34.Lb librpcsec_gss
35.Sh SYNOPSIS
36.In rpc/rpcsec_gss.h
37.Ft bool_t
38.Fo rpc_gss_set_svc_name
39.Fa "const char *principal"
40.Fa "const char *mechanism"
41.Fa "u_int req_time"
42.Fa "u_int program"
43.Fa "u_int version"
44.Fc
45.Sh DESCRIPTION
46This function registers a service principal which will be used to
47authenticate RPCSEC_GSS security contexts for a given RPC program and
48version.
49.Sh PARAMETERS
50.Bl -tag -width ".It mechanism"
51.It principal
52A string representing the service principal in the form
53.Qq service@hostname
54.It mechanism
55The name of the security mechanism
56.It req_time
57The time in seconds that the service credentials should remain
58valid.
59See
60.Xr gss_acquire_cred 3
61for more details.
62principal.
63.It program
64RPC program number for this service
65.It version
66RPC program version for this service
67.El
68.Sh RETURN VALUES
69Returns
70.Dv TRUE
71if the service principal was registered or
72.Dv FALSE
73otherwise.
74.Sh SEE ALSO
75.Xr gss_acquire_cred 3 ,
76.Xr gssapi 3 ,
77.Xr rpc 3 ,
78.Xr rpcset_gss 3
79.Sh HISTORY
80The
81.Nm
82function first appeared in
83.Fx 8.0 .
84.Sh AUTHORS
85This
86manual page was written by
87.An Doug Rabson Aq Mt dfr@FreeBSD.org .
88