/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 debian/mandos-client.README.Debian

Four new interrelated features:

1. Support using a different network interface via both initramfs.conf
   (the DEVICE setting) and the kernel command line (sixth field of
   the "ip=" option as in Linux' Documentation/nfsroot.txt).

2. Support connecting to a specified Mandos server directly using a
   kernel command line option ("mandos=connect:<ADDRESS>:<PORT>").

3. Support connecting directly to an IPv4 address (and port) using the
   "--connect" option of mandos-client.

4. Support an empty string to the --interface option to mandos-client.

* Makefile (WARN): Increase strictness by changing to
                   "-Wstrict-aliasing=1".

* debian/mandos-client.README.Debian (Use the Correct Network
  Interface): Changed to refer to initramfs.conf and nfsroot.txt.
  (Test the Server): Improve wording.
  (Non-local Connection): New section.
* initramfs-tools-script: Obey DEVICE environment variable and setting
                          from "/conf/initramfs.conf".  Also let any
                          "ip=" kernel command line option override
                          it.  Support new "mandos=connect" option.
                          Call "configure_networking" to set up IP
                          address on interface if necessary.
* plugin-runner.conf: Change example.
* plugins.d/mandos-client.c: Some whitespace and comment changes.
  (start_mandos_communication): Take an additional argument for
                                address family, all callers changed.
                                Connect to an IPv4 address if address
                                family is AF_INET.  Only set IPv6
                                scope_id for link-local addresses.
  (main): Accept empty interface name; this will not bring up any
         interface and leave the interface as unspecified.  Also do
         not restore kernel log level if lowering it failed.
* plugins.d/mandos-client.xml (OPTIONS): Document that the
                                         "--interface" option accepts
                                         an empty string.
  (EXAMPLE): Change example IPv6 address to a link-local address.

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/mandos-client.README.Debian
7
7
 
8
8
* Use the Correct Network Interface
9
9
  
10
 
  If some other network interface than "eth0" is used, it will be
11
 
  necessary to edit /etc/mandos/plugin-runner.conf to uncomment and
12
 
  change the line there.  If this is done, it will be necessary to
13
 
  update the initrd image by doing "update-initramfs -k all -u".
 
10
  Make sure that the correct network interface is specified in the
 
11
  DEVICE setting in the "/etc/initramfs-tools/initramfs.conf" file.
 
12
  If this is changed, it will be necessary to update the initrd image
 
13
  by doing "update-initramfs -k all -u".  This setting can be
 
14
  overridden at boot time on the Linux kernel command line using the
 
15
  sixth colon-separated field of the "ip=" option; for exact syntax,
 
16
  see the file "Documentation/nfsroot.txt" in the Linux source tree.
14
17
 
15
18
* Test the Server
16
19
  
23
26
                --seckey=/etc/keys/mandos/seckey.txt; echo
24
27
  
25
28
  This command should retrieve the password from the server, decrypt
26
 
  it, and output it to standard output.  It is now possible to verify
27
 
  the correctness of the password before rebooting.
 
29
  it, and output it to standard output.  There it can be verified to
 
30
  be the correct password, before rebooting.
28
31
 
29
32
* User-Supplied Plugins
30
 
 
 
33
  
31
34
  Any plugins found in /etc/mandos/plugins.d will override and add to
32
35
  the normal Mandos plugins.  When adding or changing plugins, do not
33
36
  forget to update the initital RAM disk image:
34
 
 
 
37
  
35
38
        # update-initramfs -k all -u
36
39
 
37
40
* Do *NOT* Edit /etc/crypttab
38
 
 
 
41
  
39
42
  It is NOT necessary to edit /etc/crypttab to specify
40
43
  /usr/lib/mandos/plugin-runner as a keyscript for the root file
41
44
  system; if no keyscript is given for the root file system, the
42
45
  Mandos client will be the new default way for getting a password for
43
46
  the root file system when booting.
44
47
 
45
 
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Sun,  5 Oct 2008 19:04:26 +0200
 
48
* Emergency Escape
 
49
  
 
50
  If it ever should be necessary, the Mandos client can be temporarily
 
51
  prevented from running at startup by passing the parameter
 
52
  "mandos=off" to the kernel.
 
53
 
 
54
* Non-local Connection (Not Using ZeroConf)
 
55
  
 
56
  If the "ip=" kernel command line option is used to specify a
 
57
  complete IP address and device name, as noted above, it then becomes
 
58
  possible to specify a specific IP address and port to connect to,
 
59
  instead of using ZeroConf.  The syntax for doing this is
 
60
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>".
 
61
  
 
62
  Warning: this will cause the client to make exactly one attempt at
 
63
  connecting, and then fail if it does not succeed.
 
64
  
 
65
  For very advanced users, it it possible to specify simply
 
66
  "mandos=connect" on the kernel command line to make the system only
 
67
  set up the network (using the data in the "ip=" option) and not pass
 
68
  any extra "--connect" options to mandos-client at boot.  For this to
 
69
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
 
70
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
 
71
 
 
72
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Mon,  9 Feb 2009 00:36:55 +0100