/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: 2022-04-24 16:54:30 UTC
  • mto: This revision was merged to the branch mainline in revision 406.
  • Revision ID: teddy@recompile.se-20220424165430-m687snug7o7vz4ok
Update copyright year

* debian/copyright: Update copyright year to 2022.
* dracut-module/password-agent.c: - '' -
* dracut-module/password-agent.xml: Revert copyright year to 2020.
* intro.xml: - '' -
* mandos: Update copyright year to 2022.
* mandos-ctl: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/usplash.c: - '' -

Show diffs side-by-side

added added

removed removed

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