/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 plugins.d/mandos-client.xml

  • Committer: Björn Påhlsson
  • Date: 2010-09-07 16:48:58 UTC
  • mto: (237.7.1 mandos)
  • mto: This revision was merged to the branch mainline in revision 270.
  • Revision ID: belorn@fukt.bsnet.se-20100907164858-tcg8hkxdj41zizac
mandos server: Added debuglevel that adjust at what level information
               should be reported.
plugin-runner, askpass-fifo, password-prompt, splasy, usplash:
               Using error instead of perror

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/mandos-client.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
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
 
<!ENTITY VERSION "1.0">
5
 
<!ENTITY COMMANDNAME "password-request">
6
 
<!ENTITY TIMESTAMP "2008-09-02">
 
4
<!ENTITY COMMANDNAME "mandos-client">
 
5
<!ENTITY TIMESTAMP "2009-02-09">
 
6
<!ENTITY % common SYSTEM "../common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
11
  <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
34
36
      <holder>Teddy Hogeborn</holder>
35
37
      <holder>Björn Påhlsson</holder>
36
38
    </copyright>
37
39
    <xi:include href="../legalnotice.xml"/>
38
40
  </refentryinfo>
39
 
 
 
41
  
40
42
  <refmeta>
41
43
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
44
    <manvolnum>8mandos</manvolnum>
45
47
  <refnamediv>
46
48
    <refname><command>&COMMANDNAME;</command></refname>
47
49
    <refpurpose>
48
 
      Client for mandos
 
50
      Client for <application>Mandos</application>
49
51
    </refpurpose>
50
52
  </refnamediv>
51
 
 
 
53
  
52
54
  <refsynopsisdiv>
53
55
    <cmdsynopsis>
54
56
      <command>&COMMANDNAME;</command>
55
57
      <group>
56
58
        <arg choice="plain"><option>--connect
57
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
59
        <replaceable>ADDRESS</replaceable><literal>:</literal
58
60
        ><replaceable>PORT</replaceable></option></arg>
59
61
        <arg choice="plain"><option>-c
60
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
62
        <replaceable>ADDRESS</replaceable><literal>:</literal
61
63
        ><replaceable>PORT</replaceable></option></arg>
62
64
      </group>
63
65
      <sbr/>
64
66
      <group>
65
 
        <arg choice="plain"><option>--keydir
66
 
        <replaceable>DIRECTORY</replaceable></option></arg>
67
 
        <arg choice="plain"><option>-d
68
 
        <replaceable>DIRECTORY</replaceable></option></arg>
69
 
      </group>
70
 
      <sbr/>
71
 
      <group>
72
67
        <arg choice="plain"><option>--interface
73
68
        <replaceable>NAME</replaceable></option></arg>
74
69
        <arg choice="plain"><option>-i
98
93
      </arg>
99
94
      <sbr/>
100
95
      <arg>
 
96
        <option>--delay <replaceable>SECONDS</replaceable></option>
 
97
      </arg>
 
98
      <sbr/>
 
99
      <arg>
101
100
        <option>--debug</option>
102
101
      </arg>
103
102
    </cmdsynopsis>
120
119
      </group>
121
120
    </cmdsynopsis>
122
121
  </refsynopsisdiv>
123
 
 
 
122
  
124
123
  <refsect1 id="description">
125
124
    <title>DESCRIPTION</title>
126
125
    <para>
127
126
      <command>&COMMANDNAME;</command> is a client program that
128
127
      communicates with <citerefentry><refentrytitle
129
128
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
130
 
      to get a password.  It uses IPv6 link-local addresses to get
131
 
      network connectivity, Zeroconf to find the server, and TLS with
132
 
      an OpenPGP key to ensure authenticity and confidentiality.  It
133
 
      keeps running, trying all servers on the network, until it
134
 
      receives a satisfactory reply.
 
129
      to get a password.  In slightly more detail, this client program
 
130
      brings up a network interface, uses the interface’s IPv6
 
131
      link-local address to get network connectivity, uses Zeroconf to
 
132
      find servers on the local network, and communicates with servers
 
133
      using TLS with an OpenPGP key to ensure authenticity and
 
134
      confidentiality.  This client program keeps running, trying all
 
