KRB5_PRINCIPAL_GET_... FreeBSD Library Functions Manual KRB5_PRINCIPAL_GET_...

NAME    [Toc]    [Back]

     krb5_principal_get_realm, krb5_principal_get_comp_string -- decompose a
     principal

LIBRARY    [Toc]    [Back]

     Kerberos 5 Library (libkrb5, -lkrb5)

SYNOPSIS    [Toc]    [Back]

     #include <krb5.h>

     const char *
     krb5_principal_get_realm(krb5_context context, krb5_principal principal);

     const char *
     krb5_principal_get_comp_string(krb5_context context,
         krb5_principal principal, unsigned int component);

DESCRIPTION    [Toc]    [Back]

     These functions return parts of the principal, either the realm or a specific
 component. The returned string points to data inside the principal,
     so they are valid only as long as the principal exists.

     The component argument to krb5_principal_get_comp_string() is the component
 number to return, from zero to the total number of components minus
     one. If a the requested component number is out of range, NULL is
     returned.

     These functions can be seen as a replacement for the krb5_princ_realm(),
     krb5_princ_component() and related macros, described as intermal in the
     MIT API specification. A difference is that these functions return
     strings, not krb5_data.  A reason to return krb5_data was that it was
     believed that principal components could contain binary data, but this
     belief was unfounded, and it has been decided that principal components
     are infact UTF8, so it's safe to use zero terminated strings.

     It's generally not necessary to look at the components of a principal.

SEE ALSO    [Toc]    [Back]

     krb5_unparse_name(3)

HEIMDAL                          June 20, 2001                         HEIMDAL