/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-keygen.xml

  • Committer: Teddy Hogeborn
  • Date: 2018-01-29 19:43:17 UTC
  • Revision ID: teddy@recompile.se-20180129194317-07fz89jdxefuphq1
Use "simply expanded" variables in Makefile

* (Makefile): Use "simply expanded" variables where possible.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
1
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
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos-keygen">
6
 
<!ENTITY TIMESTAMP "2008-08-31">
 
5
<!ENTITY TIMESTAMP "2017-02-23">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
34
44
      <holder>Teddy Hogeborn</holder>
35
45
      <holder>Björn Påhlsson</holder>
36
46
    </copyright>
37
 
    <legalnotice>
38
 
      <para>
39
 
        This manual page is free software: you can redistribute it
40
 
        and/or modify it under the terms of the GNU General Public
41
 
        License as published by the Free Software Foundation,
42
 
        either version 3 of the License, or (at your option) any
43
 
        later version.
44
 
      </para>
45
 
 
46
 
      <para>
47
 
        This manual page is distributed in the hope that it will
48
 
        be useful, but WITHOUT ANY WARRANTY; without even the
49
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
50
 
        PARTICULAR PURPOSE.  See the GNU General Public License
51
 
        for more details.
52
 
      </para>
53
 
 
54
 
      <para>
55
 
        You should have received a copy of the GNU General Public
56
 
        License along with this program; If not, see
57
 
        <ulink url="http://www.gnu.org/licenses/"/>.
58
 
      </para>
59
 
    </legalnotice>
 
47
    <xi:include href="legalnotice.xml"/>
60
48
  </refentryinfo>
61
 
 
 
49
  
62
50
  <refmeta>
63
51
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
52
    <manvolnum>8</manvolnum>
70
58
      Generate key and password for Mandos client and server.
71
59
    </refpurpose>
72
60
  </refnamediv>
73
 
 
 
61
  
74
62
  <refsynopsisdiv>
75
63
    <cmdsynopsis>
76
64
      <command>&COMMANDNAME;</command>
137
125
        <replaceable>TIME</replaceable></option></arg>
138
126
      </group>
139
127
      <sbr/>
140
 
      <arg><option>--force</option></arg>
 
128
      <group>
 
129
        <arg choice="plain"><option>--force</option></arg>
 
130
        <arg choice="plain"><option>-f</option></arg>
 
131
      </group>
141
132
    </cmdsynopsis>
142
133
    <cmdsynopsis>
143
134
      <command>&COMMANDNAME;</command>
144
135
      <group choice="req">
145
136
        <arg choice="plain"><option>--password</option></arg>
146
137
        <arg choice="plain"><option>-p</option></arg>
 
138
        <arg choice="plain"><option>--passfile
 
139
        <replaceable>FILE</replaceable></option></arg>
 
140
        <arg choice="plain"><option>-F</option>
 
141
        <replaceable>FILE</replaceable></arg>
147
142
      </group>
148
143
      <sbr/>
149
144
      <group>
159
154
        <arg choice="plain"><option>-n
160
155
        <replaceable>NAME</replaceable></option></arg>
161
156
      </group>
 
157
      <group>
 
158
        <arg choice="plain"><option>--no-ssh</option></arg>
 
159
        <arg choice="plain"><option>-S</option></arg>
 
160
      </group>
162
161
    </cmdsynopsis>
163
162
    <cmdsynopsis>
164
163
      <command>&COMMANDNAME;</command>
181
180
    <para>
182
181
      <command>&COMMANDNAME;</command> is a program to generate the
183
182
      OpenPGP key used by
184
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
183
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
185
184
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
186
185
      normally written to /etc/mandos for later installation into the
187
186
      initrd image, but this, and most other things, can be changed
189
188
    </para>
190
189
    <para>
191
190
      This program can also be used with the
192
 
      <option>--password</option> option to generate a ready-made
