/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: 2015-06-28 16:35:27 UTC
  • mto: This revision was merged to the branch mainline in revision 759.
  • Revision ID: teddy@recompile.se-20150628163527-cky0ec59zew7teua
Add a plugin helper directory, available to all plugins.

* Makefile (PLUGIN_HELPERS): New; list of plugin helpers.
  (CPROGS): Appended "$(PLUGIN_HELPERS)".
* initramfs-tools-hook: Create new plugin helper directory, and copy
                        plugin helpers provided by the system and/or
                        by the local administrator.
  (PLUGINHELPERDIR): New.
* plugin-runner.c: Take new --plugin-helper-dir option and provide
                   environment variable to all plugins.
  (PHDIR): New; set to "/lib/mandos/plugin-helpers".
  (main/pluginhelperdir): New.
  (main/options): New option "--plugin-helper-dir".
  (main/parse_opt, main/parse_opt_config_file): Accept new option.
  (main): Use new option to set MANDOSPLUGINHELPERDIR environment
          variable as if using --global-env MANDOSPLUGINHELPERDIR=...
* plugin-runner.xml: Document new --plugin-helper-dir option.
  (SYNOPSIS, OPTIONS): Add "--plugin-helper-dir" option.
  (PLUGINS/WRITING PLUGINS): Document new environment variable
                             available to plugins.
  (ENVIRONMENT): Document new environment variable
                 "MANDOSPLUGINHELPERDIR" affected by the new
                 --plugin-helper-dir option.

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.
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
19
        /usr/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH \
26
20
        )/mandos/plugins.d/mandos-client \
27
21
                --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
 
22
                --seckey=/etc/keys/mandos/seckey.txt; echo
31
23
  
32
24
  This command should retrieve the password from the server, decrypt
33
25
  it, and output it to standard output.  There it can be verified to
45
37
  automatically detected.  If this should result in incorrect
46
38
  interfaces, edit the DEVICE setting in the
47
39
  "/etc/initramfs-tools/initramfs.conf" file.  (The default setting is
48
 
  empty, meaning it will autodetect the interfaces.)  *If* the DEVICE
 
40
  empty, meaning it will autodetect the interface.)  *If* the DEVICE
49
41
  setting is changed, it will be necessary to update the initrd image
50
 
  by running this command:
 
42
  by running the command
51
43
  
52
 
        (For initramfs-tools:)
53
44
        update-initramfs -k all -u
54
 
        
55
 
        (For dracut:)
56
 
        dpkg-reconfigure dracut
57
45
  
58
46
  The device can also be overridden at boot time on the Linux kernel
59
47
  command line using the sixth colon-separated field of the "ip="
64
52
  Note that since the network interfaces are used in the initial RAM
65
53
  disk environment, the network interfaces *must* exist at that stage.
66
54
  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".
 
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".
73
61
 
74
62
* User-Supplied Plugins
75
63
  
77
65
  to the normal Mandos plugins.  When adding or changing plugins, do
78
66
  not forget to update the initital RAM disk image:
79
67
  
80
 
        (For initramfs-tools:)
81
68
        update-initramfs -k all -u
82
 
        
83
 
        (For dracut:)
84
 
        dpkg-reconfigure dracut
85
69
 
86
70
* Do *NOT* Edit "/etc/crypttab"
87
71
  
100
84
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
101
85
  line.
102
86
  
103
 
  For very advanced users, it is possible to specify simply
 
87
  For very advanced users, it it possible to specify simply
104
88
  "mandos=connect" on the kernel command line to make the system only
105
89
  set up the network (using the data in the "ip=" option) and not pass
106
90
  any extra "--connect" options to mandos-client at boot.  For this to
107
91
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
108
92
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
109
93
 
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
 
94
 -- Teddy Hogeborn <teddy@recompile.se>, Mon, 28 Oct 2013 11:02:26 +0100