bf932fdd72
git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@11685 ec53bebd-3082-4978-b11e-865c3cabbd6b
82 lines
3.2 KiB
Groff
82 lines
3.2 KiB
Groff
.\" Copyright (c) 2001 Kungliga Tekniska Högskolan
|
|
.\" (Royal Institute of Technology, Stockholm, Sweden).
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\"
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\"
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" 3. Neither the name of the Institute nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" $Id$
|
|
.\"
|
|
.Dd June 20, 2001
|
|
.Dt KRB5_PRINCIPAL_GET_REALM 3
|
|
.Os HEIMDAL
|
|
.Sh NAME
|
|
.Nm krb5_principal_get_realm ,
|
|
.Nm krb5_principal_get_comp_string
|
|
.Nd decompose a principal
|
|
.Sh LIBRARY
|
|
Kerberos 5 Library (libkrb5, -lkrb5)
|
|
.Sh SYNOPSIS
|
|
.Fd #include <krb5.h>
|
|
.Ft "const char *"
|
|
.Fn krb5_principal_get_realm "krb5_context context" "krb5_principal principal"
|
|
.Ft "const char *"
|
|
.Fn krb5_principal_get_comp_string "krb5_context context" "krb5_principal principal" "unsigned int component"
|
|
.Sh DESCRIPTION
|
|
These functions return parts of the
|
|
.Fa 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.
|
|
.Pp
|
|
The
|
|
.Fa component
|
|
argument to
|
|
.Fn 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,
|
|
.Dv NULL
|
|
is returned.
|
|
.Pp
|
|
These functions can be seen as a replacement for the
|
|
.Fn krb5_princ_realm ,
|
|
.Fn krb5_princ_component
|
|
and related macros, described as intermal in the MIT API
|
|
specification. A difference is that these functions return strings,
|
|
not
|
|
.Dv krb5_data .
|
|
A reason to return
|
|
.Dv 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.
|
|
.Pp
|
|
It's generally not necessary to look at the components of a principal.
|
|
.Sh SEE ALSO
|
|
.Xr krb5_unparse_name 3
|