/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: 2012-06-23 13:50:05 UTC
  • Revision ID: teddy@recompile.se-20120623135005-t0wtkmlw0ymnr2kg
* mandos (Client.start_checker): Return True (retry later) if starting
                                 checker failed.  Check for ECHILD
                                 from waitpid().

Show diffs side-by-side

added added

removed removed

Lines of Context:
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.
4
 
 
5
1
* Adding a Client Password to the Server
6
2
  
7
3
  The server must be given a password to give back to the client on
20
16
  is possible to verify that the correct password will be received by
21
17
  this client by running the command, on the client:
22
18
  
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 \
 
19
        /usr/lib/mandos/plugins.d/mandos-client \
27
20
                --pubkey=/etc/keys/mandos/pubkey.txt \
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
 
21
                --seckey=/etc/keys/mandos/seckey.txt; echo
31
22
  
32
23
  This command should retrieve the password from the server, decrypt
33
24
  it, and output it to standard output.  There it can be verified to
45
36
  automatically detected.  If this should result in incorrect
46
37
  interfaces, edit the DEVICE setting in the
47
38
  "/etc/initramfs-tools/initramfs.conf" file.  (The default setting is
48
 
  empty, meaning it will autodetect the interfaces.)  *If* the DEVICE
 
39
  empty, meaning it will autodetect the interface.)  *If* the DEVICE
49
40
  setting is changed, it will be necessary to update the initrd image
50
 
  by running this command:
 
41
  by running the command
51
42
  
52
 
        (For initramfs-tools:)
53
43
        update-initramfs -k all -u
54
 
        
55
 
        (For dracut:)
56
 
        dpkg-reconfigure dracut
57
44
  
58
45
  The device can also be overridden at boot time on the Linux kernel
59
46
  command line using the sixth colon-separated field of the "ip="
60
47
  option; for exact syntax, read the documentation in the file
61
 
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfs/nfsroot.txt",
 
48
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfsroot.txt",
62
49
  available in the "linux-doc-*" package.
63
50
  
64
51
  Note that since the network interfaces are used in the initial RAM
65
52
  disk environment, the network interfaces *must* exist at that stage.
66
53
  Thus, an interface can *not* be a pseudo-interface such as "br0" or
67
 
  "tun0"; instead, only real interfaces (such as "enp1s0" or "eth0")
68
 
  can be used. This can be overcome by writing a "network hook"
69
 
  program to create an interface (see mandos-client(8mandos)) and
70
 
  placing it in "/etc/mandos/network-hooks.d", from where it will be
71
 
  copied into the initial RAM disk.  Example network hook scripts can
72
 
  be found in "/usr/share/doc/mandos-client/examples/network-hooks.d".
 
54
  "tun0"; instead, only real interfaces (such as "eth0") can be used.
 
55
  This can be overcome by writing a "network hook" program to create
 
56
  an interface (see mandos-client(8mandos)) and placing it in
 
57
  "/etc/mandos/network-hooks.d", from where it will be copied into the
 
58
  initial RAM disk.  Example network hook scripts can be found in
 
59
  "/usr/share/doc/mandos-client/examples/network-hooks.d".
73
60
 
74
61
* User-Supplied Plugins
75
62
  
77
64
  to the normal Mandos plugins.  When adding or changing plugins, do
78
65
  not forget to update the initital RAM disk image:
79
66
  
80
 
        (For initramfs-tools:)
81
67
        update-initramfs -k all -u
82
 
        
83
 
        (For dracut:)
84
 
        dpkg-reconfigure dracut
85
68
 
86
69
* Do *NOT* Edit "/etc/crypttab"
87
70
  
100
83
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
101
84
  line.
102
85
  
103
 
  For very advanced users, it is possible to specify simply
 
86
  For very advanced users, it it possible to specify simply
104
87
  "mandos=connect" on the kernel command line to make the system only
105
88
  set up the network (using the data in the "ip=" option) and not pass
106
89
  any extra "--connect" options to mandos-client at boot.  For this to
107
90
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
108
91
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
109
92
 
110
 
* Diffie-Hellman Parameters
111
 
 
112
 
  On installation, a file with Diffie-Hellman parameters,
113
 
  /etc/keys/mandos/dhparams.pem, will be generated and automatically
114
 
  installed into the initital RAM disk image and also used by the
115
 
  Mandos Client on boot.  If different parameters are needed for
116
 
  policy or other reasons, simply replace the existing dhparams.pem
117
 
  file and update the initital RAM disk image.
118
 
 
119
 
 -- Teddy Hogeborn <teddy@recompile.se>, Mon, 15 Jul 2019 16:47:02 +0200
 
93
 -- Teddy Hogeborn <teddy@recompile.se>, Sat, 16 Jun 2012 13:09:58 +0200