/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-clients.conf.xml

  • Committer: Teddy Hogeborn
  • Date: 2019-02-09 23:36:11 UTC
  • Revision ID: teddy@recompile.se-20190209233611-qurtq0kpsoct9uwf
Doc fix: Minor clarification

* mandos-clients.conf.xml (OPTIONS/checker): Be more clear that it's
  specifically an SSH key fingerprint that is being compared, and no
  other kind of fingerprint.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2015-07-20">
 
6
<!ENTITY TIMESTAMP "2019-02-09">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
40
40
      <year>2013</year>
41
41
      <year>2014</year>
42
42
      <year>2015</year>
 
43
      <year>2016</year>
 
44
      <year>2017</year>
 
45
      <year>2018</year>
43
46
      <holder>Teddy Hogeborn</holder>
44
47
      <holder>Björn Påhlsson</holder>
45
48
    </copyright>
183
186
            >--</option> %%(host)s</literal></quote>.  Note that
184
187
            <command>mandos-keygen</command>, when generating output
185
188
            to be inserted into this file, normally looks for an SSH
186
 
            server on the Mandos client, and, if it find one, outputs
 
189
            server on the Mandos client, and, if it finds one, outputs
187
190
            a <option>checker</option> option to check for the
188
 
            client’s key fingerprint – this is more secure against
 
191
            client’s SSH key fingerprint – this is more secure against
189
192
            spoofing.
190
193
          </para>
191
194
          <para>
229
232
          <para>
230
233
            This option sets the OpenPGP fingerprint that identifies
231
234
            the public key that clients authenticate themselves with
232
 
            through TLS.  The string needs to be in hexidecimal form,
 
235
            through TLS.  The string needs to be in hexadecimal form,
 
236
            but spaces or upper/lower case are not significant.
 
237
          </para>
 
238
        </listitem>
 
239
      </varlistentry>
 
240
      
 
241
      <varlistentry>
 
242
        <term><option>key_id<literal> = </literal
 
243
        ><replaceable>HEXSTRING</replaceable></option></term>
 
244
        <listitem>
 
245
          <para>
 
246
            This option is <emphasis>optional</emphasis>.
 
247
          </para>
 
248
          <para>
 
249
            This option sets the certificate key ID that identifies
 
250
            the public key that clients authenticate themselves with
 
251
            through TLS.  The string needs to be in hexadecimal form,
233
252
            but spaces or upper/lower case are not significant.
234
253
          </para>
235
254
        </listitem>
311
330
          <para>
312
331
            If present, this option must be set to a string of
313
332
            base64-encoded binary data.  It will be decoded and sent
314
 
            to the client matching the above
315
 
            <option>fingerprint</option>.  This should, of course, be
316
 
            OpenPGP encrypted data, decryptable only by the client.
 
333
            to the client matching the above <option>key_id</option>
 
334
            or <option>fingerprint</option>.  This should, of course,
 
335
            be OpenPGP encrypted data, decryptable only by the client.
317
336
            The program <citerefentry><refentrytitle><command
318
337
            >mandos-keygen</command></refentrytitle><manvolnum
319
338
            >8</manvolnum></citerefentry> can, using its
414
433
        <quote><literal>created</literal></quote>,
415
434
        <quote><literal>enabled</literal></quote>,
416
435
        <quote><literal>expires</literal></quote>,
 
436
        <quote><literal>key_id</literal></quote>,
417
437
        <quote><literal>fingerprint</literal></quote>,
418
438
        <quote><literal>host</literal></quote>,
419
439
        <quote><literal>interval</literal></quote>,
462
482
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
463
483
      obscure.
464
484
    </para>
 
485
    <xi:include href="bugs.xml"/>
465
486
  </refsect1>
466
487
  
467
488
  <refsect1 id="example">
475
496
 
476
497
# Client "foo"
477
498
[foo]
 
499
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
478
500
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
479
501
secret =
480
502
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
497
519
 
498
520
# Client "bar"
499
521
[bar]
 
522
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
500
523
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
501
524
secfile = /etc/mandos/bar-secret
502
525
timeout = PT15M