58
67
    <refname><command>&COMMANDNAME;</command></refname>
 
60
 
      Client for <application>Mandos</application>
 
66
75
      <command>&COMMANDNAME;</command>
 
68
 
        <arg choice="plain"><option>--connect
 
69
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
70
 
        ><replaceable>PORT</replaceable></option></arg>
 
71
 
        <arg choice="plain"><option>-c
 
72
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
73
 
        ><replaceable>PORT</replaceable></option></arg>
 
77
 
        <arg choice="plain"><option>--interface
 
78
 
        <replaceable>NAME</replaceable><arg rep='repeat'
 
79
 
        >,<replaceable>NAME</replaceable></arg></option></arg>
 
80
 
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
 
81
 
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
 
86
 
        <arg choice="plain"><option>--pubkey
 
87
 
        <replaceable>FILE</replaceable></option></arg>
 
88
 
        <arg choice="plain"><option>-p
 
89
 
        <replaceable>FILE</replaceable></option></arg>
 
93
 
        <arg choice="plain"><option>--seckey
 
94
 
        <replaceable>FILE</replaceable></option></arg>
 
95
 
        <arg choice="plain"><option>-s
 
96
 
        <replaceable>FILE</replaceable></option></arg>
 
100
 
        <arg choice="plain"><option>--tls-privkey
 
101
 
        <replaceable>FILE</replaceable></option></arg>
 
102
 
        <arg choice="plain"><option>-t
 
103
 
        <replaceable>FILE</replaceable></option></arg>
 
107
 
        <arg choice="plain"><option>--tls-pubkey
 
108
 
        <replaceable>FILE</replaceable></option></arg>
 
109
 
        <arg choice="plain"><option>-T
 
110
 
        <replaceable>FILE</replaceable></option></arg>
 
114
 
        <option>--priority <replaceable>STRING</replaceable></option>
 
118
 
        <option>--dh-bits <replaceable>BITS</replaceable></option>
 
122
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
126
 
        <option>--delay <replaceable>SECONDS</replaceable></option>
 
130
 
        <option>--retry <replaceable>SECONDS</replaceable></option>
 
134
 
        <option>--network-hook-dir
 
135
 
        <replaceable>DIR</replaceable></option>
 
139
 
        <option>--debug</option>
 
143
 
      <command>&COMMANDNAME;</command>
 
145
 
        <arg choice="plain"><option>--help</option></arg>
 
146
 
        <arg choice="plain"><option>-?</option></arg>
 
150
 
      <command>&COMMANDNAME;</command>
 
151
 
      <arg choice="plain"><option>--usage</option></arg>
 
154
 
      <command>&COMMANDNAME;</command>
 
156
 
        <arg choice="plain"><option>--version</option></arg>
 
157
 
        <arg choice="plain"><option>-V</option></arg>
 
 
76
      <arg choice='opt'>--connect<arg choice='plain'>IP</arg></arg>
 
 
77
      <arg choice='opt'>--keydir<arg choice='plain'>KEYDIR</arg></arg>
 
 
78
      <arg choice='opt'>--interface<arg choice='plain'>INTERFACE</arg></arg>
 
 
79
      <arg choice='opt'>--pubkey<arg choice='plain'>PUBKEY</arg></arg>
 
 
80
      <arg choice='opt'>--seckey<arg choice='plain'>SECKEY</arg></arg>
 
 
81
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
 
 
82
      <arg choice='opt'>--dh-bits<arg choice='plain'>BITS</arg></arg>      
 
 
83
      <arg choice='opt'>--debug</arg>
 
 
86
      <command>&COMMANDNAME;</command>
 
 
87
      <arg choice='plain'>--help</arg>
 
 
90
      <command>&COMMANDNAME;</command>
 
 
91
      <arg choice='plain'>--usage</arg>
 
 
94
      <command>&COMMANDNAME;</command>
 
 
95
      <arg choice='plain'>--version</arg>
 
162
99
  <refsect1 id="description">
 
163
100
    <title>DESCRIPTION</title>
 
165
 
      <command>&COMMANDNAME;</command> is a client program that
 
166
 
      communicates with <citerefentry><refentrytitle
 
167
 
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 
168
 
      to get a password.  In slightly more detail, this client program
 
169
 
      brings up network interfaces, uses the interfaces’ IPv6
 
