66
48
<refname><command>&COMMANDNAME;</command></refname>
68
Generate keys for <citerefentry><refentrytitle>password-request
69
</refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>
50
Generate key and password for Mandos client and server.
75
56
<command>&COMMANDNAME;</command>
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>--subtype</option>
90
<replaceable>type</replaceable></arg>
93
<arg choice="plain"><option>--sublength</option>
94
<replaceable>bits</replaceable></arg>
97
<arg choice="plain"><option>--name</option>
98
<replaceable>NAME</replaceable></arg>
101
<arg choice="plain"><option>--email</option>
102
<replaceable>EMAIL</replaceable></arg>
105
<arg choice="plain"><option>--comment</option>
106
<replaceable>COMMENT</replaceable></arg>
109
<arg choice="plain"><option>--expire</option>
110
<replaceable>TIME</replaceable></arg>
113
<arg choice="plain"><option>--force</option></arg>
117
<command>&COMMANDNAME;</command>
119
<arg choice="plain"><option>-d</option>
120
<replaceable>directory</replaceable></arg>
123
<arg choice="plain"><option>-t</option>
124
<replaceable>type</replaceable></arg>
127
<arg choice="plain"><option>-l</option>
128
<replaceable>bits</replaceable></arg>
131
<arg choice="plain"><option>-s</option>
132
<replaceable>type</replaceable></arg>
135
<arg choice="plain"><option>-L</option>
136
<replaceable>bits</replaceable></arg>
139
<arg choice="plain"><option>-n</option>
140
<replaceable>NAME</replaceable></arg>
143
<arg choice="plain"><option>-e</option>
144
<replaceable>EMAIL</replaceable></arg>
147
<arg choice="plain"><option>-c</option>
148
<replaceable>COMMENT</replaceable></arg>
151
<arg choice="plain"><option>-x</option>
152
<replaceable>TIME</replaceable></arg>
155
<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>
159
123
<command>&COMMANDNAME;</command>
160
124
<group choice="req">
125
<arg choice="plain"><option>--password</option></arg>
161
126
<arg choice="plain"><option>-p</option></arg>
162
<arg choice="plain"><option>--password</option></arg>
165
<arg choice="plain"><option>--dir</option>
166
<replaceable>directory</replaceable></arg>
169
<arg choice="plain"><option>--name</option>
170
<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>
174
148
<command>&COMMANDNAME;</command>
175
149
<group choice="req">
150
<arg choice="plain"><option>--help</option></arg>
176
151
<arg choice="plain"><option>-h</option></arg>
177
<arg choice="plain"><option>--help</option></arg>
181
155
<command>&COMMANDNAME;</command>
182
156
<group choice="req">
157
<arg choice="plain"><option>--version</option></arg>
183
158
<arg choice="plain"><option>-v</option></arg>
184
<arg choice="plain"><option>--version</option></arg>
187
161
</refsynopsisdiv>
189
163
<refsect1 id="description">
190
164
<title>DESCRIPTION</title>
192
166
<command>&COMMANDNAME;</command> is a program to generate the
194
<citerefentry><refentrytitle>password-request</refentrytitle>
195
<manvolnum>8mandos</manvolnum></citerefentry>. The keys are
168
<citerefentry><refentrytitle>mandos-client</refentrytitle>
169
<manvolnum>8mandos</manvolnum></citerefentry>. The key is
196
170
normally written to /etc/mandos for later installation into the
197
initrd image, but this, like most things, can be changed with
198
command line options.
171
initrd image, but this, and most other things, can be changed
172
with command line options.
201
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
202
179
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
203
<manvolnum>5</manvolnum></citerefentry> using the
204
<option>--password</option> option.
180
<manvolnum>5</manvolnum></citerefentry>).
208
184
<refsect1 id="purpose">
209
185
<title>PURPOSE</title>
212
187
The purpose of this is to enable <emphasis>remote and unattended
213
188
rebooting</emphasis> of client host computer with an
214
189
<emphasis>encrypted root file system</emphasis>. See <xref
215
190
linkend="overview"/> for details.
220
194
<refsect1 id="options">
221
195
<title>OPTIONS</title>
225
<term><literal>-h</literal>, <literal>--help</literal></term>
199
<term><option>--help</option></term>
200
<term><option>-h</option></term>
228
203
Show a help message and exit
234
<term><literal>-d</literal>, <literal>--dir
235
<replaceable>directory</replaceable></literal></term>
210
<replaceable>DIRECTORY</replaceable></option></term>
212
<replaceable>DIRECTORY</replaceable></option></term>
238
215
Target directory for key files. Default is
429
434
Normal invocation needs no options:
432
<userinput>mandos-keygen</userinput>
437
<userinput>&COMMANDNAME;</userinput>
434
439
</informalexample>
435
440
<informalexample>
437
Create keys in another directory and of another type. Force
442
Create key in another directory and of another type. Force
438
443
overwriting old key files:
442
447
<!-- do not wrap this line -->
443
<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>
446
474
</informalexample>
449
477
<refsect1 id="security">
450
478
<title>SECURITY</title>
452
480
The <option>--type</option>, <option>--length</option>,
453
481
<option>--subtype</option>, and <option>--sublength</option>
454
options can be used to create keys of insufficient security. If
455
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.
458
The key expire time is not guaranteed to be honored by
459
<citerefentry><refentrytitle>mandos</refentrytitle>
486
The key expire time is <emphasis>not</emphasis> guaranteed to be
487
honored by <citerefentry><refentrytitle>mandos</refentrytitle>
460
488
<manvolnum>8</manvolnum></citerefentry>.
464
492
<refsect1 id="see_also">
465
493
<title>SEE ALSO</title>
467
<citerefentry><refentrytitle>password-request</refentrytitle>
468
<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>,
469
499
<citerefentry><refentrytitle>mandos</refentrytitle>
470
500
<manvolnum>8</manvolnum></citerefentry>,
471
<citerefentry><refentrytitle>gpg</refentrytitle>
472
<manvolnum>1</manvolnum></citerefentry>
501
<citerefentry><refentrytitle>mandos-client</refentrytitle>
502
<manvolnum>8mandos</manvolnum></citerefentry>
507
<!-- Local Variables: -->
508
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
509
<!-- time-stamp-end: "[\"']>" -->
510
<!-- time-stamp-format: "%:y-%02m-%02d" -->