135
      servers on the network, until it receives a satisfactory reply
 
136
      or a TERM signal is received.  If no servers are found, or after
 
137
      all servers have been tried, it waits indefinitely for new
 
138
      servers to appear.
135
139
    </para>
136
140
    <para>
137
141
      This program is not meant to be run directly; it is really meant
138
142
      to run as a plugin of the <application>Mandos</application>
139
143
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
140
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which in turn
141
 
      runs as a <quote>keyscript</quote> specified in the
142
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
143
 
      <manvolnum>5</manvolnum></citerefentry> file.
 
144
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
 
145
      initial <acronym>RAM</acronym> disk environment because it is
 
146
      specified as a <quote>keyscript</quote> in the <citerefentry>
 
147
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
 
148
      </citerefentry> file.
144
149
    </para>
145
150
  </refsect1>
146
151
  
154
159
    </para>
155
160
  </refsect1>
156
161
  
157
 
  <refsect1 id="overview">
158
 
    <title>OVERVIEW</title>
159
 
    <xi:include href="overview.xml"/>
160
 
    <para>
161
 
      This program is the client part.  It is a plugin started by
162
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
163
 
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
164
 
      an initial <acronym>RAM</acronym> disk environment.
165
 
    </para>
166
 
    <para>
167
 
      This program could, theoretically, be used as a keyscript in
168
 
      <filename>/etc/crypttab</filename>, but it would then be
169
 
      impossible to enter the encrypted root disk password at the
170
 
      console, since this program does not read from the console at
171
 
      all.  This is why a separate plugin does that, which will be run
172
 
      in parallell to this one.
173
 
    </para>
174
 
  </refsect1>
175
 
  
176
162
  <refsect1 id="options">
177
163
    <title>OPTIONS</title>
178
164
    <para>
188
174
    <variablelist>
189
175
      <varlistentry>
190
176
        <term><option>--connect=<replaceable
191
 
        >IPADDR</replaceable><literal>:</literal><replaceable
 
177
        >ADDRESS</replaceable><literal>:</literal><replaceable
192
178
        >PORT</replaceable></option></term>
193
179
        <term><option>-c
194
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
180
        <replaceable>ADDRESS</replaceable><literal>:</literal
195
181
        ><replaceable>PORT</replaceable></option></term>
196
182
        <listitem>
197
183
          <para>
202
188
            assumed to separate the address from the port number.
203
189
          </para>
204
190
          <para>
205
 
            This option is normally only useful for debugging.
 
191
            This option is normally only useful for testing and
 
192
            debugging.
206
193
          </para>
207
194
        </listitem>
208
195
      </varlistentry>
209
196
      
210
197
      <varlistentry>
211
 
        <term><option>--keydir=<replaceable
212
 
        >DIRECTORY</replaceable></option></term>
213
 
        <term><option>-d
214
 
        <replaceable>DIRECTORY</replaceable></option></term>
215
 
        <listitem>
216
 
          <para>
217
 
            Directory to read the OpenPGP key files
218
 
            <filename>pubkey.txt</filename> and
219
 
            <filename>seckey.txt</filename> from.  The default is
220
 
            <filename>/conf/conf.d/mandos</filename> (in the initial
221
 
            <acronym>RAM</acronym> disk environment).
222
 
          </para>
223
 
        </listitem>
224
 
      </varlistentry>
225
 
 
226
 
      <varlistentry>
227
 
        <term><option>--interface=
228
 
        <replaceable>NAME</replaceable></option></term>
 
198
        <term><option>--interface=<replaceable
 
199
        >NAME</replaceable></option></term>
229
200
        <term><option>-i
230
201
        <replaceable>NAME</replaceable></option></term>
231
202
        <listitem>
232
203
          <para>
233
204
            Network interface that will be brought up and scanned for
234
 
            Mandos servers to connect to.  The default it
 
205
            Mandos servers to connect to.  The default is
235
206
            <quote><literal>eth0</literal></quote>.
236
207
          </para>
 
208
          <para>
 
209
            If the <option>--connect</option> option is used, this
 
210
            specifies the interface to use to connect to the address
 
211
            given.
 
212
          </para>
 
213
          <para>
 
214
            Note that since this program will normally run in the
 
