/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

merge

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