/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to debian/mandos-client.README.Debian

  • Committer: Teddy Hogeborn
  • Date: 2016-02-21 12:55:39 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 331.
  • Revision ID: teddy@recompile.se-20160221125539-wi1n8ci0ldbdxrar
plugins.d/mandos-client.c (get_flags): Use strncpy(), not strcpy().

* plugins.d/mandos-client.c (get_flags): Use strncpy() instead of
  strcpy().  Note that as the code works currently, this is never a
  problem in practice, since only interface names which were valid
  existing interface names (and therefore had names with lengths below
  IF_NAMESIZE) is ever passed to the get_flags() function.  But it
  doesn't hurt to check, anyway.

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/mandos-client.README.Debian
1
 
* Configure The Server
2
 
  
3
 
  A client key has been automatically created in /etc/keys/mandos.
4
 
  The next step is to run "mandos-keygen --password" to get a config
5
 
  file section.  This should be appended to /etc/mandos/clients.conf
6
 
  on the Mandos server.
7
 
 
8
 
* Use the Correct Network Interface
9
 
  
10
 
  Make sure that the correct network interface is specified in the
11
 
  DEVICE setting in the "/etc/initramfs-tools/initramfs.conf" file.
12
 
  If this is changed, it will be necessary to update the initrd image
13
 
  by doing "update-initramfs -k all -u".  This setting can be
14
 
  overridden at boot time on the Linux kernel command line using the
15
 
  sixth colon-separated field of the "ip=" option; for exact syntax,
16
 
  see the file "Documentation/nfsroot.txt" in the Linux source tree.
17
 
  
18
 
  Note that since this is used in the initial RAM disk environment,
19
 
  the network interface must exist at that stage.  Thus, the interface
20
 
  can *not* be a pseudo-interface such as "br0" or "tun0"; instead, a
21
 
  real interface (such as "eth0") must be used.
22
 
 
23
 
* Test the Server
24
 
  
25
 
  After the server has been started and this client's key added, it is
26
 
  possible to verify that the correct password will be received by
 
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
 
 
5
* Adding a Client Password to the Server
 
6
  
 
7
  The server must be given a password to give back to the client on
 
8
  boot time.  This password must be a one which can be used to unlock
 
9
  the root file system device.  On the *client*, run this command:
 
10
  
 
11
        mandos-keygen --password
 
12
  
 
13
  It will prompt for a password and output a config file section.
 
14
  This output should be copied to the Mandos server and added to the
 
15
  file "/etc/mandos/clients.conf" there.
 
16
 
 
17
* Testing that it Works (Without Rebooting)
 
18
  
 
19
  After the server has been started with this client's key added, it
 
20
  is possible to verify that the correct password will be received by
27
21
  this client by running the command, on the client:
28
22
  
29
 
        # /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 \
30
27
                --pubkey=/etc/keys/mandos/pubkey.txt \
31
28
                --seckey=/etc/keys/mandos/seckey.txt; echo
32
29
  
34
31
  it, and output it to standard output.  There it can be verified to
35
32
  be the correct password, before rebooting.
36
33
 
 
34
* Emergency Escape
 
35
  
 
36
  If it ever should be necessary, the Mandos client can be temporarily
 
37
  prevented from running at startup by passing the parameter
 
38
  "mandos=off" to the kernel.
 
39
 
 
40
* Specifying a Client Network Interface
 
41
  
 
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
 
45
  "/etc/initramfs-tools/initramfs.conf" file.  (The default setting is
 
46
  empty, meaning it will autodetect the interface.)  *If* the DEVICE
 
47
  setting is changed, it will be necessary to update the initrd image
 
48
  by running the command
 
49
  
 
50
        update-initramfs -k all -u
 
51
  
 
52
  The device can also be overridden at boot time on the Linux kernel
 
53
  command line using the sixth colon-separated field of the "ip="
 
54
  option; for exact syntax, read the documentation in the file
 
55
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfs/nfsroot.txt",
 
56
  available in the "linux-doc-*" package.
 
57
  
 
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.
 
62
  This can be overcome by writing a "network hook" program to create
 
63
  an interface (see mandos-client(8mandos)) and placing it in
 
64
  "/etc/mandos/network-hooks.d", from where it will be copied into the
 
65
  initial RAM disk.  Example network hook scripts can be found in
 
66
  "/usr/share/doc/mandos-client/examples/network-hooks.d".
 
67
 
37
68
* User-Supplied Plugins
38
69
  
39
 
  Any plugins found in /etc/mandos/plugins.d will override and add to
40
 
  the normal Mandos plugins.  When adding or changing plugins, do not
41
 
  forget to update the initital RAM disk image:
 
70
  Any plugins found in "/etc/mandos/plugins.d" will override and add
 
71
  to the normal Mandos plugins.  When adding or changing plugins, do
 
72
  not forget to update the initital RAM disk image:
42
73
  
43
 
        # update-initramfs -k all -u
 
74
        update-initramfs -k all -u
44
75
 
45
 
* Do *NOT* Edit /etc/crypttab
 
76
* Do *NOT* Edit "/etc/crypttab"
46
77
  
47
 
  It is NOT necessary to edit /etc/crypttab to specify
48
 
  /usr/lib/mandos/plugin-runner as a keyscript for the root file
 
78
  It is NOT necessary to edit "/etc/crypttab" to specify
 
79
  "/usr/lib/mandos/plugin-runner" as a keyscript for the root file
49
80
  system; if no keyscript is given for the root file system, the
50
81
  Mandos client will be the new default way for getting a password for
51
82
  the root file system when booting.
52
83
 
53
 
* Emergency Escape
54
 
  
55
 
  If it ever should be necessary, the Mandos client can be temporarily
56
 
  prevented from running at startup by passing the parameter
57
 
  "mandos=off" to the kernel.
58
 
 
59
84
* Non-local Connection (Not Using ZeroConf)
60
85
  
61
86
  If the "ip=" kernel command line option is used to specify a
62
87
  complete IP address and device name, as noted above, it then becomes
63
88
  possible to specify a specific IP address and port to connect to,
64
89
  instead of using ZeroConf.  The syntax for doing this is
65
 
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>".
66
 
  
67
 
  Warning: this will cause the client to make exactly one attempt at
68
 
  connecting, and then fail if it does not succeed.
 
90
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
 
91
  line.
69
92
  
70
93
  For very advanced users, it it possible to specify simply
71
94
  "mandos=connect" on the kernel command line to make the system only
74
97
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
75
98
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
76
99
 
77
 
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Tue, 14 Apr 2009 16:51:18 +0200
 
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>, Sun, 12 Jul 2015 03:24:24 +0200