8207abca84
not the "manual page example" was introduced. Approved by: ed (mentor, implicit) MFC after: 1 week
137 lines
4.8 KiB
Groff
137 lines
4.8 KiB
Groff
.\" -*- nroff -*-
|
|
.\"
|
|
.\" Copyright (c) 2005 Doug Rabson
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.\" The following commands are required for all man pages.
|
|
.Dd January 26, 2010
|
|
.Os
|
|
.Dt GSS_CANONICALIZE_NAME 3 PRM
|
|
.Sh NAME
|
|
.Nm gss_canonicalize_name
|
|
.Nd Convert an internal name to an MN
|
|
.\" This next command is for sections 2 and 3 only.
|
|
.\" .Sh LIBRARY
|
|
.Sh SYNOPSIS
|
|
.In "gssapi/gssapi.h"
|
|
.Ft OM_uint32
|
|
.Fo gss_canonicalize_name
|
|
.Fa "OM_uint32 *minor_status"
|
|
.Fa "const gss_name_t input_name"
|
|
.Fa "const gss_OID mech_type"
|
|
.Fa "gss_name_t *output_name"
|
|
.Fc
|
|
.Sh DESCRIPTION
|
|
Generate a canonical mechanism name (MN) from an arbitrary internal
|
|
name.
|
|
The mechanism name is the name that would be returned to a context
|
|
acceptor on successful authentication of a context where the initiator
|
|
used the
|
|
.Fa input_name
|
|
in a successful call to
|
|
.Fn gss_acquire_cred ,
|
|
specifying an OID set containing
|
|
.Fa mech_type
|
|
as its only member,
|
|
followed by a call to
|
|
.Fn gss_init_sec_context ,
|
|
specifying
|
|
.Fa mech_type
|
|
as the authentication mechanism.
|
|
.Sh PARAMETERS
|
|
.Bl -tag
|
|
.It minor_status
|
|
Mechanism specific status code.
|
|
.It input_name
|
|
The name for which a canonical form is desired.
|
|
.It mech_type
|
|
The authentication mechanism for which the canonical form of the name
|
|
is desired.
|
|
The desired mechanism must be specified explicitly;
|
|
no default is provided.
|
|
.It output_name
|
|
The resultant canonical name.
|
|
Storage associated with this name must be freed by the application
|
|
after use with a call to
|
|
.Fn gss_release_name .
|
|
.El
|
|
.Sh RETURN VALUES
|
|
.Bl -tag
|
|
.It GSS_S_COMPLETE
|
|
Successful completion.
|
|
.It GSS_S_BAD_MECH
|
|
The identified mechanism is not supported.
|
|
.It GSS_S_BAD_NAMETYPE
|
|
The provided internal name contains no elements that could be
|
|
processed by the specified mechanism.
|
|
.It GSS_S_BAD_NAME
|
|
The provided internal name was ill-formed.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr gss_acquire_cred 3 ,
|
|
.Xr gss_init_sec_context 3 ,
|
|
.Xr gss_release_name 3
|
|
.Sh STANDARDS
|
|
.Bl -tag
|
|
.It RFC 2743
|
|
Generic Security Service Application Program Interface Version 2, Update 1
|
|
.It RFC 2744
|
|
Generic Security Service API Version 2 : C-bindings
|
|
.El
|
|
.Sh HISTORY
|
|
The
|
|
.Nm
|
|
function first appeared in
|
|
.Fx 7.0 .
|
|
.Sh AUTHORS
|
|
John Wray, Iris Associates
|
|
.Sh COPYRIGHT
|
|
Copyright (C) The Internet Society (2000). All Rights Reserved.
|
|
.Pp
|
|
This document and translations of it may be copied and furnished to
|
|
others, and derivative works that comment on or otherwise explain it
|
|
or assist in its implementation may be prepared, copied, published
|
|
and distributed, in whole or in part, without restriction of any
|
|
kind, provided that the above copyright notice and this paragraph are
|
|
included on all such copies and derivative works. However, this
|
|
document itself may not be modified in any way, such as by removing
|
|
the copyright notice or references to the Internet Society or other
|
|
Internet organizations, except as needed for the purpose of
|
|
developing Internet standards in which case the procedures for
|
|
copyrights defined in the Internet Standards process must be
|
|
followed, or as required to translate it into languages other than
|
|
English.
|
|
.Pp
|
|
The limited permissions granted above are perpetual and will not be
|
|
revoked by the Internet Society or its successors or assigns.
|
|
.Pp
|
|
This document and the information contained herein is provided on an
|
|
"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
|
|
TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
|
|
BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
|
|
HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
|
|
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
|