man/man3gss/gss_oid_to_str.3gss

         te
 Copyright (c) 2007, 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_oid_to_str 3GSS "15 Aug 2007" "SunOS 5.11" "Generic Security Services API Library Functions"
 NAME
gss_oid_to_str - convert an OID to a string
 SYNOPSIS

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

gss_oid_to_str(OM_uint32 *minor_status, const gss_OID oid,
 gss_buffer_toid_str);


 PARAMETERS

minor_status

Status code returned by underlying mechanism.


oid

GSS-API OID structure to convert.


oid_str

String to receive converted OID.


 DESCRIPTION

The gss_oid_to_str() function converts a GSS-API OID
structure to a string. You can use the function to convert the name of a
mechanism from an OID to a simple string. This function is a convenience
function, as is its complementary function, gss_str_to_oid(3GSS).

If an OID must be created, use gss_create_empty_oid_set(3GSS) and
gss_add_oid_set_member(3GSS) to create it. OIDs created in this
way must be released with gss_release_oid_set(3GSS). However, it is
strongly suggested that applications use the default GSS-API mechanism
instead of creating an OID for a specific mechanism.
 ERRORS

The gss_oid_to_str() function returns one of the following status codes:

GSS_S_CALL_INACCESSIBLE_READ

A required input parameter could not be read.


GSS_S_CALL_INACCESSIBLE_WRITE

A required output parameter could not be written.


GSS_S_COMPLETE

Successful completion.


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 TYPEATTRIBUTE VALUE
MT-LevelSafe


 SEE ALSO

gss_add_oid_set_member(3GSS), gss_create_empty_oid_set(3GSS),
gss_release_oid_set(3GSS), gss_str_to_oid(3GSS),
attributes(5)

Solaris Security for Developers Guide
 WARNINGS

This function is included for compatibility only with programs using earlier
versions of the GSS-API and should not be used for new programs. Other
implementations of the GSS-API might not support this function, so
portable programs should not rely on it. Sun might not continue to support this
function.