170
 
      link-local addresses to get network connectivity, uses Zeroconf
 
171
 
      to find servers on the local network, and communicates with
 
172
 
      servers using TLS with a raw public key to ensure authenticity
 
173
 
      and confidentiality.  This client program keeps running, trying
 
174
 
      all servers on the network, until it receives a satisfactory
 
175
 
      reply or a TERM signal.  After all servers have been tried, all
 
176
 
      servers are periodically retried.  If no servers are found it
 
177
 
      will wait indefinitely for new servers to appear.
 
180
 
      The network interfaces are selected like this: If any interfaces
 
181
 
      are specified using the <option>--interface</option> option,
 
182
 
      those interface are used.  Otherwise,
 
183
 
      <command>&COMMANDNAME;</command> will use all interfaces that
 
184
 
      are not loopback interfaces, are not point-to-point interfaces,
 
185
 
      are capable of broadcasting and do not have the NOARP flag (see
 
186
 
      <citerefentry><refentrytitle>netdevice</refentrytitle>
 
187
 
      <manvolnum>7</manvolnum></citerefentry>).  (If the
 
188
 
      <option>--connect</option> option is used, point-to-point
 
189
 
      interfaces and non-broadcast interfaces are accepted.)  If any
 
190
 
      used interfaces are not up and running, they are first taken up
 
191
 
      (and later taken down again on program exit).
 
194
 
      Before network interfaces are selected, all <quote>network
 
195
 
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
 
198
 
      This program is not meant to be run directly; it is really meant
 
199
 
      to be run by other programs in the initial
 
200
 
      <acronym>RAM</acronym> disk environment; see <xref
 
201
 
      linkend="overview"/>.
 
205
 
  <refsect1 id="purpose">
 
206
 
    <title>PURPOSE</title>
 
208
 
      The purpose of this is to enable <emphasis>remote and unattended
 
209
 
      rebooting</emphasis> of client host computer with an
 
210
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
 
211
 
      linkend="overview"/> for details.
 
 
102
      <command>&COMMANDNAME;</command> is a mandos plugin that works
 
 
103
      like a client program that through avahi detects mandos servers,
 
 
104
      sets up a gnutls connect and request a encrypted password. Any
 
 
105
      passwords given is automaticly decrypted and passed to
 
215
110
  <refsect1 id="options">
 
216
111
    <title>OPTIONS</title>
 
218
 
      This program is commonly not invoked from the command line; it
 
219
 
      is normally started by another program as described in <xref
 
220
 
      linkend="description"/>.  Any command line options this program
 
221
 
      accepts are therefore normally provided by the invoking program,
 
 
113
      Commonly not invoked as command lines but from configuration
 
 
114
      file of plugin runner.
 
227
 
        <term><option>--connect=<replaceable
 
228
 
        >ADDRESS</replaceable><literal>:</literal><replaceable
 
229
 
        >PORT</replaceable></option></term>
 
231
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
232
 
        ><replaceable>PORT</replaceable></option></term>
 
235
 
            Do not use Zeroconf to locate servers.  Connect directly
 
236
 
            to only one specified <application>Mandos</application>
 
237
 
            server.  Note that an IPv6 address has colon characters in
 
238
 
            it, so the <emphasis>last</emphasis> colon character is
 
239
 
            assumed to separate the address from the port number.
 
242
 
            Normally, Zeroconf would be used to locate Mandos servers,
 
243
 
            in which case this option would only be used when testing
 
250
 
        <term><option>--interface=<replaceable
 
251
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
252
 
        >NAME</replaceable></arg></option></term>
 
254
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
255
 
        >NAME</replaceable></arg></option></term>
 
258
 
            Comma separated list of network interfaces that will be
 
259
 
            brought up and scanned for Mandos servers to connect to.
 
260
 
            The default is the empty string, which will automatically
 
261
 
            use all appropriate interfaces.
 
264
 
            If the <option>--connect</option> option is used, and
 
265
 
            exactly one interface name is specified (except
 
266
 
            <quote><literal>none</literal></quote>), this specifies
 
267
 
            the interface to use to connect to the address given.
 
270
 
            Note that since this program will normally run in the
 
271
 
            initial RAM disk environment, the interface must be an
 
