/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: 2016-03-05 21:42:56 UTC
  • Revision ID: teddy@recompile.se-20160305214256-79progf0wfkd9068
Add bug reporting information to manual pages

* bugs.xml: New file.
* intro.xml (BUGS): New section; include "bugs.xml".
* mandos-clients.conf.xml (BUGS): Include "bugs.xml".
* mandos-ctl.xml (BUGS): Uncommented; include "bugs.xml".
* mandos-keygen.xml (BUGS): - '' -
* mandos-monitor.xml (BUGS): Include "bugs.xml".
* mandos.conf.xml (BUGS): - '' -
* mandos.xml (BUGS): - '' -
* plugin-runner.xml (BUGS): - '' -
* plugins.d/askpass-fifo.xml (BUGS): New section; include
                                     "../bugs.xml".
* plugins.d/mandos-client.xml (BUGS): Uncommented; include
                                     "../bugs.xml".
* plugins.d/password-prompt.xml (BUGS): Include "../bugs.xml".
* plugins.d/plymouth.xml (BUGS): - '' -
* plugins.d/splashy.xml (BUGS): - '' -
* plugins.d/usplash.xml (BUGS): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
25
25
        /usr/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH \
26
26
        )/mandos/plugins.d/mandos-client \
27
27
                --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
 
28
                --seckey=/etc/keys/mandos/seckey.txt; echo
31
29
  
32
30
  This command should retrieve the password from the server, decrypt
33
31
  it, and output it to standard output.  There it can be verified to
45
43
  automatically detected.  If this should result in incorrect
46
44
  interfaces, edit the DEVICE setting in the
47
45
  "/etc/initramfs-tools/initramfs.conf" file.  (The default setting is
48
 
  empty, meaning it will autodetect the interfaces.)  *If* the DEVICE
 
46
  empty, meaning it will autodetect the interface.)  *If* the DEVICE
49
47
  setting is changed, it will be necessary to update the initrd image
50
 
  by running this command:
 
48
  by running the command
51
49
  
52
 
        (For initramfs-tools:)
53
50
        update-initramfs -k all -u
54
 
        
55
 
        (For dracut:)
56
 
        dpkg-reconfigure dracut
57
51
  
58
52
  The device can also be overridden at boot time on the Linux kernel
59
53
  command line using the sixth colon-separated field of the "ip="
64
58
  Note that since the network interfaces are used in the initial RAM
65
59
  disk environment, the network interfaces *must* exist at that stage.
66
60
  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".
 
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".
73
67
 
74
68
* User-Supplied Plugins
75
69
  
76
70
  Any plugins found in "/etc/mandos/plugins.d" will override and add
77
71
  to the normal Mandos plugins.  When adding or changing plugins, do
78
 
  not forget to update the initial RAM disk image:
 
72
  not forget to update the initital RAM disk image:
79
73
  
80
 
        (For initramfs-tools:)
81
74
        update-initramfs -k all -u
82
 
        
83
 
        (For dracut:)
84
 
        dpkg-reconfigure dracut
85
75
 
86
76
* Do *NOT* Edit "/etc/crypttab"
87
77
  
100
90
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
101
91
  line.
102
92
  
103
 
  For very advanced users, it is possible to specify "mandos=connect"
104
 
  on the kernel command line to make the system only set up the
105
 
  network (using the data in the "ip=" option) and not pass any extra
106
 
  "--connect" options to mandos-client at boot.  For this to work,
107
 
  "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs to be
108
 
  manually added to the file "/etc/mandos/plugin-runner.conf" or, if
109
 
  dracut is used with systemd, the "--connect=<ADDRESS>:<PORT>"
110
 
  options needs to be added to an environment variable in an override
111
 
  file for the "ask-password-mandos" service, as detailed in the file
112
 
  "/usr/lib/dracut/modules.d/90mandos/ask-password-mandos.service".
 
93
  For very advanced users, it it possible to specify simply
 
94
  "mandos=connect" on the kernel command line to make the system only
 
95
  set up the network (using the data in the "ip=" option) and not pass
 
96
  any extra "--connect" options to mandos-client at boot.  For this to
 
97
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
 
98
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
113
99
 
114
100
* Diffie-Hellman Parameters
115
101
 
116
102
  On installation, a file with Diffie-Hellman parameters,
117
103
  /etc/keys/mandos/dhparams.pem, will be generated and automatically
118
 
  installed into the initial RAM disk image and also used by the
 
104
  installed into the initital RAM disk image and also used by the
119
105
  Mandos Client on boot.  If different parameters are needed for
120
106
  policy or other reasons, simply replace the existing dhparams.pem
121
 
  file and update the initial RAM disk image.
 
107
  file and update the initital RAM disk image.
122
108
 
123
 
 -- Teddy Hogeborn <teddy@recompile.se>, Sun,  8 Sep 2024 02:09:20 +0200
 
109
 -- Teddy Hogeborn <teddy@recompile.se>, Sun, 12 Jul 2015 03:24:24 +0200