193
 
      section for <filename>clients.conf</filename> (see
 
191
      <option>--password</option> or <option>--passfile</option>
 
192
      options to generate a ready-made section for
 
193
      <filename>clients.conf</filename> (see
194
194
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
195
195
      <manvolnum>5</manvolnum></citerefentry>).
196
196
    </para>
219
219
          </para>
220
220
        </listitem>
221
221
      </varlistentry>
222
 
 
 
222
      
223
223
      <varlistentry>
224
224
        <term><option>--dir
225
225
        <replaceable>DIRECTORY</replaceable></option></term>
228
228
        <listitem>
229
229
          <para>
230
230
            Target directory for key files.  Default is
231
 
            <filename>/etc/mandos</filename>.
 
231
            <filename class="directory">/etc/mandos</filename>.
232
232
          </para>
233
233
        </listitem>
234
234
      </varlistentry>
235
 
 
 
235
      
236
236
      <varlistentry>
237
237
        <term><option>--type
238
238
        <replaceable>TYPE</replaceable></option></term>
240
240
        <replaceable>TYPE</replaceable></option></term>
241
241
        <listitem>
242
242
          <para>
243
 
            Key type.  Default is <quote>DSA</quote>.
 
243
            Key type.  Default is <quote>RSA</quote>.
244
244
          </para>
245
245
        </listitem>
246
246
      </varlistentry>
247
 
 
 
247
      
248
248
      <varlistentry>
249
249
        <term><option>--length
250
250
        <replaceable>BITS</replaceable></option></term>
252
252
        <replaceable>BITS</replaceable></option></term>
253
253
        <listitem>
254
254
          <para>
255
 
            Key length in bits.  Default is 2048.
 
255
            Key length in bits.  Default is 4096.
256
256
          </para>
257
257
        </listitem>
258
258
      </varlistentry>
259
 
 
 
259
      
260
260
      <varlistentry>
261
261
        <term><option>--subtype
262
262
        <replaceable>KEYTYPE</replaceable></option></term>
264
264
        <replaceable>KEYTYPE</replaceable></option></term>
265
265
        <listitem>
266
266
          <para>
267
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
267
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
268
268
            encryption-only).
269
269
          </para>
270
270
        </listitem>
271
271
      </varlistentry>
272
 
 
 
272
      
273
273
      <varlistentry>
274
274
        <term><option>--sublength
275
275
        <replaceable>BITS</replaceable></option></term>
277
277
        <replaceable>BITS</replaceable></option></term>
278
278
        <listitem>
279
279
          <para>
280
 
            Subkey length in bits.  Default is 2048.
 
280
            Subkey length in bits.  Default is 4096.
281
281
          </para>
282
282
        </listitem>
283
283
      </varlistentry>
284
 
 
 
284
      
285
285
      <varlistentry>
286
286
        <term><option>--email
287
287
        <replaceable>ADDRESS</replaceable></option></term>
293
293
          </para>
294
294
        </listitem>
295
295
      </varlistentry>
296
 
 
 
296
      
297
297
      <varlistentry>
298
298
        <term><option>--comment
299
299
        <replaceable>TEXT</replaceable></option></term>
301
301
        <replaceable>TEXT</replaceable></option></term>
302
302
        <listitem>
303
303
          <para>
304
 
            Comment field for key.  The default value is
305
 
            <quote><literal>Mandos client key</literal></quote>.
 
304
            Comment field for key.  Default is empty.
306
305
          </para>
307
306
        </listitem>
308
307
      </varlistentry>
309
 
 
 
308
      
310
309
      <varlistentry>
311
310
        <term><option>--expire
312
311
        <replaceable>TIME</replaceable></option></term>
320
319
          </para>
321
320
        </listitem>
322
321
      </varlistentry>
323
 
 
 
322
      
324
323
      <varlistentry>
325
324
        <term><option>--force</option></term>
326
325
        <term><option>-f</option></term>
348
347
          </para>
349
348
        </listitem>
350
349
      </varlistentry>
 
350
      <varlistentry>
 
351
        <term><option>--passfile
 
352
        <replaceable>FILE</replaceable></option></term>
 
353
        <term><option>-F
 
354
        <replaceable>FILE</replaceable></option></term>
 
355
        <listitem>
 
356
          <para>
 
357
            The same as <option>--password</option>, but read from
 
358
            <replaceable>FILE</replaceable>, not the terminal.
 
