/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 INSTALL

  • Committer: Teddy Hogeborn
  • Date: 2014-07-16 23:44:54 UTC
  • Revision ID: teddy@recompile.se-20140716234454-6erpylmbf5qzndf3
mandos-client: Fix bug with GPGME 1.5.0.

* initramfs-tools-hook: If GPGME is 1.5.0 or later, copy "gpgconfig"
                        to RAM file system and do what GPGME does:
                        run "gpgconfig" to find GnuPG binary.

Show diffs side-by-side

added added

removed removed

Lines of Context:
INSTALL
4
4
  
5
5
** Operating System
6
6
   
7
 
   Debian 8.0 "jessie" or Ubuntu 15.10 "Wily Werewolf" (or later).
 
7
   Debian 6.0 "squeeze" or Ubuntu 10.10 "Maverick Meerkat".
8
8
   
9
9
   This is mostly for the support scripts which make sure that the
10
10
   client is installed and started in the initial RAM disk environment
11
 
   and that the initial RAM file system image file is automatically
12
 
   made unreadable.  The server and client programs themselves *could*
13
 
   be run in other distributions, but they *are* specific to GNU/Linux
14
 
   systems, and are not written with portabillity to other Unixes in
15
 
   mind.
 
11
   and that the initrd.img file is automatically made unreadable.  The
 
12
   server and client programs themselves *could* be run in other
 
13
   distributions, but they *are* specific to GNU/Linux systems, and
 
14
   are not written with portabillity to other Unixes in mind.
16
15
   
17
16
** Libraries
18
17
   
28
27
    + DocBook 4.5         http://www.docbook.org/
29
28
      Note: DocBook 5.0 is not compatible.
30
29
    + DocBook XSL stylesheets 1.71.0
31
 
                         http://wiki.docbook.org/DocBookXslStylesheets
 
30
                   http://wiki.docbook.org/topic/DocBookXslStylesheets
32
31
    
33
32
    Package names:
34
33
    docbook docbook-xsl
38
37
    "man -l mandos.8".
39
38
    
40
39
*** Mandos Server
41
 
    + GnuTLS 3.3          https://www.gnutls.org/
42
 
      (but not 3.6.0 or later, until 3.6.6, which works)
43
 
    + Avahi 0.6.16        https://www.avahi.org/
44
 
    + Python 2.7          https://www.python.org/
45
 
    + dbus-python 0.82.4 https://dbus.freedesktop.org/doc/dbus-python/
46
 
    + PyGObject 3.7.1     https://wiki.gnome.org/Projects/PyGObject
47
 
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
48
 
    + Urwid 1.0.1         http://urwid.org/
49
 
      (Only needed by the "mandos-monitor" tool.)
 
40
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
 
41
    + Avahi 0.6.16        http://www.avahi.org/
 
42
    + Python 2.6          http://www.python.org/
 
43
    + Python-GnuTLS 1.1.5 http://pypi.python.org/pypi/python-gnutls/
 
44
    + dbus-python 0.82.4  http://dbus.freedesktop.org/doc/dbus-python/
 
45
    + PyGObject 2.14.2    http://library.gnome.org/devel/pygobject/
 
46
    + Urwid 0.9.8.3       http://excess.org/urwid/
50
47
    
51
48
    Strongly recommended:
52
 
    + fping 2.4b2-to-ipv6      http://www.fping.org/
 
49
    + fping 2.4b2-to-ipv6 http://www.fping.com/
53
50
    + ssh-keyscan from OpenSSH http://www.openssh.com/
54
51
    
55
52
    Package names:
56
 
    avahi-daemon python python-dbus python-gi python-urwid pkg-config
57
 
    fping ssh-client
 
53
    python-gnutls avahi-daemon python python-avahi python-dbus
 
54
    python-gobject python-urwid ssh-client
58
55
    
59
56
*** Mandos Client
60
 
    + GNU C Library 2.17 https://gnu.org/software/libc/
