/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: 2019-03-07 21:38:47 UTC
  • Revision ID: teddy@recompile.se-20190307213847-9ans204sp9s3ki1s
mandos-ctl.xml: Move most normal command to top of synopsis

* mandos-ctl.xml (SYNOPSIS): Move --verbose | --dump-json to top.

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