xref: /illumos-gate/usr/src/man/man3gss/gss_import_name.3gss (revision bbf215553c7233fbab8a0afdf1fac74c44781867)
te
Copyright (C) 2005, 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_IMPORT_NAME 3GSS "Jun 30, 2005"
NAME
gss_import_name - convert a contiguous string name to GSS_API internal format
SYNOPSIS

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

OM_uint32 gss_import_name(OM_uint32 * minor_status,
 const gss_buffer_t input_name_buffer, const gss_OID input_name_type,
 gss_name_t *output_name);
DESCRIPTION

The gss_import_name() function converts a contiguous string name to internal form. In general, the internal name returned by means of the output_name parameter will not be a mechanism name; the exception to this is if the input_name_type indicates that the contiguous string provided by means of the input_name_buffer parameter is of type GSS_C_NT_EXPORT_NAME, in which case, the returned internal name will be a mechanism name for the mechanism that exported the name.

PARAMETERS

The parameter descriptions for gss_import_name() follow: minor_status

Status code returned by the underlying mechanism.

input_name_buffer

The gss_buffer_desc structure containing the name to be imported.

input_name_type

A gss_OID that specifies the format that the input_name_buffer is in.

output_name

The gss_name_t structure to receive the returned name in internal form. Storage associated with this name must be freed by the application after use with a call to gss_release_name().

ERRORS

The gss_import_name() function may return the following status codes: GSS_S_COMPLETE

The gss_import_name() function completed successfully.

GSS_S_BAD_NAMETYPE

The input_name_type was unrecognized.

GSS_S_BAD_NAME

The input_name parameter could not be interpreted as a name of the specified type.

GSS_S_BAD_MECH

The input_name_type was GSS_C_NT_EXPORT_NAME, but the mechanism contained within the input_name is not supported.

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(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level Safe
SEE ALSO

gss_release_buffer (3GSS), attributes (7)

Solaris Security for Developers Guide