/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: 2008-08-18 05:24:20 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818052420-ab5eurrioz8n2qy6
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".

* mandos-keygen Bug fix: make the --expire option modify
                KEYEXPIRE, not KEYCOMMENT.  Use the "--no-options"
                option to gpg when exporting keys from the temporary
                key ring files.

* mandos-keygen.xml (EXIT STATUS): Filled in.
  (ENVIRONMENT): New section, documenting use of TMPDIR.
  (FILES): Document use of key files and /tmp.
  (BUGS): Filled in.
  (EXAMPLE): Added two examples.
  (SECURITY): Added some text.

* plugins.d/password-prompt.xml (NOTES): Removed, since this is
                                         created automatically for
                                         footnotes.
  (ENVIRONMENT, FILES): Added empty sections.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

* plugins.d/password-request.xml: Reordered sections.
  (ENVIRONMENT): New empty section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

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
 
* 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
22
 
  this client by running the command, on the client:
23
 
  
24
 
        # /usr/lib/mandos/plugins.d/mandos-client \
25
 
                --pubkey=/etc/keys/mandos/pubkey.txt \
26
 
                --seckey=/etc/keys/mandos/seckey.txt; echo
27
 
  
28
 
  This command should retrieve the password from the server, decrypt
29
 
  it, and output it to standard output.  There it can be verified to
30
 
  be the correct password, before rebooting.
31
 
 
32
 
* User-Supplied Plugins
33
 
  
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:
37
 
  
38
 
        # update-initramfs -k all -u
39
 
 
40
 
* Do *NOT* Edit /etc/crypttab
41
 
  
42
 
  It is NOT necessary to edit /etc/crypttab to specify
43
 
  /usr/lib/mandos/plugin-runner as a keyscript for the root file
44
 
  system; if no keyscript is given for the root file system, the
45
 
  Mandos client will be the new default way for getting a password for
46
 
  the root file system when booting.
47
 
 
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
 
* Non-local Connection (Not Using ZeroConf)
55
 
  
56
 
  If the "ip=" kernel command line option is used to specify a
57
 
  complete IP address and device name, as noted above, it then becomes
58
 
  possible to specify a specific IP address and port to connect to,
59
 
  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.
64
 
  
65
 
  For very advanced users, it it possible to specify simply
66
 
  "mandos=connect" on the kernel command line to make the system only
67
 
  set up the network (using the data in the "ip=" option) and not pass
68
 
  any extra "--connect" options to mandos-client at boot.  For this to
69
 
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
70
 
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
71
 
 
72
 
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Mon,  9 Feb 2009 00:36:55 +0100