272
 
            interface which exists at that stage.  Thus, the interface
 
273
 
            can normally not be a pseudo-interface such as
 
274
 
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
 
275
 
            will not exist until much later in the boot process, and
 
276
 
            can not be used by this program, unless created by a
 
277
 
            <quote>network hook</quote> — see <xref
 
278
 
            linkend="network-hooks"/>.
 
281
 
            <replaceable>NAME</replaceable> can be the string
 
282
 
            <quote><literal>none</literal></quote>; this will make
 
283
 
            <command>&COMMANDNAME;</command> only bring up interfaces
 
284
 
            specified <emphasis>before</emphasis> this string.  This
 
285
 
            is not recommended, and only meant for advanced users.
 
291
 
        <term><option>--pubkey=<replaceable
 
292
 
        >FILE</replaceable></option></term>
 
294
 
        <replaceable>FILE</replaceable></option></term>
 
297
 
            OpenPGP public key file name.  The default name is
 
298
 
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
 
305
 
        <term><option>--seckey=<replaceable
 
306
 
        >FILE</replaceable></option></term>
 
308
 
        <replaceable>FILE</replaceable></option></term>
 
311
 
            OpenPGP secret key file name.  The default name is
 
312
 
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
 
319
 
        <term><option>--tls-pubkey=<replaceable
 
320
 
        >FILE</replaceable></option></term>
 
322
 
        <replaceable>FILE</replaceable></option></term>
 
325
 
            TLS raw public key file name.  The default name is
 
326
 
            <quote><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
 
333
 
        <term><option>--tls-privkey=<replaceable
 
334
 
        >FILE</replaceable></option></term>
 
336
 
        <replaceable>FILE</replaceable></option></term>
 
339
 
            TLS secret key file name.  The default name is
 
340
 
            <quote><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
 
347
 
        <term><option>--priority=<replaceable
 
348
 
        >STRING</replaceable></option></term>
 
350
 
          <xi:include href="../mandos-options.xml"
 
351
 
                      xpointer="priority"/>
 
356
 
        <term><option>--dh-bits=<replaceable
 
357
 
        >BITS</replaceable></option></term>
 
360
 
            Sets the number of bits to use for the prime number in the
 
361
 
            TLS Diffie-Hellman key exchange.  The default value is
 
362
 
            selected automatically based on the GnuTLS security
 
363
 
            profile set in its priority string.  Note that if the
 
364
 
            <option>--dh-params</option> option is used, the values
 
365
 
            from that file will be used instead.
 
371
 
        <term><option>--dh-params=<replaceable
 
372
 
        >FILE</replaceable></option></term>
 
375
 
            Specifies a PEM-encoded PKCS#3 file to read the parameters
 
376
 
            needed by the TLS Diffie-Hellman key exchange from.  If
 
377
 
            this option is not given, or if the file for some reason
 
378
 
            could not be used, the parameters will be generated on
 
379
 
            startup, which will take some time and processing power.
 
380
 
            Those using servers running under time, power or processor
 
381
 
            constraints may want to generate such a file in advance
 
388
 
        <term><option>--delay=<replaceable
 
389
 
        >SECONDS</replaceable></option></term>
 
392
 
            After bringing a network interface up, the program waits
 
393
 
            for the interface to arrive in a <quote>running</quote>
 
394
 
            state before proceeding.  During this time, the kernel log
 
395
 
            level will be lowered to reduce clutter on the system
 
396
 
            console, alleviating any other plugins which might be
 
397
 
            using the system console.  This option sets the upper
 
398
 
            limit of seconds to wait.  The default is 2.5 seconds.
 
404
 
        <term><option>--retry=<replaceable
 
405
 
        >SECONDS</replaceable></option></term>
 
408
 
            All Mandos servers are tried repeatedly until a password
 
409
 
            is received.  This value specifies, in seconds, how long
 
410
 
            between each successive try <emphasis>for the same
 
411
 
            server</emphasis>.  The default is 10 seconds.
 
417
 
        <term><option>--network-hook-dir=<replaceable
 
418
 
        >DIR</replaceable></option></term>
 
421
 
            Network hook directory.  The default directory is
 
422
 
            <quote><filename class="directory"
 
423
 
            >/lib/mandos/network-hooks.d</filename></quote>.
 
429
 
        <term><option>--debug</option></term>
 
