/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: 2016-08-25 17:37:05 UTC
  • Revision ID: teddy@recompile.se-20160825173705-q2v6lban8ph9uw75
PEP8 compliance: mandos

* mandos: Add PEP8 compliance (as per the "pycodestyle" tool).

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
28
                --seckey=/etc/keys/mandos/seckey.txt; echo
22
29
  
32
39
 
33
40
* Specifying a Client Network Interface
34
41
  
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
 
42
  At boot time the network interfaces to use will by default be
 
43
  automatically detected.  If this should result in incorrect
 
44
  interfaces, edit the DEVICE setting in the
38
45
  "/etc/initramfs-tools/initramfs.conf" file.  (The default setting is
39
 
  empty, meaning it will autodetect the interface.)  *If* the DEVICE
 
46
  empty, meaning it will autodetect the interfaces.)  *If* the DEVICE
40
47
  setting is changed, it will be necessary to update the initrd image
41
 
  by running the command
 
48
  by running this command:
42
49
  
43
50
        update-initramfs -k all -u
44
51
  
45
 
  The device can be overridden at boot time on the Linux kernel
 
52
  The device can also be overridden at boot time on the Linux kernel
46
53
  command line using the sixth colon-separated field of the "ip="
47
54
  option; for exact syntax, read the documentation in the file
48
 
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfsroot.txt",
 
55
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfs/nfsroot.txt",
49
56
  available in the "linux-doc-*" package.
50
57
  
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.
 
58
  Note that since the network interfaces are used in the initial RAM
 
59
  disk environment, the network interfaces *must* exist at that stage.
 
60
  Thus, an interface can *not* be a pseudo-interface such as "br0" or
 
61
  "tun0"; instead, only real interfaces (such as "eth0") can be used.
55
62
  This can be overcome by writing a "network hook" program to create
56
 
  the interface (see mandos-client(8mandos)) and placing it in
 
63
  an interface (see mandos-client(8mandos)) and placing it in
57
64
  "/etc/mandos/network-hooks.d", from where it will be copied into the
58
65
  initial RAM disk.  Example network hook scripts can be found in
59
 
  "/usr/share/doc/mandos-client/network-hooks.d".
 
66
  "/usr/share/doc/mandos-client/examples/network-hooks.d".
60
67
 
61
68
* User-Supplied Plugins
62
69
  
83
90
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
84
91
  line.
85
92
  
86
 
  For very advanced users, it it possible to specify simply
 
93
  For very advanced users, it is possible to specify simply
87
94
  "mandos=connect" on the kernel command line to make the system only
88
95
  set up the network (using the data in the "ip=" option) and not pass
89
96
  any extra "--connect" options to mandos-client at boot.  For this to
90
97
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
91
98
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
92
99
 
93
 
 -- Teddy Hogeborn <teddy@recompile.se>, Mon, 28 Nov 2011 23:07:22 +0100
 
100
* Diffie-Hellman Parameters
 
101
 
 
102
  On installation, a file with Diffie-Hellman parameters,
 
103
  /etc/keys/mandos/dhparams.pem, will be generated and automatically
 
104
  installed into the initital RAM disk image and also used by the
 
105
  Mandos Client on boot.  If different parameters are needed for
 
106
  policy or other reasons, simply replace the existing dhparams.pem
 
107
  file and update the initital RAM disk image.
 
108
 
 
109
 -- Teddy Hogeborn <teddy@recompile.se>, Tue, 21 Jun 2016 21:43:49 +0200