xref: /freebsd/lib/librpcsec_gss/rpc_gss_set_svc_name.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
18f55a568SDoug Rabson.\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/
28f55a568SDoug Rabson.\" Authors: Doug Rabson <dfr@rabson.org>
362486687SUlrich Spörlein.\" Developed with Red Inc: Alfred Perlstein <alfred@FreeBSD.org>
48f55a568SDoug Rabson.\"
58f55a568SDoug Rabson.\" Redistribution and use in source and binary forms, with or without
68f55a568SDoug Rabson.\" modification, are permitted provided that the following conditions
78f55a568SDoug Rabson.\" are met:
88f55a568SDoug Rabson.\" 1. Redistributions of source code must retain the above copyright
98f55a568SDoug Rabson.\"    notice, this list of conditions and the following disclaimer.
108f55a568SDoug Rabson.\" 2. Redistributions in binary form must reproduce the above copyright
118f55a568SDoug Rabson.\"    notice, this list of conditions and the following disclaimer in the
128f55a568SDoug Rabson.\"    documentation and/or other materials provided with the distribution.
138f55a568SDoug Rabson.\"
148f55a568SDoug Rabson.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
158f55a568SDoug Rabson.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
168f55a568SDoug Rabson.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
178f55a568SDoug Rabson.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
188f55a568SDoug Rabson.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
198f55a568SDoug Rabson.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
208f55a568SDoug Rabson.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
218f55a568SDoug Rabson.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
228f55a568SDoug Rabson.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
238f55a568SDoug Rabson.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
248f55a568SDoug Rabson.\" SUCH DAMAGE.
25621d0bd3SGavin Atkinson.Dd January 26, 2010
268f55a568SDoug Rabson.Dt RPC_GSS_SET_SVC_NAME 3
278f55a568SDoug Rabson.Os
288f55a568SDoug Rabson.Sh NAME
298f55a568SDoug Rabson.Nm rpc_gss_set_svc_name
308f55a568SDoug Rabson.Nd "Associate a GSS-API service principal with an RPC service"
318f55a568SDoug Rabson.Sh LIBRARY
328f55a568SDoug Rabson.Lb librpcsec_gss
338f55a568SDoug Rabson.Sh SYNOPSIS
348f55a568SDoug Rabson.In rpc/rpcsec_gss.h
358f55a568SDoug Rabson.Ft bool_t
368f55a568SDoug Rabson.Fo rpc_gss_set_svc_name
378f55a568SDoug Rabson.Fa "const char *principal"
388f55a568SDoug Rabson.Fa "const char *mechanism"
398f55a568SDoug Rabson.Fa "u_int req_time"
408f55a568SDoug Rabson.Fa "u_int program"
418f55a568SDoug Rabson.Fa "u_int version"
428f55a568SDoug Rabson.Fc
438f55a568SDoug Rabson.Sh DESCRIPTION
448f55a568SDoug RabsonThis function registers a service principal which will be used to
458f55a568SDoug Rabsonauthenticate RPCSEC_GSS security contexts for a given RPC program and
468f55a568SDoug Rabsonversion.
478f55a568SDoug Rabson.Sh PARAMETERS
485d53fe39SJoel Dahl.Bl -tag -width ".It mechanism"
498f55a568SDoug Rabson.It principal
508f55a568SDoug RabsonA string representing the service principal in the form
518f55a568SDoug Rabson.Qq service@hostname
5212613c1aSJens Schweikhardt.It mechanism
538f55a568SDoug RabsonThe name of the security mechanism
548f55a568SDoug Rabson.It req_time
558f55a568SDoug RabsonThe time in seconds that the service credentials should remain
568f55a568SDoug Rabsonvalid.
578f55a568SDoug RabsonSee
588f55a568SDoug Rabson.Xr gss_acquire_cred 3
598f55a568SDoug Rabsonfor more details.
608f55a568SDoug Rabsonprincipal.
618f55a568SDoug Rabson.It program
628f55a568SDoug RabsonRPC program number for this service
638f55a568SDoug Rabson.It version
648f55a568SDoug RabsonRPC program version for this service
658f55a568SDoug Rabson.El
668f55a568SDoug Rabson.Sh RETURN VALUES
678f55a568SDoug RabsonReturns
688f55a568SDoug Rabson.Dv TRUE
698f55a568SDoug Rabsonif the service principal was registered or
708f55a568SDoug Rabson.Dv FALSE
718f55a568SDoug Rabsonotherwise.
728f55a568SDoug Rabson.Sh SEE ALSO
738f55a568SDoug Rabson.Xr gss_acquire_cred 3 ,
745e4517a4SJoel Dahl.Xr gssapi 3 ,
755e4517a4SJoel Dahl.Xr rpc 3 ,
76*a09bb0edSJens Schweikhardt.Xr rpcsec_gss 3
778f55a568SDoug Rabson.Sh HISTORY
788f55a568SDoug RabsonThe
798f55a568SDoug Rabson.Nm
80ffae047bSGavin Atkinsonfunction first appeared in
818f55a568SDoug Rabson.Fx 8.0 .
828f55a568SDoug Rabson.Sh AUTHORS
838f55a568SDoug RabsonThis
848f55a568SDoug Rabsonmanual page was written by
852b7af31cSBaptiste Daroussin.An Doug Rabson Aq Mt dfr@FreeBSD.org .
86