432
 
            Enable debug mode.  This will enable a lot of output to
 
433
 
            standard error about what the program is doing.  The
 
434
 
            program will still perform all other functions normally.
 
437
 
            It will also enable debug mode in the Avahi and GnuTLS
 
438
 
            libraries, making them print large amounts of debugging
 
445
 
        <term><option>--help</option></term>
 
446
 
        <term><option>-?</option></term>
 
449
 
            Gives a help message about options and their meanings.
 
455
 
        <term><option>--usage</option></term>
 
458
 
            Gives a short usage message.
 
464
 
        <term><option>--version</option></term>
 
465
 
        <term><option>-V</option></term>
 
468
 
            Prints the program version.
 
 
119
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
 
 
120
        IP</replaceable></literal></term>
 
 
123
            Connect directly to a sepcified mandos server
 
 
129
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
 
 
130
        KEYDIR</replaceable></literal></term>
 
 
133
            Directory where the openpgp keyring is
 
 
139
        <term><literal>-i</literal>, <literal>--interface=
 
 
140
        <replaceable>INTERFACE</replaceable></literal></term>
 
 
143
            Interface that Avahi will conntect through
 
 
149
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
 
 
150
        PUBKEY</replaceable></literal></term>
 
 
153
            Public openpgp key for gnutls authentication
 
 
159
        <term><literal>-s</literal>, <literal>--seckey=<replaceable>
 
 
160
        SECKEY</replaceable></literal></term>
 
 
163
            Secret openpgp key for gnutls authentication
 
 
169
        <term><literal>--priority=<replaceable>PRIORITY</replaceable>
 
 
179
        <term><literal>--dh-bits=<replaceable>BITS</replaceable>
 
 
183
            dh-bits to use in gnutls communication
 
 
189
        <term><literal>--debug</literal></term>
 
 
198
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
 
207
        <term><literal>--usage</literal></term>
 
 
210
            Gives a short usage message
 
 
216
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
 
219
            Prints the program version
 
475
 
  <refsect1 id="overview">
 
476
 
    <title>OVERVIEW</title>
 
477
 
    <xi:include href="../overview.xml"/>
 
479
 
      This program is the client part.  It is run automatically in an
 
480
 
      initial <acronym>RAM</acronym> disk environment.
 
483
 
      In an initial <acronym>RAM</acronym> disk environment using
 
484
 
      <citerefentry><refentrytitle>systemd</refentrytitle>
 
485
 
      <manvolnum>1</manvolnum></citerefentry>, this program is started
 
486
 
      by the <application>Mandos</application> <citerefentry>
 
487
 
      <refentrytitle>password-agent</refentrytitle>
 
488
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which in turn is
 
489
 
      started automatically by the <citerefentry>
 
490
 
      <refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum>
 
491
 
      </citerefentry> <quote>Password Agent</quote> system.
 
494
 
      In the case of a non-<citerefentry>
 
495
 
      <refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum>
 
496
 
      </citerefentry> environment, this program is started as a plugin
 
497
 
      of the <application>Mandos</application> <citerefentry>
 
498
 
      <refentrytitle>plugin-runner</refentrytitle>
 
499
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
 
500
 
      initial <acronym>RAM</acronym> disk environment because it is
 
501
 
      specified as a <quote>keyscript</quote> in the <citerefentry>
 
502
 
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
 
503
 
      </citerefentry> file.
 
506
 
      This program could, theoretically, be used as a keyscript in
 
507
 
      <filename>/etc/crypttab</filename>, but it would then be
 
508
 
      impossible to enter a password for the encrypted root disk at
 
509
 
      the console, since this program does not read from the console
 
514
226
  <refsect1 id="exit_status">
 
515
227
    <title>EXIT STATUS</title>
 
517
 
      This program will exit with a successful (zero) exit status if a
 
518
 
      server could be found and the password received from it could be
 
519
 
      successfully decrypted and output on standard output.  The
 
520
 
      program will exit with a non-zero exit status only if a critical
 
521
 
      error occurs.  Otherwise, it will forever connect to any
 
522
 
      discovered <application>Mandos</application> servers, trying to
 
523
 
      get a decryptable password and print it.
 
527
 
  <refsect1 id="environment">
 
528
 
    <title>ENVIRONMENT</title>
 
