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 \
29
--tls-privkey=/etc/keys/mandos/tls-privkey.pem \
30
--tls-pubkey=/etc/keys/mandos/tls-pubkey.pem; echo
32
This command should retrieve the password from the server, decrypt
33
it, and output it to standard output. There it can be verified to
34
be the correct password, before rebooting.
38
If it ever should be necessary, the Mandos client can be temporarily
39
prevented from running at startup by passing the parameter
40
"mandos=off" to the kernel.
42
* Specifying a Client Network Interface
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:
52
update-initramfs -k all -u
54
The device can also be overridden at boot time on the Linux kernel
55
command line using the sixth colon-separated field of the "ip="
56
option; for exact syntax, read the documentation in the file
57
"/usr/share/doc/linux-doc-*/Documentation/filesystems/nfs/nfsroot.txt",
58
available in the "linux-doc-*" package.
60
Note that since the network interfaces are used in the initial RAM
61
disk environment, the network interfaces *must* exist at that stage.
62
Thus, an interface can *not* be a pseudo-interface such as "br0" or
63
"tun0"; instead, only real interfaces (such as "eth0") can be used.
64
This can be overcome by writing a "network hook" program to create
65
an interface (see mandos-client(8mandos)) and placing it in
66
"/etc/mandos/network-hooks.d", from where it will be copied into the
67
initial RAM disk. Example network hook scripts can be found in
68
"/usr/share/doc/mandos-client/examples/network-hooks.d".
70
* User-Supplied Plugins
72
Any plugins found in "/etc/mandos/plugins.d" will override and add
73
to the normal Mandos plugins. When adding or changing plugins, do
74
not forget to update the initital RAM disk image:
76
update-initramfs -k all -u
78
* Do *NOT* Edit "/etc/crypttab"
80
It is NOT necessary to edit "/etc/crypttab" to specify
81
"/usr/lib/mandos/plugin-runner" as a keyscript for the root file
82
system; if no keyscript is given for the root file system, the
83
Mandos client will be the new default way for getting a password for
84
the root file system when booting.
86
* Non-local Connection (Not Using ZeroConf)
88
If the "ip=" kernel command line option is used to specify a
89
complete IP address and device name, as noted above, it then becomes
90
possible to specify a specific IP address and port to connect to,
91
instead of using ZeroConf. The syntax for doing this is
92
"mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
95
For very advanced users, it is possible to specify simply
96
"mandos=connect" on the kernel command line to make the system only
97
set up the network (using the data in the "ip=" option) and not pass
98
any extra "--connect" options to mandos-client at boot. For this to
99
work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
100
to be manually added to the file "/etc/mandos/plugin-runner.conf".
102
* Diffie-Hellman Parameters
104
On installation, a file with Diffie-Hellman parameters,
105
/etc/keys/mandos/dhparams.pem, will be generated and automatically
106
installed into the initital RAM disk image and also used by the
107
Mandos Client on boot. If different parameters are needed for
108
policy or other reasons, simply replace the existing dhparams.pem
109
file and update the initital RAM disk image.
111
-- Teddy Hogeborn <teddy@recompile.se>, Sat, 9 Feb 2019 15:08:04 +0100
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
Also, if some other network interface than "eth0" is used, it will be
7
necessary to edit /etc/mandos/plugin-runner.conf to uncomment and
8
change the line there. If this file is changed, it will be necessary
9
to update the initrd image by doing "update-initramfs -k all -u".
11
It is NOT necessary to edit /etc/crypttab to specify
12
/usr/lib/mandos/plugin-runner as a keyscript for the root file system;
13
if no keyscript is given for the root file system, the Mandos client
14
will be the new default way for getting a password for the root file
added
removed
debian/mandos-client.README.Debian
