48
65
<refname><command>&COMMANDNAME;</command></refname>
50
Generate key and password for Mandos client and server.
67
Generate keys for <citerefentry><refentrytitle>password-request
68
</refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>
56
74
<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>
150
<arg choice="plain"><option>--help</option></arg>
151
<arg choice="plain"><option>-h</option></arg>
155
<command>&COMMANDNAME;</command>
157
<arg choice="plain"><option>--version</option></arg>
158
<arg choice="plain"><option>-v</option></arg>
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>
161
155
</refsynopsisdiv>
163
157
<refsect1 id="description">
164
158
<title>DESCRIPTION</title>
166
160
<command>&COMMANDNAME;</command> is a program to generate the
168
<citerefentry><refentrytitle>mandos-client</refentrytitle>
169
<manvolnum>8mandos</manvolnum></citerefentry>. The key is
162
<citerefentry><refentrytitle>password-request</refentrytitle>
163
<manvolnum>8mandos</manvolnum></citerefentry>. The keys are
170
164
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>).
165
initrd image, but this, like most things, can be changed with
166
command line options.
184
170
<refsect1 id="purpose">
185
171
<title>PURPOSE</title>
187
174
The purpose of this is to enable <emphasis>remote and unattended
188
175
rebooting</emphasis> of client host computer with an
189
176
<emphasis>encrypted root file system</emphasis>. See <xref
190
177
linkend="overview"/> for details.
194
182
<refsect1 id="options">
195
183
<title>OPTIONS</title>
199
<term><option>--help</option></term>
200
<term><option>-h</option></term>
187
<term><literal>-h</literal>, <literal>--help</literal></term>
203
190
Show a help message and exit
210
<replaceable>DIRECTORY</replaceable></option></term>
212
<replaceable>DIRECTORY</replaceable></option></term>
215
Target directory for key files. Default is
216
<filename>/etc/mandos</filename>.
223
<replaceable>TYPE</replaceable></option></term>
225
<replaceable>TYPE</replaceable></option></term>
228
Key type. Default is <quote>DSA</quote>.
234
<term><option>--length
235
<replaceable>BITS</replaceable></option></term>
237
<replaceable>BITS</replaceable></option></term>
240
Key length in bits. Default is 2048.
246
<term><option>--subtype
247
<replaceable>KEYTYPE</replaceable></option></term>
249
<replaceable>KEYTYPE</replaceable></option></term>
252
Subkey type. Default is <quote>ELG-E</quote> (Elgamal
259
<term><option>--sublength
260
<replaceable>BITS</replaceable></option></term>
262
<replaceable>BITS</replaceable></option></term>
265
Subkey length in bits. Default is 2048.
271
<term><option>--email
272
<replaceable>ADDRESS</replaceable></option></term>
274
<replaceable>ADDRESS</replaceable></option></term>
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>
277
230
Email address of key. Default is empty.
283
<term><option>--comment
284
<replaceable>TEXT</replaceable></option></term>
286
<replaceable>TEXT</replaceable></option></term>
236
<term><literal>-c</literal>, <literal>--comment</literal>
237
<replaceable>comment</replaceable></term>
289
240
Comment field for key. The default value is
290
<quote><literal>Mandos client key</literal></quote>.
241
"<literal>Mandos client key</literal>".
296
<term><option>--expire
297
<replaceable>TIME</replaceable></option></term>
299
<replaceable>TIME</replaceable></option></term>
247
<term><literal>-x</literal>, <literal>--expire</literal>
248
<replaceable>time</replaceable></term>
302
251
Key expire time. Default is no expiration. See
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.
259
<term><literal>-f</literal>, <literal>--force</literal></term>
262
Force overwriting old keys.
351
269
<refsect1 id="overview">
352
270
<title>OVERVIEW</title>
353
271
<xi:include href="overview.xml"/>
355
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.
273
This program is a small program to generate new OpenPGP keys for
361
278
<refsect1 id="exit_status">
362
279
<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.
281
The exit status will be 0 if new keys were successfully created,
434
351
Normal invocation needs no options:
437
<userinput>&COMMANDNAME;</userinput>
354
<userinput>mandos-keygen</userinput>
439
356
</informalexample>
440
357
<informalexample>
442
Create key in another directory and of another type. Force
359
Create keys in another directory and of another type. Force
443
360
overwriting old key files:
447
364
<!-- 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>
365
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
474
368
</informalexample>
477
371
<refsect1 id="security">
478
372
<title>SECURITY</title>
480
The <option>--type</option>, <option>--length</option>,
481
<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.
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.
486
The key expire time is <emphasis>not</emphasis> guaranteed to be
487
honored by <citerefentry><refentrytitle>mandos</refentrytitle>
379
The key expire time is not guaranteed to be honored by
380
<citerefentry><refentrytitle>mandos</refentrytitle>
488
381
<manvolnum>8</manvolnum></citerefentry>.
492
385
<refsect1 id="see_also">
493
386
<title>SEE ALSO</title>
388
<citerefentry><refentrytitle>password-request</refentrytitle>
389
<manvolnum>8mandos</manvolnum></citerefentry>,
390
<citerefentry><refentrytitle>mandos</refentrytitle>
391
<manvolnum>8</manvolnum></citerefentry>,
495
392
<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>
393
<manvolnum>1</manvolnum></citerefentry>
507
<!-- Local Variables: -->
508
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
509
<!-- time-stamp-end: "[\"']>" -->
510
<!-- time-stamp-format: "%:y-%02m-%02d" -->