/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

* debian/mandos-client.README.Debian: Added text about non-usability
                                      of pseudo-network interfaces.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
This file documents the next steps to take after installation of the
2
 
Debian package, and also contain some notes specific to the Debian
3
 
packaging which are not also in the manual.
4
 
 
5
 
* Adding a Client Password to the Server
6
 
  
7
 
  The server must be given a password to give back to the client on
8
 
  boot time.  This password must be a one which can be used to unlock
9
 
  the root file system device.  On the *client*, run this command:
10
 
  
11
 
        mandos-keygen --password
12
 
  
13
 
  It will prompt for a password and output a config file section.
14
 
  This output should be copied to the Mandos server and added to the
15
 
  file "/etc/mandos/clients.conf" there.
16
 
 
17
 
* Testing that it Works (Without Rebooting)
18
 
  
19
 
  After the server has been started with this client's key added, it
20
 
  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
  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
21
27
  this client by running the command, on the client:
22
28
  
23
 
        MANDOSPLUGINHELPERDIR=/usr/lib/$(dpkg-architecture \
24
 
        -qDEB_HOST_MULTIARCH)/mandos/plugin-helpers \
25
 
        /usr/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH \
26
 
        )/mandos/plugins.d/mandos-client \
 
29
        # /usr/lib/mandos/plugins.d/mandos-client \
27
30
                --pubkey=/etc/keys/mandos/pubkey.txt \
28
 
                --seckey=/etc/keys/mandos/seckey.txt \
29
 
                --tls-privkey=/etc/keys/mandos/tls-privkey.pem \
30
 
                --tls-pubkey=/etc/keys/mandos/tls-pubkey.pem; echo
 
31
                --seckey=/etc/keys/mandos/seckey.txt; echo
31
32
  
32
33
  This command should retrieve the password from the server, decrypt
33
34
  it, and output it to standard output.  There it can be verified to
34
35
  be the correct password, before rebooting.
35
36
 
 
37
* User-Supplied Plugins
 
38
  
 
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:
 
42
  
 
43
        # update-initramfs -k all -u
 
44
 
 
45
* Do *NOT* Edit /etc/crypttab
 
46
  
 
47
  It is NOT necessary to edit /etc/crypttab to specify
 
48
  /usr/lib/mandos/plugin-runner as a keyscript for the root file
 
49
  system; if no keyscript is given for the root file system, the
 
50
  Mandos client will be the new default way for getting a password for
 
51
  the root file system when booting.
 
52
 
36
53
* Emergency Escape
37
54
  
38
55
  If it ever should be necessary, the Mandos client can be temporarily
39
56
  prevented from running at startup by passing the parameter
40
57
  "mandos=off" to the kernel.
41
58
 
42
 
* Specifying a Client Network Interface
43
 
  
44
 
  At boot time the network interfaces to use will by default be
45
 
  automatically detected.  If this should result in incorrect
46
 
  interfaces, edit the DEVICE setting in the
47
 
  "/etc/initramfs-tools/initramfs.conf" file.  (The default setting is
48
 
  empty, meaning it will autodetect the interfaces.)  *If* the DEVICE
49
 
  setting is changed, it will be necessary to update the initrd image
50
 
  by running this command:
51
 
  
52
 
        (For initramfs-tools:)
53
 
        update-initramfs -k all -u
54
 
        
55
 
        (For dracut:)
56
 
        dpkg-reconfigure dracut
57
 
  
58
 
  The device can also be overridden at boot time on the Linux kernel
59
 
  command line using the sixth colon-separated field of the "ip="
60
 
  option; for exact syntax, read the documentation in the file
61
 
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfs/nfsroot.txt",
62
 
  available in the "linux-doc-*" package.
63
 
  
64
 
  Note that since the network interfaces are used in the initial RAM
65
 
  disk environment, the network interfaces *must* exist at that stage.
66
 
  Thus, an interface can *not* be a pseudo-interface such as "br0" or
67
 
  "tun0"; instead, only real interfaces (such as "enp1s0" or "eth0")
68
 
  can be used. This can be overcome by writing a "network hook"
69
 
  program to create an interface (see mandos-client(8mandos)) and
70
 
  placing it in "/etc/mandos/network-hooks.d", from where it will be
71
 
  copied into the initial RAM disk.  Example network hook scripts can
72
 
  be found in "/usr/share/doc/mandos-client/examples/network-hooks.d".
73
 
 
74
 
* User-Supplied Plugins
75
 
  
76
 
  Any plugins found in "/etc/mandos/plugins.d" will override and add
77
 
  to the normal Mandos plugins.  When adding or changing plugins, do
78
 
  not forget to update the initial RAM disk image:
79
 
  
80
 
        (For initramfs-tools:)
81
 
        update-initramfs -k all -u
82
 
        
83
 
        (For dracut:)
84
 
        dpkg-reconfigure dracut
85
 
 
86
 
* Do *NOT* Edit "/etc/crypttab"
87
 
  
88
 
  It is NOT necessary to edit "/etc/crypttab" to specify
89
 
  "/usr/lib/mandos/plugin-runner" as a keyscript for the root file
90
 
  system; if no keyscript is given for the root file system, the
91
 
  Mandos client will be the new default way for getting a password for
92
 
  the root file system when booting.
93
 
 
94
59
* Non-local Connection (Not Using ZeroConf)
95
60
  
96
61
  If the "ip=" kernel command line option is used to specify a
97
62
  complete IP address and device name, as noted above, it then becomes
98
63
  possible to specify a specific IP address and port to connect to,
99
64
  instead of using ZeroConf.  The syntax for doing this is
100
 
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
101
 
  line.
102
 
  
103
 
  For very advanced users, it is possible to specify "mandos=connect"
104
 
  on the kernel command line to make the system only set up the
105
 
  network (using the data in the "ip=" option) and not pass any extra
106
 
  "--connect" options to mandos-client at boot.  For this to work,
107
 
  "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs to be
108
 
  manually added to the file "/etc/mandos/plugin-runner.conf" or, if
109
 
  dracut is used with systemd, the "--connect=<ADDRESS>:<PORT>"
110
 
  options needs to be added to an environment variable in an override
111
 
  file for the "ask-password-mandos" service, as detailed in the file
112
 
  "/usr/lib/dracut/modules.d/90mandos/ask-password-mandos.service".
113
 
 
114
 
* Diffie-Hellman Parameters
115
 
 
116
 
  On installation, a file with Diffie-Hellman parameters,
117
 
  /etc/keys/mandos/dhparams.pem, will be generated and automatically
118
 
  installed into the initial RAM disk image and also used by the
119
 
  Mandos Client on boot.  If different parameters are needed for
120
 
  policy or other reasons, simply replace the existing dhparams.pem
121
 
  file and update the initial RAM disk image.
122
 
 
123
 
 -- Teddy Hogeborn <teddy@recompile.se>, Sun,  8 Sep 2024 02:09:20 +0200
 
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.
 
69
  
 
70
  For very advanced users, it it possible to specify simply
 
71
  "mandos=connect" on the kernel command line to make the system only
 
72
  set up the network (using the data in the "ip=" option) and not pass
 
73
  any extra "--connect" options to mandos-client at boot.  For this to
 
74
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
 
75
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
 
76
 
 
77
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Tue, 14 Apr 2009 16:51:18 +0200