215
            initial RAM disk environment, the interface must be an
 
216
            interface which exists at that stage.  Thus, the interface
 
217
            can not be a pseudo-interface such as <quote>br0</quote>
 
218
            or <quote>tun0</quote>; such interfaces will not exist
 
219
            until much later in the boot process, and can not be used
 
220
            by this program.
 
221
          </para>
 
222
          <para>
 
223
            <replaceable>NAME</replaceable> can be the empty string;
 
224
            this will not use any specific interface, and will not
 
225
            bring up an interface on startup.  This is not
 
226
            recommended, and only meant for advanced users.
 
227
          </para>
237
228
        </listitem>
238
229
      </varlistentry>
239
230
      
244
235
        <replaceable>FILE</replaceable></option></term>
245
236
        <listitem>
246
237
          <para>
247
 
            OpenPGP public key file name.  This will be combined with
248
 
            the directory from the <option>--keydir</option> option to
249
 
            form an absolute file name.  The default name is
250
 
            <quote><literal>pubkey.txt</literal></quote>.
 
238
            OpenPGP public key file name.  The default name is
 
239
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
 
240
            ></quote>.
251
241
          </para>
252
242
        </listitem>
253
243
      </varlistentry>
254
 
 
 
244
      
255
245
      <varlistentry>
256
246
        <term><option>--seckey=<replaceable
257
247
        >FILE</replaceable></option></term>
259
249
        <replaceable>FILE</replaceable></option></term>
260
250
        <listitem>
261
251
          <para>
262
 
            OpenPGP secret key file name.  This will be combined with
263
 
            the directory from the <option>--keydir</option> option to
264
 
            form an absolute file name.  The default name is
265
 
            <quote><literal>seckey.txt</literal></quote>.
 
252
            OpenPGP secret key file name.  The default name is
 
253
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
 
254
            ></quote>.
266
255
          </para>
267
256
        </listitem>
268
257
      </varlistentry>
271
260
        <term><option>--priority=<replaceable
272
261
        >STRING</replaceable></option></term>
273
262
        <listitem>
274
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
263
          <xi:include href="../mandos-options.xml"
 
264
                      xpointer="priority"/>
275
265
        </listitem>
276
266
      </varlistentry>
277
 
 
 
267
      
278
268
      <varlistentry>
279
269
        <term><option>--dh-bits=<replaceable
280
270
        >BITS</replaceable></option></term>
285
275
          </para>
286
276
        </listitem>
287
277
      </varlistentry>
 
278
 
 
279
      <varlistentry>
 
280
        <term><option>--delay=<replaceable
 
281
        >SECONDS</replaceable></option></term>
 
282
        <listitem>
 
283
          <para>
 
284
            After bringing the network interface up, the program waits
 
285
            for the interface to arrive in a <quote>running</quote>
 
286
            state before proceeding.  During this time, the kernel log
 
287
            level will be lowered to reduce clutter on the system
 
288
            console, alleviating any other plugins which might be
 
289
            using the system console.  This option sets the upper
 
290
            limit of seconds to wait.  The default is 2.5 seconds.
 
291
          </para>
 
292
        </listitem>
 
293
      </varlistentry>
288
294
      
289
295
      <varlistentry>
290
296
        <term><option>--debug</option></term>
320
326
          </para>
321
327
        </listitem>
322
328
      </varlistentry>
323
 
 
 
329
      
324
330
      <varlistentry>
325
331
        <term><option>--version</option></term>
326
332
        <term><option>-V</option></term>
332
338
      </varlistentry>
333
339
    </variablelist>
334
340
  </refsect1>
335
 
 
 
341
  
 
342
  <refsect1 id="overview">
 
343
    <title>OVERVIEW</title>
 
344
    <xi:include href="../overview.xml"/>
 
345
    <para>
 
346
      This program is the client part.  It is a plugin started by
 
347
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
348
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
 
349
      an initial <acronym>RAM</acronym> disk environment.
 
350
    </para>
 
351
    <para>
 
352
      This program could, theoretically, be used as a keyscript in
 
353
      <filename>/etc/crypttab</filename>, but it would then be
 
354
      impossible to enter a password for the encrypted root disk at
 
355
      the console, since this program does not read from the console
 
