xref: /illumos-gate/usr/src/man/man3gss/gss_canonicalize_name.3gss (revision b6805bf78d2bbbeeaea8909a05623587b42d58b3)
te
Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
GSS_CANONICALIZE_NAME 3GSS "Jan 14, 2003"
NAME
gss_canonicalize_name - convert an internal name to a mechanism name
SYNOPSIS

cc [flag .\|.\|.] file.\|.\|. -lgss [library .\|.\|.]
#include <gssapi/gssapi.h>

OM_uint32 gss_canonicalize_name(OM_uint32 *minor_status,
 const gss_name_t input_name,const gss_OID mech_type,
 gss_name_t *output_name);
DESCRIPTION

The gss_canonicalize_name() function generates a canonical mechanism name 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 input_name in a successful call to gss_acquire_cred(3GSS), specifying an OID set containing mech_type as its only member, followed by a call to gss_init_sec_context(3GSS), specifying mech_type as the authentication mechanism.

PARAMETERS

The parameter descriptions for gss_canonicalize_name() follow: minor_status

Mechanism-specific status code.

input_name

The name for which a canonical form is desired.

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.

output_name

The resultant canonical name. Storage associated with this name must be freed by the application after use with a call to gss_release_name(3GSS).

ERRORS

The gss_canonicalize_name() function may return the status codes: GSS_S_COMPLETE

Successful completion.

GSS_S_BAD_MECH

The identified mechanism is not supported.

GSS_S_BAD_NAMETYPE

The provided internal name contains no elements that could be processed by the specified mechanism.

GSS_S_BAD_NAME

The provided internal name was ill-formed.

GSS_S_FAILURE

The underlying mechanism detected an error for which no specific GSS status code is defined. The mechanism-specific status code reported by means of the minor_status parameter details the error condition.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level Safe
SEE ALSO

gss_acquire_cred(3GSS), gss_init_sec_context(3GSS), gss_release_name(3GSS), attributes(5)

Solaris Security for Developers Guide