chiark - git - mdw - tripe/blob - keys/tripe-keys.conf.5.in

   1 .\" -*-nroff-*-
   2 .\".
   3 .\" Manual for the key-management configuration files
   4 .\"
   5 .\" (c) 2008 Straylight/Edgeware
   6 .\"
   7 .
   8 .\"----- Licensing notice ---------------------------------------------------
   9 .\"
  10 .\" This file is part of Trivial IP Encryption (TrIPE).
  11 .\"
  12 .\" TrIPE is free software; you can redistribute it and/or modify
  13 .\" it under the terms of the GNU General Public License as published by
  14 .\" the Free Software Foundation; either version 2 of the License, or
  15 .\" (at your option) any later version.
  16 .\"
  17 .\" TrIPE is distributed in the hope that it will be useful,
  18 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 .\" GNU General Public License for more details.
  21 .\"
  22 .\" You should have received a copy of the GNU General Public License
  23 .\" along with TrIPE; if not, write to the Free Software Foundation,
  24 .\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  25 .
  26 .\"--------------------------------------------------------------------------
  27 .so ../common/defs.man \" @@@PRE@@@
  28 .
  29 .\"--------------------------------------------------------------------------
  30 .TH tripe-keys.conf 5tripe "14 September 2005" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
  31 .
  32 .\"--------------------------------------------------------------------------
  33 .SH "NAME"
  34 .
  35 tripe-keys.conf \- configuration file format for tripe-keys
  36 .
  37 .\"--------------------------------------------------------------------------
  38 .SH "DESCRIPTION"
  39 .
  40 The
  41 .B tripe-keys.master
  42 or
  43 .B tripe-keys.conf
  44 file is a simple line-based configuration file read by
  45 .BR tripe-keys (1).
  46 Lines may be empty (consist only of whitespace), be comments (first
  47 non-whitespace character is
  48 .RB ` # ')
  49 or have the form
  50 .IP
  51 .I name
  52 .RB [ = ]
  53 .I value
  54 .PP
  55 A
  56 .I name
  57 consists of alphanumeric characters and hyphens.  Values may contain
  58 substitutions, of the form
  59 .BI ${ name } \fR,
  60 which are replaced by the value assigned to
  61 .IR name .
  62 Many
  63 .IR name s
  64 have significance to the
  65 .B tripe-keys
  66 program: these are described below.  Many have sensible defaults.
  67 .SS "The tripe-keys.master file"
  68 The client configuration file is built by applying substitutions to the
  69 .B tripe-keys.master
  70 file.  The following tokens are substituted:
  71 .TP
  72 .B @MASTER-SEQUENCE@
  73 The sequence number of the most recently-added signing key.
  74 .TP
  75 .B @HK-MASTER@
  76 The fingerprint of the signing key identified by
  77 .BR @MASTER-SEQUENCE@ .
  78 .SS "Master repository parameters"
  79 .TP
  80 .I base-url
  81 The base URL of the key repository (usually with a trailing
  82 .RB ` / ').
  83 Typically, this will be something like
  84 .RB http://www.distorted.org.uk/vpn/ .
  85 No default.
  86 .TP
  87 .I repos-base
  88 The basename for the repository archive.  Default is
  89 .BR tripe-keys.tar.gz .
  90 .TP
  91 .I sig-base
  92 The basename template for repository signatures.  Default is
  93 .BR tripe-keys.sig-<SEQ> .
  94 The
  95 .RB ` <SEQ> '
  96 portion, if any, is replaced by the sequence number of the key which
  97 made the signature.
  98 .TP
  99 .I repos-url
 100 The URL for the key repository tarball.  Default is the concatenation of
 101 .I base-url
 102 and
 103 .IR repos-base .
 104 .TP
 105 .I sig-url
 106 The URL template for key repository signatures.  Default is the
 107 concatenation of
 108 .I base-url
 109 and
 110 .IR sig-base .
 111 .TP
 112 .I master-sequence
 113 The sequence number of the master authority's current signing key.  No
 114 default.  Usually set up automatically.
 115 .TP
 116 .I master-keygen-flags
 117 Additional options for generating master keys.  Default is
 118 .RB ` -l '.
 119 .TP
 120 .I master-attrs
 121 Additional attributes to set on the master key,
 122 as
 123 .IB key = value
 124 pairs separated by spaces.
 125 Default is empty.
 126 .TP
 127 .I hk-master
 128 The fingerprint of the current master signing key.  No default.  Usually
 129 set up automatically.
 130 .TP
 131 .I upload-hook
 132 A shell command to run by
 133 .B tripe-keys upload
 134 after it has successfully written the
 135 .I repos-file
 136 and
 137 .IR sig-file s.
 138 Default is
 139 .B ": run upload hook"
 140 which does nothing.
 141 .SS "Crypto parameters"
 142 .TP
 143 .I kx
 144 Key-exchange algorithm to use.  Either
 145 .B dh
 146 (integer Diffie-Hellman)
 147 or
 148 .B ec
 149 (elliptic curves).  The default is
 150 .BR dh .
 151 .ne 7
 152 .TP
 153 .I kx-genalg
 154 Key generation algorithm name to pass to
 155 .B "key add"
 156 when generating keys.
 157 Default depends on
 158 .I kx
 159 as follows.
 160 .TS
 161 center;
 162 | ci | ci |
 163 | lb | lb |.
 164 _
 165 kx      kx-genalg
 166 _
 167 dh      dh
 168 ec      ec
 169 _
 170 .TE
 171 .ne 7
 172 .TP
 173 .I kx-param-genalg
 174 Key generation algorithm name to pass to
 175 .B "key add"
 176 when generating the parameters key.
 177 Default depends on
 178 .I kx
 179 as follows.
 180 .TS
 181 center;
 182 | ci | ci |
 183 | lb | lb |.
 184 _
 185 kx      kx-param-genalg
 186 _
 187 dh      dh-param
 188 ec      ec-param
 189 _
 190 .TE
 191 .ne 7
 192 .TP
 193 .I kx-param
 194 Options to pass to
 195 .B "key add"
 196 when generating the parameters key.  Default depends on
 197 .I kx
 198 as follows.
 199 .TS
 200 center;
 201 | ci | ci |
 202 | lb | lb |.
 203 _
 204 kx      kx-param
 205 _
 206 dh      \-LS \-b3072 \-B256
 207 ec      \-Cnist-p256
 208 _
 209 .TE
 210 .TP
 211 .I kx-attrs
 212 Additional attributes to set on the parameters
 213 (and therefore copied to peer keys),
 214 as
 215 .IB key = value
 216 pairs separated by spaces.
 217 Default is
 218 .BR serialization=constlen .
 219 .TP
 220 .I kx-expire
 221 Expiry time for generated keys.  Default is
 222 .BR "now + 1 year" .
 223 .TP
 224 .I hash
 225 Hashing algorithm to use.  Default is
 226 .BR sha256 .
 227 .TP
 228 .I bulk
 229 The bulk crypto transform to use.
 230 Default is
 231 .BR iiv .
 232 .ne 8
 233 .TP
 234 .I mac
 235 Message authentication algorithm to use.
 236 Default depends on
 237 .I bulk
 238 as follows.
 239 .TS
 240 center;
 241 | ci | ci |
 242 | lb | lb |.
 243 _
 244 bulk    mac
 245 _
 246 v0      \fIhash\fB-hmac/\fIhalfhashlen
 247 iiv     \fIhash\fB-hmac/\fIhalfhashlenrijndael-cbc
 248 naclbox poly1305/128
 249 _
 250 .TE
 251 .IP
 252 (In the above,
 253 .I halfhashlen
 254 is half of
 255 .IR hash 's
 256 output length.)
 257 .TP
 258 .I mgf
 259 Mask-generation algorithm to use.  Default is
 260 .IB hash -mgf \fR.
 261 This is probably a good choice.
 262 .ne 7
 263 .TP
 264 .I cipher
 265 Symmetric encryption scheme to use.
 266 Default depends on
 267 .I bulk
 268 as follows.
 269 .TS
 270 center;
 271 | ci | ci |
 272 | lb | lb |.
 273 _
 274 bulk    cipher
 275 _
 276 v0      rijndael-cbc
 277 iiv     rijndael-cbc
 278 naclbox chacha20
 279 _
 280 .TE
 281 .ne 7
 282 .TP
 283 .I sig
 284 Signature scheme to use.  Must be one of those recognized by
 285 .BR catsign (1).
 286 Default depends on
 287 .I kx
 288 as follows.
 289 .TS
 290 center;
 291 | ci | ci |
 292 | lb | lb |.
 293 _
 294 kx      sig
 295 _
 296 dh      dsa
 297 ec      ecdsa
 298 _
 299 .TE
 300 .ne 12
 301 .TP
 302 .I sig-genalg
 303 Key-generation algorithm for signing key.  Default depends on
 304 .I sig
 305 as follows.
 306 .TS
 307 center;
 308 | ci | ci |
 309 | lb | lb |.
 310 _
 311 sig     sig-genalg
 312 _
 313 kcdsa   dh
 314 dsa     dsa
 315 rsapcs1 rsa
 316 rsapss  rsa
 317 ecdsa   ec
 318 eckcdsa ec
 319 ed25519 ed25519
 320 ed448   ed448
 321 _
 322 .TE
 323 .ne 10
 324 .TP
 325 .I sig-param
 326 Signature-key generation parameters.  Default depends on
 327 .I sig-genalg
 328 as follows.
 329 .TS
 330 center;
 331 | ci | ci |
 332 | lb | lb |.
 333 _
 334 sig-genalg      sig-param
 335 _
 336 dh      \-LS \-b3072 \-B256
 337 dsa     \-b3072 \-B256
 338 rsa     \-b3072
 339 ec      \-Cnist-p256
 340 ed25519 \fInone
 341 ed448   \fInone
 342 _
 343 .TE
 344 .TP
 345 .I sig-hash
 346 Hash function to use for making signatures.  Default is
 347 .IR hash .
 348 .TP
 349 .I sig-fresh
 350 Oldest time we should consider a signed archive to be fresh.  Default is
 351 .BR always ,
 352 meaning that all signatures are fresh.
 353 .TP
 354 .I sig-expire
 355 Expiry time for master signing key.  Default is
 356 .BR forever .
 357 .TP
 358 .I fingerprint-hash
 359 Hash function to use for key fingerprinting.  Default is
 360 .IR hash .
 361 .SS "Master maintenance parameters"
 362 .TP
 363 .I base-dir
 364 Local base directory for the repository files.  This probably ought to
 365 end in a
 366 .RB ` / '
 367 character.  Unexpected files in this directory will be removed by the
 368 .B tripe-keys upload
 369 command.  No default.
 370 .TP
 371 .I repos-file
 372 Filename for local repository tarball.  Default is the concatenation of
 373 .I base-dir
 374 and
 375 .IB repos-base .
 376 .TP
 377 .I sig-file
 378 Template for repository signatures.  Default is the concatenation of
 379 .I base-dir
 380 and
 381 .IR sig-base .
 382 .TP
 383 .I conf-file
 384 Filename for local repository configuration file.  Default is
 385 .IB basedir /tripe-keys.conf \fR.
 386 .TP
 387 .I kx-warn-days
 388 The
 389 .B "tripe-keys check"
 390 command will warn about keys which will in less than
 391 .I kx-warn-days
 392 days.  Default is 28.
 393 .
 394 .\"--------------------------------------------------------------------------
 395 .SH "SEE ALSO"
 396 .
 397 .BR tripe (8),
 398 .BR tripe\-keys (8).
 399 .
 400 .\"--------------------------------------------------------------------------
 401 .SH "AUTHOR"
 402 .
 403 Mark Wooding, <mdw@distorted.org.uk>
 404 .
 405 .\"----- That's all, folks --------------------------------------------------