/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-clients.conf.xml

  • Committer: Teddy Hogeborn
  • Date: 2019-07-29 16:35:53 UTC
  • mto: This revision was merged to the branch mainline in revision 384.
  • Revision ID: teddy@recompile.se-20190729163553-1i442i2cbx64c537
Make tests and man page examples match

Make the tests test_manual_page_example[1-5] match exactly what is
written in the manual page, and add comments to manual page as
reminders to keep tests and manual page examples in sync.

* mandos-ctl (Test_commands_from_options.test_manual_page_example_1):
  Remove "--verbose" option, since the manual does not have it as the
  first example, and change assertion to match.
* mandos-ctl.xml (EXAMPLE): Add comments to all examples documenting
  which test function they correspond to.  Also remove unnecessary
  quotes from option arguments in fourth example, and clarify language
  slightly in fifth example.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY CONFNAME "mandos-clients.conf">
5
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2017-02-23">
 
6
<!ENTITY TIMESTAMP "2019-02-10">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
42
42
      <year>2015</year>
43
43
      <year>2016</year>
44
44
      <year>2017</year>
 
45
      <year>2018</year>
 
46
      <year>2019</year>
45
47
      <holder>Teddy Hogeborn</holder>
46
48
      <holder>Björn Påhlsson</holder>
47
49
    </copyright>
185
187
            >--</option> %%(host)s</literal></quote>.  Note that
186
188
            <command>mandos-keygen</command>, when generating output
187
189
            to be inserted into this file, normally looks for an SSH
188
 
            server on the Mandos client, and, if it find one, outputs
 
190
            server on the Mandos client, and, if it finds one, outputs
189
191
            a <option>checker</option> option to check for the
190
 
            client’s key fingerprint – this is more secure against
 
192
            client’s SSH key fingerprint – this is more secure against
191
193
            spoofing.
192
194
          </para>
193
195
          <para>
238
240
      </varlistentry>
239
241
      
240
242
      <varlistentry>
 
243
        <term><option>key_id<literal> = </literal
 
244
        ><replaceable>HEXSTRING</replaceable></option></term>
 
245
        <listitem>
 
246
          <para>
 
247
            This option is <emphasis>optional</emphasis>.
 
248
          </para>
 
249
          <para>
 
250
            This option sets the certificate key ID that identifies
 
251
            the public key that clients authenticate themselves with
 
252
            through TLS.  The string needs to be in hexadecimal form,
 
253
            but spaces or upper/lower case are not significant.
 
254
          </para>
 
255
        </listitem>
 
256
      </varlistentry>
 
257
      
 
258
      <varlistentry>
241
259
        <term><option><literal>host = </literal><replaceable
242
260
        >STRING</replaceable></option></term>
243
261
        <listitem>
313
331
          <para>
314
332
            If present, this option must be set to a string of
315
333
            base64-encoded binary data.  It will be decoded and sent
316
 
            to the client matching the above
317
 
            <option>fingerprint</option>.  This should, of course, be
318
 
            OpenPGP encrypted data, decryptable only by the client.
 
334
            to the client matching the above <option>key_id</option>
 
335
            or <option>fingerprint</option>.  This should, of course,
 
336
            be OpenPGP encrypted data, decryptable only by the client.
319
337
            The program <citerefentry><refentrytitle><command
320
338
            >mandos-keygen</command></refentrytitle><manvolnum
321
339
            >8</manvolnum></citerefentry> can, using its
416
434
        <quote><literal>created</literal></quote>,
417
435
        <quote><literal>enabled</literal></quote>,
418
436
        <quote><literal>expires</literal></quote>,
 
437
        <quote><literal>key_id</literal></quote>,
419
438
        <quote><literal>fingerprint</literal></quote>,
420
439
        <quote><literal>host</literal></quote>,
421
440
        <quote><literal>interval</literal></quote>,
478
497
 
479
498
# Client "foo"
480
499
[foo]
 
500
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
481
501
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
482
502
secret =
483
503
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
500
520
 
501
521
# Client "bar"
502
522
[bar]
 
523
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
503
524
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
504
525
secfile = /etc/mandos/bar-secret
505
526
timeout = PT15M