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