/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
237.2.129 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Improved wording and formatting.
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.
20
21
* Adding a Client Password to the Server
22
  
23
  The server must be given a password to give back to the client on
24
  boot time.  This password must be a one which can be used to unlock
25
  the root file system device.  On the *client*, run this command:
26
  
27
	mandos-keygen --password
28
  
29
  It will prompt for a password and output a config file section.
30
  This output should be copied to the Mandos server and added to the
31
  file "/etc/mandos/clients.conf" there.
32
33
* Testing that it Works (Without Rebooting)
34
  
35
  After the server has been started with this client's key added, it
36
  is possible to verify that the correct password will be received by
228 by Teddy Hogeborn
* INSTALL: Add instructions on how to set the correct network
37
  this client by running the command, on the client:
38
  
237.2.129 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Improved wording and formatting.
39
	/usr/lib/mandos/plugins.d/mandos-client \
228 by Teddy Hogeborn
* INSTALL: Add instructions on how to set the correct network
40
		--pubkey=/etc/keys/mandos/pubkey.txt \
41
		--seckey=/etc/keys/mandos/seckey.txt; echo
42
  
43
  This command should retrieve the password from the server, decrypt
237.2.67 by Teddy Hogeborn
Four new interrelated features:
44
  it, and output it to standard output.  There it can be verified to
45
  be the correct password, before rebooting.
228 by Teddy Hogeborn
* INSTALL: Add instructions on how to set the correct network
46
47
* User-Supplied Plugins
237.2.67 by Teddy Hogeborn
Four new interrelated features:
48
  
237.2.129 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Improved wording and formatting.
49
  Any plugins found in "/etc/mandos/plugins.d" will override and add
50
  to the normal Mandos plugins.  When adding or changing plugins, do
51
  not forget to update the initital RAM disk image:
237.2.67 by Teddy Hogeborn
Four new interrelated features:
52
  
237.2.129 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Improved wording and formatting.
53
	update-initramfs -k all -u
228 by Teddy Hogeborn
* INSTALL: Add instructions on how to set the correct network
54
237.2.129 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Improved wording and formatting.
55
* Do *NOT* Edit "/etc/crypttab"
237.2.67 by Teddy Hogeborn
Four new interrelated features:
56
  
237.2.129 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Improved wording and formatting.
57
  It is NOT necessary to edit "/etc/crypttab" to specify
58
  "/usr/lib/mandos/plugin-runner" as a keyscript for the root file
228 by Teddy Hogeborn
* INSTALL: Add instructions on how to set the correct network
59
  system; if no keyscript is given for the root file system, the
60
  Mandos client will be the new default way for getting a password for
61
  the root file system when booting.
62
237.2.32 by Teddy Hogeborn
* debian/watch: New file.
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
237.2.67 by Teddy Hogeborn
Four new interrelated features:
69
* Non-local Connection (Not Using ZeroConf)
70
  
71
  If the "ip=" kernel command line option is used to specify a
72
  complete IP address and device name, as noted above, it then becomes
73
  possible to specify a specific IP address and port to connect to,
74
  instead of using ZeroConf.  The syntax for doing this is
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
81
  "mandos=connect" on the kernel command line to make the system only
82
  set up the network (using the data in the "ip=" option) and not pass
83
  any extra "--connect" options to mandos-client at boot.  For this to
84
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
85
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
86
237.2.129 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Improved wording and formatting.
87
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Tue,  8 Sep 2009 08:25:58 +0200