/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-ctl.xml

  • Committer: Teddy Hogeborn
  • Date: 2017-02-21 22:15:43 UTC
  • Revision ID: teddy@recompile.se-20170221221543-kkh15uag0luiyz4y
Remove useless code (and use "read -r") in initramfs-tools-hook

* initramfs-tools-hook: When reading module names from network hooks
  given the "modules" argument, use "read -r" and ignore ${target}
  variable (left over from code above it).

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl.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-ctl">
5
 
<!ENTITY TIMESTAMP "2010-09-21">
 
5
<!ENTITY TIMESTAMP "2016-06-27">
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>2010</year>
 
35
      <year>2011</year>
 
36
      <year>2012</year>
 
37
      <year>2013</year>
 
38
      <year>2014</year>
 
39
      <year>2015</year>
 
40
      <year>2016</year>
35
41
      <holder>Teddy Hogeborn</holder>
36
42
      <holder>Björn Påhlsson</holder>
37
43
    </copyright>
46
52
  <refnamediv>
47
53
    <refname><command>&COMMANDNAME;</command></refname>
48
54
    <refpurpose>
49
 
      Control the operation of the Mandos server
 
55
      Control or query the operation of the Mandos server
50
56
    </refpurpose>
51
57
  </refnamediv>
52
58
  
53
59
  <refsynopsisdiv>
54
60
    <cmdsynopsis>
55
61
      <command>&COMMANDNAME;</command>
56
 
      <group>
57
 
        <arg choice="plain"><option>--enable</option></arg>
58
 
        <arg choice="plain"><option>-e</option></arg>
59
 
        <sbr/>
60
 
        <arg choice="plain"><option>--disable</option></arg>
61
 
        <arg choice="plain"><option>-d</option></arg>
62
 
      </group>
63
 
      <sbr/>
64
 
      <group>
65
 
        <arg choice="plain"><option>--bump-timeout</option></arg>
66
 
        <arg choice="plain"><option>-b</option></arg>
67
 
      </group>
68
 
      <sbr/>
69
 
      <group>
70
 
        <arg choice="plain"><option>--start-checker</option></arg>
71
 
      </group>
72
 
      <sbr/>
73
 
      <group>
74
 
        <arg choice="plain"><option>--stop-checker</option></arg>
75
 
      </group>
76
 
      <sbr/>
77
 
      <group>
78
 
        <arg choice="plain"><option>--remove</option></arg>
79
 
        <arg choice="plain"><option>-r</option></arg>
80
 
      </group>
81
 
      <sbr/>
82
 
      <group>
83
 
        <arg choice="plain"><option>--checker
84
 
        <replaceable>COMMAND</replaceable></option></arg>
85
 
        <arg choice="plain"><option>-c
86
 
        <replaceable>COMMAND</replaceable></option></arg>
87
 
      </group>
88
 
      <sbr/>
89
 
      <group>
90
 
        <arg choice="plain"><option>--timeout
91
 
        <replaceable>TIME</replaceable></option></arg>
92
 
        <arg choice="plain"><option>-t
93
 
        <replaceable>TIME</replaceable></option></arg>
94
 
      </group>
95
 
      <sbr/>
96
 
      <group>
97
 
        <arg choice="plain"><option>--interval
98
 
        <replaceable>TIME</replaceable></option></arg>
99
 
        <arg choice="plain"><option>-i
100
 
        <replaceable>TIME</replaceable></option></arg>
101
 
      </group>
102
 
      <sbr/>
103
 
      <group>
104
 
        <arg choice="plain"><option>--host
105
 
        <replaceable>STRING</replaceable></option></arg>
106
 
        <arg choice="plain"><option>-H
107
 
        <replaceable>STRING</replaceable></option></arg>
108
 
      </group>
109
 
      <sbr/>
110
 
      <group>
111
 
        <arg choice="plain"><option>--secret
112
 
        <replaceable>FILENAME</replaceable></option></arg>
113
 
        <arg choice="plain"><option>-s
114
 
        <replaceable>FILENAME</replaceable></option></arg>
115
 
      </group>
116
 
      <sbr/>
117
 
      <group>
118
 
        <arg choice="plain"><option>--approve</option></arg>
119
 
        <arg choice="plain"><option>-A</option></arg>
120
 
        <sbr/>
121
 
        <arg choice="plain"><option>--deny</option></arg>
122
 
        <arg choice="plain"><option>-D</option></arg>
 
62
      <group choice="req">
 
63
        <group>
 
64
          <arg choice="plain"><option>--enable</option></arg>
 
65
          <arg choice="plain"><option>-e</option></arg>
 
66
          <sbr/>
 
67
          <arg choice="plain"><option>--disable</option></arg>
 
68
          <arg choice="plain"><option>-d</option></arg>
 
69
        </group>
 
