/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

  • Committer: Teddy Hogeborn
  • Date: 2024-09-08 00:24:32 UTC
  • mto: This revision was merged to the branch mainline in revision 410.
  • Revision ID: teddy@recompile.se-20240908002432-0exnlv1fp73hps8j
Document how to add options to mandos-client when using dracut

* debian/mandos-client.README.Debian: Remove unnecessary word
  "simply".  Also add instructions on how to add the --connect=
  options to mandos-client when using dracut.
* dracut-module/ask-password-mandos.service ([Service]): Add comments
  that this file should *not* be modified, and explicit instructions
  on how to instead add extra options, like --debug, to mandos-client:
  using a systemd override unit file to set an environment variable.

Show diffs side-by-side

added added

removed removed

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