/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: 2009-11-11 00:25:22 UTC
  • Revision ID: teddy@fukt.bsnet.se-20091111002522-t416fifqw46xaqn4
* debian/rules: Only set BROKEN_PIE if binutils is a specific range of
                versions.
* mandos-monitor (MandosClientWidget.keypress): Also accept "Ctrl-K"
                                                for removing client.
  (UserInterface.__init__): Use non-bold line drawing charater.
  (UserInterface.log_message): Scroll to bottom.
  (UserInterface.process_input): Also show help on "ESC" key.

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.
 
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.
4
20
 
5
21
* Adding a Client Password to the Server
6
22
  
20
36
  is possible to verify that the correct password will be received by
21
37
  this client by running the command, on the client:
22
38
  
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 \
 
39
        /usr/lib/mandos/plugins.d/mandos-client \
27
40
                --pubkey=/etc/keys/mandos/pubkey.txt \
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
 
41
                --seckey=/etc/keys/mandos/seckey.txt; echo
31
42
  
32
43
  This command should retrieve the password from the server, decrypt
33
44
  it, and output it to standard output.  There it can be verified to
34
45
  be the correct password, before rebooting.
35
46
 
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
 
 
74
47
* User-Supplied Plugins
75
48
  
76
49
  Any plugins found in "/etc/mandos/plugins.d" will override and add
77
50
  to the normal Mandos plugins.  When adding or changing plugins, do
78
51
  not forget to update the initital RAM disk image:
79
52
  
80
 
        (For initramfs-tools:)
81
53
        update-initramfs -k all -u
82
 
        
83
 
        (For dracut:)
84
 
        dpkg-reconfigure dracut
85
54
 
86
55
* Do *NOT* Edit "/etc/crypttab"
87
56
  
91
60
  Mandos client will be the new default way for getting a password for
92
61
  the root file system when booting.
93
62
 
 
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
 
94
69
* Non-local Connection (Not Using ZeroConf)
95
70
  
96
71
  If the "ip=" kernel command line option is used to specify a
97
72
  complete IP address and device name, as noted above, it then becomes
98
73
  possible to specify a specific IP address and port to connect to,
99
74
  instead of using ZeroConf.  The syntax for doing this is
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
 
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
104
81
  "mandos=connect" on the kernel command line to make the system only
105
82
  set up the network (using the data in the "ip=" option) and not pass
106
83
  any extra "--connect" options to mandos-client at boot.  For this to
107
84
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
108
85
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
109
86
 
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
 
87
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Tue,  8 Sep 2009 08:25:58 +0200