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

* plugins.d/mandos-client.c (good_interface): Use SIOCGIFFLAGS instead
                                              of reading
                                              /sys/class/net/*/flags.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
* Configure The Server
2
 
  
3
 
  A client key has been automatically created in /etc/keys/mandos.
4
 
  The next step is to run "mandos-keygen --password" to get a config
5
 
  file section.  This should be appended to /etc/mandos/clients.conf
6
 
  on the Mandos server.
7
 
 
8
 
* Use the Correct Network Interface
9
 
  
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.
17
 
  
18
 
  Note that since this is used in the initial RAM disk environment,
19
 
  the network interface must exist at that stage.  Thus, the interface
20
 
  can *not* be a pseudo-interface such as "br0" or "tun0"; instead, a
21
 
  real interface (such as "eth0") must be used.
22
 
 
23
 
* Test the Server
24
 
  
25
 
  After the server has been started and this client's key added, it is
26
 
  possible to verify that the correct password will be received by
 
1
* Adding a Client Password to the Server
 
2
  
 
3
  The server must be given a password to give back to the client on
 
4
  boot time.  This password must be a one which can be used to unlock
 
5
  the root file system device.  On the *client*, run this command:
 
6
  
 
7
        mandos-keygen --password
 
8
  
 
9
  It will prompt for a password and output a config file section.
 
10
  This output should be copied to the Mandos server and added to the
 
11
  file "/etc/mandos/clients.conf" there.
 
12
 
 
13
* Testing that it Works (Without Rebooting)
 
14
  
 
15
  After the server has been started with this client's key added, it
 
16
  is possible to verify that the correct password will be received by
27
17
  this client by running the command, on the client:
28
18
  
29
 
        # /usr/lib/mandos/plugins.d/mandos-client \
 
19
        /usr/lib/mandos/plugins.d/mandos-client \
30
20
                --pubkey=/etc/keys/mandos/pubkey.txt \
31
21
                --seckey=/etc/keys/mandos/seckey.txt; echo
32
22
  
34
24
  it, and output it to standard output.  There it can be verified to
35
25
  be the correct password, before rebooting.
36
26
 
 
27
* Emergency Escape
 
28
  
 
29
  If it ever should be necessary, the Mandos client can be temporarily
 
30
  prevented from running at startup by passing the parameter
 
31
  "mandos=off" to the kernel.
 
32
 
 
33
* Specifying a Client Network Interface
 
34
  
 
35
  At boot time the network interface to use will by default be
 
36
  automatically detected.  If should result in an incorrect interface,
 
37
  edit the DEVICE setting in the "/etc/initramfs-tools/initramfs.conf"
 
38
  file.  (The default setting is empty, meaning to autodetect the
 
39
  interface.)  *If* the DEVICE setting is changed, it will be
 
40
  necessary to update the initrd image by running the command
 
41
  
 
42
        update-initramfs -k all -u
 
43
  
 
44
  The device can be overridden at boot time on the Linux kernel
 
45
  command line using the sixth colon-separated field of the "ip="
 
46
  option; for exact syntax, read the documentation in the file
 
47
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfsroot.txt",
 
48
  available in the "linux-doc-*" package.
 
49
  
 
50
  Note that since this network interface is used in the initial RAM
 
51
  disk environment, the network interface *must* exist at that stage.
 
52
  Thus, the interface can *not* be a pseudo-interface such as "br0" or
 
53
  "tun0"; instead, only real interface (such as "eth0") can be used.
 
54
 
37
55
* User-Supplied Plugins
38
56
  
39
 
  Any plugins found in /etc/mandos/plugins.d will override and add to
40
 
  the normal Mandos plugins.  When adding or changing plugins, do not
41
 
  forget to update the initital RAM disk image:
 
57
  Any plugins found in "/etc/mandos/plugins.d" will override and add
 
58
  to the normal Mandos plugins.  When adding or changing plugins, do
 
59
  not forget to update the initital RAM disk image:
42
60
  
43
 
        # update-initramfs -k all -u
 
61
        update-initramfs -k all -u
44
62
 
45
 
* Do *NOT* Edit /etc/crypttab
 
63
* Do *NOT* Edit "/etc/crypttab"
46
64
  
47
 
  It is NOT necessary to edit /etc/crypttab to specify
48
 
  /usr/lib/mandos/plugin-runner as a keyscript for the root file
 
65
  It is NOT necessary to edit "/etc/crypttab" to specify
 
66
  "/usr/lib/mandos/plugin-runner" as a keyscript for the root file
49
67
  system; if no keyscript is given for the root file system, the
50
68
  Mandos client will be the new default way for getting a password for
51
69
  the root file system when booting.
52
70
 
53
 
* Emergency Escape
54
 
  
55
 
  If it ever should be necessary, the Mandos client can be temporarily
56
 
  prevented from running at startup by passing the parameter
57
 
  "mandos=off" to the kernel.
58
 
 
59
71
* Non-local Connection (Not Using ZeroConf)
60
72
  
61
73
  If the "ip=" kernel command line option is used to specify a
62
74
  complete IP address and device name, as noted above, it then becomes
63
75
  possible to specify a specific IP address and port to connect to,
64
76
  instead of using ZeroConf.  The syntax for doing this is
65
 
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>".
66
 
  
67
 
  Warning: this will cause the client to make exactly one attempt at
68
 
  connecting, and then fail if it does not succeed.
 
77
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
 
78
  line.
69
79
  
70
80
  For very advanced users, it it possible to specify simply
71
81
  "mandos=connect" on the kernel command line to make the system only
74
84
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
75
85
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
76
86
 
77
 
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Tue, 14 Apr 2009 16:51:18 +0200
 
87
 -- Teddy Hogeborn <teddy@recompile.se>, Wed,  5 Oct 2011 17:50:22 +0200