external/bsd/bind/dist/contrib/zkt-1.1.3/man/zkt-conf.8

   1 .\"     $NetBSD: zkt-conf.8,v 1.1.1.1 2015/07/08 15:37:49 christos Exp $
   2 .\"
   3 .TH zkt-conf 8 "February 22, 2010" "ZKT 1.0" ""
   4 \" turn off hyphenation
   5 .\"     if n .nh
   6 .nh
   7 .SH NAME
   8 zkt-conf \(em Secure DNS zone key config tool
   9
  10 .SH SYNOPSYS
  11 .na
  12 .B zkt-conf
  13 .RB [ \-V
  14 .IR "name" ]
  15 .RB [ \-w ]
  16 .B \-d
  17 .RB [ \-O
  18 .IR "optstr" ]
  19 .br
  20 .B zkt-conf
  21 .RB [ \-V
  22 .IR "name" ]
  23 .RB [ \-w ]
  24 .RB [ \-s ]
  25 .RB [ \-c
  26 .IR "file" ]
  27 .RB [ \-O
  28 .IR "optstr" ]
  29 .br
  30 .B zkt-conf
  31 .RB [ \-V
  32 .IR "name" ]
  33 .RB [ \-w ]
  34 .B  \-l
  35 .RB [ \-a ]
  36 .RB [ \-c
  37 .IR "file" ]
  38 .RB [ \-O
  39 .IR "optstr" ]
  40
  41 .B zkt-conf
  42 .RB [ \-c
  43 .IR "file" ]
  44 .RB [ \-w ]
  45 .I "zonefile"
  46
  47 .br
  48 .ad
  49 .SH DESCRIPTION
  50 The
  51 .I zkt-conf
  52 command helps to create and show a config file for use by
  53 the Zone Key Tool commands, which are currently
  54 .I zkt-ls(8) ,
  55 .I zkt-keyman(8) ,
  56 and
  57 .IR zkt-signer(8) .
  58 .PP
  59 In general, the ZKT commands uses up to three consequitive sources for config
  60 parameter settings:
  61 .IP
  62 a)
  63 The build-in default parameters
  64 .IP
  65 b)
  66 The side wide config file or the file specified with option -c
  67 overloads the built-in vars.
  68 The file is
  69 .I /var/named/dnssec.conf
  70 or the one set by the environment variable ZKT_CONFFILE.
  71 .IP
  72 c)
  73 The local config file
  74 .I dnssec.conf
  75 in the current zone directory also overloads the parameter read so far.
  76 .PP
  77 Because of the overload feature, none of the config files has to have
  78 a complete parameter set.
  79 Typically the local config file will have only those parameters which are
  80 different from the global or built-in ones.
  81 .PP
  82 The default operation of
  83 .I zkt-conf(8)
  84 is to print the site wide config file (same as option
  85 .BR \-s ).
  86 Option
  87 .B \-d
  88 will print out the built-in defaults while
  89 .B \-l
  90 print those local parameters which are different to the global ones.
  91 In the last case
  92 .B \-a
  93 gives the fully
  94 .RB ( \-\-all )
  95 parameter list.
  96 .PP
  97 In all forms of the command, the parameters are changeable via option
  98 .B \-O
  99 .RB ( \-\-config-option ).
 100 .PP
 101 With option
 102 .B \-w
 103 .RB ( \-\-write )
 104 the confg parameters are written back to the config file.
 105 This is useful in case of an ZKT upgrade or if one or more parameters are changed
 106 by option
 107 .BR \-O .
 108 .PP
 109 Option
 110 .B \-t
 111 checks some of the parameter for reasonable values.
 112 .PP
 113 .PP
 114 Which config file is shown (or modified or checked) is determined by an option.
 115 .B \-d
 116 means the built-in defaults, option
 117 .B \-l
 118 is for the local config file and
 119 .B \-s
 120 specifies the site wide config file.
 121 Option
 122 .B \-s
 123 is the default.
 124 .PP
 125 In the last form of the command, the
 126 maximum TTL value of all the resource records of
 127 .I zonefile
 128 is calculated and print on stdout.
 129 Additional, the zonefile is checked if the key database
 130 .RI ( dnskey.db )
 131 is included in the zone file.
 132 If option
 133 .B \-w
 134 is set, than the INCLUDE directive will be added to the zone file if
 135 necessary, and the maximum ttl value is written to a local config file.
 136
 137 .SH COMMAND OPTIONS
 138 .TP
 139 .BR \-h ", " \-\-help
 140 Print out the online help.
 141 .TP
 142 .BR \-d ", " \-\-built-in-defaults
 143 List all the built-in default parameter.
 144 .TP
 145 .BR \-s ", " \-\-sitecfg
 146 List all site wide config parameter (this is the default).
 147 .TP
 148 .BR \-l ", "  \-\-localcfg
 149 List local config parameter which are different to the site wide config
 150 parameter.
 151 With otion
 152 .B \-a
 153 .RB ( \-\-all )
 154 all config parameters will be shown.
 155
 156 .SH OPTIONS
 157 .TP
 158 .BI \-V " view" ", \-\-view=" view
 159 Try to read the default configuration out of a file named
 160 .I dnssec-<view>.conf .
 161 Instead of specifying the
 162 .B \-V
 163 or
 164 .B \-\-view
 165 option every time, it is also possible to create a hard or softlink to the
 166 executable file and name it like
 167 .I zkt-conf-<view> .
 168 .TP
 169 .BI \-c " file" ", \-\-config=" file
 170 Read all parameter from the specified config file.
 171 Otherwise the default config file is read or build in defaults
 172 will be used.
 173 .TP
 174 .BI \-O " optstr" ", \-\-config-option=" optstr
 175 Set any config file parameter via the commandline.
 176 Several config file options could be specified at the argument string
 177 but have to be delimited by semicolon (or newline).
 178 .TP
 179 .BR \-a ", " \-\-all
 180 In case of showing the local config file parameter
 181 .RB ( \-l )
 182 this prints all parameter, not just the ones different to the site wide
 183 or built-in defaults.
 184
 185 .SH SAMPLE USAGE
 186 .TP
 187 .fam C
 188 .B "zkt-conf \-d
 189 .fam T
 190 Print the built-in default config pars.
 191 .TP
 192 .fam C
 193 .B "zkt-conf \-d \-w
 194 .fam T
 195 Write all the built-in defaults into the site wide config file.
 196 .TP
 197 .fam C
 198 .B "zkt-conf \-s \-O ""SerialFormat: Incremental; Zonedir: /var/named/zones"" \-w"
 199 .fam T
 200 Change two parameters in the site wide
 201 .I dnssec.conf
 202 file.
 203 .TP
 204 .fam C
 205 .B "zkt-conf \-w zone.db
 206 .fam T
 207 Add
 208 .B "$INCLUDE dnskey.db"
 209 to the zone file and set the maximum ttl paramter in the local config file
 210 to the maximum ttl fond in any RR of
 211 .IR zone.db .
 212
 213 .SH ENVIRONMENT VARIABLES
 214 .TP
 215 ZKT_CONFFILE
 216 Specifies the name of the default global configuration files.
 217
 218 .SH FILES
 219 .TP
 220 .I /var/named/dnssec.conf
 221 Default global configuration file.
 222 The name of the default global config file is settable via
 223 the environment variable ZKT_CONFFILE.
 224 .TP
 225 .I /var/named/dnssec-<view>.conf
 226 View specific global configuration file.
 227 .TP
 228 .I ./dnssec.conf
 229 Local configuration file (additionally used in
 230 .B \-l
 231 mode).
 232
 233 .SH AUTHORS
 234 Holger Zuleger
 235
 236 .SH COPYRIGHT
 237 Copyright (c) 2005 \- 2010 by Holger Zuleger.
 238 Licensed under the BSD Licences. There is NO warranty; not even for MERCHANTABILITY or
 239 FITNESS FOR A PARTICULAR PURPOSE.
 240 .\"--------------------------------------------------
 241 .SH SEE ALSO
 242 dnssec-keygen(8), dnssec-signzone(8), rndc(8), named.conf(5), zkt-signer(8), zkt-ls(8), zkt-keyman(8),
 243 .br
 244 RFC4641
 245 "DNSSEC Operational Practices" by Miek Gieben and Olaf Kolkman,
 246 .br
 247 DNSSEC HOWTO Tutorial by Olaf Kolkman, RIPE NCC
 248 .br
 249 (http://www.nlnetlabs.nl/dnssec_howto/)