12
11
<title>Mandos Manual</title>
13
12
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
14
<productnumber>&VERSION;</productnumber>
16
15
<date>&TIMESTAMP;</date>
19
18
<firstname>Björn</firstname>
20
19
<surname>Påhlsson</surname>
22
<email>belorn@recompile.se</email>
21
<email>belorn@fukt.bsnet.se</email>
26
25
<firstname>Teddy</firstname>
27
26
<surname>Hogeborn</surname>
29
<email>teddy@recompile.se</email>
28
<email>teddy@fukt.bsnet.se</email>
46
34
<holder>Teddy Hogeborn</holder>
47
35
<holder>Björn Påhlsson</holder>
49
<xi:include href="legalnotice.xml"/>
39
This manual page is free software: you can redistribute it
40
and/or modify it under the terms of the GNU General Public
41
License as published by the Free Software Foundation,
42
either version 3 of the License, or (at your option) any
47
This manual page is distributed in the hope that it will
48
be useful, but WITHOUT ANY WARRANTY; without even the
49
implied warranty of MERCHANTABILITY or FITNESS FOR A
50
PARTICULAR PURPOSE. See the GNU General Public License
55
You should have received a copy of the GNU General Public
56
License along with this program; If not, see
57
<ulink url="http://www.gnu.org/licenses/"/>.
53
63
<refentrytitle>&COMMANDNAME;</refentrytitle>
54
64
<manvolnum>8</manvolnum>
127
138
<replaceable>TIME</replaceable></option></arg>
131
<arg choice="plain"><option>--tls-keytype
132
<replaceable>KEYTYPE</replaceable></option></arg>
133
<arg choice="plain"><option>-T
134
<replaceable>KEYTYPE</replaceable></option></arg>
138
<arg choice="plain"><option>--force</option></arg>
139
<arg choice="plain"><option>-f</option></arg>
141
<arg><option>--force</option></arg>
143
144
<command>&COMMANDNAME;</command>
144
145
<group choice="req">
145
146
<arg choice="plain"><option>--password</option></arg>
146
147
<arg choice="plain"><option>-p</option></arg>
147
<arg choice="plain"><option>--passfile
148
<replaceable>FILE</replaceable></option></arg>
149
<arg choice="plain"><option>-F</option>
150
<replaceable>FILE</replaceable></arg>
185
178
</refsynopsisdiv>
187
180
<refsect1 id="description">
188
181
<title>DESCRIPTION</title>
190
183
<command>&COMMANDNAME;</command> is a program to generate the
191
TLS and OpenPGP keys used by
192
<citerefentry><refentrytitle>mandos-client</refentrytitle>
185
<citerefentry><refentrytitle>password-request</refentrytitle>
193
186
<manvolnum>8mandos</manvolnum></citerefentry>. The keys are
194
normally written to /etc/keys/mandos for later installation into
195
the initrd image, but this, and most other things, can be
196
changed with command line options.
187
normally written to /etc/mandos for later installation into the
188
initrd image, but this, like most things, can be changed with
189
command line options.
199
This program can also be used with the
200
<option>--password</option> or <option>--passfile</option>
201
options to generate a ready-made section for
202
<filename>clients.conf</filename> (see
192
It can also be used to generate ready-made sections for
203
193
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
204
<manvolnum>5</manvolnum></citerefentry>).
194
<manvolnum>5</manvolnum></citerefentry> using the
195
<option>--password</option> option.
208
199
<refsect1 id="purpose">
209
200
<title>PURPOSE</title>
211
203
The purpose of this is to enable <emphasis>remote and unattended
212
204
rebooting</emphasis> of client host computer with an
213
205
<emphasis>encrypted root file system</emphasis>. See <xref
214
206
linkend="overview"/> for details.
218
211
<refsect1 id="options">
219
212
<title>OPTIONS</title>
223
<term><option>--help</option></term>
224
<term><option>-h</option></term>
216
<term><literal>-h</literal>, <literal>--help</literal></term>
227
219
Show a help message and exit
234
<replaceable>DIRECTORY</replaceable></option></term>
236
<replaceable>DIRECTORY</replaceable></option></term>
239
Target directory for key files. Default is <filename
240
class="directory">/etc/keys/mandos</filename>.
247
<replaceable>TYPE</replaceable></option></term>
249
<replaceable>TYPE</replaceable></option></term>
252
OpenPGP key type. Default is <quote>RSA</quote>.
258
<term><option>--length
259
<replaceable>BITS</replaceable></option></term>
261
<replaceable>BITS</replaceable></option></term>
264
OpenPGP key length in bits. Default is 4096.
270
<term><option>--subtype
271
<replaceable>KEYTYPE</replaceable></option></term>
273
<replaceable>KEYTYPE</replaceable></option></term>
276
OpenPGP subkey type. Default is <quote>RSA</quote>
282
<term><option>--sublength
283
<replaceable>BITS</replaceable></option></term>
285
<replaceable>BITS</replaceable></option></term>
288
OpenPGP subkey length in bits. Default is 4096.
294
<term><option>--email
295
<replaceable>ADDRESS</replaceable></option></term>
297
<replaceable>ADDRESS</replaceable></option></term>
225
<term><literal>-d</literal>, <literal>--dir
226
<replaceable>directory</replaceable></literal></term>
229
Target directory for key files. Default is
230
<filename>/etc/mandos</filename>.
236
<term><literal>-t</literal>, <literal>--type
237
<replaceable>type</replaceable></literal></term>
240
Key type. Default is <quote>DSA</quote>.
246
<term><literal>-l</literal>, <literal>--length
247
<replaceable>bits</replaceable></literal></term>
250
Key length in bits. Default is 2048.
256
<term><literal>-s</literal>, <literal>--subtype
257
<replaceable>type</replaceable></literal></term>
260
Subkey type. Default is <quote>ELG-E</quote> (Elgamal
267
<term><literal>-L</literal>, <literal>--sublength
268
<replaceable>bits</replaceable></literal></term>
271
Subkey length in bits. Default is 2048.
277
<term><literal>-e</literal>, <literal>--email</literal>
278
<replaceable>address</replaceable></term>
300
281
Email address of key. Default is empty.
306
<term><option>--comment
307
<replaceable>TEXT</replaceable></option></term>
309
<replaceable>TEXT</replaceable></option></term>
287
<term><literal>-c</literal>, <literal>--comment</literal>
288
<replaceable>comment</replaceable></term>
312
Comment field for key. Default is empty.
291
Comment field for key. The default value is
292
<quote><literal>Mandos client key</literal></quote>.
318
<term><option>--expire
319
<replaceable>TIME</replaceable></option></term>
321
<replaceable>TIME</replaceable></option></term>
298
<term><literal>-x</literal>, <literal>--expire</literal>
299
<replaceable>time</replaceable></term>
324
302
Key expire time. Default is no expiration. See
332
<term><option>--tls-keytype
333
<replaceable>KEYTYPE</replaceable></option></term>
335
<replaceable>KEYTYPE</replaceable></option></term>
338
TLS key type. Default is <quote>ed25519</quote>
344
<term><option>--force</option></term>
345
<term><option>-f</option></term>
348
Force overwriting old key.
353
<term><option>--password</option></term>
354
<term><option>-p</option></term>
310
<term><literal>-f</literal>, <literal>--force</literal></term>
313
Force overwriting old keys.
318
<term><literal>-p</literal>, <literal>--password</literal
357
322
Prompt for a password and encrypt it with the key already
358
present in either <filename>/etc/keys/mandos</filename> or
359
the directory specified with the <option>--dir</option>
323
present in either <filename>/etc/mandos</filename> or the
324
directory specified with the <option>--dir</option>
360
325
option. Outputs, on standard output, a section suitable
361
326
for inclusion in <citerefentry><refentrytitle
362
327
>mandos-clients.conf</refentrytitle><manvolnum
363
328
>8</manvolnum></citerefentry>. The host name or the name
364
329
specified with the <option>--name</option> option is used
365
330
for the section header. All other options are ignored,
366
and no key is created. Note: white space is stripped from
367
the beginning and from the end of the password; See <xref
373
<term><option>--passfile
374
<replaceable>FILE</replaceable></option></term>
376
<replaceable>FILE</replaceable></option></term>
379
The same as <option>--password</option>, but read from
380
<replaceable>FILE</replaceable>, not the terminal, and
381
white space is not stripped from the password in any way.
386
<term><option>--no-ssh</option></term>
387
<term><option>-S</option></term>
390
When <option>--password</option> or
391
<option>--passfile</option> is given, this option will
392
prevent <command>&COMMANDNAME;</command> from calling
393
<command>ssh-keyscan</command> to get an SSH fingerprint
394
for this host and, if successful, output suitable config
395
options to use this fingerprint as a
396
<option>checker</option> option in the output. This is
397
otherwise the default behavior.
331
and no keys are created.
404
338
<refsect1 id="overview">
405
339
<title>OVERVIEW</title>
406
340
<xi:include href="overview.xml"/>
408
This program is a small utility to generate new TLS and OpenPGP
409
keys for new Mandos clients, and to generate sections for
410
inclusion in <filename>clients.conf</filename> on the server.
342
This program is a small utility to generate new OpenPGP keys for
414
347
<refsect1 id="exit_status">
415
348
<title>EXIT STATUS</title>
417
The exit status will be 0 if a new key (or password, if the
418
<option>--password</option> option was used) was successfully
419
created, otherwise not.
350
The exit status will be 0 if new keys were successfully created,
526
437
</informalexample>
529
Prompt for a password, encrypt it with the keys in <filename
530
class="directory">/etc/keys/mandos</filename> and output a
531
section suitable for <filename>clients.conf</filename>.
534
<userinput>&COMMANDNAME; --password</userinput>
539
Prompt for a password, encrypt it with the keys in the
540
<filename>client-key</filename> directory and output a section
541
suitable for <filename>clients.conf</filename>.
545
<!-- do not wrap this line -->
546
<userinput>&COMMANDNAME; --password --dir client-key</userinput>
552
440
<refsect1 id="security">
553
441
<title>SECURITY</title>
555
443
The <option>--type</option>, <option>--length</option>,
556
444
<option>--subtype</option>, and <option>--sublength</option>
557
options can be used to create keys of low security. If in
558
doubt, leave them to the default values.
445
options can be used to create keys of insufficient security. If
446
in doubt, leave them to the default values.
561
The key expire time is <emphasis>not</emphasis> guaranteed to be
562
honored by <citerefentry><refentrytitle>mandos</refentrytitle>
449
The key expire time is not guaranteed to be honored by
450
<citerefentry><refentrytitle>mandos</refentrytitle>
563
451
<manvolnum>8</manvolnum></citerefentry>.
567
455
<refsect1 id="see_also">
568
456
<title>SEE ALSO</title>
570
<citerefentry><refentrytitle>intro</refentrytitle>
571
<manvolnum>8mandos</manvolnum></citerefentry>,
572
458
<citerefentry><refentrytitle>gpg</refentrytitle>
573
459
<manvolnum>1</manvolnum></citerefentry>,
574
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
575
<manvolnum>5</manvolnum></citerefentry>,
576
460
<citerefentry><refentrytitle>mandos</refentrytitle>
577
461
<manvolnum>8</manvolnum></citerefentry>,
578
<citerefentry><refentrytitle>mandos-client</refentrytitle>
579
<manvolnum>8mandos</manvolnum></citerefentry>,
580
<citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
581
<manvolnum>1</manvolnum></citerefentry>
462
<citerefentry><refentrytitle>password-request</refentrytitle>
463
<manvolnum>8mandos</manvolnum></citerefentry>