/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

Rename all D-Bus properties to conform to D-Bus naming conventions;
all programs changed.

Also rename client setting "approved_delay" to "approval_delay", and
"approved_duration" to "approval_duration"; all programs changed.

* mandos (ClientDBus.NeedApproval): Bug fix: send an UInt64, not a
                                    float.
  (ClientDBus.ApprovedByDefault_dbus_property,
  ClientDBus.ApprovalDelay_dbus_property,
  ClientDBus.ApprovalDuration_dbus_property): Bug fix: send
                                              PropertyChanged signal.

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/mandos-client.README.Debian
1
 
This file documents the next steps to take after installation of the
2
 
Debian package, and also contain some notes specific to the Debian
3
 
packaging which are not also in the manual.
 
1
* Choose the Client Network Interface
 
2
  
 
3
  You MUST make sure that the correct network interface is specified
 
4
  in the DEVICE setting in the "/etc/initramfs-tools/initramfs.conf"
 
5
  file.  *If* this is changed, it will be necessary to update the
 
6
  initrd image by running the command
 
7
  
 
8
        update-initramfs -k all -u
 
9
  
 
10
  The device can be overridden at boot time on the Linux kernel
 
11
  command line using the sixth colon-separated field of the "ip="
 
12
  option; for exact syntax, read the documentation in the file
 
13
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfsroot.txt",
 
14
  available in the "linux-doc-*" package.
 
15
  
 
16
  Note that since this network interface is used in the initial RAM
 
17
  disk environment, the network interface *must* exist at that stage.
 
18
  Thus, the interface can *not* be a pseudo-interface such as "br0" or
 
19
  "tun0"; instead, a real interface (such as "eth0") must be used.
4
20
 
5
21
* Adding a Client Password to the Server
6
22
  
20
36
  is possible to verify that the correct password will be received by
21
37
  this client by running the command, on the client:
22
38
  
23
 
        MANDOSPLUGINHELPERDIR=/usr/lib/$(dpkg-architecture \
24
 
        -qDEB_HOST_MULTIARCH)/mandos/plugin-helpers \
25
 
        /usr/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH \
26
 
        )/mandos/plugins.d/mandos-client \
 
39
        /usr/lib/mandos/plugins.d/mandos-client \
27
40
                --pubkey=/etc/keys/mandos/pubkey.txt \
28
41
                --seckey=/etc/keys/mandos/seckey.txt; echo
29
42
  
31
44
  it, and output it to standard output.  There it can be verified to
32
45
  be the correct password, before rebooting.
33
46
 
34
 
* Emergency Escape
35
 
  
36
 
  If it ever should be necessary, the Mandos client can be temporarily
37
 
  prevented from running at startup by passing the parameter
38
 
  "mandos=off" to the kernel.
39
 
 
40
 
* Specifying a Client Network Interface
41
 
  
42
 
  At boot time the network interfaces to use will by default be
43
 
  automatically detected.  If this should result in incorrect
44
 
  interfaces, edit the DEVICE setting in the
45
 
  "/etc/initramfs-tools/initramfs.conf" file.  (The default setting is
46
 
  empty, meaning it will autodetect the interface.)  *If* the DEVICE
47
 
  setting is changed, it will be necessary to update the initrd image
48
 
  by running the command
49
 
  
50
 
        update-initramfs -k all -u
51
 
  
52
 
  The device can also be overridden at boot time on the Linux kernel
53
 
  command line using the sixth colon-separated field of the "ip="
54
 
  option; for exact syntax, read the documentation in the file
55
 
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfs/nfsroot.txt",
56
 
  available in the "linux-doc-*" package.
57
 
  
58
 
  Note that since the network interfaces are used in the initial RAM
59
 
  disk environment, the network interfaces *must* exist at that stage.
60
 
  Thus, an interface can *not* be a pseudo-interface such as "br0" or
61
 
  "tun0"; instead, only real interfaces (such as "eth0") can be used.
62
 
  This can be overcome by writing a "network hook" program to create
63
 
  an interface (see mandos-client(8mandos)) and placing it in
64
 
  "/etc/mandos/network-hooks.d", from where it will be copied into the
65
 
  initial RAM disk.  Example network hook scripts can be found in
66
 
  "/usr/share/doc/mandos-client/examples/network-hooks.d".
67
 
 
68
47
* User-Supplied Plugins
69
48
  
70
49
  Any plugins found in "/etc/mandos/plugins.d" will override and add
81
60
  Mandos client will be the new default way for getting a password for
82
61
  the root file system when booting.
83
62
 
 
63
* Emergency Escape
 
64
  
 
65
  If it ever should be necessary, the Mandos client can be temporarily
 
66
  prevented from running at startup by passing the parameter
 
67
  "mandos=off" to the kernel.
 
68
 
84
69
* Non-local Connection (Not Using ZeroConf)
85
70
  
86
71
  If the "ip=" kernel command line option is used to specify a
87
72
  complete IP address and device name, as noted above, it then becomes
88
73
  possible to specify a specific IP address and port to connect to,
89
74
  instead of using ZeroConf.  The syntax for doing this is
90
 
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
91
 
  line.
 
75
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>".
 
76
  
 
77
  Warning: this will cause the client to make exactly one attempt at
 
78
  connecting, and then fail if it does not succeed.
92
79
  
93
80
  For very advanced users, it it possible to specify simply
94
81
  "mandos=connect" on the kernel command line to make the system only
97
84
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
98
85
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
99
86
 
100
 
* Diffie-Hellman Parameters
101
 
 
102
 
  On installation, a file with Diffie-Hellman parameters,
103
 
  /etc/keys/mandos/dhparams.pem, will be generated and automatically
104
 
  installed into the initital RAM disk image and also used by the
105
 
  Mandos Client on boot.  If different parameters are needed for
106
 
  policy or other reasons, simply replace the existing dhparams.pem
107
 
  file and update the initital RAM disk image.
108
 
 
109
 
 -- Teddy Hogeborn <teddy@recompile.se>, Sun, 12 Jul 2015 03:24:24 +0200
 
87
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Tue,  8 Sep 2009 08:25:58 +0200