xref: /freebsd/lib/librpcsec_gss/rpc_gss_get_principal_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_GET_PRINCIPAL_NAME 3
27.Os
28.Sh NAME
29.Nm rpc_gss_get_principal_name
30.Nd "Get a principal name"
31.Sh LIBRARY
32.Lb librpcsec_gss
33.Sh SYNOPSIS
34.In rpc/rpcsec_gss.h
35.Ft bool_t
36.Fo rpc_gss_get_principal_name
37.Fa "rpc_gss_principal_t *principal"
38.Fa "const char *mech"
39.Fa "const char *name"
40.Fa "const char *node"
41.Fa "const char *domain"
42.Fc
43.Sh DESCRIPTION
44This function can be used to generate a client principal name from
45various strings.
46.Sh PARAMETERS
47.Bl -tag -width ".It principal"
48.It principal
49If the principal is created successfully,
50.Fa *principal
51will be set to point at the new principal in GSS-API exported name form
52.It mech
53The name of the mechanism for this principal
54.It name
55The name part of the principal
56.It node
57If non-null, the hostname or instance part of the principal
58.It domain
59If non-null, the domain or realm part of the principal
60.El
61.Sh RETURN VALUES
62Returns
63.Dv TRUE
64if the principal was created or
65.Dv FALSE
66otherwise
67.Sh SEE ALSO
68.Xr gss_export_name 3 ,
69.Xr gssapi 3 ,
70.Xr rpc 3 ,
71.Xr rpcsec_gss 3
72.Sh HISTORY
73The
74.Nm
75function first appeared in
76.Fx 8.0 .
77.Sh AUTHORS
78This
79manual page was written by
80.An Doug Rabson Aq Mt dfr@FreeBSD.org .
81