359
          </para>
 
360
        </listitem>
 
361
      </varlistentry>
 
362
      <varlistentry>
 
363
        <term><option>--no-ssh</option></term>
 
364
        <term><option>-S</option></term>
 
365
        <listitem>
 
366
          <para>
 
367
            When <option>--password</option> or
 
368
            <option>--passfile</option> is given, this option will
 
369
            prevent <command>&COMMANDNAME;</command> from calling
 
370
            <command>ssh-keyscan</command> to get an SSH fingerprint
 
371
            for this host and, if successful, output suitable config
 
372
            options to use this fingerprint as a
 
373
            <option>checker</option> option in the output.  This is
 
374
            otherwise the default behavior.
 
375
          </para>
 
376
        </listitem>
 
377
      </varlistentry>
351
378
    </variablelist>
352
379
  </refsect1>
353
 
 
 
380
  
354
381
  <refsect1 id="overview">
355
382
    <title>OVERVIEW</title>
356
383
    <xi:include href="overview.xml"/>
360
387
      <filename>clients.conf</filename> on the server.
361
388
    </para>
362
389
  </refsect1>
363
 
 
 
390
  
364
391
  <refsect1 id="exit_status">
365
392
    <title>EXIT STATUS</title>
366
393
    <para>
386
413
    </variablelist>
387
414
  </refsect1>
388
415
  
389
 
  <refsect1 id="file">
 
416
  <refsect1 id="files">
390
417
    <title>FILES</title>
391
418
    <para>
392
419
      Use the <option>--dir</option> option to change where
413
440
        </listitem>
414
441
      </varlistentry>
415
442
      <varlistentry>
416
 
        <term><filename>/tmp</filename></term>
 
443
        <term><filename class="directory">/tmp</filename></term>
417
444
        <listitem>
418
445
          <para>
419
446
            Temporary files will be written here if
423
450
      </varlistentry>
424
451
    </variablelist>
425
452
  </refsect1>
426
 
 
 
453
  
427
454
  <refsect1 id="bugs">
428
455
    <title>BUGS</title>
429
 
    <para>
430
 
      None are known at this time.
431
 
    </para>
 
456
    <xi:include href="bugs.xml"/>
432
457
  </refsect1>
433
 
 
 
458
  
434
459
  <refsect1 id="example">
435
460
    <title>EXAMPLE</title>
436
461
    <informalexample>
455
480
    </informalexample>
456
481
    <informalexample>
457
482
      <para>
458
 
        Prompt for a password, encrypt it with the key in
459
 
        <filename>/etc/mandos</filename> and output a section suitable
460
 
        for <filename>clients.conf</filename>.
 
483
        Prompt for a password, encrypt it with the key in <filename
 
484
        class="directory">/etc/mandos</filename> and output a section
 
485
        suitable for <filename>clients.conf</filename>.
461
486
      </para>
462
487
      <para>
463
488
        <userinput>&COMMANDNAME; --password</userinput>
477
502
      </para>
478
503
    </informalexample>
479
504
  </refsect1>
480
 
 
 
505
  
481
506
  <refsect1 id="security">
482
507
    <title>SECURITY</title>
483
508
    <para>
492
517
      <manvolnum>8</manvolnum></citerefentry>.
493
518
    </para>
494
519
  </refsect1>
495
 
 
 
520
  
496
521
  <refsect1 id="see_also">
497
522
    <title>SEE ALSO</title>
498
523
    <para>
 
524
      <citerefentry><refentrytitle>intro</refentrytitle>
 
525
      <manvolnum>8mandos</manvolnum></citerefentry>,
499
526
      <citerefentry><refentrytitle>gpg</refentrytitle>
500
527
      <manvolnum>1</manvolnum></citerefentry>,
501
528
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
502
529
      <manvolnum>5</manvolnum></citerefentry>,
503
530
      <citerefentry><refentrytitle>mandos</refentrytitle>
504
531
      <manvolnum>8</manvolnum></citerefentry>,
505
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
506
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
532
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
533
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
534
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
 
535
      <manvolnum>1</manvolnum></citerefentry>
507
536
    </para>
508
537
  </refsect1>
509
538