356
      at all.  This is why a separate plugin runner (<citerefentry>
 
357
      <refentrytitle>plugin-runner</refentrytitle>
 
358
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
 
359
      both this program and others in in parallel,
 
360
      <emphasis>one</emphasis> of which will prompt for passwords on
 
361
      the system console.
 
362
    </para>
 
363
  </refsect1>
 
364
  
336
365
  <refsect1 id="exit_status">
337
366
    <title>EXIT STATUS</title>
338
367
    <para>
341
370
      successfully decrypted and output on standard output.  The
342
371
      program will exit with a non-zero exit status only if a critical
343
372
      error occurs.  Otherwise, it will forever connect to new
344
 
      <application>Mandosservers</application> servers as they appear,
345
 
      trying to get a decryptable password.
346
 
    </para>
347
 
  </refsect1>
348
 
  
349
 
<!--   <refsect1 id="environment"> -->
350
 
<!--     <title>ENVIRONMENT</title> -->
 
373
      <application>Mandos</application> servers as they appear, trying
 
374
      to get a decryptable password and print it.
 
375
    </para>
 
376
  </refsect1>
 
377
  
 
378
  <refsect1 id="environment">
 
379
    <title>ENVIRONMENT</title>
 
380
    <para>
 
381
      This program does not use any environment variables, not even
 
382
      the ones provided by <citerefentry><refentrytitle
 
383
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
 
384
    </citerefentry>.
 
385
    </para>
 
386
  </refsect1>
 
387
  
 
388
  <refsect1 id="files">
 
389
    <title>FILES</title>
 
390
    <variablelist>
 
391
      <varlistentry>
 
392
        <term><filename>/conf/conf.d/mandos/pubkey.txt</filename
 
393
        ></term>
 
394
        <term><filename>/conf/conf.d/mandos/seckey.txt</filename
 
395
        ></term>
 
396
        <listitem>
 
397
          <para>
 
398
            OpenPGP public and private key files, in <quote>ASCII
 
399
            Armor</quote> format.  These are the default file names,
 
400
            they can be changed with the <option>--pubkey</option> and
 
401
            <option>--seckey</option> options.
 
402
          </para>
 
403
        </listitem>
 
404
      </varlistentry>
 
405
    </variablelist>
 
406
  </refsect1>
 
407
  
 
408
<!--   <refsect1 id="bugs"> -->
 
409
<!--     <title>BUGS</title> -->
351
410
<!--     <para> -->
352
 
<!--       This program does not use any environment variables. -->
353
411
<!--     </para> -->
354
412
<!--   </refsect1> -->
355
413
  
356
 
  <refsect1 id="file">
357
 
    <title>FILES</title>
358
 
    <para>
359
 
    </para>
360
 
  </refsect1>
361
 
  
362
 
  <refsect1 id="bugs">
363
 
    <title>BUGS</title>
364
 
    <para>
365
 
    </para>
366
 
  </refsect1>
367
 
 
368
414
  <refsect1 id="example">
369
415
    <title>EXAMPLE</title>
370
416
    <para>
 
417
      Note that normally, command line options will not be given
 
418
      directly, but via options for the Mandos <citerefentry
 
419
      ><refentrytitle>plugin-runner</refentrytitle>
 
420
      <manvolnum>8mandos</manvolnum></citerefentry>.
371
421
    </para>
 
422
    <informalexample>
 
423
      <para>
 
424
        Normal invocation needs no options, if the network interface
 
425
        is <quote>eth0</quote>:
 
426
      </para>
 
427
      <para>
 
428
        <userinput>&COMMANDNAME;</userinput>
 
429
      </para>
 
430
    </informalexample>
 
431
    <informalexample>
 
432
      <para>
 
433
        Search for Mandos servers (and connect to them) using another
 
434
        interface:
 
435
      </para>
 
436
      <para>
 
437
        <!-- do not wrap this line -->
 
438
        <userinput>&COMMANDNAME; --interface eth1</userinput>
 
439
      </para>
 
440
    </informalexample>
 
441
    <informalexample>
 
442
      <para>
 
443
        Run in debug mode, and use a custom key:
 
444
      </para>
 
445
      <para>
 
446
 
 
447
<!-- do not wrap this line -->
 
448
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
 
449
 
 
450
      </para>
 
451
    </informalexample>
 
452
    <informalexample>
 
453
      <para>
 
454
        Run in debug mode, with a custom key, and do not use Zeroconf
 
455
        to locate a server; connect directly to the IPv6 link-local
 
456
        address <quote><systemitem class="ipaddress"
 
457
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
 
458
        using interface eth2:
 
459
      </para>
 
460
      <para>
 
461
 
 
462
<!-- do not wrap this line -->
 
463
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
464
 
 
465
      </para>
 
466
    </informalexample>
372
467
  </refsect1>
373
 
 
 
468
  
374
469
  <refsect1 id="security">
375
470
    <title>SECURITY</title>
376
471
    <para>
 
472
      This program is set-uid to root, but will switch back to the
 
473
      original (and presumably non-privileged) user and group after
 
474
      bringing up the network interface.
 
475
    </para>
 
476
    <para>
 
477
      To use this program for its intended purpose (see <xref
 
478
      linkend="purpose"/>), the password for the root file system will
 
479
      have to be given out to be stored in a server computer, after
 
480
      having been encrypted using an OpenPGP key.  This encrypted data
 
481
      which will be stored in a server can only be decrypted by the
 
482
      OpenPGP key, and the data will only be given out to those
 
483
      clients who can prove they actually have that key.  This key,
 
484
      however, is stored unencrypted on the client side in its initial
 
485
      <acronym>RAM</acronym> disk image file system.  This is normally
 
486
      readable by all, but this is normally fixed during installation
 
487
      of this program; file permissions are set so that no-one is able
 
488
      to read that file.
 
489
    </para>
 
490
    <para>
 
491
      The only remaining weak point is that someone with physical
 
492
      access to the client hard drive might turn off the client
 
493
      computer, read the OpenPGP keys directly from the hard drive,
 
494
      and communicate with the server.  To safeguard against this, the
 
495
      server is supposed to notice the client disappearing and stop
 
496
      giving out the encrypted data.  Therefore, it is important to
 
497
      set the timeout and checker interval values tightly on the
 
498
      server.  See <citerefentry><refentrytitle
 
499
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
 
500
    </para>
 
501
    <para>
 
502
      It will also help if the checker program on the server is
 
503
      configured to request something from the client which can not be
 
504
      spoofed by someone else on the network, unlike unencrypted
 
505
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
 
506
    </para>
 
507
    <para>
 
508
      <emphasis>Note</emphasis>: This makes it completely insecure to
 
509
      have <application >Mandos</application> clients which dual-boot
 
510
      to another operating system which is <emphasis>not</emphasis>
 
511
      trusted to keep the initial <acronym>RAM</acronym> disk image
 
512
      confidential.
377
513
    </para>
378
514
  </refsect1>
379
 
 
 
515
  
380
516
  <refsect1 id="see_also">
381
517
    <title>SEE ALSO</title>
382
518
    <para>
 
519
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
520
      <manvolnum>8</manvolnum></citerefentry>,
 
521
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
522
      <manvolnum>5</manvolnum></citerefentry>,
383
523
      <citerefentry><refentrytitle>mandos</refentrytitle>
384
524
      <manvolnum>8</manvolnum></citerefentry>,
385
525
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
387
527
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
388
528
      <manvolnum>8mandos</manvolnum></citerefentry>
389
529
    </para>
390
 
    <itemizedlist>
391
 
      <listitem><para>
392
 
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
393
 
      </para></listitem>
394
 
      
395
 
      <listitem><para>
396
 
        <ulink url="http://www.avahi.org/">Avahi</ulink>
397
 
      </para></listitem>
398
 
      
399
 
      <listitem><para>
400
 
        <ulink
401
 
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
402
 
      </para></listitem>
403
 
      
404
 
      <listitem><para>
405
 
        <ulink
406
 
        url="http://www.gnupg.org/related_software/gpgme/">
407
 
        GPGME</ulink>
408
 
      </para></listitem>
409
 
      
410
 
      <listitem><para>
411
 
        <citation>RFC 4880: <citetitle>OpenPGP Message
412
 
        Format</citetitle></citation>
413
 
      </para></listitem>
414
 
      
415
 
      <listitem><para>
416
 
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
417
 
        Transport Layer Security</citetitle></citation>
418
 
      </para></listitem>
419
 
      
420
 
      <listitem><para>
421
 
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
422
 
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
423
 
        Unicast Addresses</citation>
424
 
      </para></listitem>
425
 
    </itemizedlist>
 
530
    <variablelist>
 
531
      <varlistentry>
 
532
        <term>
 
533
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
534
        </term>
 
535
        <listitem>
 
536
          <para>
 
537
            Zeroconf is the network protocol standard used for finding
 
538
            Mandos servers on the local network.
 
539
          </para>
 
540
        </listitem>
 
541
      </varlistentry>
 
542
      <varlistentry>
 
543
        <term>
 
544
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
545
        </term>
 
546
      <listitem>
 
547
        <para>
 
548
          Avahi is the library this program calls to find Zeroconf
 
549
          services.
 
550
        </para>
 
551
      </listitem>
 
552
      </varlistentry>
 
553
      <varlistentry>
 
554
        <term>
 
555
          <ulink url="http://www.gnu.org/software/gnutls/"
 
556
          >GnuTLS</ulink>
 
557
        </term>
 
558
      <listitem>
 
559
        <para>
 
560
          GnuTLS is the library this client uses to implement TLS for
 
561
          communicating securely with the server, and at the same time
 
562
          send the public OpenPGP key to the server.
 
563
        </para>
 
564
      </listitem>
 
565
      </varlistentry>
 
566
      <varlistentry>
 
567
        <term>
 
568
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
569
                 >GPGME</ulink>
 
570
        </term>
 
571
        <listitem>
 
572
          <para>
 
573
            GPGME is the library used to decrypt the OpenPGP data sent
 
574
            by the server.
 
575
          </para>
 
576
        </listitem>
 
577
      </varlistentry>
 
578
      <varlistentry>
 
579
        <term>
 
580
          RFC 4291: <citetitle>IP Version 6 Addressing
 
581
          Architecture</citetitle>
 
582
        </term>
 
583
        <listitem>
 
584
          <variablelist>
 
585
            <varlistentry>
 
586
              <term>Section 2.2: <citetitle>Text Representation of
 
587
              Addresses</citetitle></term>
 
588
              <listitem><para/></listitem>
 
589
            </varlistentry>
 
590
            <varlistentry>
 
591
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
592
              Address</citetitle></term>
 
593
              <listitem><para/></listitem>
 
594
            </varlistentry>
 
595
            <varlistentry>
 
596
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
597
            Addresses</citetitle></term>
 
598
            <listitem>
 
599
              <para>
 
600
                This client uses IPv6 link-local addresses, which are
 
601
                immediately usable since a link-local addresses is
 
602
                automatically assigned to a network interfaces when it
 
603
                is brought up.
 
604
              </para>
 
605
            </listitem>
 
606
            </varlistentry>
 
607
          </variablelist>
 
608
        </listitem>
 
609
      </varlistentry>
 
610
      <varlistentry>
 
611
        <term>
 
612
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
613
          Protocol Version 1.1</citetitle>
 
614
        </term>
 
615
      <listitem>
 
616
        <para>
 
617
          TLS 1.1 is the protocol implemented by GnuTLS.
 
618
        </para>
 
619
      </listitem>
 
620
      </varlistentry>
 
621
      <varlistentry>
 
622
        <term>
 
623
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
624
        </term>
 
625
      <listitem>
 
626
        <para>
 
627
          The data received from the server is binary encrypted
 
628
          OpenPGP data.
 
629
        </para>
 
630
      </listitem>
 
631
      </varlistentry>
 
632
      <varlistentry>
 
633
        <term>
 
634
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
635
          Security</citetitle>
 
636
        </term>
 
637
      <listitem>
 
638
        <para>
 
639
          This is implemented by GnuTLS and used by this program so
 
640
          that OpenPGP keys can be used.
 
641
        </para>
 
642
      </listitem>
 
643
      </varlistentry>
 
644
    </variablelist>
426
645
  </refsect1>
427
 
 
428
646
</refentry>
 
647
 
429
648
<!-- Local Variables: -->
430
649
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
431
650
<!-- time-stamp-end: "[\"']>" -->