/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: 2015-06-28 16:35:27 UTC
  • mto: This revision was merged to the branch mainline in revision 759.
  • Revision ID: teddy@recompile.se-20150628163527-cky0ec59zew7teua
Add a plugin helper directory, available to all plugins.

* Makefile (PLUGIN_HELPERS): New; list of plugin helpers.
  (CPROGS): Appended "$(PLUGIN_HELPERS)".
* initramfs-tools-hook: Create new plugin helper directory, and copy
                        plugin helpers provided by the system and/or
                        by the local administrator.
  (PLUGINHELPERDIR): New.
* plugin-runner.c: Take new --plugin-helper-dir option and provide
                   environment variable to all plugins.
  (PHDIR): New; set to "/lib/mandos/plugin-helpers".
  (main/pluginhelperdir): New.
  (main/options): New option "--plugin-helper-dir".
  (main/parse_opt, main/parse_opt_config_file): Accept new option.
  (main): Use new option to set MANDOSPLUGINHELPERDIR environment
          variable as if using --global-env MANDOSPLUGINHELPERDIR=...
* plugin-runner.xml: Document new --plugin-helper-dir option.
  (SYNOPSIS, OPTIONS): Add "--plugin-helper-dir" option.
  (PLUGINS/WRITING PLUGINS): Document new environment variable
                             available to plugins.
  (ENVIRONMENT): Document new environment variable
                 "MANDOSPLUGINHELPERDIR" affected by the new
                 --plugin-helper-dir option.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
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 COMMANDNAME "mandos-keygen">
5
 
<!ENTITY TIMESTAMP "2009-01-04">
 
5
<!ENTITY TIMESTAMP "2014-06-22">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
 
36
      <year>2011</year>
 
37
      <year>2012</year>
36
38
      <holder>Teddy Hogeborn</holder>
37
39
      <holder>Björn Påhlsson</holder>
38
40
    </copyright>
117
119
        <replaceable>TIME</replaceable></option></arg>
118
120
      </group>
119
121
      <sbr/>
120
 
      <arg><option>--force</option></arg>
 
122
      <group>
 
123
        <arg choice="plain"><option>--force</option></arg>
 
124
        <arg choice="plain"><option>-f</option></arg>
 
125
      </group>
121
126
    </cmdsynopsis>
122
127
    <cmdsynopsis>
123
128
      <command>&COMMANDNAME;</command>
143
148
        <arg choice="plain"><option>-n
144
149
        <replaceable>NAME</replaceable></option></arg>
145
150
      </group>
 
151
      <group>
 
152
        <arg choice="plain"><option>--no-ssh</option></arg>
 
153
        <arg choice="plain"><option>-S</option></arg>
 
154
      </group>
146
155
    </cmdsynopsis>
147
156
    <cmdsynopsis>
148
157
      <command>&COMMANDNAME;</command>
213
222
        <listitem>
214
223
          <para>
215
224
            Target directory for key files.  Default is
216
 
            <filename>/etc/mandos</filename>.
 
225
            <filename class="directory">/etc/mandos</filename>.
217
226
          </para>
218
227
        </listitem>
219
228
      </varlistentry>
225
234
        <replaceable>TYPE</replaceable></option></term>
226
235
        <listitem>
227
236
          <para>
228
 
            Key type.  Default is <quote>DSA</quote>.
 
237
            Key type.  Default is <quote>RSA</quote>.
229
238
          </para>
230
239
        </listitem>
231
240
      </varlistentry>
237
246
        <replaceable>BITS</replaceable></option></term>
238
247
        <listitem>
239
248
          <para>
240
 
            Key length in bits.  Default is 2048.
 
249
            Key length in bits.  Default is 4096.
241
250
          </para>
242
251
        </listitem>
243
252
      </varlistentry>
249
258
        <replaceable>KEYTYPE</replaceable></option></term>
250
259
        <listitem>
251
260
          <para>
252
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
261
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
253
262
            encryption-only).
254
263
          </para>
255
264
        </listitem>
262
271
        <replaceable>BITS</replaceable></option></term>
263
272
        <listitem>
264
273
          <para>
265
 
            Subkey length in bits.  Default is 2048.
 
274
            Subkey length in bits.  Default is 4096.
266
275
          </para>
267
276
        </listitem>
268
277
      </varlistentry>
286
295
        <replaceable>TEXT</replaceable></option></term>
287
296
        <listitem>
288
297
          <para>
289
 
            Comment field for key.  The default value is
290
 
            <quote><literal>Mandos client key</literal></quote>.
 
298
            Comment field for key.  Default is empty.
291
299
          </para>
292
300
        </listitem>
293
301
      </varlistentry>
345
353
          </para>
346
354
        </listitem>
347
355
      </varlistentry>
 
356
      <varlistentry>
 
357
        <term><option>--no-ssh</option></term>
 
358
        <term><option>-S</option></term>
 
359
        <listitem>
 
360
          <para>
 
361
            When <option>--password</option> or
 
362
            <option>--passfile</option> is given, this option will
 
363
            prevent <command>&COMMANDNAME;</command> from calling
 
364
            <command>ssh-keyscan</command> to get an SSH fingerprint
 
365
            for this host and, if successful, output suitable config
 
366
            options to use this fingerprint as a
 
367
            <option>checker</option> option in the output.  This is
 
368
            otherwise the default behavior.
 
369
          </para>
 
370
        </listitem>
 
371
      </varlistentry>
348
372
    </variablelist>
349
373
  </refsect1>
350
374
  
410
434
        </listitem>
411
435
      </varlistentry>
412
436
      <varlistentry>
413
 
        <term><filename>/tmp</filename></term>
 
437
        <term><filename class="directory">/tmp</filename></term>
414
438
        <listitem>
415
439
          <para>
416
440
            Temporary files will be written here if
451
475
    </informalexample>
452
476
    <informalexample>
453
477
      <para>
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>.
 
478
        Prompt for a password, encrypt it with the key in <filename
 
479
        class="directory">/etc/mandos</filename> and output a section
 
480
        suitable for <filename>clients.conf</filename>.
457
481
      </para>
458
482
      <para>
459
483
        <userinput>&COMMANDNAME; --password</userinput>
492
516
  <refsect1 id="see_also">
493
517
    <title>SEE ALSO</title>
494
518
    <para>
 
519
      <citerefentry><refentrytitle>intro</refentrytitle>
 
520
      <manvolnum>8mandos</manvolnum></citerefentry>,
495
521
      <citerefentry><refentrytitle>gpg</refentrytitle>
496
522
      <manvolnum>1</manvolnum></citerefentry>,
497
523
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
499
525
      <citerefentry><refentrytitle>mandos</refentrytitle>
500
526
      <manvolnum>8</manvolnum></citerefentry>,
501
527
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
502
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
528
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
529
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
 
530
      <manvolnum>1</manvolnum></citerefentry>
503
531
    </para>
504
532
  </refsect1>
505
533