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