/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
21
                --seckey=/etc/keys/mandos/seckey.txt; echo
29
22
  
39
32
 
40
33
* Specifying a Client Network Interface
41
34
  
42
 
  At boot time the network interfaces to use will by default be
43
 
  automatically detected.  If this should result in incorrect
44
 
  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
45
38
  "/etc/initramfs-tools/initramfs.conf" file.  (The default setting is
46
 
  empty, meaning it will autodetect the interfaces.)  *If* the DEVICE
 
39
  empty, meaning it will autodetect the interface.)  *If* the DEVICE
47
40
  setting is changed, it will be necessary to update the initrd image
48
 
  by running this command:
 
41
  by running the command
49
42
  
50
43
        update-initramfs -k all -u
51
44
  
52
 
  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
53
46
  command line using the sixth colon-separated field of the "ip="
54
47
  option; for exact syntax, read the documentation in the file
55
 
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfs/nfsroot.txt",
 
48
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfsroot.txt",
56
49
  available in the "linux-doc-*" package.
57
50
  
58
 
  Note that since the network interfaces are used in the initial RAM
59
 
  disk environment, the network interfaces *must* exist at that stage.
60
 
  Thus, an interface can *not* be a pseudo-interface such as "br0" or
61
 
  "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.
62
55
  This can be overcome by writing a "network hook" program to create
63
 
  an interface (see mandos-client(8mandos)) and placing it in
 
56
  the interface (see mandos-client(8mandos)) and placing it in
64
57
  "/etc/mandos/network-hooks.d", from where it will be copied into the
65
58
  initial RAM disk.  Example network hook scripts can be found in
66
 
  "/usr/share/doc/mandos-client/examples/network-hooks.d".
 
59
  "/usr/share/doc/mandos-client/network-hooks.d".
67
60
 
68
61
* User-Supplied Plugins
69
62
  
90
83
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
91
84
  line.
92
85
  
93
 
  For very advanced users, it is possible to specify simply
 
86
  For very advanced users, it it possible to specify simply
94
87
  "mandos=connect" on the kernel command line to make the system only
95
88
  set up the network (using the data in the "ip=" option) and not pass
96
89
  any extra "--connect" options to mandos-client at boot.  For this to
97
90
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
98
91
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
99
92
 
100
 
* Diffie-Hellman Parameters
101
 
 
102
 
  On installation, a file with Diffie-Hellman parameters,
103
 
  /etc/keys/mandos/dhparams.pem, will be generated and automatically
104
 
  installed into the initital RAM disk image and also used by the
105
 
  Mandos Client on boot.  If different parameters are needed for
106
 
  policy or other reasons, simply replace the existing dhparams.pem
107
 
  file and update the initital RAM disk image.
108
 
 
109
 
 -- Teddy Hogeborn <teddy@recompile.se>, Tue, 21 Jun 2016 21:43:49 +0200
 
93
 -- Teddy Hogeborn <teddy@recompile.se>, Mon, 28 Nov 2011 23:07:22 +0100