70
        <sbr/>
 
71
        <group>
 
72
          <arg choice="plain"><option>--bump-timeout</option></arg>
 
73
          <arg choice="plain"><option>-b</option></arg>
 
74
        </group>
 
75
        <sbr/>
 
76
        <group>
 
77
          <arg choice="plain"><option>--start-checker</option></arg>
 
78
        </group>
 
79
        <sbr/>
 
80
        <group>
 
81
          <arg choice="plain"><option>--stop-checker</option></arg>
 
82
        </group>
 
83
        <sbr/>
 
84
        <group>
 
85
          <arg choice="plain"><option>--remove</option></arg>
 
86
          <arg choice="plain"><option>-r</option></arg>
 
87
        </group>
 
88
        <sbr/>
 
89
        <group>
 
90
          <arg choice="plain"><option>--checker
 
91
          <replaceable>COMMAND</replaceable></option></arg>
 
92
          <arg choice="plain"><option>-c
 
93
          <replaceable>COMMAND</replaceable></option></arg>
 
94
        </group>
 
95
        <sbr/>
 
96
        <group>
 
97
          <arg choice="plain"><option>--timeout
 
98
          <replaceable>TIME</replaceable></option></arg>
 
99
          <arg choice="plain"><option>-t
 
100
          <replaceable>TIME</replaceable></option></arg>
 
101
        </group>
 
102
        <sbr/>
 
103
        <group>
 
104
          <arg choice="plain"><option>--extended-timeout
 
105
          <replaceable>TIME</replaceable></option></arg>
 
106
        </group>
 
107
        <sbr/>
 
108
        <group>
 
109
          <arg choice="plain"><option>--interval
 
110
          <replaceable>TIME</replaceable></option></arg>
 
111
          <arg choice="plain"><option>-i
 
112
          <replaceable>TIME</replaceable></option></arg>
 
113
        </group>
 
114
        <sbr/>
 
115
        <group>
 
116
          <arg choice="plain"><option>--approve-by-default</option
 
117
          ></arg>
 
118
          <sbr/>
 
119
          <arg choice="plain"><option>--deny-by-default</option></arg>
 
120
        </group>
 
121
        <sbr/>
 
122
        <group>
 
123
          <arg choice="plain"><option>--approval-delay
 
124
          <replaceable>TIME</replaceable></option></arg>
 
125
        </group>
 
126
        <sbr/>
 
127
        <group>
 
128
          <arg choice="plain"><option>--approval-duration
 
129
          <replaceable>TIME</replaceable></option></arg>
 
130
        </group>
 
131
        <sbr/>
 
132
        <group>
 
133
          <arg choice="plain"><option>--interval
 
134
          <replaceable>TIME</replaceable></option></arg>
 
135
          <arg choice="plain"><option>-i
 
136
          <replaceable>TIME</replaceable></option></arg>
 
137
        </group>
 
138
        <sbr/>
 
139
        <group>
 
140
          <arg choice="plain"><option>--host
 
141
          <replaceable>STRING</replaceable></option></arg>
 
142
          <arg choice="plain"><option>-H
 
143
          <replaceable>STRING</replaceable></option></arg>
 
144
        </group>
 
145
        <sbr/>
 
146
        <group>
 
147
          <arg choice="plain"><option>--secret
 
148
          <replaceable>FILENAME</replaceable></option></arg>
 
149
          <arg choice="plain"><option>-s
 
150
          <replaceable>FILENAME</replaceable></option></arg>
 
151
        </group>
 
152
        <sbr/>
 
153
        <group>
 
154
          <arg choice="plain"><option>--approve</option></arg>
 
155
          <arg choice="plain"><option>-A</option></arg>
 
156
          <sbr/>
 
157
          <arg choice="plain"><option>--deny</option></arg>
 
158
          <arg choice="plain"><option>-D</option></arg>
 
159
        </group>
123
160
      </group>
124
161
      <sbr/>
125
162
      <group choice="req">
133
170
    <cmdsynopsis>
134
171
      <command>&COMMANDNAME;</command>
135
172
      <group>
136
 
        <arg choice="plain"><option>--verbose</option></arg>
137
 
        <arg choice="plain"><option>-v</option></arg>
 
173
          <arg choice="plain"><option>--verbose</option></arg>
 
174
          <arg choice="plain"><option>-v</option></arg>
 
175
          <sbr/>
 
176
          <arg choice="plain"><option>--dump-json</option></arg>
 
177
          <arg choice="plain"><option>-j</option></arg>
138
178
      </group>
139
179
      <group>
140
180
        <arg rep='repeat' choice='plain'>
164
204
        <arg choice="plain"><option>-v</option></arg>
165
205
      </group>
166
206
    </cmdsynopsis>
 
207
    <cmdsynopsis>
 
