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.
5
* Adding a Client Password to the Server
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:
11
mandos-keygen --password
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.
17
* Testing that it Works (Without Rebooting)
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
21
this client by running the command, on the client:
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 \
27
--pubkey=/etc/keys/mandos/pubkey.txt \
28
--seckey=/etc/keys/mandos/seckey.txt; echo
30
This command should retrieve the password from the server, decrypt
31
it, and output it to standard output. There it can be verified to
32
be the correct password, before rebooting.
36
If it ever should be necessary, the Mandos client can be temporarily
37
prevented from running at startup by passing the parameter
38
"mandos=off" to the kernel.
40
* Specifying a Client Network Interface
42
At boot time the network interfaces to use will by default be
43
automatically detected. If this should result in incorrect
44
interfaces, edit the DEVICE setting in the
45
"/etc/initramfs-tools/initramfs.conf" file. (The default setting is
46
empty, meaning it will autodetect the interfaces.) *If* the DEVICE
47
setting is changed, it will be necessary to update the initrd image
48
by running this command:
50
update-initramfs -k all -u
52
The device can also be overridden at boot time on the Linux kernel
53
command line using the sixth colon-separated field of the "ip="
54
option; for exact syntax, read the documentation in the file
55
"/usr/share/doc/linux-doc-*/Documentation/filesystems/nfs/nfsroot.txt",
56
available in the "linux-doc-*" package.
58
Note that since the network interfaces are used in the initial RAM
59
disk environment, the network interfaces *must* exist at that stage.
60
Thus, an interface can *not* be a pseudo-interface such as "br0" or
61
"tun0"; instead, only real interfaces (such as "eth0") can be used.
62
This can be overcome by writing a "network hook" program to create
63
an interface (see mandos-client(8mandos)) and placing it in
64
"/etc/mandos/network-hooks.d", from where it will be copied into the
65
initial RAM disk. Example network hook scripts can be found in
66
"/usr/share/doc/mandos-client/examples/network-hooks.d".
68
* User-Supplied Plugins
70
Any plugins found in "/etc/mandos/plugins.d" will override and add
71
to the normal Mandos plugins. When adding or changing plugins, do
72
not forget to update the initital RAM disk image:
74
update-initramfs -k all -u
76
* Do *NOT* Edit "/etc/crypttab"
78
It is NOT necessary to edit "/etc/crypttab" to specify
79
"/usr/lib/mandos/plugin-runner" as a keyscript for the root file
80
system; if no keyscript is given for the root file system, the
81
Mandos client will be the new default way for getting a password for
82
the root file system when booting.
84
* Non-local Connection (Not Using ZeroConf)
86
If the "ip=" kernel command line option is used to specify a
87
complete IP address and device name, as noted above, it then becomes
88
possible to specify a specific IP address and port to connect to,
89
instead of using ZeroConf. The syntax for doing this is
90
"mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
93
For very advanced users, it it possible to specify simply
94
"mandos=connect" on the kernel command line to make the system only
95
set up the network (using the data in the "ip=" option) and not pass
96
any extra "--connect" options to mandos-client at boot. For this to
97
work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
98
to be manually added to the file "/etc/mandos/plugin-runner.conf".
100
* Diffie-Hellman Parameters
102
On installation, a file with Diffie-Hellman parameters,
103
/etc/keys/mandos/dhparams.pem, will be generated and automatically
104
installed into the initital RAM disk image and also used by the
105
Mandos Client on boot. If different parameters are needed for
106
policy or other reasons, simply replace the existing dhparams.pem
107
file and update the initital RAM disk image.
109
-- Teddy Hogeborn <teddy@recompile.se>, Tue, 5 Apr 2016 08:53:39 +0200
1
A client key has been automatically created in /etc/keys/mandos. The
2
next step is to run "mandos-keygen --password" to get a config file
3
stanza to copy and paste into /etc/mandos/clients.conf on the Mandos
6
It is NOT necessary to edit /etc/crypttab to specify
7
/usr/lib/mandos/plugin-runner as a keyscript for the root file system;
8
if no keyscript is given for the root file system, the Mandos client
9
will be the new default way for getting a password for the root file
added
removed
debian/mandos-client.README.Debian
