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