/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to debian/mandos-client.README.Debian

  • Committer: Teddy Hogeborn
  • Date: 2019-07-15 01:59:36 UTC
  • Revision ID: teddy@recompile.se-20190715015936-09xieyg8ogdxvoi2
Debian package change: Add autopkgtest support

* Makefile (check): Run a few more superficial tests.
  (debian/control/[Source: mandos]/Testsuite): New; set to
                                               "autopkgtest".
  (debian/tests/control): New.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
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
27
21
  this client by running the command, on the client:
28
22
  
29
 
        # /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 \
30
27
                --pubkey=/etc/keys/mandos/pubkey.txt \
31
 
                --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
32
31
  
33
32
  This command should retrieve the password from the server, decrypt
34
33
  it, and output it to standard output.  There it can be verified to
35
34
  be the correct password, before rebooting.
36
35
 
 
36
* Emergency Escape
 
37
  
 
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.
 
41
 
 
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
        update-initramfs -k all -u
 
53
  
 
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.
 
59
  
 
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 "enp1s0" or "eth0")
 
64
  can be used. This can be overcome by writing a "network hook"
 
65
  program to create an interface (see mandos-client(8mandos)) and
 
66
  placing it in "/etc/mandos/network-hooks.d", from where it will be
 
67
  copied into the initial RAM disk.  Example network hook scripts can
 
68
  be found in "/usr/share/doc/mandos-client/examples/network-hooks.d".
 
69
 
37
70
* User-Supplied Plugins
38
71
  
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:
 
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:
42
75
  
43
 
        # update-initramfs -k all -u
 
76
        update-initramfs -k all -u
44
77
 
45
 
* Do *NOT* Edit /etc/crypttab
 
78
* Do *NOT* Edit "/etc/crypttab"
46
79
  
47
 
  It is NOT necessary to edit /etc/crypttab to specify
48
 
  /usr/lib/mandos/plugin-runner as a keyscript for the root file
 
80
  It is NOT necessary to edit "/etc/crypttab" to specify
 
81
  "/usr/lib/mandos/plugin-runner" as a keyscript for the root file
49
82
  system; if no keyscript is given for the root file system, the
50
83
  Mandos client will be the new default way for getting a password for
51
84
  the root file system when booting.
52
85
 
53
 
* Emergency Escape
54
 
  
55
 
  If it ever should be necessary, the Mandos client can be temporarily
56
 
  prevented from running at startup by passing the parameter
57
 
  "mandos=off" to the kernel.
58
 
 
59
86
* Non-local Connection (Not Using ZeroConf)
60
87
  
61
88
  If the "ip=" kernel command line option is used to specify a
62
89
  complete IP address and device name, as noted above, it then becomes
63
90
  possible to specify a specific IP address and port to connect to,
64
91
  instead of using ZeroConf.  The syntax for doing this is
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
 
92
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
 
93
  line.
 
94
  
 
95
  For very advanced users, it is possible to specify simply
71
96
  "mandos=connect" on the kernel command line to make the system only
72
97
  set up the network (using the data in the "ip=" option) and not pass
73
98
  any extra "--connect" options to mandos-client at boot.  For this to
74
99
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
75
100
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
76
101
 
77
 
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Tue, 14 Apr 2009 16:51:18 +0200
 
102
* Diffie-Hellman Parameters
 
103
 
 
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.
 
110
 
 
111
 -- Teddy Hogeborn <teddy@recompile.se>, Thu, 20 Jun 2019 20:28:25 +0200