68
48
<refname><command>&COMMANDNAME;</command></refname>
70
Generate keys for <citerefentry><refentrytitle>password-request
71
</refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>
50
Generate key and password for Mandos client and server.
77
56
<command>&COMMANDNAME;</command>
79
<arg choice="plain"><option>--dir</option>
80
<replaceable>directory</replaceable></arg>
83
<arg choice="plain"><option>--type</option>
84
<replaceable>type</replaceable></arg>
87
<arg choice="plain"><option>--length</option>
88
<replaceable>bits</replaceable></arg>
91
<arg choice="plain"><option>--subtype</option>
92
<replaceable>type</replaceable></arg>
95
<arg choice="plain"><option>--sublength</option>
96
<replaceable>bits</replaceable></arg>
99
<arg choice="plain"><option>--name</option>
100
<replaceable>NAME</replaceable></arg>
103
<arg choice="plain"><option>--email</option>
104
<replaceable>EMAIL</replaceable></arg>
107
<arg choice="plain"><option>--comment</option>
108
<replaceable>COMMENT</replaceable></arg>
111
<arg choice="plain"><option>--expire</option>
112
<replaceable>TIME</replaceable></arg>
115
<arg choice="plain"><option>--force</option></arg>
119
<command>&COMMANDNAME;</command>
121
<arg choice="plain"><option>-d</option>
122
<replaceable>directory</replaceable></arg>
125
<arg choice="plain"><option>-t</option>
126
<replaceable>type</replaceable></arg>
129
<arg choice="plain"><option>-l</option>
130
<replaceable>bits</replaceable></arg>
133
<arg choice="plain"><option>-s</option>
134
<replaceable>type</replaceable></arg>
137
<arg choice="plain"><option>-L</option>
138
<replaceable>bits</replaceable></arg>
141
<arg choice="plain"><option>-n</option>
142
<replaceable>NAME</replaceable></arg>
145
<arg choice="plain"><option>-e</option>
146
<replaceable>EMAIL</replaceable></arg>
149
<arg choice="plain"><option>-c</option>
150
<replaceable>COMMENT</replaceable></arg>
153
<arg choice="plain"><option>-x</option>
154
<replaceable>TIME</replaceable></arg>
157
<arg choice="plain"><option>-f</option></arg>
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>
161
123
<command>&COMMANDNAME;</command>
162
124
<group choice="req">
125
<arg choice="plain"><option>--password</option></arg>
163
126
<arg choice="plain"><option>-p</option></arg>
164
<arg choice="plain"><option>--password</option></arg>
167
<arg choice="plain"><option>--dir</option>
168
<replaceable>directory</replaceable></arg>
171
<arg choice="plain"><option>--name</option>
172
<replaceable>NAME</replaceable></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>
176
148
<command>&COMMANDNAME;</command>
177
149
<group choice="req">
150
<arg choice="plain"><option>--help</option></arg>
178
151
<arg choice="plain"><option>-h</option></arg>
179
<arg choice="plain"><option>--help</option></arg>
183
155
<command>&COMMANDNAME;</command>
184
156
<group choice="req">
157
<arg choice="plain"><option>--version</option></arg>
185
158
<arg choice="plain"><option>-v</option></arg>
186
<arg choice="plain"><option>--version</option></arg>
189
161
</refsynopsisdiv>
191
163
<refsect1 id="description">
192
164
<title>DESCRIPTION</title>
194
166
<command>&COMMANDNAME;</command> is a program to generate the
196
<citerefentry><refentrytitle>password-request</refentrytitle>
197
<manvolnum>8mandos</manvolnum></citerefentry>. The keys are
168
<citerefentry><refentrytitle>mandos-client</refentrytitle>
169
<manvolnum>8mandos</manvolnum></citerefentry>. The key is
198
170
normally written to /etc/mandos for later installation into the
199
initrd image, but this, like most things, can be changed with
200
command line options.
171
initrd image, but this, and most other things, can be changed
172
with command line options.
203
It can also be used to generate ready-made sections for
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
204
179
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
205
<manvolnum>5</manvolnum></citerefentry> using the
206
<option>--password</option> option.
180
<manvolnum>5</manvolnum></citerefentry>).
210
184
<refsect1 id="purpose">
211
185
<title>PURPOSE</title>
214
187
The purpose of this is to enable <emphasis>remote and unattended
215
188
rebooting</emphasis> of client host computer with an
216
189
<emphasis>encrypted root file system</emphasis>. See <xref
217
190
linkend="overview"/> for details.
222
194
<refsect1 id="options">
223
195
<title>OPTIONS</title>
227
<term><literal>-h</literal>, <literal>--help</literal></term>
199
<term><option>--help</option></term>
200
<term><option>-h</option></term>
230
203
Show a help message and exit
236
<term><literal>-d</literal>, <literal>--dir
237
<replaceable>directory</replaceable></literal></term>
210
<replaceable>DIRECTORY</replaceable></option></term>
212
<replaceable>DIRECTORY</replaceable></option></term>
240
215
Target directory for key files. Default is
431
434
Normal invocation needs no options:
434
<userinput>mandos-keygen</userinput>
437
<userinput>&COMMANDNAME;</userinput>
436
439
</informalexample>
437
440
<informalexample>
439
Create keys in another directory and of another type. Force
442
Create key in another directory and of another type. Force
440
443
overwriting old key files:
444
447
<!-- do not wrap this line -->
445
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
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>
448
474
</informalexample>
451
477
<refsect1 id="security">
452
478
<title>SECURITY</title>
454
480
The <option>--type</option>, <option>--length</option>,
455
481
<option>--subtype</option>, and <option>--sublength</option>
456
options can be used to create keys of insufficient security. If
457
in doubt, leave them to the default values.
482
options can be used to create keys of low security. If in
483
doubt, leave them to the default values.
460
The key expire time is not guaranteed to be honored by
461
<citerefentry><refentrytitle>mandos</refentrytitle>
486
The key expire time is <emphasis>not</emphasis> guaranteed to be
487
honored by <citerefentry><refentrytitle>mandos</refentrytitle>
462
488
<manvolnum>8</manvolnum></citerefentry>.
466
492
<refsect1 id="see_also">
467
493
<title>SEE ALSO</title>
469
<citerefentry><refentrytitle>password-request</refentrytitle>
470
<manvolnum>8mandos</manvolnum></citerefentry>,
495
<citerefentry><refentrytitle>gpg</refentrytitle>
496
<manvolnum>1</manvolnum></citerefentry>,
497
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
498
<manvolnum>5</manvolnum></citerefentry>,
471
499
<citerefentry><refentrytitle>mandos</refentrytitle>
472
500
<manvolnum>8</manvolnum></citerefentry>,
473
<citerefentry><refentrytitle>gpg</refentrytitle>
474
<manvolnum>1</manvolnum></citerefentry>
501
<citerefentry><refentrytitle>mandos-client</refentrytitle>
502
<manvolnum>8mandos</manvolnum></citerefentry>