/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: 2011-07-25 18:52:11 UTC
  • mfrom: (237.7.37 trunk)
  • Revision ID: teddy@fukt.bsnet.se-20110725185211-wlitr9jvs70e1xh8
MergeĀ fromĀ trunk.

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
* Choose the Client Network Interface
 
2
  
 
3
  Please make sure that the correct network interface is specified in
 
4
  the DEVICE setting in the "/etc/initramfs-tools/initramfs.conf"
 
5
  file.  If the setting is empty, the interface will be autodetected
 
6
  at boot time, which may not be correct.  *If* the DEVICE setting is
 
7
  changed, it will be necessary to update the initrd image by running
 
8
  the command
 
9
  
 
10
        update-initramfs -k all -u
 
11
  
 
12
  The device can be overridden at boot time on the Linux kernel
 
13
  command line using the sixth colon-separated field of the "ip="
 
14
  option; for exact syntax, read the documentation in the file
 
15
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfsroot.txt",
 
16
  available in the "linux-doc-*" package.
 
17
  
 
18
  Note that since this network interface is used in the initial RAM
 
19
  disk environment, the network interface *must* exist at that stage.
 
20
  Thus, the interface can *not* be a pseudo-interface such as "br0" or
 
21
  "tun0"; instead, a real interface (such as "eth0") must be used.
 
22
 
 
23
* Adding a Client Password to the Server
 
24
  
 
25
  The server must be given a password to give back to the client on
 
26
  boot time.  This password must be a one which can be used to unlock
 
27
  the root file system device.  On the *client*, run this command:
 
28
  
 
29
        mandos-keygen --password
 
30
  
 
31
  It will prompt for a password and output a config file section.
 
32
  This output should be copied to the Mandos server and added to the
 
33
  file "/etc/mandos/clients.conf" there.
 
34
 
 
35
* Testing that it Works (Without Rebooting)
 
36
  
 
37
  After the server has been started with this client's key added, it
 
38
  is possible to verify that the correct password will be received by
22
39
  this client by running the command, on the client:
23
40
  
24
 
        # /usr/lib/mandos/plugins.d/mandos-client \
 
41
        /usr/lib/mandos/plugins.d/mandos-client \
25
42
                --pubkey=/etc/keys/mandos/pubkey.txt \
26
43
                --seckey=/etc/keys/mandos/seckey.txt; echo
27
44
  
31
48
 
32
49
* User-Supplied Plugins
33
50
  
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:
 
51
  Any plugins found in "/etc/mandos/plugins.d" will override and add
 
52
  to the normal Mandos plugins.  When adding or changing plugins, do
 
53
  not forget to update the initital RAM disk image:
37
54
  
38
 
        # update-initramfs -k all -u
 
55
        update-initramfs -k all -u
39
56
 
40
 
* Do *NOT* Edit /etc/crypttab
 
57
* Do *NOT* Edit "/etc/crypttab"
41
58
  
42
 
  It is NOT necessary to edit /etc/crypttab to specify
43
 
  /usr/lib/mandos/plugin-runner as a keyscript for the root file
 
59
  It is NOT necessary to edit "/etc/crypttab" to specify
 
60
  "/usr/lib/mandos/plugin-runner" as a keyscript for the root file
44
61
  system; if no keyscript is given for the root file system, the
45
62
  Mandos client will be the new default way for getting a password for
46
63
  the root file system when booting.
59
76
  instead of using ZeroConf.  The syntax for doing this is
60
77
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>".
61
78
  
62
 
  Warning: this will cause the client to make exactly one attempt at
63
 
  connecting, and then fail if it does not succeed.
64
 
  
65
79
  For very advanced users, it it possible to specify simply
66
80
  "mandos=connect" on the kernel command line to make the system only
67
81
  set up the network (using the data in the "ip=" option) and not pass
69
83
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
70
84
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
71
85
 
72
 
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Mon,  9 Feb 2009 00:36:55 +0100
 
86
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Mon, 27 Sep 2010 19:53:21 +0200