xref: /freebsd/lib/libgssapi/gss_export_name.3 (revision c0b9f4fe659b6839541970eb5675e57f4d814969)
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.\" Copyright (C) The Internet Society (2000).  All Rights Reserved.
30.\"
31.\" This document and translations of it may be copied and furnished to
32.\" others, and derivative works that comment on or otherwise explain it
33.\" or assist in its implementation may be prepared, copied, published
34.\" and distributed, in whole or in part, without restriction of any
35.\" kind, provided that the above copyright notice and this paragraph are
36.\" included on all such copies and derivative works.  However, this
37.\" document itself may not be modified in any way, such as by removing
38.\" the copyright notice or references to the Internet Society or other
39.\" Internet organizations, except as needed for the purpose of
40.\" developing Internet standards in which case the procedures for
41.\" copyrights defined in the Internet Standards process must be
42.\" followed, or as required to translate it into languages other than
43.\" English.
44.\"
45.\" The limited permissions granted above are perpetual and will not be
46.\" revoked by the Internet Society or its successors or assigns.
47.\"
48.\" This document and the information contained herein is provided on an
49.\" "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
50.\" TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
51.\" BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
52.\" HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
53.\" MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
54.\"
55.\" The following commands are required for all man pages.
56.Dd November 12, 2005
57.Os
58.Dt GSS_EXPORT_NAME 3 PRM
59.Sh NAME
60.Nm gss_export_name
61.Nd Convert an MN to export form
62.\" This next command is for sections 2 and 3 only.
63.\" .Sh LIBRARY
64.Sh SYNOPSIS
65.In "gssapi/gssapi.h"
66.Ft OM_uint32
67.Fo gss_export_name
68.Fa "OM_uint32 *minor_status"
69.Fa "const gss_name_t input_name"
70.Fa "gss_buffer_t exported_name"
71.Fc
72.Sh DESCRIPTION
73To produce a canonical contiguous string representation of a mechanism
74name (MN),
75suitable for direct comparison
76(e.g. with memcmp)
77for use in authorization functions
78(e.g. matching entries in an access-control list).
79The
80.Fa input_name
81parameter must specify a valid MN
82(i.e. an internal name generated by
83.Fn gss_accept_sec_context
84or by
85.Fn gss_canonicalize_name ).
86.Sh PARAMETERS
87.Bl -tag
88.It minor_status
89Mechanism specific status code.
90.It input_name
91The MN to be exported.
92.It exported_name
93The canonical contiguous string form of
94.Fa input_name .
95Storage associated with this string must freed by the application
96after use with
97.Fn gss_release_buffer .
98.El
99.Sh RETURN VALUES
100.Bl -tag
101.It GSS_S_COMPLETE
102Successful completion
103.It GSS_S_NAME_NOT_MN
104The provided internal name was not a mechanism name.
105.It GSS_S_BAD_NAME
106The provided internal name was ill-formed.
107.It GSS_S_BAD_NAMETYPE
108The internal name was of a type not supported by the GSS-API implementation.
109.El
110.Sh SEE ALSO
111.Xr gss_accept_sec_context 3 ,
112.Xr gss_canonicalize_name 3 ,
113.Xr gss_release_buffer 3
114.Sh STANDARDS
115.Bl -tag
116.It RFC 2743
117Generic Security Service Application Program Interface Version 2, Update 1
118.It RFC 2744
119Generic Security Service API Version 2 : C-bindings
120.\" .Sh HISTORY
121.El
122.Sh HISTORY
123The
124.Nm
125manual page example first appeared in
126.Fx 7.0 .
127.Sh AUTHORS
128John Wray, Iris Associates
129