/mandos/release

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

« back to all changes in this revision

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

Merge "--socket" option for server.

This is suggested by the GNU Coding Standards' Table of Long Options,
and will probably also allow socket activation (e.g. by systemd(8)).

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/mandos-client.README.Debian
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
1
* Adding a Client Password to the Server
6
2
  
7
3
  The server must be given a password to give back to the client on
20
16
  is possible to verify that the correct password will be received by
21
17
  this client by running the command, on the client:
22
18
  
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 \
 
19
        /usr/lib/mandos/plugins.d/mandos-client \
27
20
                --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
 
21
                --seckey=/etc/keys/mandos/seckey.txt; echo
31
22
  
32
23
  This command should retrieve the password from the server, decrypt
33
24
  it, and output it to standard output.  There it can be verified to
41
32
 
42
33
* Specifying a Client Network Interface
43
34
  
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
 
35
  At boot time the network interface to use will by default be
 
36
  automatically detected.  If this should result in an incorrect
 
37
  interface, edit the DEVICE setting in the
47
38
  "/etc/initramfs-tools/initramfs.conf" file.  (The default setting is
48
 
  empty, meaning it will autodetect the interfaces.)  *If* the DEVICE
 
39
  empty, meaning it will autodetect the interface.)  *If* the DEVICE
49
40
  setting is changed, it will be necessary to update the initrd image
50
 
  by running this command:
 
41
  by running the command
51
42
  
52
43
        update-initramfs -k all -u
53
44
  
54
 
  The device can also be overridden at boot time on the Linux kernel
 
45
  The device can be overridden at boot time on the Linux kernel
55
46
  command line using the sixth colon-separated field of the "ip="
56
47
  option; for exact syntax, read the documentation in the file
57
 
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfs/nfsroot.txt",
 
48
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfsroot.txt",
58
49
  available in the "linux-doc-*" package.
59
50
  
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.
 
51
  Note that since this network interface is used in the initial RAM
 
52
  disk environment, the network interface *must* exist at that stage.
 
53
  Thus, the interface can *not* be a pseudo-interface such as "br0" or
 
54
  "tun0"; instead, only real interface (such as "eth0") can be used.
64
55
  This can be overcome by writing a "network hook" program to create
65
 
  an interface (see mandos-client(8mandos)) and placing it in
 
56
  the interface (see mandos-client(8mandos)) and placing it in
66
57
  "/etc/mandos/network-hooks.d", from where it will be copied into the
67
58
  initial RAM disk.  Example network hook scripts can be found in
68
 
  "/usr/share/doc/mandos-client/examples/network-hooks.d".
 
59
  "/usr/share/doc/mandos-client/network-hooks.d".
69
60
 
70
61
* User-Supplied Plugins
71
62
  
92
83
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
93
84
  line.
94
85
  
95
 
  For very advanced users, it is possible to specify simply
 
86
  For very advanced users, it it possible to specify simply
96
87
  "mandos=connect" on the kernel command line to make the system only
97
88
  set up the network (using the data in the "ip=" option) and not pass
98
89
  any extra "--connect" options to mandos-client at boot.  For this to
99
90
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
100
91
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
101
92
 
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>, Sat,  9 Feb 2019 15:08:04 +0100
 
93
 -- Teddy Hogeborn <teddy@recompile.se>, Mon, 28 Nov 2011 23:07:22 +0100