531
 
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
 
534
 
            This environment variable will be assumed to contain the
 
535
 
            directory containing any helper executables.  The use and
 
536
 
            nature of these helper executables, if any, is purposely
 
543
 
      This program does not use any other environment variables, not
 
544
 
      even the ones provided by <citerefentry><refentrytitle
 
545
 
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
 
550
 
  <refsect1 id="network-hooks">
 
551
 
    <title>NETWORK HOOKS</title>
 
553
 
      If a network interface like a bridge or tunnel is required to
 
554
 
      find a Mandos server, this requires the interface to be up and
 
555
 
      running before <command>&COMMANDNAME;</command> starts looking
 
556
 
      for Mandos servers.  This can be accomplished by creating a
 
557
 
      <quote>network hook</quote> program, and placing it in a special
 
561
 
      Before the network is used (and again before program exit), any
 
562
 
      runnable programs found in the network hook directory are run
 
563
 
      with the argument <quote><literal>start</literal></quote> or
 
564
 
      <quote><literal>stop</literal></quote>.  This should bring up or
 
565
 
      down, respectively, any network interface which
 
566
 
      <command>&COMMANDNAME;</command> should use.
 
568
 
    <refsect2 id="hook-requirements">
 
569
 
      <title>REQUIREMENTS</title>
 
571
 
        A network hook must be an executable file, and its name must
 
572
 
        consist entirely of upper and lower case letters, digits,
 
573
 
        underscores, periods, and hyphens.
 
576
 
        A network hook will receive one argument, which can be one of
 
581
 
          <term><literal>start</literal></term>
 
584
 
              This should make the network hook create (if necessary)
 
585
 
              and bring up a network interface.
 
590
 
          <term><literal>stop</literal></term>
 
593
 
              This should make the network hook take down a network
 
594
 
              interface, and delete it if it did not exist previously.
 
599
 
          <term><literal>files</literal></term>
 
602
 
              This should make the network hook print, <emphasis>one
 
603
 
              file per line</emphasis>, all the files needed for it to
 
604
 
              run.  (These files will be copied into the initial RAM
 
605
 
              filesystem.)  Typical use is for a network hook which is
 
606
 
              a shell script to print its needed binaries.
 
609
 
              It is not necessary to print any non-executable files
 
610
 
              already in the network hook directory, these will be
 
611
 
              copied implicitly if they otherwise satisfy the name
 
617
 
          <term><literal>modules</literal></term>
 
620
 
              This should make the network hook print, <emphasis>on
 
621
 
              separate lines</emphasis>, all the kernel modules needed
 
622
 
              for it to run.  (These modules will be copied into the
 
623
 
              initial RAM filesystem.)  For instance, a tunnel
 
625
 
              <quote><literal>tun</literal></quote> module.
 
631
 
        The network hook will be provided with a number of environment
 
636
 
          <term><envar>MANDOSNETHOOKDIR</envar></term>
 
639
 
              The network hook directory, specified to
 
640
 
              <command>&COMMANDNAME;</command> by the
 
641
 
              <option>--network-hook-dir</option> option.  Note: this
 
642
 
              should <emphasis>always</emphasis> be used by the
 
643
 
              network hook to refer to itself or any files in the hook
 
644
 
              directory it may require.
 
649
 
          <term><envar>DEVICE</envar></term>
 
652
 
              The network interfaces, as specified to
 
653
 
              <command>&COMMANDNAME;</command> by the
 
654
 
              <option>--interface</option> option, combined to one
 
655
 
              string and separated by commas.  If this is set, and
 
656
 
              does not contain the interface a hook will bring up,
 
657
 
              there is no reason for a hook to continue.
 
662
 
          <term><envar>MODE</envar></term>
 
665
 
              This will be the same as the first argument;
 
666
 
              i.e. <quote><literal>start</literal></quote>,
 
667
 
              <quote><literal>stop</literal></quote>,
 
668
 
              <quote><literal>files</literal></quote>, or
 
669
 
              <quote><literal>modules</literal></quote>.
 
674
 
          <term><envar>VERBOSITY</envar></term>
 
677
 
              This will be the <quote><literal>1</literal></quote> if
 
678
 
              the <option>--debug</option> option is passed to
 
