/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: 2015-07-08 21:18:49 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150708211849-scisutuofnxumqc7
mandos-client: Add --dh-params FILE option.

* plugins.d/mandos-client.c: Added --dh-params FILE option.
  (init_gnutls_global): New "dhparamsfilename" argument.  All callers
                        changed.  Read and use Diffie-Hellman
                        parameters from it.  Bug fix:  check for error
                        when opening seckeyfile for the second time.
  (init_gnutls_session): Remove unnecessary call to
                         gnutls_dh_set_prime_bits();
  (main): New variable "dh_params_file".
  (main/argp_options): Added "--dh-params" option.
  (main/parse_opt): - '' -
* plugins.d/mandos-client.xml (SYNOPSIS): Add --dh-params option.
  (OPTIONS): Document --dh-params option and document that the
             --dh-bits options is potentially overridden by the
             --dh-params option.

Show diffs side-by-side

added added

removed removed

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