/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: 2014-10-05 19:39:25 UTC
  • mto: (237.7.304 trunk)
  • mto: This revision was merged to the branch mainline in revision 323.
  • Revision ID: teddy@recompile.se-20141005193925-jjqx2n2dt3icy28u
* mandos.service ([Unit]/Documentation): New.

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
 
 
23
1
* Adding a Client Password to the Server
24
2
  
25
3
  The server must be given a password to give back to the client on
38
16
  is possible to verify that the correct password will be received by
39
17
  this client by running the command, on the client:
40
18
  
41
 
        /usr/lib/mandos/plugins.d/mandos-client \
 
19
        /usr/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH \
 
20
        )/mandos/plugins.d/mandos-client \
42
21
                --pubkey=/etc/keys/mandos/pubkey.txt \
43
22
                --seckey=/etc/keys/mandos/seckey.txt; echo
44
23
  
46
25
  it, and output it to standard output.  There it can be verified to
47
26
  be the correct password, before rebooting.
48
27
 
 
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
 
49
62
* User-Supplied Plugins
50
63
  
51
64
  Any plugins found in "/etc/mandos/plugins.d" will override and add
62
75
  Mandos client will be the new default way for getting a password for
63
76
  the root file system when booting.
64
77
 
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
 
 
71
78
* Non-local Connection (Not Using ZeroConf)
72
79
  
73
80
  If the "ip=" kernel command line option is used to specify a
74
81
  complete IP address and device name, as noted above, it then becomes
75
82
  possible to specify a specific IP address and port to connect to,
76
83
  instead of using ZeroConf.  The syntax for doing this is
77
 
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>".
 
84
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
 
85
  line.
78
86
  
79
87
  For very advanced users, it it possible to specify simply
80
88
  "mandos=connect" on the kernel command line to make the system only
83
91
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
84
92
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
85
93
 
86
 
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Mon, 27 Sep 2010 19:53:21 +0200
 
94
 -- Teddy Hogeborn <teddy@recompile.se>, Mon, 28 Oct 2013 11:02:26 +0100