xref: /freebsd/lib/libgssapi/gss_import_name.3 (revision d6b92ffa)
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 January 26, 2010
31.Dt GSS_IMPORT_NAME 3 PRM
32.Os
33.Sh NAME
34.Nm gss_import_name
35.Nd Convert a contiguous string name to internal-form
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_import_name
42.Fa "OM_uint32 *minor_status"
43.Fa "const gss_buffer_t input_name_buffer"
44.Fa "const gss_OID input_name_type"
45.Fa "gss_name_t *output_name"
46.Fc
47.Sh DESCRIPTION
48Convert a contiguous string name to internal form.
49In general,
50the internal name returned (via the
51.Fa output_name
52parameter) will not be an MN;
53the exception to this is if the
54.Fa input_name_type
55indicates that the contiguous string provided via the
56.Fa input_name_buffer
57parameter is of type
58.Dv GSS_C_NT_EXPORT_NAME ,
59in which case the returned internal name will be an MN for the
60mechanism that exported the name.
61.Sh PARAMETERS
62.Bl -tag -width ".It input_name_buffer"
63.It minor_status
64Mechanism specific status code.
65.It input_name_buffer
66Buffer containing contiguous string name to convert.
67.It input_name_type
68Object ID specifying type of printable name.
69Applications may specify either
70.Dv GSS_C_NO_OID
71to use a mechanism-specific default printable syntax,
72or an OID recognized by the GSS-API implementation to name a specific
73namespace.
74.It output_name
75Returned name in internal form.
76Storage associated with this name must be freed by the application
77after use with a call to
78.Fn gss_release_name .
79.El
80.Sh RETURN VALUES
81.Bl -tag -width "It GSS_S_BAD_NAMETYPE"
82.It GSS_S_COMPLETE
83Successful completion
84.It GSS_S_BAD_NAMETYPE
85The
86.Fa input_name_type
87was unrecognized
88.It GSS_S_BAD_NAME
89The
90.Fa input_name
91parameter could not be interpreted as a name of the specified type
92.It GSS_S_BAD_MECH
93The input name-type was
94.Dv GSS_C_NT_EXPORT_NAME ,
95but the mechanism contained within the input-name is not supported
96.El
97.Sh SEE ALSO
98.Xr gss_release_name 3
99.Sh STANDARDS
100.Bl -tag -width ".It RFC 2743"
101.It RFC 2743
102Generic Security Service Application Program Interface Version 2, Update 1
103.It RFC 2744
104Generic Security Service API Version 2 : C-bindings
105.El
106.Sh HISTORY
107The
108.Nm
109function first appeared in
110.Fx 7.0 .
111.Sh AUTHORS
112John Wray, Iris Associates
113.Sh COPYRIGHT
114Copyright (C) The Internet Society (2000).  All Rights Reserved.
115.Pp
116This document and translations of it may be copied and furnished to
117others, and derivative works that comment on or otherwise explain it
118or assist in its implementation may be prepared, copied, published
119and distributed, in whole or in part, without restriction of any
120kind, provided that the above copyright notice and this paragraph are
121included on all such copies and derivative works.  However, this
122document itself may not be modified in any way, such as by removing
123the copyright notice or references to the Internet Society or other
124Internet organizations, except as needed for the purpose of
125developing Internet standards in which case the procedures for
126copyrights defined in the Internet Standards process must be
127followed, or as required to translate it into languages other than
128English.
129.Pp
130The limited permissions granted above are perpetual and will not be
131revoked by the Internet Society or its successors or assigns.
132.Pp
133This document and the information contained herein is provided on an
134"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
135TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
136BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
137HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
138MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
139