HP Open Source Security for OpenVMS Volume 3: Kerberos > Chapter 5 GSSAPI (Generic Security Services Application Programming Interface)

gss_display_name — Provide textual representation of opaque internal name

 » Table of Contents

 » Glossary

 » Index

C Prototype

OM_uint32 gss_display_name(
OM_uint32 * minor_status,
gss_name_t input_name,
gss_buffer_t output_name_buffer,
gss_OID * output_name_type );

Arguments

minor_status (output) 

An implementation-specific status code.

input_name (input) 

The name to be displayed.

output_name_buffer (output) 

A buffer to receive the textual name string. The application must free storage associated with this name after use with a call to gss_release_buffer.

output_name_type (output) 

The type of the returned name. The returned gss_OID will be a pointer into static storage, and should be treated as read-only by the caller. (In particular, the application should not attempt to free it). Specify NULL if not required.

Description

This routine allows an application to obtain a textual representation of an opaque internal-form name for display purposes. The syntax of a printable name is defined by the GSSAPI implementation.

If input_name denotes an anonymous principal, the routine will return the gss_OID value GSS_C_NT_ANONYMOUS as the output_name_type, and a textual name that is syntactically distinct from all valid supported printable names in the output_name_buffer.

Return Values

This routine returns one of the following GSS status codes:

GSS_S_COMPLETE

Successful completion.
GSS_S_BAD_NAMETYPEThe type of input_name was not recognized.
GSS_S_BAD_NAMEThe input_name was ill formed.