xref: /minix3/crypto/external/bsd/heimdal/dist/lib/krb5/krb5_check_transited.3 (revision 0a6a1f1d05b60e214de2f05a7310ddd1f0e590e7)
1*0a6a1f1dSLionel Sambuc.\"	$NetBSD: krb5_check_transited.3,v 1.1.1.3 2014/04/24 12:45:50 pettai Exp $
2ebfedea0SLionel Sambuc.\"
3ebfedea0SLionel Sambuc.\" Copyright (c) 2004, 2006 Kungliga Tekniska Högskolan
4ebfedea0SLionel Sambuc.\" (Royal Institute of Technology, Stockholm, Sweden).
5ebfedea0SLionel Sambuc.\" All rights reserved.
6ebfedea0SLionel Sambuc.\"
7ebfedea0SLionel Sambuc.\" Redistribution and use in source and binary forms, with or without
8ebfedea0SLionel Sambuc.\" modification, are permitted provided that the following conditions
9ebfedea0SLionel Sambuc.\" are met:
10ebfedea0SLionel Sambuc.\"
11ebfedea0SLionel Sambuc.\" 1. Redistributions of source code must retain the above copyright
12ebfedea0SLionel Sambuc.\"    notice, this list of conditions and the following disclaimer.
13ebfedea0SLionel Sambuc.\"
14ebfedea0SLionel Sambuc.\" 2. Redistributions in binary form must reproduce the above copyright
15ebfedea0SLionel Sambuc.\"    notice, this list of conditions and the following disclaimer in the
16ebfedea0SLionel Sambuc.\"    documentation and/or other materials provided with the distribution.
17ebfedea0SLionel Sambuc.\"
18ebfedea0SLionel Sambuc.\" 3. Neither the name of the Institute nor the names of its contributors
19ebfedea0SLionel Sambuc.\"    may be used to endorse or promote products derived from this software
20ebfedea0SLionel Sambuc.\"    without specific prior written permission.
21ebfedea0SLionel Sambuc.\"
22ebfedea0SLionel Sambuc.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
23ebfedea0SLionel Sambuc.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24ebfedea0SLionel Sambuc.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25ebfedea0SLionel Sambuc.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
26ebfedea0SLionel Sambuc.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27ebfedea0SLionel Sambuc.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28ebfedea0SLionel Sambuc.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29ebfedea0SLionel Sambuc.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30ebfedea0SLionel Sambuc.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31ebfedea0SLionel Sambuc.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32ebfedea0SLionel Sambuc.\" SUCH DAMAGE.
33ebfedea0SLionel Sambuc.\"
34ebfedea0SLionel Sambuc.\" Id
35ebfedea0SLionel Sambuc.\"
36ebfedea0SLionel Sambuc.Dd May  1, 2006
37ebfedea0SLionel Sambuc.Dt KRB5_CHECK_TRANSITED 3
38ebfedea0SLionel Sambuc.Os
39ebfedea0SLionel Sambuc.Sh NAME
40ebfedea0SLionel Sambuc.Nm krb5_check_transited ,
41ebfedea0SLionel Sambuc.Nm krb5_check_transited_realms ,
42ebfedea0SLionel Sambuc.Nm krb5_domain_x500_decode ,
43ebfedea0SLionel Sambuc.Nm krb5_domain_x500_encode
44ebfedea0SLionel Sambuc.Nd realm transit verification and encoding/decoding functions
45ebfedea0SLionel Sambuc.Sh LIBRARY
46ebfedea0SLionel SambucKerberos 5 Library (libkrb5, -lkrb5)
47ebfedea0SLionel Sambuc.Sh SYNOPSIS
48ebfedea0SLionel Sambuc.In krb5/krb5.h
49ebfedea0SLionel Sambuc.Ft krb5_error_code
50ebfedea0SLionel Sambuc.Fo krb5_check_transited
51ebfedea0SLionel Sambuc.Fa "krb5_context context"
52ebfedea0SLionel Sambuc.Fa "krb5_const_realm client_realm"
53ebfedea0SLionel Sambuc.Fa "krb5_const_realm server_realm"
54ebfedea0SLionel Sambuc.Fa "krb5_realm *realms"
55ebfedea0SLionel Sambuc.Fa "int num_realms"
56ebfedea0SLionel Sambuc.Fa "int *bad_realm"
57ebfedea0SLionel Sambuc.Fc
58ebfedea0SLionel Sambuc.Ft krb5_error_code
59ebfedea0SLionel Sambuc.Fo krb5_check_transited_realms
60ebfedea0SLionel Sambuc.Fa "krb5_context context"
61ebfedea0SLionel Sambuc.Fa "const char *const *realms"
62ebfedea0SLionel Sambuc.Fa "int num_realms"
63ebfedea0SLionel Sambuc.Fa "int *bad_realm"
64ebfedea0SLionel Sambuc.Fc
65ebfedea0SLionel Sambuc.Ft krb5_error_code
66ebfedea0SLionel Sambuc.Fo krb5_domain_x500_decode
67ebfedea0SLionel Sambuc.Fa "krb5_context context"
68ebfedea0SLionel Sambuc.Fa "krb5_data tr"
69ebfedea0SLionel Sambuc.Fa "char ***realms"
70ebfedea0SLionel Sambuc.Fa "int *num_realms"
71ebfedea0SLionel Sambuc.Fa "const char *client_realm"
72ebfedea0SLionel Sambuc.Fa "const char *server_realm"
73ebfedea0SLionel Sambuc.Fc
74ebfedea0SLionel Sambuc.Ft krb5_error_code
75ebfedea0SLionel Sambuc.Fo krb5_domain_x500_encode
76ebfedea0SLionel Sambuc.Fa "char **realms"
77ebfedea0SLionel Sambuc.Fa "int num_realms"
78ebfedea0SLionel Sambuc.Fa "krb5_data *encoding"
79ebfedea0SLionel Sambuc.Fc
80ebfedea0SLionel Sambuc.Sh DESCRIPTION
81ebfedea0SLionel Sambuc.Fn krb5_check_transited
82ebfedea0SLionel Sambucchecks the path from
83ebfedea0SLionel Sambuc.Fa client_realm
84ebfedea0SLionel Sambucto
85ebfedea0SLionel Sambuc.Fa server_realm
86ebfedea0SLionel Sambucwhere
87ebfedea0SLionel Sambuc.Fa realms
88ebfedea0SLionel Sambucand
89ebfedea0SLionel Sambuc.Fa num_realms
90ebfedea0SLionel Sambucis the realms between them.
91ebfedea0SLionel SambucIf the function returns an error value,
92ebfedea0SLionel Sambuc.Fa bad_realm
93ebfedea0SLionel Sambucwill be set to the realm in the list causing the error.
94ebfedea0SLionel Sambuc.Fn krb5_check_transited
95ebfedea0SLionel Sambucis used internally by the KDC and libkrb5 and should not be called by
96ebfedea0SLionel Sambucclient applications.
97ebfedea0SLionel Sambuc.Pp
98ebfedea0SLionel Sambuc.Fn krb5_check_transited_realms
99ebfedea0SLionel Sambucis deprecated.
100ebfedea0SLionel Sambuc.Pp
101ebfedea0SLionel Sambuc.Fn krb5_domain_x500_encode
102ebfedea0SLionel Sambucand
103ebfedea0SLionel Sambuc.Fn krb5_domain_x500_decode
104ebfedea0SLionel Sambucencodes and decodes the realm names in the X500 format that Kerberos
105ebfedea0SLionel Sambucuses to describe the transited realms in krbtgts.
106ebfedea0SLionel Sambuc.Sh SEE ALSO
107ebfedea0SLionel Sambuc.Xr krb5 3 ,
108ebfedea0SLionel Sambuc.Xr krb5.conf 5
109