/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: 2019-09-01 07:07:15 UTC
  • Revision ID: teddy@recompile.se-20190901070715-wxmzxxlpx70vewto
Address Python 3 bytes/str warnings

* mandos-monitor (UserInterface.run): Ignore BytesWarning from urwid;
                                      work around Debian bug #939084.

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
  
67
77
  to the normal Mandos plugins.  When adding or changing plugins, do
68
78
  not forget to update the initital 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
 
103
  For very advanced users, it is possible to specify simply
90
104
  "mandos=connect" on the kernel command line to make the system only
91
105
  set up the network (using the data in the "ip=" option) and not pass
92
106
  any extra "--connect" options to mandos-client at boot.  For this to
93
107
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
94
108
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
95
109
 
96
 
 -- Teddy Hogeborn <teddy@recompile.se>, Mon, 29 Jun 2015 18:17:41 +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