/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: 2019-02-10 03:50:20 UTC
  • Revision ID: teddy@recompile.se-20190210035020-nttr1tybgwwixueu
Show debconf note about new TLS key IDs

If mandos-client did not see TLS keys and had to create them, or if
mandos sees GnuTLS version 3.6.6 or later, show an important notice on
package installation about the importance of adding the new key_id
options to clients.conf on the Mandos server.

* debian/control (Package: mandos, Package: mandos-client): Depend on
                                                            debconf.
* debian/mandos-client.lintian-overrides: Override warnings.
* debian/mandos-client.postinst (create_keys): Show notice if new TLS
                                               key files were created.
* debian/mandos-client.templates: New.
* debian/mandos.lintian-overrides: Override warnings.
* debian/mandos.postinst (configure): If GnuTLS 3.6.6 or later is
                                      detected, show an important
                                      notice (once) about the new
                                      key_id option required in
                                      clients.conf.
* debian/mandos.templates: New.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2019-07-29">
 
5
<!ENTITY TIMESTAMP "2018-02-08">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
40
40
      <year>2016</year>
41
41
      <year>2017</year>
42
42
      <year>2018</year>
43
 
      <year>2019</year>
44
43
      <holder>Teddy Hogeborn</holder>
45
44
      <holder>Björn Påhlsson</holder>
46
45
    </copyright>
62
61
  <refsynopsisdiv>
63
62
    <cmdsynopsis>
64
63
      <command>&COMMANDNAME;</command>
65
 
      <group>
66
 
          <arg choice="plain"><option>--verbose</option></arg>
67
 
          <arg choice="plain"><option>-v</option></arg>
68
 
          <sbr/>
69
 
          <arg choice="plain"><option>--dump-json</option></arg>
70
 
          <arg choice="plain"><option>-j</option></arg>
71
 
      </group>
72
 
      <arg><option>--debug</option></arg>
73
 
      <group>
74
 
        <arg rep='repeat' choice='plain'>
75
 
          <replaceable>CLIENT</replaceable>
76
 
        </arg>
77
 
      </group>
78
 
    </cmdsynopsis>
79
 
    <cmdsynopsis>
80
 
      <command>&COMMANDNAME;</command>
81
64
      <group choice="req">
82
65
        <group>
83
66
          <arg choice="plain"><option>--enable</option></arg>
94
77
        <sbr/>
95
78
        <group>
96
79
          <arg choice="plain"><option>--start-checker</option></arg>
 
80
        </group>
 
81
        <sbr/>
 
82
        <group>
97
83
          <arg choice="plain"><option>--stop-checker</option></arg>
98
84
        </group>
99
85
        <sbr/>
100
86
        <group>
 
87
          <arg choice="plain"><option>--remove</option></arg>
 
88
          <arg choice="plain"><option>-r</option></arg>
 
89
        </group>
 
90
        <sbr/>
 
91
        <group>
101
92
          <arg choice="plain"><option>--checker
102
93
          <replaceable>COMMAND</replaceable></option></arg>
103
94
          <arg choice="plain"><option>-c
141
132
        </group>
142
133
        <sbr/>
143
134
        <group>
 
135
          <arg choice="plain"><option>--interval
 
136
          <replaceable>TIME</replaceable></option></arg>
 
137
          <arg choice="plain"><option>-i
 
138
          <replaceable>TIME</replaceable></option></arg>
 
139
        </group>
 
140
        <sbr/>
 
141
        <group>
144
142
          <arg choice="plain"><option>--host
145
143
          <replaceable>STRING</replaceable></option></arg>
146
144
          <arg choice="plain"><option>-H
163
161
        </group>
164
162
      </group>
165
163
      <sbr/>
166
 
      <arg><option>--debug</option></arg>
167
164
      <group choice="req">
168
165
        <arg choice="plain"><option>--all</option></arg>
169
166
        <arg choice="plain"><option>-a</option></arg>
175
172
    <cmdsynopsis>
176
173
      <command>&COMMANDNAME;</command>