208
      <command>&COMMANDNAME;</command>
 
209
      <arg choice="plain"><option>--check</option></arg>
 
210
    </cmdsynopsis>
167
211
  </refsynopsisdiv>
168
212
  
169
213
  <refsect1 id="description">
170
214
    <title>DESCRIPTION</title>
171
215
    <para>
172
 
      <command>&COMMANDNAME;</command> is a program to control the
173
 
      operation of the Mandos server <citerefentry><refentrytitle
174
 
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
 
216
      <command>&COMMANDNAME;</command> is a program to control or
 
217
      query the operation of the Mandos server
 
218
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
 
219
      >8</manvolnum></citerefentry>.
175
220
    </para>
176
221
    <para>
177
222
      This program can be used to change client settings, approve or
273
318
          <para>
274
319
            Set the <varname>checker</varname> option of the specified
275
320
            client(s); see <citerefentry><refentrytitle
276
 
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
277
 
            ></citerefentry>.
 
321
            >mandos-clients.conf</refentrytitle><manvolnum
 
322
            >5</manvolnum></citerefentry>.
278
323
          </para>
279
324
        </listitem>
280
325
      </varlistentry>
288
333
          <para>
289
334
            Set the <varname>timeout</varname> option of the specified
290
335
            client(s); see <citerefentry><refentrytitle
291
 
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
292
 
            ></citerefentry>.
 
336
            >mandos-clients.conf</refentrytitle><manvolnum
 
337
            >5</manvolnum></citerefentry>.
 
338
          </para>
 
339
        </listitem>
 
340
      </varlistentry>
 
341
 
 
342
      <varlistentry>
 
343
        <term><option>--extended-timeout
 
344
        <replaceable>TIME</replaceable></option></term>
 
345
        <listitem>
 
346
          <para>
 
347
            Set the <varname>extended_timeout</varname> option of the
 
348
            specified client(s); see <citerefentry><refentrytitle
 
349
            >mandos-clients.conf</refentrytitle><manvolnum
 
350
            >5</manvolnum></citerefentry>.
293
351
          </para>
294
352
        </listitem>
295
353
      </varlistentry>
301
359
        <replaceable>TIME</replaceable></option></term>
302
360
        <listitem>
303
361
          <para>
304
 
            Set the <varname>interval</varname> option of the specified
305
 
            client(s); see <citerefentry><refentrytitle
306
 
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
307
 
            ></citerefentry>.
 
362
            Set the <varname>interval</varname> option of the
 
363
            specified client(s); see <citerefentry><refentrytitle
 
364
            >mandos-clients.conf</refentrytitle><manvolnum
 
365
            >5</manvolnum></citerefentry>.
 
366
          </para>
 
367
        </listitem>
 
368
      </varlistentry>
 
369
      
 
370
      <varlistentry>
 
371
        <term><option>--approve-by-default</option></term>
 
372
        <term><option>--deny-by-default</option></term>
 
373
        <listitem>
 
374
          <para>
 
375
            Set the <varname>approved_by_default</varname> option of
 
376
            the specified client(s) to <literal>True</literal> or
 
377
            <literal>False</literal>, respectively; see
 
378
            <citerefentry><refentrytitle
 
379
            >mandos-clients.conf</refentrytitle><manvolnum
 
380
            >5</manvolnum></citerefentry>.
 
381
          </para>
 
382
        </listitem>
 
383
      </varlistentry>
 
384
      
 
385
      <varlistentry>
 
386
        <term><option>--approval-delay
 
387
        <replaceable>TIME</replaceable></option></term>
 
388
        <listitem>
 
389
          <para>
 
390
            Set the <varname>approval_delay</varname> option of the
 
391
            specified client(s); see <citerefentry><refentrytitle
 
392
            >mandos-clients.conf</refentrytitle><manvolnum
 
393
            >5</manvolnum></citerefentry>.
 
394
          </para>
 
395
        </listitem>
 
396
      </varlistentry>
 
397
      
 
398
      <varlistentry>
 
399
        <term><option>--approval-duration
 
400
        <replaceable>TIME</replaceable></option></term>
 
401
        <listitem>
 
402
          <para>
 
403
            Set the <varname>approval_duration</varname> option of the
 
404
            specified client(s); see <citerefentry><refentrytitle
 
405
            >mandos-clients.conf</refentrytitle><manvolnum
 
406
            >5</manvolnum></citerefentry>.
308
407
          </para>
309
408
        </listitem>
310
409
      </varlistentry>
318
417
          <para>
319
418
            Set the <varname>host</varname> option of the specified
320
419
            client(s); see <citerefentry><refentrytitle
321
 
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
322
 
            ></citerefentry>.
 
420
            >mandos-clients.conf</refentrytitle><manvolnum
 
421
            >5</manvolnum></citerefentry>.
