47
66
<refname><command>&COMMANDNAME;</command></refname>
49
Generate key and password for Mandos client and server.
68
Generate keys for <citerefentry><refentrytitle>password-request
69
</refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>
55
75
<command>&COMMANDNAME;</command>
57
<arg choice="plain"><option>--dir
58
<replaceable>DIRECTORY</replaceable></option></arg>
59
<arg choice="plain"><option>-d
60
<replaceable>DIRECTORY</replaceable></option></arg>
64
<arg choice="plain"><option>--type
65
<replaceable>KEYTYPE</replaceable></option></arg>
66
<arg choice="plain"><option>-t
67
<replaceable>KEYTYPE</replaceable></option></arg>
71
<arg choice="plain"><option>--length
72
<replaceable>BITS</replaceable></option></arg>
73
<arg choice="plain"><option>-l
74
<replaceable>BITS</replaceable></option></arg>
78
<arg choice="plain"><option>--subtype
79
<replaceable>KEYTYPE</replaceable></option></arg>
80
<arg choice="plain"><option>-s
81
<replaceable>KEYTYPE</replaceable></option></arg>
85
<arg choice="plain"><option>--sublength
86
<replaceable>BITS</replaceable></option></arg>
87
<arg choice="plain"><option>-L
88
<replaceable>BITS</replaceable></option></arg>
92
<arg choice="plain"><option>--name
93
<replaceable>NAME</replaceable></option></arg>
94
<arg choice="plain"><option>-n
95
<replaceable>NAME</replaceable></option></arg>
99
<arg choice="plain"><option>--email
100
<replaceable>ADDRESS</replaceable></option></arg>
101
<arg choice="plain"><option>-e
102
<replaceable>ADDRESS</replaceable></option></arg>
106
<arg choice="plain"><option>--comment
107
<replaceable>TEXT</replaceable></option></arg>
108
<arg choice="plain"><option>-c
109
<replaceable>TEXT</replaceable></option></arg>
113
<arg choice="plain"><option>--expire
114
<replaceable>TIME</replaceable></option></arg>
115
<arg choice="plain"><option>-x
116
<replaceable>TIME</replaceable></option></arg>
119
<arg><option>--force</option></arg>
122
<command>&COMMANDNAME;</command>
124
<arg choice="plain"><option>--password</option></arg>
125
<arg choice="plain"><option>-p</option></arg>
126
<arg choice="plain"><option>--passfile
127
<replaceable>FILE</replaceable></option></arg>
128
<arg choice="plain"><option>-F</option>
129
<replaceable>FILE</replaceable></arg>
133
<arg choice="plain"><option>--dir
134
<replaceable>DIRECTORY</replaceable></option></arg>
135
<arg choice="plain"><option>-d
136
<replaceable>DIRECTORY</replaceable></option></arg>
140
<arg choice="plain"><option>--name
141
<replaceable>NAME</replaceable></option></arg>
142
<arg choice="plain"><option>-n
143
<replaceable>NAME</replaceable></option></arg>
147
<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>
149
162
<arg choice="plain"><option>--help</option></arg>
150
<arg choice="plain"><option>-h</option></arg>
154
166
<command>&COMMANDNAME;</command>
155
167
<group choice="req">
168
<arg choice="plain"><option>-v</option></arg>
156
169
<arg choice="plain"><option>--version</option></arg>
157
<arg choice="plain"><option>-v</option></arg>
160
172
</refsynopsisdiv>
162
174
<refsect1 id="description">
163
175
<title>DESCRIPTION</title>
165
177
<command>&COMMANDNAME;</command> is a program to generate the
167
<citerefentry><refentrytitle>mandos-client</refentrytitle>
168
<manvolnum>8mandos</manvolnum></citerefentry>. The key is
179
<citerefentry><refentrytitle>password-request</refentrytitle>
180
<manvolnum>8mandos</manvolnum></citerefentry>. The keys are
169
181
normally written to /etc/mandos for later installation into the
170
initrd image, but this, and most other things, can be changed
171
with command line options.
174
This program can also be used with the
175
<option>--password</option> or <option>--passfile</option>
176
options to generate a ready-made section for
177
<filename>clients.conf</filename> (see
178
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
179
<manvolnum>5</manvolnum></citerefentry>).
182
initrd image, but this, like most things, can be changed with
183
command line options.
183
187
<refsect1 id="purpose">
184
188
<title>PURPOSE</title>
186
191
The purpose of this is to enable <emphasis>remote and unattended
187
192
rebooting</emphasis> of client host computer with an
188
193
<emphasis>encrypted root file system</emphasis>. See <xref
189
194
linkend="overview"/> for details.
193
199
<refsect1 id="options">
194
200
<title>OPTIONS</title>
198
<term><option>--help</option></term>
199
<term><option>-h</option></term>
204
<term><literal>-h</literal>, <literal>--help</literal></term>
202
207
Show a help message and exit
209
<replaceable>DIRECTORY</replaceable></option></term>
211
<replaceable>DIRECTORY</replaceable></option></term>
213
<term><literal>-d</literal>, <literal>--dir
214
<replaceable>directory</replaceable></literal></term>
214
Target directory for key files. Default is
215
<filename>/etc/mandos</filename>.
217
Target directory for key files.
222
<replaceable>TYPE</replaceable></option></term>
224
<replaceable>TYPE</replaceable></option></term>
223
<term><literal>-t</literal>, <literal>--type
224
<replaceable>type</replaceable></literal></term>
227
227
Key type. Default is <quote>DSA</quote>.
233
<term><option>--length
234
<replaceable>BITS</replaceable></option></term>
236
<replaceable>BITS</replaceable></option></term>
233
<term><literal>-l</literal>, <literal>--length
234
<replaceable>bits</replaceable></literal></term>
239
Key length in bits. Default is 2048.
237
Key length in bits. Default is 1024.
245
<term><option>--subtype
246
<replaceable>KEYTYPE</replaceable></option></term>
248
<replaceable>KEYTYPE</replaceable></option></term>
243
<term><literal>-s</literal>, <literal>--subtype
244
<replaceable>type</replaceable></literal></term>
251
247
Subkey type. Default is <quote>ELG-E</quote> (Elgamal
309
<term><option>--force</option></term>
310
<term><option>-f</option></term>
313
Force overwriting old key.
318
<term><option>--password</option></term>
319
<term><option>-p</option></term>
322
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>
325
option. Outputs, on standard output, a section suitable
326
for inclusion in <citerefentry><refentrytitle
327
>mandos-clients.conf</refentrytitle><manvolnum
328
>8</manvolnum></citerefentry>. The host name or the name
329
specified with the <option>--name</option> option is used
330
for the section header. All other options are ignored,
331
and no key is created.
336
<term><option>--passfile
337
<replaceable>FILE</replaceable></option></term>
339
<replaceable>FILE</replaceable></option></term>
342
The same as <option>--password</option>, but read from
343
<replaceable>FILE</replaceable>, not the terminal.
297
<term><literal>-f</literal>, <literal>--force</literal></term>
300
Force overwriting old keys.
350
307
<refsect1 id="overview">
351
308
<title>OVERVIEW</title>
352
309
<xi:include href="overview.xml"/>
354
311
This program is a small utility to generate new OpenPGP keys for
355
new Mandos clients, and to generate sections for inclusion in
356
<filename>clients.conf</filename> on the server.
360
316
<refsect1 id="exit_status">
361
317
<title>EXIT STATUS</title>
363
The exit status will be 0 if a new key (or password, if the
364
<option>--password</option> option was used) was successfully
365
created, otherwise not.
319
The exit status will be 0 if new keys were successfully created,
433
389
Normal invocation needs no options:
436
<userinput>&COMMANDNAME;</userinput>
392
<userinput>mandos-keygen</userinput>
438
394
</informalexample>
439
395
<informalexample>
441
Create key in another directory and of another type. Force
397
Create keys in another directory and of another type. Force
442
398
overwriting old key files:
446
402
<!-- do not wrap this line -->
447
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
453
Prompt for a password, encrypt it with the key in
454
<filename>/etc/mandos</filename> and output a section suitable
455
for <filename>clients.conf</filename>.
458
<userinput>&COMMANDNAME; --password</userinput>
463
Prompt for a password, encrypt it with the key in the
464
<filename>client-key</filename> directory and output a section
465
suitable for <filename>clients.conf</filename>.
469
<!-- do not wrap this line -->
470
<userinput>&COMMANDNAME; --password --dir client-key</userinput>
403
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
473
406
</informalexample>
476
409
<refsect1 id="security">
477
410
<title>SECURITY</title>
479
412
The <option>--type</option>, <option>--length</option>,
480
413
<option>--subtype</option>, and <option>--sublength</option>
481
options can be used to create keys of low security. If in
482
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.
485
The key expire time is <emphasis>not</emphasis> guaranteed to be
486
honored by <citerefentry><refentrytitle>mandos</refentrytitle>
418
The key expire time is not guaranteed to be honored by
419
<citerefentry><refentrytitle>mandos</refentrytitle>
487
420
<manvolnum>8</manvolnum></citerefentry>.
491
424
<refsect1 id="see_also">
492
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>,
494
431
<citerefentry><refentrytitle>gpg</refentrytitle>
495
<manvolnum>1</manvolnum></citerefentry>,
496
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
497
<manvolnum>5</manvolnum></citerefentry>,
498
<citerefentry><refentrytitle>mandos</refentrytitle>
499
<manvolnum>8</manvolnum></citerefentry>,
500
<citerefentry><refentrytitle>mandos-client</refentrytitle>
501
<manvolnum>8mandos</manvolnum></citerefentry>
432
<manvolnum>1</manvolnum></citerefentry>
506
<!-- Local Variables: -->
507
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
508
<!-- time-stamp-end: "[\"']>" -->
509
<!-- time-stamp-format: "%:y-%02m-%02d" -->