177
174
      <group>
178
 
        <arg choice="plain"><option>--deny</option></arg>
179
 
        <arg choice="plain"><option>-D</option></arg>
180
 
      </group>
181
 
      <group choice="req">
182
 
          <arg choice="plain"><option>--remove</option></arg>
183
 
          <arg choice="plain"><option>-r</option></arg>
184
 
      </group>
185
 
      <sbr/>
186
 
      <arg><option>--debug</option></arg>
187
 
      <group choice="req">
188
 
        <arg choice="plain"><option>--all</option></arg>
189
 
        <arg choice="plain"><option>-a</option></arg>
 
175
          <arg choice="plain"><option>--verbose</option></arg>
 
176
          <arg choice="plain"><option>-v</option></arg>
 
177
          <sbr/>
 
178
          <arg choice="plain"><option>--dump-json</option></arg>
 
179
          <arg choice="plain"><option>-j</option></arg>
 
180
      </group>
 
181
      <group>
190
182
        <arg rep='repeat' choice='plain'>
191
183
          <replaceable>CLIENT</replaceable>
192
184
        </arg>
198
190
        <arg choice="plain"><option>--is-enabled</option></arg>
199
191
        <arg choice="plain"><option>-V</option></arg>
200
192
      </group>
201
 
      <arg><option>--debug</option></arg>
202
193
      <arg choice='plain'><replaceable>CLIENT</replaceable></arg>
203
194
    </cmdsynopsis>
204
195
    <cmdsynopsis>
512
503
      </varlistentry>
513
504
      
514
505
      <varlistentry>
515
 
        <term><option>--debug</option></term>
516
 
        <listitem>
517
 
          <para>
518
 
            Show debug output; currently, this means show D-Bus calls.
519
 
          </para>
520
 
        </listitem>
521
 
      </varlistentry>
522
 
      
523
 
      <varlistentry>
524
506
        <term><option>--check</option></term>
525
507
        <listitem>
526
508
          <para>
557
539
  
558
540
  <refsect1 id="example">
559
541
    <title>EXAMPLE</title>
560
 
    <!-- Name of test methods in class Test_commands_from_options are
561
 
         written in comments below.  When adding an example, add a
562
 
         test too which tests the documented behavior. -->
563
542
    <informalexample>
564
 
      <!-- Test method: test_manual_page_example_1() -->
565
543
      <para>
566
544
        To list all clients:
567
545
      </para>
571
549
    </informalexample>
572
550
    
573
551
    <informalexample>
574
 
      <!-- Test method: test_manual_page_example_2() -->
575
552
      <para>
576
553
        To list <emphasis>all</emphasis> settings for the clients
577
554
        named <quote>foo1.example.org</quote> and <quote
586
563
    </informalexample>
587
564
    
588
565
    <informalexample>
589
 
      <!-- Test method: test_manual_page_example_3() -->
590
566
      <para>
591
567
        To enable all clients:
592
568
      </para>
596
572
    </informalexample>
597
573
    
598
574
    <informalexample>
599
 
      <!-- Test method: test_manual_page_example_4() -->
600
575
      <para>
601
576
        To change timeout and interval value for the clients
602
577
        named <quote>foo1.example.org</quote> and <quote
605
580
      <para>
606
581
 
607
582
<!-- do not wrap this line -->
608
 
<userinput>&COMMANDNAME; --timeout=PT5M --interval=PT1M foo1.example.org foo2.example.org</userinput>
 
583
<userinput>&COMMANDNAME; --timeout="5m" --interval="1m" foo1.example.org foo2.example.org</userinput>
609
584
 
610
585
      </para>
611
586
    </informalexample>
612
587
    
613
588
    <informalexample>
614
 
      <!-- Test method: test_manual_page_example_5() -->
615
589
      <para>
616
 
        To approve all clients currently waiting for approval:
 
590
        To approve all clients currently waiting for it:
617
591
      </para>
618
592
      <para>
619
593
        <userinput>&COMMANDNAME; --approve --all</userinput>