/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-08 02:08:04 UTC
  • Revision ID: teddy@recompile.se-20240908020804-cwv3omisabchontu
Remove obsolete "gnupg2" dependency (Debian bug #1055402)

* debian/control (Package: mandos/Depends): Remove "gnupg2 |".

Closes: #1055402
Reported-By: Andreas Metzler <ametzler@bebt.de>

Show diffs side-by-side

added added

removed removed

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