/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: 2011-07-16 00:29:19 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110716002919-r77yikuiulj42o40
* initramfs-tools-script: Abort if plugin-runner is missing.  Removed
                          workaround for Debian bug #633582; the
                          workaround required getopt, which can not be
                          guaranteed.
* plugin-runner.c (main): Work around Debian bug #633582.
* plugins.d/mandos-client.c (main): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
* Choose the Client Network Interface
 
2
  
 
3
  Please make sure that the correct network interface is specified in
 
4
  the DEVICE setting in the "/etc/initramfs-tools/initramfs.conf"
 
5
  file.  If the setting is empty, the interface will be autodetected
 
6
  at boot time, which may not be correct.  *If* the DEVICE setting is
 
7
  changed, it will be necessary to update the initrd image by running
 
8
  the command
 
9
  
 
10
        update-initramfs -k all -u
 
11
  
 
12
  The device can be overridden at boot time on the Linux kernel
 
13
  command line using the sixth colon-separated field of the "ip="
 
14
  option; for exact syntax, read the documentation in the file
 
15
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfsroot.txt",
 
16
  available in the "linux-doc-*" package.
 
17
  
 
18
  Note that since this network interface is used in the initial RAM
 
19
  disk environment, the network interface *must* exist at that stage.
 
20
  Thus, the interface can *not* be a pseudo-interface such as "br0" or
 
21
  "tun0"; instead, a real interface (such as "eth0") must be used.
 
22
 
1
23
* Adding a Client Password to the Server
2
24
  
3
25
  The server must be given a password to give back to the client on
16
38
  is possible to verify that the correct password will be received by
17
39
  this client by running the command, on the client:
18
40
  
19
 
        /usr/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH \
20
 
        )/mandos/plugins.d/mandos-client \
 
41
        /usr/lib/mandos/plugins.d/mandos-client \
21
42
                --pubkey=/etc/keys/mandos/pubkey.txt \
22
43
                --seckey=/etc/keys/mandos/seckey.txt; echo
23
44
  
25
46
  it, and output it to standard output.  There it can be verified to
26
47
  be the correct password, before rebooting.
27
48
 
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
 
  
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
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
43
 
  
44
 
        update-initramfs -k all -u
45
 
  
46
 
  The device can also be overridden at boot time on the Linux kernel
47
 
  command line using the sixth colon-separated field of the "ip="
48
 
  option; for exact syntax, read the documentation in the file
49
 
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfs/nfsroot.txt",
50
 
  available in the "linux-doc-*" package.
51
 
  
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.
56
 
  This can be overcome by writing a "network hook" program to create
57
 
  an interface (see mandos-client(8mandos)) and placing it in
58
 
  "/etc/mandos/network-hooks.d", from where it will be copied into the
59
 
  initial RAM disk.  Example network hook scripts can be found in
60
 
  "/usr/share/doc/mandos-client/examples/network-hooks.d".
61
 
 
62
49
* User-Supplied Plugins
63
50
  
64
51
  Any plugins found in "/etc/mandos/plugins.d" will override and add
75
62
  Mandos client will be the new default way for getting a password for
76
63
  the root file system when booting.
77
64
 
 
65
* Emergency Escape
 
66
  
 
67
  If it ever should be necessary, the Mandos client can be temporarily
 
68
  prevented from running at startup by passing the parameter
 
69
  "mandos=off" to the kernel.
 
70
 
78
71
* Non-local Connection (Not Using ZeroConf)
79
72
  
80
73
  If the "ip=" kernel command line option is used to specify a
81
74
  complete IP address and device name, as noted above, it then becomes
82
75
  possible to specify a specific IP address and port to connect to,
83
76
  instead of using ZeroConf.  The syntax for doing this is
84
 
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
85
 
  line.
 
77
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>".
86
78
  
87
79
  For very advanced users, it it possible to specify simply
88
80
  "mandos=connect" on the kernel command line to make the system only
91
83
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
92
84
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
93
85
 
94
 
 -- Teddy Hogeborn <teddy@recompile.se>, Mon, 28 Oct 2013 11:02:26 +0100
 
86
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Mon, 27 Sep 2010 19:53:21 +0200