/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

* README (The Plugin System): Improve wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
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
* Test the Server
 
19
  
 
20
  After the server has been started and this client's key added, it is
 
21
  possible to verify that the correct password will be received by
17
22
  this client by running the command, on the client:
18
23
  
19
 
        /usr/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH \
20
 
        )/mandos/plugins.d/mandos-client \
 
24
        # /usr/lib/mandos/plugins.d/mandos-client \
21
25
                --pubkey=/etc/keys/mandos/pubkey.txt \
22
26
                --seckey=/etc/keys/mandos/seckey.txt; echo
23
27
  
25
29
  it, and output it to standard output.  There it can be verified to
26
30
  be the correct password, before rebooting.
27
31
 
 
32
* User-Supplied Plugins
 
33
  
 
34
  Any plugins found in /etc/mandos/plugins.d will override and add to
 
35
  the normal Mandos plugins.  When adding or changing plugins, do not
 
36
  forget to update the initital RAM disk image:
 
37
  
 
38
        # update-initramfs -k all -u
 
39
 
 
40
* Do *NOT* Edit /etc/crypttab
 
41
  
 
42
  It is NOT necessary to edit /etc/crypttab to specify
 
43
  /usr/lib/mandos/plugin-runner as a keyscript for the root file
 
44
  system; if no keyscript is given for the root file system, the
 
45
  Mandos client will be the new default way for getting a password for
 
46
  the root file system when booting.
 
47
 
28
48
* Emergency Escape
29
49
  
30
50
  If it ever should be necessary, the Mandos client can be temporarily
31
51
  prevented from running at startup by passing the parameter
32
52
  "mandos=off" to the kernel.
33
53
 
34
 
* Specifying a Client Network Interface
35
 
  
36
 
  At boot time the network interfaces to use will by default be
37
 
  automatically detected.  If this should result in incorrect
38
 
  interfaces, edit the DEVICE setting in the
39
 
  "/etc/initramfs-tools/initramfs.conf" file.  (The default setting is
40
 
  empty, meaning it will autodetect the interface.)  *If* the DEVICE
41
 
  setting is changed, it will be necessary to update the initrd image
42
 
  by running the command
43
 
  
44
 
        update-initramfs -k all -u
45
 
  
46
 
  The device can also be overridden at boot time on the Linux kernel
47
 
  command line using the sixth colon-separated field of the "ip="
48
 
  option; for exact syntax, read the documentation in the file
49
 
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfs/nfsroot.txt",
50
 
  available in the "linux-doc-*" package.
51
 
  
52
 
  Note that since the network interfaces are used in the initial RAM
53
 
  disk environment, the network interfaces *must* exist at that stage.
54
 
  Thus, an interface can *not* be a pseudo-interface such as "br0" or
55
 
  "tun0"; instead, only real interfaces (such as "eth0") can be used.
56
 
  This can be overcome by writing a "network hook" program to create
57
 
  an interface (see mandos-client(8mandos)) and placing it in
58
 
  "/etc/mandos/network-hooks.d", from where it will be copied into the
59
 
  initial RAM disk.  Example network hook scripts can be found in
60
 
  "/usr/share/doc/mandos-client/examples/network-hooks.d".
61
 
 
62
 
* User-Supplied Plugins
63
 
  
64
 
  Any plugins found in "/etc/mandos/plugins.d" will override and add
65
 
  to the normal Mandos plugins.  When adding or changing plugins, do
66
 
  not forget to update the initital RAM disk image:
67
 
  
68
 
        update-initramfs -k all -u
69
 
 
70
 
* Do *NOT* Edit "/etc/crypttab"
71
 
  
72
 
  It is NOT necessary to edit "/etc/crypttab" to specify
73
 
  "/usr/lib/mandos/plugin-runner" as a keyscript for the root file
74
 
  system; if no keyscript is given for the root file system, the
75
 
  Mandos client will be the new default way for getting a password for
76
 
  the root file system when booting.
77
 
 
78
54
* Non-local Connection (Not Using ZeroConf)
79
55
  
80
56
  If the "ip=" kernel command line option is used to specify a
81
57
  complete IP address and device name, as noted above, it then becomes
82
58
  possible to specify a specific IP address and port to connect to,
83
59
  instead of using ZeroConf.  The syntax for doing this is
84
 
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
85
 
  line.
 
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.
86
64
  
87
65
  For very advanced users, it it possible to specify simply
88
66
  "mandos=connect" on the kernel command line to make the system only
91
69
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
92
70
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
93
71
 
94
 
 -- Teddy Hogeborn <teddy@recompile.se>, Mon, 28 Oct 2013 11:02:26 +0100
 
72
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Mon,  9 Feb 2009 00:36:55 +0100