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