11
12
<title>Mandos Manual</title>
12
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
<productname>Mandos</productname>
14
<productnumber>&VERSION;</productnumber>
15
<productnumber>&version;</productnumber>
15
16
<date>&TIMESTAMP;</date>
18
19
<firstname>Björn</firstname>
19
20
<surname>Påhlsson</surname>
21
<email>belorn@fukt.bsnet.se</email>
22
<email>belorn@recompile.se</email>
25
26
<firstname>Teddy</firstname>
26
27
<surname>Hogeborn</surname>
28
<email>teddy@fukt.bsnet.se</email>
29
<email>teddy@recompile.se</email>
34
45
<holder>Teddy Hogeborn</holder>
35
46
<holder>Björn Påhlsson</holder>
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/"/>.
48
<xi:include href="legalnotice.xml"/>
63
52
<refentrytitle>&COMMANDNAME;</refentrytitle>
64
53
<manvolnum>8</manvolnum>
160
162
<arg choice="plain"><option>-n
161
163
<replaceable>NAME</replaceable></option></arg>
166
<arg choice="plain"><option>--no-ssh</option></arg>
167
<arg choice="plain"><option>-S</option></arg>
165
171
<command>&COMMANDNAME;</command>
166
172
<group choice="req">
173
<arg choice="plain"><option>--help</option></arg>
167
174
<arg choice="plain"><option>-h</option></arg>
168
<arg choice="plain"><option>--help</option></arg>
172
178
<command>&COMMANDNAME;</command>
173
179
<group choice="req">
180
<arg choice="plain"><option>--version</option></arg>
174
181
<arg choice="plain"><option>-v</option></arg>
175
<arg choice="plain"><option>--version</option></arg>
178
184
</refsynopsisdiv>
180
186
<refsect1 id="description">
181
187
<title>DESCRIPTION</title>
183
189
<command>&COMMANDNAME;</command> is a program to generate the
185
<citerefentry><refentrytitle>password-request</refentrytitle>
190
TLS and OpenPGP keys used by
191
<citerefentry><refentrytitle>mandos-client</refentrytitle>
186
192
<manvolnum>8mandos</manvolnum></citerefentry>. The keys are
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.
193
normally written to /etc/keys/mandos for later installation into
194
the initrd image, but this, and most other things, can be
195
changed with command line options.
192
It can also be used to generate ready-made sections for
198
This program can also be used with the
199
<option>--password</option> or <option>--passfile</option>
200
options to generate a ready-made section for
201
<filename>clients.conf</filename> (see
193
202
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
194
<manvolnum>5</manvolnum></citerefentry> using the
195
<option>--password</option> option.
203
<manvolnum>5</manvolnum></citerefentry>).
199
207
<refsect1 id="purpose">
200
208
<title>PURPOSE</title>
203
210
The purpose of this is to enable <emphasis>remote and unattended
204
211
rebooting</emphasis> of client host computer with an
205
212
<emphasis>encrypted root file system</emphasis>. See <xref
206
213
linkend="overview"/> for details.
211
217
<refsect1 id="options">
212
218
<title>OPTIONS</title>
216
<term><literal>-h</literal>, <literal>--help</literal></term>
222
<term><option>--help</option></term>
223
<term><option>-h</option></term>
219
226
Show a help message and exit
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>
233
<replaceable>DIRECTORY</replaceable></option></term>
235
<replaceable>DIRECTORY</replaceable></option></term>
238
Target directory for key files. Default is <filename
239
class="directory">/etc/keys/mandos</filename>.
246
<replaceable>TYPE</replaceable></option></term>
248
<replaceable>TYPE</replaceable></option></term>
251
OpenPGP key type. Default is <quote>RSA</quote>.
257
<term><option>--length
258
<replaceable>BITS</replaceable></option></term>
260
<replaceable>BITS</replaceable></option></term>
263
OpenPGP key length in bits. Default is 4096.
269
<term><option>--subtype
270
<replaceable>KEYTYPE</replaceable></option></term>
272
<replaceable>KEYTYPE</replaceable></option></term>
275
OpenPGP subkey type. Default is <quote>RSA</quote>
281
<term><option>--sublength
282
<replaceable>BITS</replaceable></option></term>
284
<replaceable>BITS</replaceable></option></term>
287
OpenPGP subkey length in bits. Default is 4096.
293
<term><option>--email
294
<replaceable>ADDRESS</replaceable></option></term>
296
<replaceable>ADDRESS</replaceable></option></term>
281
299
Email address of key. Default is empty.
287
<term><literal>-c</literal>, <literal>--comment</literal>
288
<replaceable>comment</replaceable></term>
305
<term><option>--comment
306
<replaceable>TEXT</replaceable></option></term>
308
<replaceable>TEXT</replaceable></option></term>
291
Comment field for key. The default value is
292
<quote><literal>Mandos client key</literal></quote>.
311
Comment field for key. Default is empty.
298
<term><literal>-x</literal>, <literal>--expire</literal>
299
<replaceable>time</replaceable></term>
317
<term><option>--expire
318
<replaceable>TIME</replaceable></option></term>
320
<replaceable>TIME</replaceable></option></term>
302
323
Key expire time. Default is no expiration. See
310
<term><literal>-f</literal>, <literal>--force</literal></term>
313
Force overwriting old keys.
318
<term><literal>-p</literal>, <literal>--password</literal
331
<term><option>--tls-keytype
332
<replaceable>KEYTYPE</replaceable></option></term>
334
<replaceable>KEYTYPE</replaceable></option></term>
337
TLS key type. Default is <quote>ed25519</quote>
343
<term><option>--force</option></term>
344
<term><option>-f</option></term>
347
Force overwriting old key.
352
<term><option>--password</option></term>
353
<term><option>-p</option></term>
322
356
Prompt for a password and encrypt it with the key already
323
present in either <filename>/etc/mandos</filename> or the
324
directory specified with the <option>--dir</option>
357
present in either <filename>/etc/keys/mandos</filename> or
358
the directory specified with the <option>--dir</option>
325
359
option. Outputs, on standard output, a section suitable
326
360
for inclusion in <citerefentry><refentrytitle
327
361
>mandos-clients.conf</refentrytitle><manvolnum
328
362
>8</manvolnum></citerefentry>. The host name or the name
329
363
specified with the <option>--name</option> option is used
330
364
for the section header. All other options are ignored,
331
and no keys are created.
365
and no key is created.
370
<term><option>--passfile
371
<replaceable>FILE</replaceable></option></term>
373
<replaceable>FILE</replaceable></option></term>
376
The same as <option>--password</option>, but read from
377
<replaceable>FILE</replaceable>, not the terminal.
382
<term><option>--no-ssh</option></term>
383
<term><option>-S</option></term>
386
When <option>--password</option> or
387
<option>--passfile</option> is given, this option will
388
prevent <command>&COMMANDNAME;</command> from calling
389
<command>ssh-keyscan</command> to get an SSH fingerprint
390
for this host and, if successful, output suitable config
391
options to use this fingerprint as a
392
<option>checker</option> option in the output. This is
393
otherwise the default behavior.
338
400
<refsect1 id="overview">
339
401
<title>OVERVIEW</title>
340
402
<xi:include href="overview.xml"/>
342
This program is a small utility to generate new OpenPGP keys for
404
This program is a small utility to generate new TLS and OpenPGP
405
keys for new Mandos clients, and to generate sections for
406
inclusion in <filename>clients.conf</filename> on the server.
347
410
<refsect1 id="exit_status">
348
411
<title>EXIT STATUS</title>
350
The exit status will be 0 if new keys were successfully created,
413
The exit status will be 0 if a new key (or password, if the
414
<option>--password</option> option was used) was successfully
415
created, otherwise not.
437
515
</informalexample>
518
Prompt for a password, encrypt it with the keys in <filename
519
class="directory">/etc/keys/mandos</filename> and output a
520
section suitable for <filename>clients.conf</filename>.
523
<userinput>&COMMANDNAME; --password</userinput>
528
Prompt for a password, encrypt it with the keys in the
529
<filename>client-key</filename> directory and output a section
530
suitable for <filename>clients.conf</filename>.
534
<!-- do not wrap this line -->
535
<userinput>&COMMANDNAME; --password --dir client-key</userinput>
440
541
<refsect1 id="security">
441
542
<title>SECURITY</title>
443
544
The <option>--type</option>, <option>--length</option>,
444
545
<option>--subtype</option>, and <option>--sublength</option>
445
options can be used to create keys of insufficient security. If
446
in doubt, leave them to the default values.
546
options can be used to create keys of low security. If in
547
doubt, leave them to the default values.
449
The key expire time is not guaranteed to be honored by
450
<citerefentry><refentrytitle>mandos</refentrytitle>
550
The key expire time is <emphasis>not</emphasis> guaranteed to be
551
honored by <citerefentry><refentrytitle>mandos</refentrytitle>
451
552
<manvolnum>8</manvolnum></citerefentry>.
455
556
<refsect1 id="see_also">
456
557
<title>SEE ALSO</title>
559
<citerefentry><refentrytitle>intro</refentrytitle>
560
<manvolnum>8mandos</manvolnum></citerefentry>,
458
561
<citerefentry><refentrytitle>gpg</refentrytitle>
459
562
<manvolnum>1</manvolnum></citerefentry>,
563
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
564
<manvolnum>5</manvolnum></citerefentry>,
460
565
<citerefentry><refentrytitle>mandos</refentrytitle>
461
566
<manvolnum>8</manvolnum></citerefentry>,
462
<citerefentry><refentrytitle>password-request</refentrytitle>
463
<manvolnum>8mandos</manvolnum></citerefentry>
567
<citerefentry><refentrytitle>mandos-client</refentrytitle>
568
<manvolnum>8mandos</manvolnum></citerefentry>,
569
<citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
570
<manvolnum>1</manvolnum></citerefentry>