KRB5_RD_ERROR

Section: C Library Functions (3) Local index Up

BSD mandoc
HEIMDAL

NAME

krb5_rd_error krb5_free_error krb5_free_error_contents krb5_error_from_rd_error - parse, free and read error from KRB-ERROR message

LIBRARY

Kerberos 5 Library (libkrb5, -lkrb5)

SYNOPSIS

In krb5.h Ft krb5_error_code Fo krb5_rd_error Fa krb5_context context Fa const krb5_data *msg Fa KRB_ERROR *result Fc Ft void Fo krb5_free_error Fa krb5_context context Fa krb5_error *error Fc Ft void Fo krb5_free_error_contents Fa krb5_context context Fa krb5_error *error Fc Ft krb5_error_code Fo krb5_error_from_rd_error Fa krb5_context context Fa const krb5_error *error Fa const krb5_creds *creds Fc

DESCRIPTION

Usually applications never needs to parse and understand Kerberos error messages since higher level functions will parse and push up the error in the krb5_context. These functions are described for completeness.

Fn krb5_rd_error parses and returns the kerboeros error message, the structure should be freed with Fn krb5_free_error_contents when the caller is done with the structure.

Fn krb5_free_error frees the content and the memory region holding the structure iself.

Fn krb5_free_error_contents free the content of the KRB-ERROR message.

Fn krb5_error_from_rd_error will parse the error message and set the error buffer in krb5_context to the error string passed back or the matching error code in the KRB-ERROR message. Caller should pick up the message with Fn krb5_get_error_string 3 (don't forget to free the returned string with Fn krb5_free_error_string ) .