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>
149
<arg choice="plain"><option>--help</option></arg>
150
<arg choice="plain"><option>-h</option></arg>
154
<command>&COMMANDNAME;</command>
156
<arg choice="plain"><option>--version</option></arg>
157
<arg choice="plain"><option>-v</option></arg>
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>--name</option>
90
<replaceable>NAME</replaceable></arg>
93
<arg choice="plain"><option>--email</option>
94
<replaceable>EMAIL</replaceable></arg>
97
<arg choice="plain"><option>--comment</option>
98
<replaceable>COMMENT</replaceable></arg>
101
<arg choice="plain"><option>--expire</option>
102
<replaceable>TIME</replaceable></arg>
105
<arg choice="plain"><option>--force</option></arg>
109
<command>&COMMANDNAME;</command>
111
<arg choice="plain"><option>-d</option>
112
<replaceable>directory</replaceable></arg>
115
<arg choice="plain"><option>-t</option>
116
<replaceable>type</replaceable></arg>
119
<arg choice="plain"><option>-l</option>
120
<replaceable>bits</replaceable></arg>
123
<arg choice="plain"><option>-n</option>
124
<replaceable>NAME</replaceable></arg>
127
<arg choice="plain"><option>-e</option>
128
<replaceable>EMAIL</replaceable></arg>
131
<arg choice="plain"><option>-c</option>
132
<replaceable>COMMENT</replaceable></arg>
135
<arg choice="plain"><option>-x</option>
136
<replaceable>TIME</replaceable></arg>
139
<arg choice="plain"><option>-f</option></arg>
143
<command>&COMMANDNAME;</command>
145
<arg choice='plain'><option>-h</option></arg>
146
<arg choice='plain'><option>--help</option></arg>
150
<command>&COMMANDNAME;</command>
152
<arg choice='plain'><option>-v</option></arg>
153
<arg choice='plain'><option>--version</option></arg>
160
156
</refsynopsisdiv>
162
158
<refsect1 id="description">
163
159
<title>DESCRIPTION</title>
165
161
<command>&COMMANDNAME;</command> is a program to generate the
167
<citerefentry><refentrytitle>mandos-client</refentrytitle>
168
<manvolnum>8mandos</manvolnum></citerefentry>. The key is
163
<citerefentry><refentrytitle>password-request</refentrytitle>
164
<manvolnum>8mandos</manvolnum></citerefentry>. The keys are
169
165
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>).
166
initrd image, but this, like most things, can be changed with
167
command line options.
183
171
<refsect1 id="purpose">
184
172
<title>PURPOSE</title>
186
175
The purpose of this is to enable <emphasis>remote and unattended
187
176
rebooting</emphasis> of client host computer with an
188
177
<emphasis>encrypted root file system</emphasis>. See <xref
189
178
linkend="overview"/> for details.
193
183
<refsect1 id="options">
194
184
<title>OPTIONS</title>
198
<term><option>--help</option></term>
199
<term><option>-h</option></term>
188
<term><literal>-h</literal>, <literal>--help</literal></term>
202
191
Show a help message and exit
209
<replaceable>DIRECTORY</replaceable></option></term>
211
<replaceable>DIRECTORY</replaceable></option></term>
214
Target directory for key files. Default is
215
<filename>/etc/mandos</filename>.
222
<replaceable>TYPE</replaceable></option></term>
224
<replaceable>TYPE</replaceable></option></term>
227
Key type. Default is <quote>DSA</quote>.
233
<term><option>--length
234
<replaceable>BITS</replaceable></option></term>
236
<replaceable>BITS</replaceable></option></term>
239
Key length in bits. Default is 2048.
245
<term><option>--subtype
246
<replaceable>KEYTYPE</replaceable></option></term>
248
<replaceable>KEYTYPE</replaceable></option></term>
251
Subkey type. Default is <quote>ELG-E</quote> (Elgamal
258
<term><option>--sublength
259
<replaceable>BITS</replaceable></option></term>
261
<replaceable>BITS</replaceable></option></term>
264
Subkey length in bits. Default is 2048.
270
<term><option>--email
271
<replaceable>ADDRESS</replaceable></option></term>
273
<replaceable>ADDRESS</replaceable></option></term>
197
<term><literal>-d</literal>, <literal>--dir
198
<replaceable>directory</replaceable></literal></term>
201
Target directory for key files.
207
<term><literal>-t</literal>, <literal>--type
208
<replaceable>type</replaceable></literal></term>
211
Key type. Default is DSA.
217
<term><literal>-l</literal>, <literal>--length
218
<replaceable>bits</replaceable></literal></term>
221
Key length in bits. Default is 1024.
227
<term><literal>-e</literal>, <literal>--email</literal>
228
<replaceable>address</replaceable></term>
276
231
Email address of key. Default is empty.
282
<term><option>--comment
283
<replaceable>TEXT</replaceable></option></term>
285
<replaceable>TEXT</replaceable></option></term>
237
<term><literal>-c</literal>, <literal>--comment</literal>
238
<replaceable>comment</replaceable></term>
288
241
Comment field for key. The default value is
289
<quote><literal>Mandos client key</literal></quote>.
242
"<literal>Mandos client key</literal>".
295
<term><option>--expire
296
<replaceable>TIME</replaceable></option></term>
298
<replaceable>TIME</replaceable></option></term>
248
<term><literal>-x</literal>, <literal>--expire</literal>
249
<replaceable>time</replaceable></term>
301
252
Key expire time. Default is no expiration. See
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.
260
<term><literal>-f</literal>, <literal>--force</literal></term>
263
Force overwriting old keys.
350
270
<refsect1 id="overview">
351
271
<title>OVERVIEW</title>
352
<xi:include href="overview.xml"/>
354
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.
274
This program is a small program to generate new OpenPGP keys for
360
279
<refsect1 id="exit_status">
361
280
<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.
282
The exit status will be 0 if new keys were successfully created,
433
352
Normal invocation needs no options:
436
<userinput>&COMMANDNAME;</userinput>
355
<userinput>mandos-keygen</userinput>
438
357
</informalexample>
439
358
<informalexample>
441
Create key in another directory and of another type. Force
360
Create keys in another directory and of another type. Force
442
361
overwriting old key files:
446
365
<!-- 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>
366
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
473
369
</informalexample>
476
372
<refsect1 id="security">
477
373
<title>SECURITY</title>
479
The <option>--type</option>, <option>--length</option>,
480
<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.
375
The <option>--type</option> and <option>--length</option>
376
options can be used to create keys of insufficient security. If
377
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>
380
The key expire time is not guaranteed to be honored by
381
<citerefentry><refentrytitle>mandos</refentrytitle>
487
382
<manvolnum>8</manvolnum></citerefentry>.
491
386
<refsect1 id="see_also">
492
387
<title>SEE ALSO</title>
389
<citerefentry><refentrytitle>password-request</refentrytitle>
390
<manvolnum>8mandos</manvolnum></citerefentry>,
391
<citerefentry><refentrytitle>mandos</refentrytitle>
392
<manvolnum>8</manvolnum></citerefentry>, and
494
393
<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>
394
<manvolnum>1</manvolnum></citerefentry>
506
<!-- Local Variables: -->
507
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
508
<!-- time-stamp-end: "[\"']>" -->
509
<!-- time-stamp-format: "%:y-%02m-%02d" -->