1
 
* Choose the Client Network Interface
 
3
 
  Please make sure that the correct network interface is specified in
 
4
 
  the DEVICE setting in the "/etc/initramfs-tools/initramfs.conf"
 
5
 
  file.  If the setting is empty, the interface will be autodetected
 
6
 
  at boot time, which may not be correct.  *If* the DEVICE setting is
 
7
 
  changed, it will be necessary to update the initrd image by running
 
10
 
        update-initramfs -k all -u
 
12
 
  The device can be overridden at boot time on the Linux kernel
 
13
 
  command line using the sixth colon-separated field of the "ip="
 
14
 
  option; for exact syntax, read the documentation in the file
 
15
 
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfsroot.txt",
 
16
 
  available in the "linux-doc-*" package.
 
18
 
  Note that since this network interface is used in the initial RAM
 
19
 
  disk environment, the network interface *must* exist at that stage.
 
20
 
  Thus, the interface can *not* be a pseudo-interface such as "br0" or
 
21
 
  "tun0"; instead, a real interface (such as "eth0") must be used.
 
 
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.
 
23
5
* Adding a Client Password to the Server
 
 
38
20
  is possible to verify that the correct password will be received by
 
39
21
  this client by running the command, on the client:
 
41
 
        /usr/lib/mandos/plugins.d/mandos-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 \
 
42
27
                --pubkey=/etc/keys/mandos/pubkey.txt \
 
43
 
                --seckey=/etc/keys/mandos/seckey.txt; echo
 
 
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
 
45
32
  This command should retrieve the password from the server, decrypt
 
46
33
  it, and output it to standard output.  There it can be verified to
 
47
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
        (For initramfs-tools:)
 
 
53
        update-initramfs -k all -u
 
 
56
        dpkg-reconfigure dracut
 
 
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.
 
 
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".
 
49
74
* User-Supplied Plugins
 
51
76
  Any plugins found in "/etc/mandos/plugins.d" will override and add
 
52
77
  to the normal Mandos plugins.  When adding or changing plugins, do
 
53
78
  not forget to update the initital RAM disk image:
 
 
80
        (For initramfs-tools:)
 
55
81
        update-initramfs -k all -u
 
 
84
        dpkg-reconfigure dracut
 
57
86
* Do *NOT* Edit "/etc/crypttab"
 
 
62
91
  Mandos client will be the new default way for getting a password for
 
63
92
  the root file system when booting.
 
67
 
  If it ever should be necessary, the Mandos client can be temporarily
 
68
 
  prevented from running at startup by passing the parameter
 
69
 
  "mandos=off" to the kernel.
 
71
94
* Non-local Connection (Not Using ZeroConf)
 
73
96
  If the "ip=" kernel command line option is used to specify a
 
74
97
  complete IP address and device name, as noted above, it then becomes
 
75
98
  possible to specify a specific IP address and port to connect to,
 
76
99
  instead of using ZeroConf.  The syntax for doing this is
 
77
 
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>".
 
79
 
  Warning: this will cause the client to make exactly one attempt at
 
80
 
  connecting, and then fail if it does not succeed.
 
82
 
  For very advanced users, it it possible to specify simply
 
 
100
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
 
 
103
  For very advanced users, it is possible to specify simply
 
83
104
  "mandos=connect" on the kernel command line to make the system only
 
84
105
  set up the network (using the data in the "ip=" option) and not pass
 
85
106
  any extra "--connect" options to mandos-client at boot.  For this to
 
86
107
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
 
87
108
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
 
89
 
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Sun, 26 Sep 2010 20:08:05 +0200
 
 
110
* Diffie-Hellman Parameters
 
 
112
  On installation, a file with Diffie-Hellman parameters,
 
 
113
  /etc/keys/mandos/dhparams.pem, will be generated and automatically
 
 
114
  installed into the initital RAM disk image and also used by the
 
 
115
  Mandos Client on boot.  If different parameters are needed for
 
 
116
  policy or other reasons, simply replace the existing dhparams.pem
 
 
117
  file and update the initital RAM disk image.
 
 
119
 -- Teddy Hogeborn <teddy@recompile.se>, Mon, 15 Jul 2019 16:47:02 +0200