lib/krb5/krb5_check_transited.3

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