/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-09 04:24:39 UTC
  • Revision ID: teddy@recompile.se-20240909042439-j85mr20uli2hnyis
Eliminate compiler warnings

Many programs use nested functions, which now result in a linker
warning about executable stack.  Hide this warning.  Also, rewrite a
loop in the plymouth plugin to avoid warning about signed overflow.
This change also makes the plugin pick the alphabetically first
process entry instead of the last, in case many plymouth processes are
found (which should be unlikely).

* Makefile (plugin-runner, dracut-module/password-agent,
  plugins.d/password-prompt, plugins.d/mandos-client,
  plugins.d/plymouth): New target; set LDFLAGS to add "-Xlinker
  --no-warn-execstack".
* plugins.d/plymouth.c (get_pid): When no pid files are found, and we
  are looking through the process list, go though it from the start
  instead of from the end, i.e. in normal alphabetical order and not
  in reverse order.

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/mandos-client.README.Debian
1
 
* Choose the Client Network Interface
2
 
  
3
 
  Please make sure that the correct network interface is specified in
4
 
  the DEVICE setting in the "/etc/initramfs-tools/initramfs.conf"
5
 
  file.  If the setting is empty, the interface will be autodetected
6
 
  at boot time, which may not be correct.  *If* the DEVICE setting is
7
 
  changed, it will be necessary to update the initrd image by running
8
 
  the command
9
 
  
10
 
        update-initramfs -k all -u
11
 
  
12
 
  The device can be overridden at boot time on the Linux kernel
13
 
  command line using the sixth colon-separated field of the "ip="
14
 
  option; for exact syntax, read the documentation in the file
15
 
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfsroot.txt",
16
 
  available in the "linux-doc-*" package.
17
 
  
18
 
  Note that since this network interface is used in the initial RAM
19
 
  disk environment, the network interface *must* exist at that stage.
20
 
  Thus, the interface can *not* be a pseudo-interface such as "br0" or
21
 
  "tun0"; instead, a real interface (such as "eth0") must be used.
 
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.
22
4
 
23
5
* Adding a Client Password to the Server
24
6
  
38
20
  is possible to verify that the correct password will be received by
39
21
  this client by running the command, on the client:
40
22
  
41
 
        /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 \
42
27
                --pubkey=/etc/keys/mandos/pubkey.txt \
43
 
                --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
44
31
  
45
32
  This command should retrieve the password from the server, decrypt
46
33
  it, and output it to standard output.  There it can be verified to
47
34
  be the correct password, before rebooting.
48
35
 
 
36
* Emergency Escape
 
37
  
 
38
  If it ever should be necessary, the Mandos client can be temporarily
 
39
  prevented from running at startup by passing the parameter
 
40
  "mandos=off" to the kernel.
 
41
 
 
42
* Specifying a Client Network Interface
 
43
  
 
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:
 
51
  
 
52
        (For initramfs-tools:)
 
53
        update-initramfs -k all -u
 
54
        
 
55
        (For dracut:)
 
56
        dpkg-reconfigure dracut
 
57
  
 
58
  The device can also be overridden at boot time on the Linux kernel
 
59
  command line using the sixth colon-separated field of the "ip="
 
60
  option; for exact syntax, read the documentation in the file
 
61
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfs/nfsroot.txt",
 
62
  available in the "linux-doc-*" package.
 
63
  
 
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".
 
73
 
49
74
* User-Supplied Plugins
50
75
  
51
76
  Any plugins found in "/etc/mandos/plugins.d" will override and add
52
77
  to the normal Mandos plugins.  When adding or changing plugins, do
53
 
  not forget to update the initital RAM disk image:
 
78
  not forget to update the initial RAM disk image:
54
79
  
 
80
        (For initramfs-tools:)
55
81
        update-initramfs -k all -u
 
82
        
 
83
        (For dracut:)
 
84
        dpkg-reconfigure dracut
56
85
 
57
86
* Do *NOT* Edit "/etc/crypttab"
58
87
  
62
91
  Mandos client will be the new default way for getting a password for
63
92
  the root file system when booting.
64
93
 
65
 
* Emergency Escape
66
 
  
67
 
  If it ever should be necessary, the Mandos client can be temporarily
68
 
  prevented from running at startup by passing the parameter
69
 
  "mandos=off" to the kernel.
70
 
 
71
94
* Non-local Connection (Not Using ZeroConf)
72
95
  
73
96
  If the "ip=" kernel command line option is used to specify a
74
97
  complete IP address and device name, as noted above, it then becomes
75
98
  possible to specify a specific IP address and port to connect to,
76
99
  instead of using ZeroConf.  The syntax for doing this is
77
 
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>".
 
100
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
 
101
  line.
78
102
  
79
 
  For very advanced users, it it possible to specify simply
80
 
  "mandos=connect" on the kernel command line to make the system only
81
 
  set up the network (using the data in the "ip=" option) and not pass
82
 
  any extra "--connect" options to mandos-client at boot.  For this to
83
 
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
84
 
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
85
 
 
86
 
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Mon, 27 Sep 2010 19:53:21 +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