/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: 2024-09-08 00:11:24 UTC
  • mto: This revision was merged to the branch mainline in revision 410.
  • Revision ID: teddy@recompile.se-20240908001124-nq0ja17503ua9nmw
Minor documentation improvements 

* TODO (mandos-applet): Add link.
* debian/mandos-client.README.Debian: Fix spelling.

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 "2016-02-28">
 
6
<!ENTITY TIMESTAMP "2019-02-10">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
41
41
      <year>2014</year>
42
42
      <year>2015</year>
43
43
      <year>2016</year>
 
44
      <year>2017</year>
 
45
      <year>2018</year>
 
46
      <year>2019</year>
44
47
      <holder>Teddy Hogeborn</holder>
45
48
      <holder>Björn Påhlsson</holder>
46
49
    </copyright>
184
187
            >--</option> %%(host)s</literal></quote>.  Note that
185
188
            <command>mandos-keygen</command>, when generating output
186
189
            to be inserted into this file, normally looks for an SSH
187
 
            server on the Mandos client, and, if it find one, outputs
 
190
            server on the Mandos client, and, if it finds one, outputs
188
191
            a <option>checker</option> option to check for the
189
 
            client’s key fingerprint – this is more secure against
 
192
            client’s SSH key fingerprint – this is more secure against
190
193
            spoofing.
191
194
          </para>
192
195
          <para>
225
228
        ><replaceable>HEXSTRING</replaceable></option></term>
226
229
        <listitem>
227
230
          <para>
228
 
            This option is <emphasis>required</emphasis>.
229
 
          </para>
230
 
          <para>
231
 
            This option sets the OpenPGP fingerprint that identifies
232
 
            the public key that clients authenticate themselves with
233
 
            through TLS.  The string needs to be in hexidecimal form,
234
 
            but spaces or upper/lower case are not significant.
 
231
            This option is <emphasis>required</emphasis> if the
 
232
            <option>key_id</option> is not set, and
 
233
            <emphasis>optional</emphasis> otherwise.
 
234
          </para>
 
235
          <para>
 
236
            This option sets the OpenPGP fingerprint that (before
 
237
            GnuTLS 3.6.0) identified the public key that clients
 
238
            authenticate themselves with through TLS.  The string
 
239
            needs to be in hexadecimal form, but spaces or upper/lower
 
240
            case are not significant.
 
241
          </para>
 
242
        </listitem>
 
243
      </varlistentry>
 
244
      
 
245
      <varlistentry>
 
246
        <term><option>key_id<literal> = </literal
 
247
        ><replaceable>HEXSTRING</replaceable></option></term>
 
248
        <listitem>
 
249
          <para>
 
250
            This option is <emphasis>required</emphasis> if the
 
251
            <option>fingerprint</option> is not set, and
 
252
            <emphasis>optional</emphasis> otherwise.
 
253
          </para>
 
254
          <para>
 
255
            This option sets the certificate key ID that (with GnuTLS
 
256
            3.6.6 or later) identifies the public key that clients
 
257
            authenticate themselves with through TLS.  The string
 
258
            needs to be in hexadecimal form, but spaces or upper/lower
 
259
            case are not significant.
235
260
          </para>
236
261
        </listitem>
237
262
      </varlistentry>
312
337
          <para>
313
338
            If present, this option must be set to a string of
314
339
            base64-encoded binary data.  It will be decoded and sent
315
 
            to the client matching the above
316
 
            <option>fingerprint</option>.  This should, of course, be
317
 
            OpenPGP encrypted data, decryptable only by the client.
 
340
            to the client matching the above <option>key_id</option>
 
341
            or <option>fingerprint</option>.  This should, of course,
 
342
            be OpenPGP encrypted data, decryptable only by the client.
318
343
            The program <citerefentry><refentrytitle><command
319
344
            >mandos-keygen</command></refentrytitle><manvolnum
320
345
            >8</manvolnum></citerefentry> can, using its
415
440
        <quote><literal>created</literal></quote>,
416
441
        <quote><literal>enabled</literal></quote>,
417
442
        <quote><literal>expires</literal></quote>,
 
443
        <quote><literal>key_id</literal></quote>,
418
444
        <quote><literal>fingerprint</literal></quote>,
419
445
        <quote><literal>host</literal></quote>,
420
446
        <quote><literal>interval</literal></quote>,
463
489
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
464
490
      obscure.
465
491
    </para>
 
492
    <xi:include href="bugs.xml"/>
466
493
  </refsect1>
467
494
  
468
495
  <refsect1 id="example">
476
503
 
477
504
# Client "foo"
478
505
[foo]
 
506
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
479
507
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
480
508
secret =
481
509
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
498
526
 
499
527
# Client "bar"
500
528
[bar]
 
529
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
501
530
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
502
531
secfile = /etc/mandos/bar-secret
503
532
timeout = PT15M