xref: /freebsd/lib/librpcsec_gss/rpc_gss_get_principal_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_GET_PRINCIPAL_NAME 3
278f55a568SDoug Rabson.Os
288f55a568SDoug Rabson.Sh NAME
298f55a568SDoug Rabson.Nm rpc_gss_get_principal_name
308f55a568SDoug Rabson.Nd "Get a principal name"
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_get_principal_name
378f55a568SDoug Rabson.Fa "rpc_gss_principal_t *principal"
388f55a568SDoug Rabson.Fa "const char *mech"
398f55a568SDoug Rabson.Fa "const char *name"
408f55a568SDoug Rabson.Fa "const char *node"
418f55a568SDoug Rabson.Fa "const char *domain"
428f55a568SDoug Rabson.Fc
438f55a568SDoug Rabson.Sh DESCRIPTION
448f55a568SDoug RabsonThis function can be used to generate a client principal name from
458f55a568SDoug Rabsonvarious strings.
468f55a568SDoug Rabson.Sh PARAMETERS
475d53fe39SJoel Dahl.Bl -tag -width ".It principal"
488f55a568SDoug Rabson.It principal
498f55a568SDoug RabsonIf the principal is created successfully,
508f55a568SDoug Rabson.Fa *principal
518f55a568SDoug Rabsonwill be set to point at the new principal in GSS-API exported name form
528f55a568SDoug Rabson.It mech
538f55a568SDoug RabsonThe name of the mechanism for this principal
548f55a568SDoug Rabson.It name
558f55a568SDoug RabsonThe name part of the principal
568f55a568SDoug Rabson.It node
578f55a568SDoug RabsonIf non-null, the hostname or instance part of the principal
588f55a568SDoug Rabson.It domain
598f55a568SDoug RabsonIf non-null, the domain or realm part of the principal
608f55a568SDoug Rabson.El
618f55a568SDoug Rabson.Sh RETURN VALUES
628f55a568SDoug RabsonReturns
638f55a568SDoug Rabson.Dv TRUE
648f55a568SDoug Rabsonif the principal was created or
658f55a568SDoug Rabson.Dv FALSE
668f55a568SDoug Rabsonotherwise
678f55a568SDoug Rabson.Sh SEE ALSO
688f55a568SDoug Rabson.Xr gss_export_name 3 ,
695e4517a4SJoel Dahl.Xr gssapi 3 ,
705e4517a4SJoel Dahl.Xr rpc 3 ,
71*a09bb0edSJens Schweikhardt.Xr rpcsec_gss 3
728f55a568SDoug Rabson.Sh HISTORY
738f55a568SDoug RabsonThe
748f55a568SDoug Rabson.Nm
75ffae047bSGavin Atkinsonfunction first appeared in
768f55a568SDoug Rabson.Fx 8.0 .
778f55a568SDoug Rabson.Sh AUTHORS
788f55a568SDoug RabsonThis
798f55a568SDoug Rabsonmanual page was written by
802b7af31cSBaptiste Daroussin.An Doug Rabson Aq Mt dfr@FreeBSD.org .
81