crypto/dist/heimdal/lib/krb5/verify_krb5_conf.8

   1 .\" Copyright (c) 2000 - 2004 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 .\" $Heimdal: verify_krb5_conf.8 14375 2004-12-08 17:52:41Z lha $
  33 .\" $NetBSD: verify_krb5_conf.8,v 1.9 2008/03/22 08:37:15 mlelstv Exp $
  34 .\"
  35 .Dd December  8, 2004
  36 .Dt VERIFY_KRB5_CONF 8
  37 .Os
  38 .Sh NAME
  39 .Nm verify_krb5_conf
  40 .Nd checks krb5.conf for obvious errors
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Ar [config-file]
  44 .Sh DESCRIPTION
  45 .Nm
  46 reads the configuration file
  47 .Pa krb5.conf ,
  48 or the file given on the command line,
  49 and parses it, thereby verifying that the syntax is not correctly wrong.
  50 .Pp
  51 If the file is syntactically correct,
  52 .Nm
  53 tries to verify that the contents of the file is of relevant nature.
  54 .Sh ENVIRONMENT
  55 .Ev KRB5_CONFIG
  56 points to the configuration file to read.
  57 .Sh FILES
  58 .Bl -tag -width /etc/krb5.conf -compact
  59 .It Pa /etc/krb5.conf
  60 Kerberos 5 configuration file
  61 .El
  62 .Sh DIAGNOSTICS
  63 Possible output from
  64 .Nm
  65 include:
  66 .Bl -tag -width "FpathF"
  67 .It "<path>: failed to parse <something> as size/time/number/boolean"
  68 Usually means that <something> is misspelled, or that it contains
  69 weird characters. The parsing done by
  70 .Nm
  71 is more strict than the one performed by libkrb5, so strings that
  72 work in real life might be reported as bad.
  73 .It "<path>: host not found (<hostname>)"
  74 Means that <path> is supposed to point to a host, but it can't be
  75 recognised as one.
  76 .It <path>: unknown or wrong type
  77 Means that <path> is either a string when it should be a list, vice
  78 versa, or just that
  79 .Nm
  80 is confused.
  81 .It <path>: unknown entry
  82 Means that <string> is not known by
  83 .Nm .
  84 .El
  85 .Sh SEE ALSO
  86 .Xr krb5.conf 5
  87 .Sh BUGS
  88 Since each application can put almost anything in the config file,
  89 it's hard to come up with a watertight verification process. Most of
  90 the default settings are sanity checked, but this does not mean that
  91 every problem is discovered, or that everything that is reported as a
  92 possible problem actually is one. This tool should thus be used with
  93 some care.
  94 .Pp
  95 It should warn about obsolete data, or bad practice, but currently
  96 doesn't.