679
 
              <command>&COMMANDNAME;</command>, otherwise
 
680
 
              <quote><literal>0</literal></quote>.
 
685
 
          <term><envar>DELAY</envar></term>
 
688
 
              This will be the same as the <option>--delay</option>
 
689
 
              option passed to <command>&COMMANDNAME;</command>.  Is
 
690
 
              only set if <envar>MODE</envar> is
 
691
 
              <quote><literal>start</literal></quote> or
 
692
 
              <quote><literal>stop</literal></quote>.
 
697
 
          <term><envar>CONNECT</envar></term>
 
700
 
              This will be the same as the <option>--connect</option>
 
701
 
              option passed to <command>&COMMANDNAME;</command>.  Is
 
702
 
              only set if <option>--connect</option> is passed and
 
703
 
              <envar>MODE</envar> is
 
704
 
              <quote><literal>start</literal></quote> or
 
705
 
              <quote><literal>stop</literal></quote>.
 
711
 
        A hook may not read from standard input, and should be
 
712
 
        restrictive in printing to standard output or standard error
 
713
 
        unless <varname>VERBOSITY</varname> is
 
714
 
        <quote><literal>1</literal></quote>.
 
719
 
  <refsect1 id="files">
 
720
233
    <title>FILES</title>
 
723
 
        <term><filename>/conf/conf.d/mandos/pubkey.txt</filename
 
725
 
        <term><filename>/conf/conf.d/mandos/seckey.txt</filename
 
729
 
            OpenPGP public and private key files, in <quote>ASCII
 
730
 
            Armor</quote> format.  These are the default file names,
 
731
 
            they can be changed with the <option>--pubkey</option> and
 
732
 
            <option>--seckey</option> options.
 
737
 
        <term><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
 
739
 
        <term><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
 
743
 
            Public and private raw key files, in <quote>PEM</quote>
 
744
 
            format.  These are the default file names, they can be
 
745
 
            changed with the <option>--tls-pubkey</option> and
 
746
 
            <option>--tls-privkey</option> options.
 
752
 
        class="directory">/lib/mandos/network-hooks.d</filename></term>
 
755
 
            Directory where network hooks are located.  Change this
 
756
 
            with the <option>--network-hook-dir</option> option.  See
 
757
 
            <xref linkend="network-hooks"/>.
 
 
238
  <refsect1 id="notes">
 
764
244
  <refsect1 id="bugs">
 
765
245
    <title>BUGS</title>
 
766
 
    <xi:include href="../bugs.xml"/>
 
769
 
  <refsect1 id="example">
 
770
 
    <title>EXAMPLE</title>
 
772
 
      Note that normally, command line options will not be given
 
773
 
      directly, but passed on via the program responsible for starting
 
774
 
      this program; see <xref linkend="overview"/>.
 
778
 
        Normal invocation needs no options, if the network interfaces
 
779
 
        can be automatically determined:
 
782
 
        <userinput>&COMMANDNAME;</userinput>
 
787
 
        Search for Mandos servers (and connect to them) using one
 
791
 
        <!-- do not wrap this line -->
 
792
 
        <userinput>&COMMANDNAME; --interface eth1</userinput>
 
797
 
        Run in debug mode, and use custom keys:
 
801
 
<!-- do not wrap this line -->
 
802
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem</userinput>
 
808
 
        Run in debug mode, with custom keys, and do not use Zeroconf
 
809
 
        to locate a server; connect directly to the IPv6 link-local
 
810
 
        address <quote><systemitem class="ipaddress"
 
811
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
 
812
 
        using interface eth2:
 
816
 
<!-- do not wrap this line -->
 
817
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
 
250
  <refsect1 id="examples">
 
 
251
    <title>EXAMPLES</title>
 
823
256
  <refsect1 id="security">
 
824
257
    <title>SECURITY</title>
 
826
 
      This program assumes that it is set-uid to root, and will switch
 
827
 
      back to the original (and presumably non-privileged) user and
 
828
 
      group after bringing up the network interface.
 
831
 
      To use this program for its intended purpose (see <xref
 
832
 
      linkend="purpose"/>), the password for the root file system will
 
833
 
      have to be given out to be stored in a server computer, after
 
834
 
      having been encrypted using an OpenPGP key.  This encrypted data
 
835
 
      which will be stored in a server can only be decrypted by the
 
