keyhole logo

Heimdal Kerberos 5 principal functions


Functions

void KRB5_LIB_FUNCTION krb5_free_principal (krb5_context context, krb5_principal p)
void KRB5_LIB_FUNCTION krb5_principal_set_type (krb5_context context, krb5_principal principal, int type)
unsigned int KRB5_LIB_FUNCTION krb5_principal_get_num_comp (krb5_context context, krb5_const_principal principal)
krb5_error_code KRB5_LIB_FUNCTION krb5_unparse_name_fixed (krb5_context context, krb5_const_principal principal, char *name, size_t len)
krb5_error_code KRB5_LIB_FUNCTION krb5_unparse_name_fixed_short (krb5_context context, krb5_const_principal principal, char *name, size_t len)
krb5_error_code KRB5_LIB_FUNCTION krb5_unparse_name_fixed_flags (krb5_context context, krb5_const_principal principal, int flags, char *name, size_t len)
krb5_error_code KRB5_LIB_FUNCTION krb5_unparse_name (krb5_context context, krb5_const_principal principal, char **name)
krb5_error_code KRB5_LIB_FUNCTION krb5_unparse_name_flags (krb5_context context, krb5_const_principal principal, int flags, char **name)
krb5_error_code KRB5_LIB_FUNCTION krb5_unparse_name_short (krb5_context context, krb5_const_principal principal, char **name)
krb5_error_code KRB5_LIB_FUNCTION krb5_principal_set_realm (krb5_context context, krb5_principal principal, krb5_const_realm realm)
krb5_boolean KRB5_LIB_FUNCTION krb5_principal_compare_any_realm (krb5_context context, krb5_const_principal princ1, krb5_const_principal princ2)
krb5_error_code KRB5_LIB_FUNCTION krb5_sname_to_principal (krb5_context context, const char *hostname, const char *sname, int32_t type, krb5_principal *ret_princ)

Detailed Description


Function Documentation

void KRB5_LIB_FUNCTION krb5_free_principal ( krb5_context  context,
krb5_principal  p 
)

Frees a Kerberos principal allocated by the library with krb5_parse_name(), krb5_make_principal() or any other related principal functions.

Parameters:
context A Kerberos context.
p a principal to free.
Returns:
An krb5 error code, see krb5_get_error_message().

krb5_boolean KRB5_LIB_FUNCTION krb5_principal_compare_any_realm ( krb5_context  context,
krb5_const_principal  princ1,
krb5_const_principal  princ2 
)

Return TRUE iff princ1 == princ2 (without considering the realm)

Parameters:
context Kerberos 5 context
princ1 first principal to compare
princ2 second principal to compare
Returns:
non zero if equal, 0 if not

unsigned int KRB5_LIB_FUNCTION krb5_principal_get_num_comp ( krb5_context  context,
krb5_const_principal  principal 
)

Get number of component is principal.

Parameters:
context Kerberos 5 context
principal principal to query
Returns:
number of components in string

krb5_error_code KRB5_LIB_FUNCTION krb5_principal_set_realm ( krb5_context  context,
krb5_principal  principal,
krb5_const_realm  realm 
)

Set a new realm for a principal, and as a side-effect free the previous realm.

Parameters:
context A Kerberos context.
principal principal set the realm for
realm the new realm to set
Returns:
An krb5 error code, see krb5_get_error_message().

void KRB5_LIB_FUNCTION krb5_principal_set_type ( krb5_context  context,
krb5_principal  principal,
int  type 
)

Set the type of the principal

Parameters:
context A Kerberos context.
principal principal to set the type for
type the new type
Returns:
An krb5 error code, see krb5_get_error_message().

krb5_error_code KRB5_LIB_FUNCTION krb5_sname_to_principal ( krb5_context  context,
const char *  hostname,
const char *  sname,
int32_t  type,
krb5_principal *  ret_princ 
)

Create a principal for the service running on hostname. If KRB5_NT_SRV_HST is used, the hostname is canonization using DNS (or some other service), this is potentially insecure.

Parameters:
context A Kerberos context.
hostname hostname to use
sname Service name to use
type name type of pricipal, use KRB5_NT_SRV_HST or KRB5_NT_UNKNOWN.
ret_princ return principal, free with krb5_free_principal().
Returns:
An krb5 error code, see krb5_get_error_message().

krb5_error_code KRB5_LIB_FUNCTION krb5_unparse_name ( krb5_context  context,
krb5_const_principal  principal,
char **  name 
)

Unparse the Kerberos name into a string

Parameters:
context Kerberos 5 context
principal principal to query
name resulting string, free with krb5_xfree()
Returns:
An krb5 error code, see krb5_get_error_message().

krb5_error_code KRB5_LIB_FUNCTION krb5_unparse_name_fixed ( krb5_context  context,
krb5_const_principal  principal,
char *  name,
size_t  len 
)

Unparse the principal name to a fixed buffer

Parameters:
context A Kerberos context.
principal principal to unparse
name buffer to write name to
len length of buffer
Returns:
An krb5 error code, see krb5_get_error_message().

krb5_error_code KRB5_LIB_FUNCTION krb5_unparse_name_fixed_flags ( krb5_context  context,
krb5_const_principal  principal,
int  flags,
char *  name,
size_t  len 
)

Unparse the principal name with unparse flags to a fixed buffer.

Parameters:
context A Kerberos context.
principal principal to unparse
flags unparse flags
name buffer to write name to
len length of buffer
Returns:
An krb5 error code, see krb5_get_error_message().

krb5_error_code KRB5_LIB_FUNCTION krb5_unparse_name_fixed_short ( krb5_context  context,
krb5_const_principal  principal,
char *  name,
size_t  len 
)

Unparse the principal name to a fixed buffer. The realm is skipped if its a default realm.

Parameters:
context A Kerberos context.
principal principal to unparse
name buffer to write name to
len length of buffer
Returns:
An krb5 error code, see krb5_get_error_message().

krb5_error_code KRB5_LIB_FUNCTION krb5_unparse_name_flags ( krb5_context  context,
krb5_const_principal  principal,
int  flags,
char **  name 
)

Unparse the Kerberos name into a string

Parameters:
context Kerberos 5 context
principal principal to query
flags flag to determine the behavior
name resulting string, free with krb5_xfree()
Returns:
An krb5 error code, see krb5_get_error_message().

krb5_error_code KRB5_LIB_FUNCTION krb5_unparse_name_short ( krb5_context  context,
krb5_const_principal  principal,
char **  name 
)

Unparse the principal name to a allocated buffer. The realm is skipped if its a default realm.

Parameters:
context A Kerberos context.
principal principal to unparse
name returned buffer, free with krb5_xfree()
Returns:
An krb5 error code, see krb5_get_error_message().


Generated on Thu Sep 3 10:49:01 2009 for HeimdalKerberos5library by doxygen 1.5.6