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
46
<holder>Teddy Hogeborn</holder>
35
47
<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/"/>.
49
<xi:include href="legalnotice.xml"/>
63
53
<refentrytitle>&COMMANDNAME;</refentrytitle>
64
54
<manvolnum>8</manvolnum>
160
163
<arg choice="plain"><option>-n
161
164
<replaceable>NAME</replaceable></option></arg>
167
<arg choice="plain"><option>--no-ssh</option></arg>
168
<arg choice="plain"><option>-S</option></arg>
165
172
<command>&COMMANDNAME;</command>
166
173
<group choice="req">
174
<arg choice="plain"><option>--help</option></arg>
167
175
<arg choice="plain"><option>-h</option></arg>
168
<arg choice="plain"><option>--help</option></arg>
172
179
<command>&COMMANDNAME;</command>
173
180
<group choice="req">
181
<arg choice="plain"><option>--version</option></arg>
174
182
<arg choice="plain"><option>-v</option></arg>
175
<arg choice="plain"><option>--version</option></arg>
178
185
</refsynopsisdiv>
180
187
<refsect1 id="description">
181
188
<title>DESCRIPTION</title>
183
190
<command>&COMMANDNAME;</command> is a program to generate the
185
<citerefentry><refentrytitle>password-request</refentrytitle>
191
TLS and OpenPGP keys used by
192
<citerefentry><refentrytitle>mandos-client</refentrytitle>
186
193
<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.
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.
192
It can also be used to generate ready-made sections for
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
193
203
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
194
<manvolnum>5</manvolnum></citerefentry> using the
195
<option>--password</option> option.
204
<manvolnum>5</manvolnum></citerefentry>).
199
208
<refsect1 id="purpose">
200
209
<title>PURPOSE</title>
203
211
The purpose of this is to enable <emphasis>remote and unattended
204
212
rebooting</emphasis> of client host computer with an
205
213
<emphasis>encrypted root file system</emphasis>. See <xref
206
214
linkend="overview"/> for details.
211
218
<refsect1 id="options">
212
219
<title>OPTIONS</title>
216
<term><literal>-h</literal>, <literal>--help</literal></term>
223
<term><option>--help</option></term>
224
<term><option>-h</option></term>
219
227
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>
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>
281
300
Email address of key. Default is empty.
287
<term><literal>-c</literal>, <literal>--comment</literal>
288
<replaceable>comment</replaceable></term>
306
<term><option>--comment
307
<replaceable>TEXT</replaceable></option></term>
309
<replaceable>TEXT</replaceable></option></term>
291
Comment field for key. The default value is
292
<quote><literal>Mandos client key</literal></quote>.
312
Comment field for key. Default is empty.
298
<term><literal>-x</literal>, <literal>--expire</literal>
299
<replaceable>time</replaceable></term>
318
<term><option>--expire
319
<replaceable>TIME</replaceable></option></term>
321
<replaceable>TIME</replaceable></option></term>
302
324
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
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>
322
357
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>
358
present in either <filename>/etc/keys/mandos</filename> or
359
the directory specified with the <option>--dir</option>
325
360
option. Outputs, on standard output, a section suitable
326
361
for inclusion in <citerefentry><refentrytitle
327
362
>mandos-clients.conf</refentrytitle><manvolnum
328
363
>8</manvolnum></citerefentry>. The host name or the name
329
364
specified with the <option>--name</option> option is used
330
365
for the section header. All other options are ignored,
331
and no keys are created.
366
and no key is created.
371
<term><option>--passfile
372
<replaceable>FILE</replaceable></option></term>
374
<replaceable>FILE</replaceable></option></term>
377
The same as <option>--password</option>, but read from
378
<replaceable>FILE</replaceable>, not the terminal.
383
<term><option>--no-ssh</option></term>
384
<term><option>-S</option></term>
387
When <option>--password</option> or
388
<option>--passfile</option> is given, this option will
389
prevent <command>&COMMANDNAME;</command> from calling
390
<command>ssh-keyscan</command> to get an SSH fingerprint
391
for this host and, if successful, output suitable config
392
options to use this fingerprint as a
393
<option>checker</option> option in the output. This is
394
otherwise the default behavior.
338
401
<refsect1 id="overview">
339
402
<title>OVERVIEW</title>
340
403
<xi:include href="overview.xml"/>
342
This program is a small utility to generate new OpenPGP keys for
405
This program is a small utility to generate new TLS and OpenPGP
406
keys for new Mandos clients, and to generate sections for
407
inclusion in <filename>clients.conf</filename> on the server.
347
411
<refsect1 id="exit_status">
348
412
<title>EXIT STATUS</title>
350
The exit status will be 0 if new keys were successfully created,
414
The exit status will be 0 if a new key (or password, if the
415
<option>--password</option> option was used) was successfully
416
created, otherwise not.
437
516
</informalexample>
519
Prompt for a password, encrypt it with the keys in <filename
520
class="directory">/etc/keys/mandos</filename> and output a
521
section suitable for <filename>clients.conf</filename>.
524
<userinput>&COMMANDNAME; --password</userinput>
529
Prompt for a password, encrypt it with the keys in the
530
<filename>client-key</filename> directory and output a section
531
suitable for <filename>clients.conf</filename>.
535
<!-- do not wrap this line -->
536
<userinput>&COMMANDNAME; --password --dir client-key</userinput>
440
542
<refsect1 id="security">
441
543
<title>SECURITY</title>
443
545
The <option>--type</option>, <option>--length</option>,
444
546
<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.
547
options can be used to create keys of low security. If in
548
doubt, leave them to the default values.
449
The key expire time is not guaranteed to be honored by
450
<citerefentry><refentrytitle>mandos</refentrytitle>
551
The key expire time is <emphasis>not</emphasis> guaranteed to be
552
honored by <citerefentry><refentrytitle>mandos</refentrytitle>
451
553
<manvolnum>8</manvolnum></citerefentry>.
455
557
<refsect1 id="see_also">
456
558
<title>SEE ALSO</title>
560
<citerefentry><refentrytitle>intro</refentrytitle>
561
<manvolnum>8mandos</manvolnum></citerefentry>,
458
562
<citerefentry><refentrytitle>gpg</refentrytitle>
459
563
<manvolnum>1</manvolnum></citerefentry>,
564
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
565
<manvolnum>5</manvolnum></citerefentry>,
460
566
<citerefentry><refentrytitle>mandos</refentrytitle>
461
567
<manvolnum>8</manvolnum></citerefentry>,
462
<citerefentry><refentrytitle>password-request</refentrytitle>
463
<manvolnum>8mandos</manvolnum></citerefentry>
568
<citerefentry><refentrytitle>mandos-client</refentrytitle>
569
<manvolnum>8mandos</manvolnum></citerefentry>,
570
<citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
571
<manvolnum>1</manvolnum></citerefentry>