61
 
    + GnuTLS 3.3        https://www.gnutls.org/
62
 
      (but not 3.6.0 or later, until 3.6.6 which works)
63
 
    + Avahi 0.6.16      https://www.avahi.org/
64
 
    + GnuPG 1.4.9       https://www.gnupg.org/
65
 
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
66
 
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
67
 
    + libnl-route 3     https://www.infradead.org/~tgr/libnl/
68
 
    + GLib 2.40         http://www.gtk.org/
69
 
    
70
 
    One of:
71
57
    + initramfs-tools 0.85i
72
 
                        https://tracker.debian.org/pkg/initramfs-tools
73
 
    + dracut 044+241
74
 
         http://www.kernel.org/pub/linux/utils/boot/dracut/dracut.html
 
58
                  http://packages.qa.debian.org/i/initramfs-tools.html
 
59
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
 
60
    + Avahi 0.6.16        http://www.avahi.org/
 
61
    + GnuPG 1.4.9         http://www.gnupg.org/
 
62
    + GPGME 1.1.6         http://www.gnupg.org/related_software/gpgme/
75
63
    
76
64
    Strongly recommended:
77
 
    + OpenSSH           http://www.openssh.com/
 
65
    + OpenSSH             http://www.openssh.com/
78
66
    
79
67
    Package names:
80
 
    initramfs-tools dracut libgnutls-dev gnutls-bin libavahi-core-dev
81
 
    gnupg libgpgme11-dev pkg-config ssh libnl-route-3-dev
82
 
    libglib2.0-dev
 
68
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
 
69
    libgpgme11-dev ssh
83
70
 
84
71
* Installing the Mandos server
85
72
  
115
102
     and append this to the file "/etc/mandos/clients.conf" *on the
116
103
     server computer*.
117
104
  
118
 
  4. Configure the client to use any special configuration needed for
119
 
     your local system.  Note: This is not necessary if the server is
120
 
     present on the same wired local network as the client.  If you do
121
 
     make changes to /etc/mandos/plugin-runner.conf, the initrd.img
122
 
     file must be updated, possibly using the following command:
 
105
  4. Configure the client to use the correct network interface.  The
 
106
     interface to use is automatically chosen at boot, and if this
 
107
     needs to be adjusted, it will be necessary to edit
 
108
     /etc/initramfs-tools/initramfs.conf to change the DEVICE setting
 
109
     there.  Alternatively, the file /etc/mandos/plugin-runner.conf
 
110
     can be edited to add a "--device" parameter for the
 
111
     mandos-client(8) plugin.  Please note: If any of those files are
 
112
     changed, the initrd.img file must be updated, possibly using the
 
113
     following command:
123
114
     
124
115
        # update-initramfs -k all -u
125
116
  
132
123
     
133
124
        # /usr/lib/mandos/plugins.d/mandos-client \
134
125
                --pubkey=/etc/keys/mandos/pubkey.txt \
135
 
                --seckey=/etc/keys/mandos/seckey.txt \
136
 
                --tls-privkey=/etc/keys/mandos/tls-privkey.pem \
137
 
                --tls-pubkey=/etc/keys/mandos/tls-pubkey.pem; echo
 
126
                --seckey=/etc/keys/mandos/seckey.txt; echo
138
127
     
139
128
     This command should retrieve the password from the server,
140
129
     decrypt it, and output it to standard output.
141
130
     
142
131
     After this, the client computer should be able to reboot without
143
132
     needing a password entered on the console, as long as it does not
144
 
     take more than five minutes to reboot.
 
133
     take more than an hour to reboot.
145
134
 
146
135
* Further customizations
147
136
  
150
139
  If IPsec is not used and SSH is not installed, it is suggested that
151
140
  a more cryptographically secure checker program is used and
152
141
  configured, since, without IPsec, ping packets can be faked.
153
 
 
154
 
#+STARTUP: showall