/mandos/trunk

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

« back to all changes in this revision

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

  • Committer: Teddy Hogeborn
  • Date: 2008-09-17 00:34:09 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080917003409-bxbjsc4o69nx40t6
* .bzr-builddeb/default.conf: New.

* Makefile (install-server): Do not create directories that
                             should already be present in a
                             normal system.
  (install-client-nokey): - '' -  Also specify non-executable
                          mode for "initramfs-tools-hook-conf".

* README: Improved wording.  Use real copyright mark.

* debian/changelog: New.
* debian/compat: - '' -
* debian/control: - '' -
* debian/copyright: - '' -
* debian/mandos-client.README.Debian: - '' -
* debian/mandos-client.dirs: - '' -
* debian/mandos-client.lintian-overrides: - '' -
* debian/mandos-client.postinst: - '' -
* debian/mandos-client.postrm: - '' -
* debian/mandos.dirs: - '' -
* debian/mandos.lintian-overrides: - '' -
* debian/rules: - '' -
* default-mandos: - '' -

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
27
 
  this client by running the command, on the client:
28
 
  
29
 
        # /usr/lib/mandos/plugins.d/mandos-client \
30
 
                --pubkey=/etc/keys/mandos/pubkey.txt \
31
 
                --seckey=/etc/keys/mandos/seckey.txt; echo
32
 
  
33
 
  This command should retrieve the password from the server, decrypt
34
 
  it, and output it to standard output.  There it can be verified to
35
 
  be the correct password, before rebooting.
36
 
 
37
 
* User-Supplied Plugins
38
 
  
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:
42
 
  
43
 
        # update-initramfs -k all -u
44
 
 
45
 
* Do *NOT* Edit /etc/crypttab
46
 
  
47
 
  It is NOT necessary to edit /etc/crypttab to specify
48
 
  /usr/lib/mandos/plugin-runner as a keyscript for the root file
49
 
  system; if no keyscript is given for the root file system, the
50
 
  Mandos client will be the new default way for getting a password for
51
 
  the root file system when booting.
52
 
 
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
 
* Non-local Connection (Not Using ZeroConf)
60
 
  
61
 
  If the "ip=" kernel command line option is used to specify a
62
 
  complete IP address and device name, as noted above, it then becomes
63
 
  possible to specify a specific IP address and port to connect to,
64
 
  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.
69
 
  
70
 
  For very advanced users, it it possible to specify simply
71
 
  "mandos=connect" on the kernel command line to make the system only
72
 
  set up the network (using the data in the "ip=" option) and not pass
73
 
  any extra "--connect" options to mandos-client at boot.  For this to
74
 
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
75
 
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
76
 
 
77
 
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Tue, 14 Apr 2009 16:51:18 +0200
 
1
A client key has been automatically created in /etc/keys/mandos.  The
 
2
next step is to run "mandos-keygen --password" to get a config file
 
3
stanza to copy and paste into /etc/mandos/clients.conf on the Mandos
 
4
server.
 
5
 
 
6
It is NOT necessary to edit /etc/crypttab to specify
 
7
/usr/lib/mandos/plugin-runner as a keyscript for the root file system;
 
8
if no keyscript is given for the root file system, the Mandos client
 
9
will be the new default way for getting a password for the root file
 
10
system when booting.