836
 
      OpenPGP key, and the data will only be given out to those
 
837
 
      clients who can prove they actually have that key.  This key,
 
838
 
      however, is stored unencrypted on the client side in its initial
 
839
 
      <acronym>RAM</acronym> disk image file system.  This is normally
 
840
 
      readable by all, but this is normally fixed during installation
 
841
 
      of this program; file permissions are set so that no-one is able
 
845
 
      The only remaining weak point is that someone with physical
 
846
 
      access to the client hard drive might turn off the client
 
847
 
      computer, read the OpenPGP and TLS keys directly from the hard
 
848
 
      drive, and communicate with the server.  To safeguard against
 
849
 
      this, the server is supposed to notice the client disappearing
 
850
 
      and stop giving out the encrypted data.  Therefore, it is
 
851
 
      important to set the timeout and checker interval values tightly
 
852
 
      on the server.  See <citerefentry><refentrytitle
 
853
 
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
 
856
 
      It will also help if the checker program on the server is
 
857
 
      configured to request something from the client which can not be
 
858
 
      spoofed by someone else on the network, like SSH server key
 
859
 
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
 
860
 
      echo (<quote>ping</quote>) replies.
 
863
 
      <emphasis>Note</emphasis>: This makes it completely insecure to
 
864
 
      have <application >Mandos</application> clients which dual-boot
 
865
 
      to another operating system which is <emphasis>not</emphasis>
 
866
 
      trusted to keep the initial <acronym>RAM</acronym> disk image
 
871
262
  <refsect1 id="see_also">
 
872
263
    <title>SEE ALSO</title>
 
874
 
      <citerefentry><refentrytitle>intro</refentrytitle>
 
875
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
876
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
877
 
      <manvolnum>8</manvolnum></citerefentry>,
 
878
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
879
 
      <manvolnum>5</manvolnum></citerefentry>,
 
880
265
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
881
 
      <manvolnum>8</manvolnum></citerefentry>,
 
882
 
      <citerefentry><refentrytitle>password-agent</refentrytitle>
 
883
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
884
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
 
266
      <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
 
267
      <refentrytitle>plugin-runner</refentrytitle>
 
 
268
      <manvolnum>8mandos</manvolnum></citerefentry> and <citerefentry>
 
 
269
      <refentrytitle>password-prompt</refentrytitle>
 
885
270
      <manvolnum>8mandos</manvolnum></citerefentry>
 
890
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
894
 
            Zeroconf is the network protocol standard used for finding
 
895
 
            Mandos servers on the local network.
 
901
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
905
 
          Avahi is the library this program calls to find Zeroconf
 
912
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
916
 
          GnuTLS is the library this client uses to implement TLS for
 
917
 
          communicating securely with the server, and at the same time
 
918
 
          send the public key to the server.
 
924
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
929
 
            GPGME is the library used to decrypt the OpenPGP data sent
 
936
 
          RFC 4291: <citetitle>IP Version 6 Addressing
 
937
 
          Architecture</citetitle>
 
942
 
              <term>Section 2.2: <citetitle>Text Representation of
 
943
 
              Addresses</citetitle></term>
 
944
 
              <listitem><para/></listitem>
 
947
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
948
 
              Address</citetitle></term>
 
949
 
              <listitem><para/></listitem>
 
952
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
953
 
            Addresses</citetitle></term>
 
956
 
                This client uses IPv6 link-local addresses, which are
 
957
 
                immediately usable since a link-local addresses is
 
958
 
                automatically assigned to a network interface when it
 
968
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
969
 
          Protocol Version 1.2</citetitle>
 
973
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
979
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
983
 
          The data received from the server is binary encrypted
 
990
 
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
 
991
 
          Layer Security (TLS) and Datagram Transport Layer Security
 
996
 
          This is implemented by GnuTLS in version 3.6.6 and is, if
 
997
 
          present, used by this program so that raw public keys can be
 
1004
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
1005
 
          Security</citetitle>
 
1009
 
          This is implemented by GnuTLS before version 3.6.0 and is,
 
1010
 
          if present, used by this program so that OpenPGP keys can be
 
1019
 
<!-- Local Variables: -->
 
1020
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
1021
 
<!-- time-stamp-end: "[\"']>" -->
 
1022
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->