1
<?xml version="1.0" encoding="UTF-8"?>
1
<?xml version='1.0' encoding='UTF-8'?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "mandos-keygen">
6
<!ENTITY TIMESTAMP "2008-08-29">
6
<!ENTITY OVERVIEW SYSTEM "overview.xml">
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
<title>Mandos Manual</title>
12
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
<productname>Mandos</productname>
11
<title>&COMMANDNAME;</title>
12
<!-- NWalsh's docbook scripts use this to generate the footer: -->
13
<productname>&COMMANDNAME;</productname>
14
14
<productnumber>&VERSION;</productnumber>
15
<date>&TIMESTAMP;</date>
18
17
<firstname>Björn</firstname>
88
86
<replaceable>bits</replaceable></arg>
90
88
<group choice="opt">
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
89
<arg choice="plain"><option>--name</option>
100
90
<replaceable>NAME</replaceable></arg>
130
120
<replaceable>bits</replaceable></arg>
132
122
<group choice="opt">
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
123
<arg choice="plain"><option>-n</option>
142
124
<replaceable>NAME</replaceable></arg>
161
143
<command>&COMMANDNAME;</command>
162
144
<group choice="req">
163
<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>
176
<command>&COMMANDNAME;</command>
178
<arg choice="plain"><option>-h</option></arg>
179
<arg choice="plain"><option>--help</option></arg>
183
<command>&COMMANDNAME;</command>
185
<arg choice="plain"><option>-v</option></arg>
186
<arg choice="plain"><option>--version</option></arg>
145
<arg choice='plain'><option>-h</option></arg>
146
<arg choice='plain'><option>--help</option></arg>
150
<command>&COMMANDNAME;</command>
152
<arg choice='plain'><option>-v</option></arg>
153
<arg choice='plain'><option>--version</option></arg>
189
156
</refsynopsisdiv>
199
166
initrd image, but this, like most things, can be changed with
200
167
command line options.
203
It can also be used to generate ready-made sections for
204
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
205
<manvolnum>5</manvolnum></citerefentry> using the
206
<option>--password</option> option.
210
171
<refsect1 id="purpose">
258
218
<replaceable>bits</replaceable></literal></term>
261
Key length in bits. Default is 2048.
267
<term><literal>-s</literal>, <literal>--subtype
268
<replaceable>type</replaceable></literal></term>
271
Subkey type. Default is <quote>ELG-E</quote> (Elgamal
278
<term><literal>-L</literal>, <literal>--sublength
279
<replaceable>bits</replaceable></literal></term>
282
Subkey length in bits. Default is 2048.
221
Key length in bits. Default is 1024.
329
<term><literal>-p</literal>, <literal>--password</literal
333
Prompt for a password and encrypt it with the key already
334
present in either <filename>/etc/mandos</filename> or the
335
directory specified with the <option>--dir</option>
336
option. Outputs, on standard output, a section suitable
337
for inclusion in <citerefentry><refentrytitle
338
>mandos-clients.conf</refentrytitle><manvolnum
339
>8</manvolnum></citerefentry>. The host name or the name
340
specified with the <option>--name</option> option is used
341
for the section header. All other options are ignored,
342
and no keys are created.
349
270
<refsect1 id="overview">
350
271
<title>OVERVIEW</title>
351
<xi:include href="overview.xml"/>
353
This program is a small utility to generate new OpenPGP keys for
274
This program is a small program to generate new OpenPGP keys for
354
275
new Mandos clients.
358
279
<refsect1 id="exit_status">
359
280
<title>EXIT STATUS</title>
361
The exit status will be 0 if new keys were successfully created,
366
<refsect1 id="environment">
367
<title>ENVIRONMENT</title>
370
<term><varname>TMPDIR</varname></term>
373
If set, temporary files will be created here. See
374
<citerefentry><refentrytitle>mktemp</refentrytitle>
375
<manvolnum>1</manvolnum></citerefentry>.
382
285
<refsect1 id="file">
383
286
<title>FILES</title>
385
Use the <option>--dir</option> option to change where
386
<command>&COMMANDNAME;</command> will write the key files. The
387
default file names are shown here.
391
<term><filename>/etc/mandos/seckey.txt</filename></term>
394
OpenPGP secret key file which will be created or
400
<term><filename>/etc/mandos/pubkey.txt</filename></term>
403
OpenPGP public key file which will be created or
409
<term><filename>/tmp</filename></term>
412
Temporary files will be written here if
413
<varname>TMPDIR</varname> is not set.
420
291
<refsect1 id="bugs">
421
292
<title>BUGS</title>
423
None are known at this time.
427
297
<refsect1 id="example">
428
298
<title>EXAMPLE</title>
431
Normal invocation needs no options:
434
<userinput>&COMMANDNAME;</userinput>
439
Create keys in another directory and of another type. Force
440
overwriting old key files:
444
<!-- do not wrap this line -->
445
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
451
303
<refsect1 id="security">
452
304
<title>SECURITY</title>
454
The <option>--type</option>, <option>--length</option>,
455
<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.
460
The key expire time is not guaranteed to be honored by
461
<citerefentry><refentrytitle>mandos</refentrytitle>
462
<manvolnum>8</manvolnum></citerefentry>.
469
312
<citerefentry><refentrytitle>password-request</refentrytitle>
470
313
<manvolnum>8mandos</manvolnum></citerefentry>,
471
314
<citerefentry><refentrytitle>mandos</refentrytitle>
472
<manvolnum>8</manvolnum></citerefentry>,
315
<manvolnum>8</manvolnum></citerefentry>, and
473
316
<citerefentry><refentrytitle>gpg</refentrytitle>
474
317
<manvolnum>1</manvolnum></citerefentry>
479
<!-- Local Variables: -->
480
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
481
<!-- time-stamp-end: "[\"']>" -->
482
<!-- time-stamp-format: "%:y-%02m-%02d" -->