323
422
          </para>
324
423
        </listitem>
325
424
      </varlistentry>
333
432
          <para>
334
433
            Set the <varname>secfile</varname> option of the specified
335
434
            client(s); see <citerefentry><refentrytitle
336
 
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
337
 
            ></citerefentry>.
 
435
            >mandos-clients.conf</refentrytitle><manvolnum
 
436
            >5</manvolnum></citerefentry>.
338
437
          </para>
339
438
        </listitem>
340
439
      </varlistentry>
381
480
      </varlistentry>
382
481
      
383
482
      <varlistentry>
 
483
        <term><option>--dump-json</option></term>
 
484
        <term><option>-j</option></term>
 
485
        <listitem>
 
486
          <para>
 
487
            Dump client settings as JSON to standard output.
 
488
          </para>
 
489
        </listitem>
 
490
      </varlistentry>
 
491
      
 
492
      <varlistentry>
384
493
        <term><option>--is-enabled</option></term>
385
494
        <term><option>-V</option></term>
386
495
        <listitem>
391
500
        </listitem>
392
501
      </varlistentry>
393
502
      
 
503
      <varlistentry>
 
504
        <term><option>--check</option></term>
 
505
        <listitem>
 
506
          <para>
 
507
            Run self-tests.  This includes any unit tests, etc.
 
508
          </para>
 
509
        </listitem>
 
510
      </varlistentry>
 
511
      
394
512
    </variablelist>
395
513
  </refsect1>
396
514
  
412
530
    </para>
413
531
  </refsect1>
414
532
  
415
 
<!--   <refsect1 id="bugs"> -->
416
 
<!--     <title>BUGS</title> -->
417
 
<!--     <para> -->
418
 
<!--     </para> -->
419
 
<!--   </refsect1> -->
 
533
  <refsect1 id="bugs">
 
534
    <title>BUGS</title>
 
535
    <xi:include href="bugs.xml"/>
 
536
  </refsect1>
420
537
  
421
538
  <refsect1 id="example">
422
539
    <title>EXAMPLE</title>
423
540
    <informalexample>
424
541
      <para>
425
 
        List all clients with some of their settings:
 
542
        To list all clients:
426
543
      </para>
427
544
      <para>
428
545
        <userinput>&COMMANDNAME;</userinput>
429
546
      </para>
430
547
    </informalexample>
431
 
    <informalexample>
432
 
      <para>
433
 
        Show all settings for the clients named <quote>foo</quote> and
434
 
        <quote>bar</quote>:
435
 
      </para>
436
 
      <para>
437
 
 
438
 
<!-- do not wrap this line -->
439
 
<userinput>&COMMANDNAME; --verbose foo bar</userinput>
440
 
 
 
548
    
 
549
    <informalexample>
 
550
      <para>
 
551
        To list <emphasis>all</emphasis> settings for the clients
 
552
        named <quote>foo1.example.org</quote> and <quote
 
553
        >foo2.example.org</quote>:
 
554
      </para>
 
555
      <para>
 
556
 
 
557
<!-- do not wrap this line -->
 
558
<userinput>&COMMANDNAME; --verbose foo1.example.org foo2.example.org</userinput>
 
559
 
 
560
      </para>
 
561
    </informalexample>
 
562
    
 
563
    <informalexample>
 
564
      <para>
 
565
        To enable all clients:
 
566
      </para>
 
567
      <para>
 
568
        <userinput>&COMMANDNAME; --enable --all</userinput>
 
569
      </para>
 
570
    </informalexample>
 
571
    
 
572
    <informalexample>
 
573
      <para>
 
574
        To change timeout and interval value for the clients
 
575
        named <quote>foo1.example.org</quote> and <quote
 
576
        >foo2.example.org</quote>:
 
577
      </para>
 
578
      <para>
 
579
 
 
580
<!-- do not wrap this line -->
 
581
<userinput>&COMMANDNAME; --timeout="5m" --interval="1m" foo1.example.org foo2.example.org</userinput>
 
582
 
 
583
      </para>
 
584
    </informalexample>
 
585
    
 
586
    <informalexample>
 
587
      <para>
 
588
        To approve all clients currently waiting for it:
 
589
      </para>
 
590
      <para>
 
591
        <userinput>&COMMANDNAME; --approve --all</userinput>
441
592
      </para>
442
593
    </informalexample>
443
594
  </refsect1>
454
605
  <refsect1 id="see_also">
455
606
    <title>SEE ALSO</title>
456
607
    <para>
 
608
      <citerefentry><refentrytitle>intro</refentrytitle>
 
609
      <manvolnum>8mandos</manvolnum></citerefentry>,
457
610
      <citerefentry><refentrytitle>mandos</refentrytitle>
458
611
      <manvolnum>8</manvolnum></citerefentry>,
459
612
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>