gss_export_name()--Create Opaque Token for a Mechanism Name

Syntax

 #include <krb5.h>

 krb5_error_code gss_export_name (
    OM_uint32 *                         minor_status,
    gss_name_t                          input_name,
    gss_buffer_t                  exported_name)

  Service Program Name: QSYS/QKRBGSS

  Default public authority: *USE

  Threadsafe: Yes

The gss_export_name() routine creates an opaque token for a mechanism name.

Parameters

minor_status (Output): Status code returned from the security mechanism.
input_name (Input): The GSS-API name to be exported. This must represent a mechanism name.
exported_name (Output): The token returned that represents the GSS-API name. The gss_release_buffer() routine should be called to release the token when it is no longer needed.

Return Value

The return value is one of the following status codes:

GSS_S_COMPLETE: The routine completed successfully.
GSS_S_FAILURE: The routine failed for reasons which are not defined at the GSS level. The minor_status return parameter contains a mechanism-dependent error code describing the reason for the failure.
GSS_S_NAME_NOT_MN: The supplied name is not a mechanism name. Use the gss_canonicalize_name() routine to convert an internal name to a mechanism name.
GSS_S_BAD_NAMETYPE: The input name is not supported by the current GSS-API Implementation.
GSS_S_BAD_NAME: The input name is not valid.

Authorities

None.

Error Messages

Message ID	Error Message Text
CPE3418 E	Possible APAR condition or hardware failure.
CPFA081 E	Unable to set return value or error code.

The gss_canonicalize_name() routine will convert a GSS-API internal name with multiple mechanism representations to a mechanism name. The gss_canonicalize_name() and gss_export_name() calls enable callers to acquire and process exported name objects, canonicalized and translated in accordance with the procedures of a particular GSS-API mechanism. Exported name objects can, in turn, be input to gss_import_name(), yielding equivalent mechanism names. These facilities are designed specifically to enable efficient storage and comparison of names (for example, for use in access control lists).

API introduced: V5R2

[ Back to top | Security APIs | UNIX-Type APIs | APIs by category ]