107 lines
3.3 KiB
Groff
107 lines
3.3 KiB
Groff
.\" Copyright (c) 2004, 2006 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: krb5_check_transited.3 17382 2006-05-01 07:09:16Z lha $
|
|
.\"
|
|
.Dd May 1, 2006
|
|
.Dt KRB5_CHECK_TRANSITED 3
|
|
.Os HEIMDAL
|
|
.Sh NAME
|
|
.Nm krb5_check_transited ,
|
|
.Nm krb5_check_transited_realms ,
|
|
.Nm krb5_domain_x500_decode ,
|
|
.Nm krb5_domain_x500_encode
|
|
.Nd realm transit verification and encoding/decoding functions
|
|
.Sh LIBRARY
|
|
Kerberos 5 Library (libkrb5, -lkrb5)
|
|
.Sh SYNOPSIS
|
|
.In krb5.h
|
|
.Ft krb5_error_code
|
|
.Fo krb5_check_transited
|
|
.Fa "krb5_context context"
|
|
.Fa "krb5_const_realm client_realm"
|
|
.Fa "krb5_const_realm server_realm"
|
|
.Fa "krb5_realm *realms"
|
|
.Fa "int num_realms"
|
|
.Fa "int *bad_realm"
|
|
.Fc
|
|
.Ft krb5_error_code
|
|
.Fo krb5_check_transited_realms
|
|
.Fa "krb5_context context"
|
|
.Fa "const char *const *realms"
|
|
.Fa "int num_realms"
|
|
.Fa "int *bad_realm"
|
|
.Fc
|
|
.Ft krb5_error_code
|
|
.Fo krb5_domain_x500_decode
|
|
.Fa "krb5_context context"
|
|
.Fa "krb5_data tr"
|
|
.Fa "char ***realms"
|
|
.Fa "int *num_realms"
|
|
.Fa "const char *client_realm"
|
|
.Fa "const char *server_realm"
|
|
.Fc
|
|
.Ft krb5_error_code
|
|
.Fo krb5_domain_x500_encode
|
|
.Fa "char **realms"
|
|
.Fa "int num_realms"
|
|
.Fa "krb5_data *encoding"
|
|
.Fc
|
|
.Sh DESCRIPTION
|
|
.Fn krb5_check_transited
|
|
checks the path from
|
|
.Fa client_realm
|
|
to
|
|
.Fa server_realm
|
|
where
|
|
.Fa realms
|
|
and
|
|
.Fa num_realms
|
|
is the realms between them.
|
|
If the function returns an error value,
|
|
.Fa bad_realm
|
|
will be set to the realm in the list causing the error.
|
|
.Fn krb5_check_transited
|
|
is used internally by the KDC and libkrb5 and should not be called by
|
|
client applications.
|
|
.Pp
|
|
.Fn krb5_check_transited_realms
|
|
is deprecated.
|
|
.Pp
|
|
.Fn krb5_domain_x500_encode
|
|
and
|
|
.Fn krb5_domain_x500_decode
|
|
encodes and decodes the realm names in the X500 format that Kerberos
|
|
uses to describe the transited realms in krbtgts.
|
|
.Sh SEE ALSO
|
|
.Xr krb5 3 ,
|
|
.Xr krb5.conf 5
|