/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-08-24 15:33:58 UTC
  • Revision ID: teddy@recompile.se-20190824153358-o69zprg8yiub1t0d
mandos-monitor: Use new GLib.io_add_watch() call signature

* mandos-monitor: When calling GLib.io_add_watch(), always pass a
                  channel as the first argument instead of a file
                  descriptor, and pass priority as the second
                  argument.  This is supported by PyGObject 3.8 or
                  later.

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