/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: 2014-06-13 22:13:56 UTC
  • Revision ID: teddy@recompile.se-20140613221356-b9c36ctxmw4pelja
Fix free() of possibly uninitialized pointer in mandos-client.

* plugins.d/mandos-client (main): Initialize "direntries" to NULL so
                                  it can be free()'d even if scandir()
                                  fails.

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
19
        /usr/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH \
26
20
        )/mandos/plugins.d/mandos-client \
27
21
                --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
 
22
                --seckey=/etc/keys/mandos/seckey.txt; echo
31
23
  
32
24
  This command should retrieve the password from the server, decrypt
33
25
  it, and output it to standard output.  There it can be verified to
45
37
  automatically detected.  If this should result in incorrect
46
38
  interfaces, edit the DEVICE setting in the
47
39
  "/etc/initramfs-tools/initramfs.conf" file.  (The default setting is
48
 
  empty, meaning it will autodetect the interfaces.)  *If* the DEVICE
 
40
  empty, meaning it will autodetect the interface.)  *If* the DEVICE
49
41
  setting is changed, it will be necessary to update the initrd image
50
 
  by running this command:
 
42
  by running the command
51
43
  
52
 
        (For initramfs-tools:)
53
44
        update-initramfs -k all -u
54
 
        
55
 
        (For dracut:)
56
 
        dpkg-reconfigure dracut
57
45
  
58
46
  The device can also be overridden at boot time on the Linux kernel
59
47
  command line using the sixth colon-separated field of the "ip="
64
52
  Note that since the network interfaces are used in the initial RAM
65
53
  disk environment, the network interfaces *must* exist at that stage.
66
54
  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".
 
55
  "tun0"; instead, only real interfaces (such as "eth0") can be used.
 
56
  This can be overcome by writing a "network hook" program to create
 
57
  an interface (see mandos-client(8mandos)) and placing it in
 
58
  "/etc/mandos/network-hooks.d", from where it will be copied into the
 
59
  initial RAM disk.  Example network hook scripts can be found in
 
60
  "/usr/share/doc/mandos-client/examples/network-hooks.d".
73
61
 
74
62
* User-Supplied Plugins
75
63
  
76
64
  Any plugins found in "/etc/mandos/plugins.d" will override and add
77
65
  to the normal Mandos plugins.  When adding or changing plugins, do
78
 
  not forget to update the initial RAM disk image:
 
66
  not forget to update the initital RAM disk image:
79
67
  
80
 
        (For initramfs-tools:)
81
68
        update-initramfs -k all -u
82
 
        
83
 
        (For dracut:)
84
 
        dpkg-reconfigure dracut
85
69
 
86
70
* Do *NOT* Edit "/etc/crypttab"
87
71
  
100
84
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
101
85
  line.
102
86
  
103
 
  For very advanced users, it is possible to specify "mandos=connect"
104
 
  on the kernel command line to make the system only set up the
105
 
  network (using the data in the "ip=" option) and not pass any extra
106
 
  "--connect" options to mandos-client at boot.  For this to work,
107
 
  "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs to be
108
 
  manually added to the file "/etc/mandos/plugin-runner.conf" or, if
109
 
  dracut is used with systemd, the "--connect=<ADDRESS>:<PORT>"
110
 
  options needs to be added to an environment variable in an override
111
 
  file for the "ask-password-mandos" service, as detailed in the file
112
 
  "/usr/lib/dracut/modules.d/90mandos/ask-password-mandos.service".
113
 
 
114
 
* Diffie-Hellman Parameters
115
 
 
116
 
  On installation, a file with Diffie-Hellman parameters,
117
 
  /etc/keys/mandos/dhparams.pem, will be generated and automatically
118
 
  installed into the initial RAM disk image and also used by the
119
 
  Mandos Client on boot.  If different parameters are needed for
120
 
  policy or other reasons, simply replace the existing dhparams.pem
121
 
  file and update the initial RAM disk image.
122
 
 
123
 
 -- Teddy Hogeborn <teddy@recompile.se>, Sun,  8 Sep 2024 02:09:20 +0200
 
87
  For very advanced users, it it possible to specify simply
 
88
  "mandos=connect" on the kernel command line to make the system only
 
89
  set up the network (using the data in the "ip=" option) and not pass
 
90
  any extra "--connect" options to mandos-client at boot.  For this to
 
91
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
 
92
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
 
93
 
 
94
 -- Teddy Hogeborn <teddy@recompile.se>, Mon, 28 Oct 2013 11:02:26 +0100