xref: /freebsd/lib/libgssapi/gss_canonicalize_name.3 (revision d056fa046c6a91b90cd98165face0e42a33a5173)
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 2005 Doug Rabson
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\"	$FreeBSD$
28.\"
29.\" The following commands are required for all man pages.
30.Dd November 12, 2005
31.Os
32.Dt GSS_CANONICALIZE_NAME 3 PRM
33.Sh NAME
34.Nm gss_canonicalize_name
35.Nd Convert an internal name to an MN
36.\" This next command is for sections 2 and 3 only.
37.\" .Sh LIBRARY
38.Sh SYNOPSIS
39.In "gssapi/gssapi.h"
40.Ft OM_uint32
41.Fo gss_canonicalize_name
42.Fa "OM_uint32 *minor_status"
43.Fa "const gss_name_t input_name"
44.Fa "const gss_OID mech_type"
45.Fa "gss_name_t *output_name"
46.Fc
47.Sh DESCRIPTION
48Generate a canonical mechanism name (MN) from an arbitrary internal
49name.
50The mechanism name is the name that would be returned to a context
51acceptor on successful authentication of a context where the initiator
52used the
53.Fa input_name
54in a successful call to
55.Fn gss_acquire_cred ,
56specifying an OID set containing
57.Fa mech_type
58as its only member,
59followed by a call to
60.Fn gss_init_sec_context ,
61specifying
62.Fa mech_type
63as the authentication mechanism.
64.Sh PARAMETERS
65.Bl -tag
66.It minor_status
67Mechanism specific status code.
68.It input_name
69The name for which a canonical form is desired.
70.It mech_type
71The authentication mechanism for which the canonical form of the name
72is desired.
73The desired mechanism must be specified explicitly;
74 no default is provided.
75.It output_name
76The resultant canonical name.
77Storage associated with this name must be freed by the application
78after use with a call to
79.Fn gss_release_name .
80.El
81.Sh RETURN VALUES
82.Bl -tag
83.It GSS_S_COMPLETE
84Successful completion.
85.It GSS_S_BAD_MECH
86The identified mechanism is not supported.
87.It GSS_S_BAD_NAMETYPE
88The provided internal name contains no elements that could be
89processed by the specified mechanism.
90.It GSS_S_BAD_NAME
91The provided internal name was ill-formed.
92.El
93.Sh SEE ALSO
94.Xr gss_acquire_cred 3 ,
95.Xr gss_init_sec_context 3 ,
96.Xr gss_release_name 3
97.Sh STANDARDS
98.Bl -tag
99.It RFC 2743
100Generic Security Service Application Program Interface Version 2, Update 1
101.It RFC 2744
102Generic Security Service API Version 2 : C-bindings
103.\" .Sh HISTORY
104.El
105.Sh HISTORY
106The
107.Nm
108manual page example first appeared in
109.Fx 7.0 .
110.Sh AUTHORS
111John Wray, Iris Associates
112.Sh COPYRIGHT
113Copyright (C) The Internet Society (2000).  All Rights Reserved.
114.Pp
115This document and translations of it may be copied and furnished to
116others, and derivative works that comment on or otherwise explain it
117or assist in its implementation may be prepared, copied, published
118and distributed, in whole or in part, without restriction of any
119kind, provided that the above copyright notice and this paragraph are
120included on all such copies and derivative works.  However, this
121document itself may not be modified in any way, such as by removing
122the copyright notice or references to the Internet Society or other
123Internet organizations, except as needed for the purpose of
124developing Internet standards in which case the procedures for
125copyrights defined in the Internet Standards process must be
126followed, or as required to translate it into languages other than
127English.
128.Pp
129The limited permissions granted above are perpetual and will not be
130revoked by the Internet Society or its successors or assigns.
131.Pp
132This document and the information contained herein is provided on an
133"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
134TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
135BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
136HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
137MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
138