/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: 2024-09-16 21:01:52 UTC
  • Revision ID: teddy@recompile.se-20240916210152-0xbv4b15jyho9ydk
Override lintian experimental tag "executable-in-usr-lib"

Lintian reports executable files in /usr/lib, since binaries which are
executed internally are supposed to be stored in /usr/libexec.  But
the executables we store in /usr/lib are all files to be copied into
the initial RAM disk image, and are never executed from their storage
location in /usr/lib.  Except one; the Dracut module-setup.sh file.
But that file seems to be required to be executable; the
module-setup.sh file of every other Dracut module is also an
executable file.

* debian/mandos-client.lintian-overrides: Override experimental tag
  "executable-in-usr-lib" about files which are not actually executed
  from this location, and only exist to be copied to the initial RAM
  disk image.  Also the Dracut module-setup.sh file, which merely
  follows the pattern of all other Dracut module-setup.sh files from
  other Dracut modules.

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
21
25
        /usr/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH \
22
26
        )/mandos/plugins.d/mandos-client \
23
27
                --pubkey=/etc/keys/mandos/pubkey.txt \
24
 
                --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
25
31
  
26
32
  This command should retrieve the password from the server, decrypt
27
33
  it, and output it to standard output.  There it can be verified to
39
45
  automatically detected.  If this should result in incorrect
40
46
  interfaces, edit the DEVICE setting in the
41
47
  "/etc/initramfs-tools/initramfs.conf" file.  (The default setting is
42
 
  empty, meaning it will autodetect the interface.)  *If* the DEVICE
 
48
  empty, meaning it will autodetect the interfaces.)  *If* the DEVICE
43
49
  setting is changed, it will be necessary to update the initrd image
44
 
  by running the command
 
50
  by running this command:
45
51
  
 
52
        (For initramfs-tools:)
46
53
        update-initramfs -k all -u
 
54
        
 
55
        (For dracut:)
 
56
        dpkg-reconfigure dracut
47
57
  
48
58
  The device can also be overridden at boot time on the Linux kernel
49
59
  command line using the sixth colon-separated field of the "ip="
54
64
  Note that since the network interfaces are used in the initial RAM
55
65
  disk environment, the network interfaces *must* exist at that stage.
56
66
  Thus, an interface can *not* be a pseudo-interface such as "br0" or
57
 
  "tun0"; instead, only real interfaces (such as "eth0") can be used.
58
 
  This can be overcome by writing a "network hook" program to create
59
 
  an interface (see mandos-client(8mandos)) and placing it in
60
 
  "/etc/mandos/network-hooks.d", from where it will be copied into the
61
 
  initial RAM disk.  Example network hook scripts can be found in
62
 
  "/usr/share/doc/mandos-client/examples/network-hooks.d".
 
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".
63
73
 
64
74
* User-Supplied Plugins
65
75
  
66
76
  Any plugins found in "/etc/mandos/plugins.d" will override and add
67
77
  to the normal Mandos plugins.  When adding or changing plugins, do
68
 
  not forget to update the initital RAM disk image:
 
78
  not forget to update the initial RAM disk image:
69
79
  
 
80
        (For initramfs-tools:)
70
81
        update-initramfs -k all -u
 
82
        
 
83
        (For dracut:)
 
84
        dpkg-reconfigure dracut
71
85
 
72
86
* Do *NOT* Edit "/etc/crypttab"
73
87
  
86
100
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
87
101
  line.
88
102
  
89
 
  For very advanced users, it it possible to specify simply
90
 
  "mandos=connect" on the kernel command line to make the system only
91
 
  set up the network (using the data in the "ip=" option) and not pass
92
 
  any extra "--connect" options to mandos-client at boot.  For this to
93
 
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
94
 
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
95
 
 
96
 
 -- Teddy Hogeborn <teddy@recompile.se>, Mon, 29 Jun 2015 18:17:41 +0200
 
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