/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk
366 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Improved wording and formatting.
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
228 by Teddy Hogeborn
* INSTALL: Add instructions on how to set the correct network
17
  this client by running the command, on the client:
18
  
641 by Teddy Hogeborn
Doc fix: Refer to architecture libdir.
19
	/usr/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH \
20
	)/mandos/plugins.d/mandos-client \
228 by Teddy Hogeborn
* INSTALL: Add instructions on how to set the correct network
21
		--pubkey=/etc/keys/mandos/pubkey.txt \
22
		--seckey=/etc/keys/mandos/seckey.txt; echo
23
  
24
  This command should retrieve the password from the server, decrypt
304 by Teddy Hogeborn
Four new interrelated features:
25
  it, and output it to standard output.  There it can be verified to
26
  be the correct password, before rebooting.
228 by Teddy Hogeborn
* INSTALL: Add instructions on how to set the correct network
27
505.1.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
28
* Emergency Escape
29
  
30
  If it ever should be necessary, the Mandos client can be temporarily
31
  prevented from running at startup by passing the parameter
32
  "mandos=off" to the kernel.
33
34
* Specifying a Client Network Interface
35
  
600 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Update documentation for using
36
  At boot time the network interfaces to use will by default be
37
  automatically detected.  If this should result in incorrect
38
  interfaces, edit the DEVICE setting in the
547 by Björn Påhlsson
adding missing words
39
  "/etc/initramfs-tools/initramfs.conf" file.  (The default setting is
40
  empty, meaning it will autodetect the interface.)  *If* the DEVICE
41
  setting is changed, it will be necessary to update the initrd image
42
  by running the command
505.1.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
43
  
44
	update-initramfs -k all -u
45
  
600 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Update documentation for using
46
  The device can also be overridden at boot time on the Linux kernel
505.1.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
47
  command line using the sixth colon-separated field of the "ip="
48
  option; for exact syntax, read the documentation in the file
621 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Update Linux documentation link.
49
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfs/nfsroot.txt",
505.1.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
50
  available in the "linux-doc-*" package.
51
  
600 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Update documentation for using
52
  Note that since the network interfaces are used in the initial RAM
53
  disk environment, the network interfaces *must* exist at that stage.
54
  Thus, an interface can *not* be a pseudo-interface such as "br0" or
55
  "tun0"; instead, only real interfaces (such as "eth0") can be used.
505.3.14 by teddy at bsnet
Hooks take new "modules" argument, and hook names can contain periods.
56
  This can be overcome by writing a "network hook" program to create
600 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Update documentation for using
57
  an interface (see mandos-client(8mandos)) and placing it in
505.3.13 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document network hook facility.
58
  "/etc/mandos/network-hooks.d", from where it will be copied into the
505.3.14 by teddy at bsnet
Hooks take new "modules" argument, and hook names can contain periods.
59
  initial RAM disk.  Example network hook scripts can be found in
594 by Teddy Hogeborn
* debian/copyright (Copyright): Join the two lines to one line.
60
  "/usr/share/doc/mandos-client/examples/network-hooks.d".
505.1.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
61
228 by Teddy Hogeborn
* INSTALL: Add instructions on how to set the correct network
62
* User-Supplied Plugins
304 by Teddy Hogeborn
Four new interrelated features:
63
  
366 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Improved wording and formatting.
64
  Any plugins found in "/etc/mandos/plugins.d" will override and add
65
  to the normal Mandos plugins.  When adding or changing plugins, do
66
  not forget to update the initital RAM disk image:
304 by Teddy Hogeborn
Four new interrelated features:
67
  
366 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Improved wording and formatting.
68
	update-initramfs -k all -u
228 by Teddy Hogeborn
* INSTALL: Add instructions on how to set the correct network
69
366 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Improved wording and formatting.
70
* Do *NOT* Edit "/etc/crypttab"
304 by Teddy Hogeborn
Four new interrelated features:
71
  
366 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Improved wording and formatting.
72
  It is NOT necessary to edit "/etc/crypttab" to specify
73
  "/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
74
  system; if no keyscript is given for the root file system, the
75
  Mandos client will be the new default way for getting a password for
76
  the root file system when booting.
77
304 by Teddy Hogeborn
Four new interrelated features:
78
* Non-local Connection (Not Using ZeroConf)
79
  
80
  If the "ip=" kernel command line option is used to specify a
81
  complete IP address and device name, as noted above, it then becomes
82
  possible to specify a specific IP address and port to connect to,
83
  instead of using ZeroConf.  The syntax for doing this is
505.1.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
84
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
85
  line.
304 by Teddy Hogeborn
Four new interrelated features:
86
  
87
  For very advanced users, it it possible to specify simply
88
  "mandos=connect" on the kernel command line to make the system only
89
  set up the network (using the data in the "ip=" option) and not pass
90
  any extra "--connect" options to mandos-client at boot.  For this to
91
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
92
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
93
641 by Teddy Hogeborn
Doc fix: Refer to architecture libdir.
94
 -- Teddy Hogeborn <teddy@recompile.se>, Mon, 28 Oct 2013 11:02:26 +0100