68
47
<refname><command>&COMMANDNAME;</command></refname>
70
Generate keys for <citerefentry><refentrytitle>password-request
71
</refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>
49
Generate key and password for Mandos client and server.
77
55
<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>
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>
161
122
<command>&COMMANDNAME;</command>
162
123
<group choice="req">
124
<arg choice="plain"><option>--password</option></arg>
163
125
<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>
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>
176
147
<command>&COMMANDNAME;</command>
177
148
<group choice="req">
149
<arg choice="plain"><option>--help</option></arg>
178
150
<arg choice="plain"><option>-h</option></arg>
179
<arg choice="plain"><option>--help</option></arg>
183
154
<command>&COMMANDNAME;</command>
184
155
<group choice="req">
156
<arg choice="plain"><option>--version</option></arg>
185
157
<arg choice="plain"><option>-v</option></arg>
186
<arg choice="plain"><option>--version</option></arg>
189
160
</refsynopsisdiv>
191
162
<refsect1 id="description">
192
163
<title>DESCRIPTION</title>
194
165
<command>&COMMANDNAME;</command> is a program to generate the
196
<citerefentry><refentrytitle>password-request</refentrytitle>
197
<manvolnum>8mandos</manvolnum></citerefentry>. The keys are
167
<citerefentry><refentrytitle>mandos-client</refentrytitle>
168
<manvolnum>8mandos</manvolnum></citerefentry>. The key is
198
169
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.
170
initrd image, but this, and most other things, can be changed
171
with command line options.
203
It can also be used to generate ready-made sections for
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
204
178
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
205
<manvolnum>5</manvolnum></citerefentry> using the
206
<option>--password</option> option.
179
<manvolnum>5</manvolnum></citerefentry>).
210
183
<refsect1 id="purpose">
211
184
<title>PURPOSE</title>
214
186
The purpose of this is to enable <emphasis>remote and unattended
215
187
rebooting</emphasis> of client host computer with an
216
188
<emphasis>encrypted root file system</emphasis>. See <xref
217
189
linkend="overview"/> for details.
222
193
<refsect1 id="options">
223
194
<title>OPTIONS</title>
227
<term><literal>-h</literal>, <literal>--help</literal></term>
198
<term><option>--help</option></term>
199
<term><option>-h</option></term>
230
202
Show a help message and exit
236
<term><literal>-d</literal>, <literal>--dir
237
<replaceable>directory</replaceable></literal></term>
209
<replaceable>DIRECTORY</replaceable></option></term>
211
<replaceable>DIRECTORY</replaceable></option></term>
240
214
Target directory for key files. Default is
431
433
Normal invocation needs no options:
434
<userinput>mandos-keygen</userinput>
436
<userinput>&COMMANDNAME;</userinput>
436
438
</informalexample>
437
439
<informalexample>
439
Create keys in another directory and of another type. Force
441
Create key in another directory and of another type. Force
440
442
overwriting old key files:
444
446
<!-- do not wrap this line -->
445
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
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>
448
473
</informalexample>
451
476
<refsect1 id="security">
452
477
<title>SECURITY</title>
454
479
The <option>--type</option>, <option>--length</option>,
455
480
<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.
481
options can be used to create keys of low security. If in
482
doubt, leave them to the default values.
460
The key expire time is not guaranteed to be honored by
461
<citerefentry><refentrytitle>mandos</refentrytitle>
485
The key expire time is <emphasis>not</emphasis> guaranteed to be
486
honored by <citerefentry><refentrytitle>mandos</refentrytitle>
462
487
<manvolnum>8</manvolnum></citerefentry>.
466
491
<refsect1 id="see_also">
467
492
<title>SEE ALSO</title>
469
<citerefentry><refentrytitle>password-request</refentrytitle>
470
<manvolnum>8mandos</manvolnum></citerefentry>,
494
<citerefentry><refentrytitle>gpg</refentrytitle>
495
<manvolnum>1</manvolnum></citerefentry>,
496
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
497
<manvolnum>5</manvolnum></citerefentry>,
471
498
<citerefentry><refentrytitle>mandos</refentrytitle>
472
499
<manvolnum>8</manvolnum></citerefentry>,
473
<citerefentry><refentrytitle>gpg</refentrytitle>
474
<manvolnum>1</manvolnum></citerefentry>
500
<citerefentry><refentrytitle>mandos-client</refentrytitle>
501
<manvolnum>8mandos</manvolnum></citerefentry>