47
66
<refname><command>&COMMANDNAME;</command></refname>
49
Generate key and password for Mandos client and server.
68
Generate keys for <citerefentry><refentrytitle>password-request
69
</refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>
55
75
<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>
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>
122
159
<command>&COMMANDNAME;</command>
123
160
<group choice="req">
161
<arg choice="plain"><option>-p</option></arg>
124
162
<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>
165
<arg choice="plain"><option>--dir</option>
166
<replaceable>directory</replaceable></arg>
169
<arg choice="plain"><option>--name</option>
170
<replaceable>NAME</replaceable></arg>
147
174
<command>&COMMANDNAME;</command>
148
175
<group choice="req">
176
<arg choice="plain"><option>-h</option></arg>
149
177
<arg choice="plain"><option>--help</option></arg>
150
<arg choice="plain"><option>-h</option></arg>
154
181
<command>&COMMANDNAME;</command>
155
182
<group choice="req">
183
<arg choice="plain"><option>-v</option></arg>
156
184
<arg choice="plain"><option>--version</option></arg>
157
<arg choice="plain"><option>-v</option></arg>
160
187
</refsynopsisdiv>
162
189
<refsect1 id="description">
163
190
<title>DESCRIPTION</title>
165
192
<command>&COMMANDNAME;</command> is a program to generate the
167
<citerefentry><refentrytitle>mandos-client</refentrytitle>
168
<manvolnum>8mandos</manvolnum></citerefentry>. The key is
194
<citerefentry><refentrytitle>password-request</refentrytitle>
195
<manvolnum>8mandos</manvolnum></citerefentry>. The keys are
169
196
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.
197
initrd image, but this, like most things, can be changed with
198
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
201
It can also be used to generate ready-made sections for
178
202
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
179
<manvolnum>5</manvolnum></citerefentry>).
203
<manvolnum>5</manvolnum></citerefentry> using the
204
<option>--password</option> option.
183
208
<refsect1 id="purpose">
184
209
<title>PURPOSE</title>
186
212
The purpose of this is to enable <emphasis>remote and unattended
187
213
rebooting</emphasis> of client host computer with an
188
214
<emphasis>encrypted root file system</emphasis>. See <xref
189
215
linkend="overview"/> for details.
193
220
<refsect1 id="options">
194
221
<title>OPTIONS</title>
198
<term><option>--help</option></term>
199
<term><option>-h</option></term>
225
<term><literal>-h</literal>, <literal>--help</literal></term>
202
228
Show a help message and exit
209
<replaceable>DIRECTORY</replaceable></option></term>
211
<replaceable>DIRECTORY</replaceable></option></term>
234
<term><literal>-d</literal>, <literal>--dir
235
<replaceable>directory</replaceable></literal></term>
214
238
Target directory for key files. Default is
433
429
Normal invocation needs no options:
436
<userinput>&COMMANDNAME;</userinput>
432
<userinput>mandos-keygen</userinput>
438
434
</informalexample>
439
435
<informalexample>
441
Create key in another directory and of another type. Force
437
Create keys in another directory and of another type. Force
442
438
overwriting old key files:
446
442
<!-- 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>
443
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
473
446
</informalexample>
476
449
<refsect1 id="security">
477
450
<title>SECURITY</title>
479
452
The <option>--type</option>, <option>--length</option>,
480
453
<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.
454
options can be used to create keys of insufficient security. If
455
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>
458
The key expire time is not guaranteed to be honored by
459
<citerefentry><refentrytitle>mandos</refentrytitle>
487
460
<manvolnum>8</manvolnum></citerefentry>.
491
464
<refsect1 id="see_also">
492
465
<title>SEE ALSO</title>
467
<citerefentry><refentrytitle>password-request</refentrytitle>
468
<manvolnum>8mandos</manvolnum></citerefentry>,
469
<citerefentry><refentrytitle>mandos</refentrytitle>
470
<manvolnum>8</manvolnum></citerefentry>,
494
471
<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>
472
<manvolnum>1</manvolnum></citerefentry>
506
<!-- Local Variables: -->
507
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
508
<!-- time-stamp-end: "[\"']>" -->
509
<!-- time-stamp-format: "%:y-%02m-%02d" -->