48
68
<refname><command>&COMMANDNAME;</command></refname>
50
Generate key and password for Mandos client and server.
70
Generate keys for <citerefentry><refentrytitle>password-request
71
</refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>
56
77
<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>
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>
123
161
<command>&COMMANDNAME;</command>
124
162
<group choice="req">
163
<arg choice="plain"><option>-p</option></arg>
125
164
<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>
167
<arg choice="plain"><option>--dir</option>
168
<replaceable>directory</replaceable></arg>
171
<arg choice="plain"><option>--name</option>
172
<replaceable>NAME</replaceable></arg>
148
176
<command>&COMMANDNAME;</command>
149
177
<group choice="req">
178
<arg choice="plain"><option>-h</option></arg>
150
179
<arg choice="plain"><option>--help</option></arg>
151
<arg choice="plain"><option>-h</option></arg>
155
183
<command>&COMMANDNAME;</command>
156
184
<group choice="req">
185
<arg choice="plain"><option>-v</option></arg>
157
186
<arg choice="plain"><option>--version</option></arg>
158
<arg choice="plain"><option>-v</option></arg>
161
189
</refsynopsisdiv>
163
191
<refsect1 id="description">
164
192
<title>DESCRIPTION</title>
166
194
<command>&COMMANDNAME;</command> is a program to generate the
168
<citerefentry><refentrytitle>mandos-client</refentrytitle>
169
<manvolnum>8mandos</manvolnum></citerefentry>. The key is
196
<citerefentry><refentrytitle>password-request</refentrytitle>
197
<manvolnum>8mandos</manvolnum></citerefentry>. The keys are
170
198
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.
199
initrd image, but this, like most things, can be changed with
200
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
203
It can also be used to generate ready-made sections for
179
204
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
180
<manvolnum>5</manvolnum></citerefentry>).
205
<manvolnum>5</manvolnum></citerefentry> using the
206
<option>--password</option> option.
184
210
<refsect1 id="purpose">
185
211
<title>PURPOSE</title>
187
214
The purpose of this is to enable <emphasis>remote and unattended
188
215
rebooting</emphasis> of client host computer with an
189
216
<emphasis>encrypted root file system</emphasis>. See <xref
190
217
linkend="overview"/> for details.
194
222
<refsect1 id="options">
195
223
<title>OPTIONS</title>
199
<term><option>--help</option></term>
200
<term><option>-h</option></term>
227
<term><literal>-h</literal>, <literal>--help</literal></term>
203
230
Show a help message and exit
210
<replaceable>DIRECTORY</replaceable></option></term>
212
<replaceable>DIRECTORY</replaceable></option></term>
236
<term><literal>-d</literal>, <literal>--dir
237
<replaceable>directory</replaceable></literal></term>
215
240
Target directory for key files. Default is
434
431
Normal invocation needs no options:
437
<userinput>&COMMANDNAME;</userinput>
434
<userinput>mandos-keygen</userinput>
439
436
</informalexample>
440
437
<informalexample>
442
Create key in another directory and of another type. Force
439
Create keys in another directory and of another type. Force
443
440
overwriting old key files:
447
444
<!-- 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>
445
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
474
448
</informalexample>
477
451
<refsect1 id="security">
478
452
<title>SECURITY</title>
480
454
The <option>--type</option>, <option>--length</option>,
481
455
<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.
456
options can be used to create keys of insufficient security. If
457
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>
460
The key expire time is not guaranteed to be honored by
461
<citerefentry><refentrytitle>mandos</refentrytitle>
488
462
<manvolnum>8</manvolnum></citerefentry>.
492
466
<refsect1 id="see_also">
493
467
<title>SEE ALSO</title>
469
<citerefentry><refentrytitle>password-request</refentrytitle>
470
<manvolnum>8mandos</manvolnum></citerefentry>,
471
<citerefentry><refentrytitle>mandos</refentrytitle>
472
<manvolnum>8</manvolnum></citerefentry>,
495
473
<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>
474
<manvolnum>1</manvolnum></citerefentry>