/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: 2015-07-01 20:01:26 UTC
  • mto: This revision was merged to the branch mainline in revision 759.
  • Revision ID: teddy@recompile.se-20150701200126-qb3f6c3jcas2f4og
mandos-client: Try to start a plugin to add and remove a local route.

* debian/mandos-client.README.Debian: Add setting of environment
                                      variable MANDOSPLUGINHELPERDIR
                                      to command line testing
                                      mandos-client.
* mandos-client.c (raise_privileges): Moved to top of file.
                  (raise_privileges_permanently): - '' -
                  (lower_privileges): - '' -
                  (lower_privileges_permanently): - '' -
  (add_remove_local_route, add_local_route, remove_local_route): New.
  (start_mandos_communication): Set SOCK_CLOEXEC flag on socket.  Run
                                the above functions to add (and
                                remove) local route, if the conditions
                                indicates it could help.
  (run_network_hooks): Use O_DIRECTORY, O_PATH, and O_CLOEXEC flags
                       when opening network hook directory. Do
                       TEMP_FAILURE_RETRY around opening of /dev/null
                       and network hook executables.  Move redirecting
                       of stdout and stderr to as late as possible
                       before fexecve().
  (main): Use O_DIRECTORY and O_PATH when opening temporary directory.
* plugins.d/mandos-client.xml (ENVIRONMENT): Document usage of the
                                             MANDOSPLUGINHELPERDIR
                                             environment variable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/mandos-client.README.Debian
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
 
Also, if some other network interface than "eth0" is used, it will be
7
 
necessary to edit /etc/mandos/plugin-runner.conf to uncomment and
8
 
change the line there.  If this file is changed, it will be necessary
9
 
to update the initrd image by doing "update-initramfs -k all -u".
10
 
 
11
 
Any plugins found in /etc/mandos/plugins.d will override and add to
12
 
the normal Mandos plugins.  When adding or changing plugins, do not
13
 
forget to update the initital RAM disk image:
14
 
 
15
 
# update-initramfs -k all -u
16
 
 
17
 
It is NOT necessary to edit /etc/crypttab to specify
18
 
/usr/lib/mandos/plugin-runner as a keyscript for the root file system;
19
 
if no keyscript is given for the root file system, the Mandos client
20
 
will be the new default way for getting a password for the root file
21
 
system when booting.
22
 
 
23
 
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Fri, 19 Sep 2008 22:50:16 +0200
 
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
 
17
  this client by running the command, on the client:
 
18
  
 
19
        MANDOSPLUGINHELPERDIR=/usr/lib/$(dpkg-architecture \
 
20
        -qDEB_HOST_MULTIARCH)/mandos/plugin-helpers \
 
21
        /usr/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH \
 
22
        )/mandos/plugins.d/mandos-client \
 
23
                --pubkey=/etc/keys/mandos/pubkey.txt \
 
24
                --seckey=/etc/keys/mandos/seckey.txt; echo
 
25
  
 
26
  This command should retrieve the password from the server, decrypt
 
27
  it, and output it to standard output.  There it can be verified to
 
28
  be the correct password, before rebooting.
 
29
 
 
30
* Emergency Escape
 
31
  
 
32
  If it ever should be necessary, the Mandos client can be temporarily
 
33
  prevented from running at startup by passing the parameter
 
34
  "mandos=off" to the kernel.
 
35
 
 
36
* Specifying a Client Network Interface
 
37
  
 
38
  At boot time the network interfaces to use will by default be
 
39
  automatically detected.  If this should result in incorrect
 
40
  interfaces, edit the DEVICE setting in the
 
41
  "/etc/initramfs-tools/initramfs.conf" file.  (The default setting is
 
42
  empty, meaning it will autodetect the interface.)  *If* the DEVICE
 
43
  setting is changed, it will be necessary to update the initrd image
 
44
  by running the command
 
45
  
 
46
        update-initramfs -k all -u
 
47
  
 
48
  The device can also be overridden at boot time on the Linux kernel
 
49
  command line using the sixth colon-separated field of the "ip="
 
50
  option; for exact syntax, read the documentation in the file
 
51
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfs/nfsroot.txt",
 
52
  available in the "linux-doc-*" package.
 
53
  
 
54
  Note that since the network interfaces are used in the initial RAM
 
55
  disk environment, the network interfaces *must* exist at that stage.
 
56
  Thus, an interface can *not* be a pseudo-interface such as "br0" or
 
57
  "tun0"; instead, only real interfaces (such as "eth0") can be used.
 
58
  This can be overcome by writing a "network hook" program to create
 
59
  an interface (see mandos-client(8mandos)) and placing it in
 
60
  "/etc/mandos/network-hooks.d", from where it will be copied into the
 
61
  initial RAM disk.  Example network hook scripts can be found in
 
62
  "/usr/share/doc/mandos-client/examples/network-hooks.d".
 
63
 
 
64
* User-Supplied Plugins
 
65
  
 
66
  Any plugins found in "/etc/mandos/plugins.d" will override and add
 
67
  to the normal Mandos plugins.  When adding or changing plugins, do
 
68
  not forget to update the initital RAM disk image:
 
69
  
 
70
        update-initramfs -k all -u
 
71
 
 
72
* Do *NOT* Edit "/etc/crypttab"
 
73
  
 
74
  It is NOT necessary to edit "/etc/crypttab" to specify
 
75
  "/usr/lib/mandos/plugin-runner" as a keyscript for the root file
 
76
  system; if no keyscript is given for the root file system, the
 
77
  Mandos client will be the new default way for getting a password for
 
78
  the root file system when booting.
 
79
 
 
80
* Non-local Connection (Not Using ZeroConf)
 
81
  
 
82
  If the "ip=" kernel command line option is used to specify a
 
83
  complete IP address and device name, as noted above, it then becomes
 
84
  possible to specify a specific IP address and port to connect to,
 
85
  instead of using ZeroConf.  The syntax for doing this is
 
86
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
 
87
  line.
 
88
  
 
89
  For very advanced users, it it possible to specify simply
 
90
  "mandos=connect" on the kernel command line to make the system only
 
91
  set up the network (using the data in the "ip=" option) and not pass
 
92
  any extra "--connect" options to mandos-client at boot.  For this to
 
93
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
 
94
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
 
95
 
 
96
 -- Teddy Hogeborn <teddy@recompile.se>, Mon, 29 Jun 2015 18:17:41 +0200