65
46
<refname><command>&COMMANDNAME;</command></refname>
67
Generate keys for <citerefentry><refentrytitle>password-request
68
</refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>
48
Generate key and password for Mandos client and server.
74
54
<command>&COMMANDNAME;</command>
76
<arg choice="plain"><option>--dir</option>
77
<replaceable>directory</replaceable></arg>
80
<arg choice="plain"><option>--type</option>
81
<replaceable>type</replaceable></arg>
84
<arg choice="plain"><option>--length</option>
85
<replaceable>bits</replaceable></arg>
88
<arg choice="plain"><option>--name</option>
89
<replaceable>NAME</replaceable></arg>
92
<arg choice="plain"><option>--email</option>
93
<replaceable>EMAIL</replaceable></arg>
96
<arg choice="plain"><option>--comment</option>
97
<replaceable>COMMENT</replaceable></arg>
100
<arg choice="plain"><option>--expire</option>
101
<replaceable>TIME</replaceable></arg>
104
<arg choice="plain"><option>--force</option></arg>
108
<command>&COMMANDNAME;</command>
110
<arg choice="plain"><option>-d</option>
111
<replaceable>directory</replaceable></arg>
114
<arg choice="plain"><option>-t</option>
115
<replaceable>type</replaceable></arg>
118
<arg choice="plain"><option>-l</option>
119
<replaceable>bits</replaceable></arg>
122
<arg choice="plain"><option>-n</option>
123
<replaceable>NAME</replaceable></arg>
126
<arg choice="plain"><option>-e</option>
127
<replaceable>EMAIL</replaceable></arg>
130
<arg choice="plain"><option>-c</option>
131
<replaceable>COMMENT</replaceable></arg>
134
<arg choice="plain"><option>-x</option>
135
<replaceable>TIME</replaceable></arg>
138
<arg choice="plain"><option>-f</option></arg>
142
<command>&COMMANDNAME;</command>
144
<arg choice='plain'><option>-h</option></arg>
145
<arg choice='plain'><option>--help</option></arg>
149
<command>&COMMANDNAME;</command>
151
<arg choice='plain'><option>-v</option></arg>
152
<arg choice='plain'><option>--version</option></arg>
56
<arg choice="plain"><option>--dir
57
<replaceable>DIRECTORY</replaceable></option></arg>
58
<arg choice="plain"><option>-d
59
<replaceable>DIRECTORY</replaceable></option></arg>
63
<arg choice="plain"><option>--type
64
<replaceable>KEYTYPE</replaceable></option></arg>
65
<arg choice="plain"><option>-t
66
<replaceable>KEYTYPE</replaceable></option></arg>
70
<arg choice="plain"><option>--length
71
<replaceable>BITS</replaceable></option></arg>
72
<arg choice="plain"><option>-l
73
<replaceable>BITS</replaceable></option></arg>
77
<arg choice="plain"><option>--subtype
78
<replaceable>KEYTYPE</replaceable></option></arg>
79
<arg choice="plain"><option>-s
80
<replaceable>KEYTYPE</replaceable></option></arg>
84
<arg choice="plain"><option>--sublength
85
<replaceable>BITS</replaceable></option></arg>
86
<arg choice="plain"><option>-L
87
<replaceable>BITS</replaceable></option></arg>
91
<arg choice="plain"><option>--name
92
<replaceable>NAME</replaceable></option></arg>
93
<arg choice="plain"><option>-n
94
<replaceable>NAME</replaceable></option></arg>
98
<arg choice="plain"><option>--email
99
<replaceable>ADDRESS</replaceable></option></arg>
100
<arg choice="plain"><option>-e
101
<replaceable>ADDRESS</replaceable></option></arg>
105
<arg choice="plain"><option>--comment
106
<replaceable>TEXT</replaceable></option></arg>
107
<arg choice="plain"><option>-c
108
<replaceable>TEXT</replaceable></option></arg>
112
<arg choice="plain"><option>--expire
113
<replaceable>TIME</replaceable></option></arg>
114
<arg choice="plain"><option>-x
115
<replaceable>TIME</replaceable></option></arg>
118
<arg><option>--force</option></arg>
121
<command>&COMMANDNAME;</command>
123
<arg choice="plain"><option>--password</option></arg>
124
<arg choice="plain"><option>-p</option></arg>
125
<arg choice="plain"><option>--passfile
126
<replaceable>FILE</replaceable></option></arg>
127
<arg choice="plain"><option>-F</option>
128
<replaceable>FILE</replaceable></arg>
132
<arg choice="plain"><option>--dir
133
<replaceable>DIRECTORY</replaceable></option></arg>
134
<arg choice="plain"><option>-d
135
<replaceable>DIRECTORY</replaceable></option></arg>
139
<arg choice="plain"><option>--name
140
<replaceable>NAME</replaceable></option></arg>
141
<arg choice="plain"><option>-n
142
<replaceable>NAME</replaceable></option></arg>
146
<command>&COMMANDNAME;</command>
148
<arg choice="plain"><option>--help</option></arg>
149
<arg choice="plain"><option>-h</option></arg>
153
<command>&COMMANDNAME;</command>
155
<arg choice="plain"><option>--version</option></arg>
156
<arg choice="plain"><option>-v</option></arg>
155
159
</refsynopsisdiv>
157
161
<refsect1 id="description">
158
162
<title>DESCRIPTION</title>
160
164
<command>&COMMANDNAME;</command> is a program to generate the
162
<citerefentry><refentrytitle>password-request</refentrytitle>
163
<manvolnum>8mandos</manvolnum></citerefentry>. The keys are
166
<citerefentry><refentrytitle>mandos-client</refentrytitle>
167
<manvolnum>8mandos</manvolnum></citerefentry>. The key is
164
168
normally written to /etc/mandos for later installation into the
165
initrd image, but this, like most things, can be changed with
166
command line options.
169
initrd image, but this, and most other things, can be changed
170
with command line options.
173
This program can also be used with the
174
<option>--password</option> or <option>--passfile</option>
175
options to generate a ready-made section for
176
<filename>clients.conf</filename> (see
177
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
178
<manvolnum>5</manvolnum></citerefentry>).
170
182
<refsect1 id="purpose">
171
183
<title>PURPOSE</title>
174
185
The purpose of this is to enable <emphasis>remote and unattended
175
186
rebooting</emphasis> of client host computer with an
176
187
<emphasis>encrypted root file system</emphasis>. See <xref
177
188
linkend="overview"/> for details.
182
192
<refsect1 id="options">
183
193
<title>OPTIONS</title>
187
<term><literal>-h</literal>, <literal>--help</literal></term>
197
<term><option>--help</option></term>
198
<term><option>-h</option></term>
190
201
Show a help message and exit
196
<term><literal>-d</literal>, <literal>--dir
197
<replaceable>directory</replaceable></literal></term>
200
Target directory for key files.
206
<term><literal>-t</literal>, <literal>--type
207
<replaceable>type</replaceable></literal></term>
210
Key type. Default is DSA.
216
<term><literal>-l</literal>, <literal>--length
217
<replaceable>bits</replaceable></literal></term>
220
Key length in bits. Default is 1024.
226
<term><literal>-e</literal>, <literal>--email</literal>
227
<replaceable>address</replaceable></term>
208
<replaceable>DIRECTORY</replaceable></option></term>
210
<replaceable>DIRECTORY</replaceable></option></term>
213
Target directory for key files. Default is
214
<filename>/etc/mandos</filename>.
221
<replaceable>TYPE</replaceable></option></term>
223
<replaceable>TYPE</replaceable></option></term>
226
Key type. Default is <quote>DSA</quote>.
232
<term><option>--length
233
<replaceable>BITS</replaceable></option></term>
235
<replaceable>BITS</replaceable></option></term>
238
Key length in bits. Default is 2048.
244
<term><option>--subtype
245
<replaceable>KEYTYPE</replaceable></option></term>
247
<replaceable>KEYTYPE</replaceable></option></term>
250
Subkey type. Default is <quote>ELG-E</quote> (Elgamal
257
<term><option>--sublength
258
<replaceable>BITS</replaceable></option></term>
260
<replaceable>BITS</replaceable></option></term>
263
Subkey length in bits. Default is 2048.
269
<term><option>--email
270
<replaceable>ADDRESS</replaceable></option></term>
272
<replaceable>ADDRESS</replaceable></option></term>
230
275
Email address of key. Default is empty.
236
<term><literal>-c</literal>, <literal>--comment</literal>
237
<replaceable>comment</replaceable></term>
281
<term><option>--comment
282
<replaceable>TEXT</replaceable></option></term>
284
<replaceable>TEXT</replaceable></option></term>
240
287
Comment field for key. The default value is
241
"<literal>Mandos client key</literal>".
288
<quote><literal>Mandos client key</literal></quote>.
247
<term><literal>-x</literal>, <literal>--expire</literal>
248
<replaceable>time</replaceable></term>
294
<term><option>--expire
295
<replaceable>TIME</replaceable></option></term>
297
<replaceable>TIME</replaceable></option></term>
251
300
Key expire time. Default is no expiration. See
259
<term><literal>-f</literal>, <literal>--force</literal></term>
262
Force overwriting old keys.
308
<term><option>--force</option></term>
309
<term><option>-f</option></term>
312
Force overwriting old key.
317
<term><option>--password</option></term>
318
<term><option>-p</option></term>
321
Prompt for a password and encrypt it with the key already
322
present in either <filename>/etc/mandos</filename> or the
323
directory specified with the <option>--dir</option>
324
option. Outputs, on standard output, a section suitable
325
for inclusion in <citerefentry><refentrytitle
326
>mandos-clients.conf</refentrytitle><manvolnum
327
>8</manvolnum></citerefentry>. The host name or the name
328
specified with the <option>--name</option> option is used
329
for the section header. All other options are ignored,
330
and no key is created.
335
<term><option>--passfile
336
<replaceable>FILE</replaceable></option></term>
338
<replaceable>FILE</replaceable></option></term>
341
The same as <option>--password</option>, but read from
342
<replaceable>FILE</replaceable>, not the terminal.
269
349
<refsect1 id="overview">
270
350
<title>OVERVIEW</title>
271
351
<xi:include href="overview.xml"/>
273
This program is a small program to generate new OpenPGP keys for
353
This program is a small utility to generate new OpenPGP keys for
354
new Mandos clients, and to generate sections for inclusion in
355
<filename>clients.conf</filename> on the server.
278
359
<refsect1 id="exit_status">
279
360
<title>EXIT STATUS</title>
281
The exit status will be 0 if new keys were successfully created,
362
The exit status will be 0 if a new key (or password, if the
363
<option>--password</option> option was used) was successfully
364
created, otherwise not.
351
432
Normal invocation needs no options:
354
<userinput>mandos-keygen</userinput>
435
<userinput>&COMMANDNAME;</userinput>
356
437
</informalexample>
357
438
<informalexample>
359
Create keys in another directory and of another type. Force
440
Create key in another directory and of another type. Force
360
441
overwriting old key files:
364
445
<!-- do not wrap this line -->
365
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
446
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
452
Prompt for a password, encrypt it with the key in
453
<filename>/etc/mandos</filename> and output a section suitable
454
for <filename>clients.conf</filename>.
457
<userinput>&COMMANDNAME; --password</userinput>
462
Prompt for a password, encrypt it with the key in the
463
<filename>client-key</filename> directory and output a section
464
suitable for <filename>clients.conf</filename>.
468
<!-- do not wrap this line -->
469
<userinput>&COMMANDNAME; --password --dir client-key</userinput>
368
472
</informalexample>
371
475
<refsect1 id="security">
372
476
<title>SECURITY</title>
374
The <option>--type</option> and <option>--length</option>
375
options can be used to create keys of insufficient security. If
376
in doubt, leave them to the default values.
478
The <option>--type</option>, <option>--length</option>,
479
<option>--subtype</option>, and <option>--sublength</option>
480
options can be used to create keys of low security. If in
481
doubt, leave them to the default values.
379
The key expire time is not guaranteed to be honored by
380
<citerefentry><refentrytitle>mandos</refentrytitle>
484
The key expire time is <emphasis>not</emphasis> guaranteed to be
485
honored by <citerefentry><refentrytitle>mandos</refentrytitle>
381
486
<manvolnum>8</manvolnum></citerefentry>.
385
490
<refsect1 id="see_also">
386
491
<title>SEE ALSO</title>
388
<citerefentry><refentrytitle>password-request</refentrytitle>
389
<manvolnum>8mandos</manvolnum></citerefentry>,
493
<citerefentry><refentrytitle>gpg</refentrytitle>
494
<manvolnum>1</manvolnum></citerefentry>,
495
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
496
<manvolnum>5</manvolnum></citerefentry>,
390
497
<citerefentry><refentrytitle>mandos</refentrytitle>
391
498
<manvolnum>8</manvolnum></citerefentry>,
392
<citerefentry><refentrytitle>gpg</refentrytitle>
393
<manvolnum>1</manvolnum></citerefentry>
499
<citerefentry><refentrytitle>mandos-client</refentrytitle>
500
<manvolnum>8mandos</manvolnum></citerefentry>
505
<!-- Local Variables: -->
506
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
507
<!-- time-stamp-end: "[\"']>" -->
508
<!-- time-stamp-format: "%:y-%02m-%02d" -->