48
66
<refname><command>&COMMANDNAME;</command></refname>
50
Generate key and password for Mandos client and server.
68
Generate keys for <citerefentry><refentrytitle>password-request
69
</refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>
56
75
<command>&COMMANDNAME;</command>
58
<arg choice="plain"><option>--dir
59
<replaceable>DIRECTORY</replaceable></option></arg>
60
<arg choice="plain"><option>-d
61
<replaceable>DIRECTORY</replaceable></option></arg>
65
<arg choice="plain"><option>--type
66
<replaceable>KEYTYPE</replaceable></option></arg>
67
<arg choice="plain"><option>-t
68
<replaceable>KEYTYPE</replaceable></option></arg>
72
<arg choice="plain"><option>--length
73
<replaceable>BITS</replaceable></option></arg>
74
<arg choice="plain"><option>-l
75
<replaceable>BITS</replaceable></option></arg>
79
<arg choice="plain"><option>--subtype
80
<replaceable>KEYTYPE</replaceable></option></arg>
81
<arg choice="plain"><option>-s
82
<replaceable>KEYTYPE</replaceable></option></arg>
86
<arg choice="plain"><option>--sublength
87
<replaceable>BITS</replaceable></option></arg>
88
<arg choice="plain"><option>-L
89
<replaceable>BITS</replaceable></option></arg>
93
<arg choice="plain"><option>--name
94
<replaceable>NAME</replaceable></option></arg>
95
<arg choice="plain"><option>-n
96
<replaceable>NAME</replaceable></option></arg>
100
<arg choice="plain"><option>--email
101
<replaceable>ADDRESS</replaceable></option></arg>
102
<arg choice="plain"><option>-e
103
<replaceable>ADDRESS</replaceable></option></arg>
107
<arg choice="plain"><option>--comment
108
<replaceable>TEXT</replaceable></option></arg>
109
<arg choice="plain"><option>-c
110
<replaceable>TEXT</replaceable></option></arg>
114
<arg choice="plain"><option>--expire
115
<replaceable>TIME</replaceable></option></arg>
116
<arg choice="plain"><option>-x
117
<replaceable>TIME</replaceable></option></arg>
120
<arg><option>--force</option></arg>
123
<command>&COMMANDNAME;</command>
125
<arg choice="plain"><option>--password</option></arg>
126
<arg choice="plain"><option>-p</option></arg>
127
<arg choice="plain"><option>--passfile
128
<replaceable>FILE</replaceable></option></arg>
129
<arg choice="plain"><option>-F</option>
130
<replaceable>FILE</replaceable></arg>
134
<arg choice="plain"><option>--dir
135
<replaceable>DIRECTORY</replaceable></option></arg>
136
<arg choice="plain"><option>-d
137
<replaceable>DIRECTORY</replaceable></option></arg>
141
<arg choice="plain"><option>--name
142
<replaceable>NAME</replaceable></option></arg>
143
<arg choice="plain"><option>-n
144
<replaceable>NAME</replaceable></option></arg>
148
<command>&COMMANDNAME;</command>
77
<arg choice="plain"><option>--dir</option>
78
<replaceable>directory</replaceable></arg>
81
<arg choice="plain"><option>--type</option>
82
<replaceable>type</replaceable></arg>
85
<arg choice="plain"><option>--length</option>
86
<replaceable>bits</replaceable></arg>
89
<arg choice="plain"><option>--subtype</option>
90
<replaceable>type</replaceable></arg>
93
<arg choice="plain"><option>--sublength</option>
94
<replaceable>bits</replaceable></arg>
97
<arg choice="plain"><option>--name</option>
98
<replaceable>NAME</replaceable></arg>
101
<arg choice="plain"><option>--email</option>
102
<replaceable>EMAIL</replaceable></arg>
105
<arg choice="plain"><option>--comment</option>
106
<replaceable>COMMENT</replaceable></arg>
109
<arg choice="plain"><option>--expire</option>
110
<replaceable>TIME</replaceable></arg>
113
<arg choice="plain"><option>--force</option></arg>
117
<command>&COMMANDNAME;</command>
119
<arg choice="plain"><option>-d</option>
120
<replaceable>directory</replaceable></arg>
123
<arg choice="plain"><option>-t</option>
124
<replaceable>type</replaceable></arg>
127
<arg choice="plain"><option>-l</option>
128
<replaceable>bits</replaceable></arg>
131
<arg choice="plain"><option>-s</option>
132
<replaceable>type</replaceable></arg>
135
<arg choice="plain"><option>-L</option>
136
<replaceable>bits</replaceable></arg>
139
<arg choice="plain"><option>-n</option>
140
<replaceable>NAME</replaceable></arg>
143
<arg choice="plain"><option>-e</option>
144
<replaceable>EMAIL</replaceable></arg>
147
<arg choice="plain"><option>-c</option>
148
<replaceable>COMMENT</replaceable></arg>
151
<arg choice="plain"><option>-x</option>
152
<replaceable>TIME</replaceable></arg>
155
<arg choice="plain"><option>-f</option></arg>
159
<command>&COMMANDNAME;</command>
161
<arg choice="plain"><option>-h</option></arg>
150
162
<arg choice="plain"><option>--help</option></arg>
151
<arg choice="plain"><option>-h</option></arg>
155
166
<command>&COMMANDNAME;</command>
156
167
<group choice="req">
168
<arg choice="plain"><option>-v</option></arg>
157
169
<arg choice="plain"><option>--version</option></arg>
158
<arg choice="plain"><option>-v</option></arg>
161
172
</refsynopsisdiv>
163
174
<refsect1 id="description">
164
175
<title>DESCRIPTION</title>
166
177
<command>&COMMANDNAME;</command> is a program to generate the
168
<citerefentry><refentrytitle>mandos-client</refentrytitle>
169
<manvolnum>8mandos</manvolnum></citerefentry>. The key is
179
<citerefentry><refentrytitle>password-request</refentrytitle>
180
<manvolnum>8mandos</manvolnum></citerefentry>. The keys are
170
181
normally written to /etc/mandos for later installation into the
171
initrd image, but this, and most other things, can be changed
172
with command line options.
175
This program can also be used with the
176
<option>--password</option> or <option>--passfile</option>
177
options to generate a ready-made section for
178
<filename>clients.conf</filename> (see
179
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
180
<manvolnum>5</manvolnum></citerefentry>).
182
initrd image, but this, like most things, can be changed with
183
command line options.
184
187
<refsect1 id="purpose">
185
188
<title>PURPOSE</title>
187
191
The purpose of this is to enable <emphasis>remote and unattended
188
192
rebooting</emphasis> of client host computer with an
189
193
<emphasis>encrypted root file system</emphasis>. See <xref
190
194
linkend="overview"/> for details.
194
199
<refsect1 id="options">
195
200
<title>OPTIONS</title>
199
<term><option>--help</option></term>
200
<term><option>-h</option></term>
204
<term><literal>-h</literal>, <literal>--help</literal></term>
203
207
Show a help message and exit
210
<replaceable>DIRECTORY</replaceable></option></term>
212
<replaceable>DIRECTORY</replaceable></option></term>
213
<term><literal>-d</literal>, <literal>--dir
214
<replaceable>directory</replaceable></literal></term>
215
Target directory for key files. Default is
216
<filename>/etc/mandos</filename>.
217
Target directory for key files.
223
<replaceable>TYPE</replaceable></option></term>
225
<replaceable>TYPE</replaceable></option></term>
223
<term><literal>-t</literal>, <literal>--type
224
<replaceable>type</replaceable></literal></term>
228
227
Key type. Default is <quote>DSA</quote>.
234
<term><option>--length
235
<replaceable>BITS</replaceable></option></term>
237
<replaceable>BITS</replaceable></option></term>
233
<term><literal>-l</literal>, <literal>--length
234
<replaceable>bits</replaceable></literal></term>
240
Key length in bits. Default is 2048.
237
Key length in bits. Default is 1024.
246
<term><option>--subtype
247
<replaceable>KEYTYPE</replaceable></option></term>
249
<replaceable>KEYTYPE</replaceable></option></term>
243
<term><literal>-s</literal>, <literal>--subtype
244
<replaceable>type</replaceable></literal></term>
252
247
Subkey type. Default is <quote>ELG-E</quote> (Elgamal
310
<term><option>--force</option></term>
311
<term><option>-f</option></term>
314
Force overwriting old key.
319
<term><option>--password</option></term>
320
<term><option>-p</option></term>
323
Prompt for a password and encrypt it with the key already
324
present in either <filename>/etc/mandos</filename> or the
325
directory specified with the <option>--dir</option>
326
option. Outputs, on standard output, a section suitable
327
for inclusion in <citerefentry><refentrytitle
328
>mandos-clients.conf</refentrytitle><manvolnum
329
>8</manvolnum></citerefentry>. The host name or the name
330
specified with the <option>--name</option> option is used
331
for the section header. All other options are ignored,
332
and no key is created.
337
<term><option>--passfile
338
<replaceable>FILE</replaceable></option></term>
340
<replaceable>FILE</replaceable></option></term>
343
The same as <option>--password</option>, but read from
344
<replaceable>FILE</replaceable>, not the terminal.
297
<term><literal>-f</literal>, <literal>--force</literal></term>
300
Force overwriting old keys.
351
307
<refsect1 id="overview">
352
308
<title>OVERVIEW</title>
353
309
<xi:include href="overview.xml"/>
355
311
This program is a small utility to generate new OpenPGP keys for
356
new Mandos clients, and to generate sections for inclusion in
357
<filename>clients.conf</filename> on the server.
361
316
<refsect1 id="exit_status">
362
317
<title>EXIT STATUS</title>
364
The exit status will be 0 if a new key (or password, if the
365
<option>--password</option> option was used) was successfully
366
created, otherwise not.
319
The exit status will be 0 if new keys were successfully created,
434
389
Normal invocation needs no options:
437
<userinput>&COMMANDNAME;</userinput>
392
<userinput>mandos-keygen</userinput>
439
394
</informalexample>
440
395
<informalexample>
442
Create key in another directory and of another type. Force
397
Create keys in another directory and of another type. Force
443
398
overwriting old key files:
447
402
<!-- do not wrap this line -->
448
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
454
Prompt for a password, encrypt it with the key in
455
<filename>/etc/mandos</filename> and output a section suitable
456
for <filename>clients.conf</filename>.
459
<userinput>&COMMANDNAME; --password</userinput>
464
Prompt for a password, encrypt it with the key in the
465
<filename>client-key</filename> directory and output a section
466
suitable for <filename>clients.conf</filename>.
470
<!-- do not wrap this line -->
471
<userinput>&COMMANDNAME; --password --dir client-key</userinput>
403
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
474
406
</informalexample>
477
409
<refsect1 id="security">
478
410
<title>SECURITY</title>
480
412
The <option>--type</option>, <option>--length</option>,
481
413
<option>--subtype</option>, and <option>--sublength</option>
482
options can be used to create keys of low security. If in
483
doubt, leave them to the default values.
414
options can be used to create keys of insufficient security. If
415
in doubt, leave them to the default values.
486
The key expire time is <emphasis>not</emphasis> guaranteed to be
487
honored by <citerefentry><refentrytitle>mandos</refentrytitle>
418
The key expire time is not guaranteed to be honored by
419
<citerefentry><refentrytitle>mandos</refentrytitle>
488
420
<manvolnum>8</manvolnum></citerefentry>.
492
424
<refsect1 id="see_also">
493
425
<title>SEE ALSO</title>
427
<citerefentry><refentrytitle>password-request</refentrytitle>
428
<manvolnum>8mandos</manvolnum></citerefentry>,
429
<citerefentry><refentrytitle>mandos</refentrytitle>
430
<manvolnum>8</manvolnum></citerefentry>,
495
431
<citerefentry><refentrytitle>gpg</refentrytitle>
496
<manvolnum>1</manvolnum></citerefentry>,
497
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
498
<manvolnum>5</manvolnum></citerefentry>,
499
<citerefentry><refentrytitle>mandos</refentrytitle>
500
<manvolnum>8</manvolnum></citerefentry>,
501
<citerefentry><refentrytitle>mandos-client</refentrytitle>
502
<manvolnum>8mandos</manvolnum></citerefentry>
432
<manvolnum>1</manvolnum></citerefentry>
507
<!-- Local Variables: -->
508
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
509
<!-- time-stamp-end: "[\"']>" -->
510
<!-- time-stamp-format: "%:y-%02m-%02d" -->