/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 at recompile
  • Date: 2020-02-08 14:01:38 UTC
  • Revision ID: teddy@recompile.se-20200208140138-h3ett0amdelfpt90
mandos: If possible, use shlex.quote() instead of re.escape()

* mandos: Make sure shlex.quote() exists (falling back to assigning
  re.escape to it).
  (Client.start_checker): Use shlex.quote() instead of re.escape().

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
 
1
5
* Adding a Client Password to the Server
2
6
  
3
7
  The server must be given a password to give back to the client on
16
20
  is possible to verify that the correct password will be received by
17
21
  this client by running the command, on the client:
18
22
  
19
 
        /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 \
20
27
                --pubkey=/etc/keys/mandos/pubkey.txt \
21
 
                --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
22
31
  
23
32
  This command should retrieve the password from the server, decrypt
24
33
  it, and output it to standard output.  There it can be verified to
32
41
 
33
42
* Specifying a Client Network Interface
34
43
  
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
 
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:
41
51
  
 
52
        (For initramfs-tools:)
42
53
        update-initramfs -k all -u
 
54
        
 
55
        (For dracut:)
 
56
        dpkg-reconfigure dracut
43
57
  
44
 
  The device can be overridden at boot time on the Linux kernel
 
58
  The device can also be overridden at boot time on the Linux kernel
45
59
  command line using the sixth colon-separated field of the "ip="
46
60
  option; for exact syntax, read the documentation in the file
47
 
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfsroot.txt",
 
61
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfs/nfsroot.txt",
48
62
  available in the "linux-doc-*" package.
49
63
  
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".
 
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".
59
73
 
60
74
* User-Supplied Plugins
61
75
  
63
77
  to the normal Mandos plugins.  When adding or changing plugins, do
64
78
  not forget to update the initital RAM disk image:
65
79
  
 
80
        (For initramfs-tools:)
66
81
        update-initramfs -k all -u
 
82
        
 
83
        (For dracut:)
 
84
        dpkg-reconfigure dracut
67
85
 
68
86
* Do *NOT* Edit "/etc/crypttab"
69
87
  
82
100
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
83
101
  line.
84
102
  
85
 
  For very advanced users, it it possible to specify simply
 
103
  For very advanced users, it is possible to specify simply
86
104
  "mandos=connect" on the kernel command line to make the system only
87
105
  set up the network (using the data in the "ip=" option) and not pass
88
106
  any extra "--connect" options to mandos-client at boot.  For this to
89
107
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
90
108
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
91
109
 
92
 
 -- Teddy Hogeborn <teddy@recompile.se>, Mon, 28 Nov 2011 23:07:22 +0100
 
110
* Diffie-Hellman Parameters
 
111
 
 
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.
 
118
 
 
119
 -- Teddy Hogeborn <teddy@recompile.se>, Mon, 15 Jul 2019 16:47:02 +0200