/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-13 21:02:53 UTC
  • mto: This revision was merged to the branch mainline in revision 711.
  • Revision ID: teddy@recompile.se-20140713210253-ftnydds0bnvbzxaa
Tags: version-1.6.6-1
* Makefile (version): Changed to "1.6.6".
* NEWS (Version 1.6.6): New entry.
* debian/changelog (1.6.6-1): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 3           https://www.python.org/
45
 
      Note: Python 2.7 is still supported, if the "mandos",
46
 
      "mandos-ctl", and "mandos-monitor" files are edited to contain
47
 
      "#!/usr/bin/python" instead of python3.
48
 
    + dbus-python 0.82.4 https://dbus.freedesktop.org/doc/dbus-python/
49
 
    + PyGObject 3.8      https://wiki.gnome.org/Projects/PyGObject
50
 
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
51
 
    + Urwid 1.0.1         http://urwid.org/
52
 
      (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/
53
47
    
54
48
    Strongly recommended:
55
 
    + fping 2.4b2-to-ipv6      http://www.fping.org/
 
49
    + fping 2.4b2-to-ipv6 http://www.fping.com/
56
50
    + ssh-keyscan from OpenSSH http://www.openssh.com/
57
51
    
58
52
    Package names:
59
 
    avahi-daemon python3 python3-dbus python3-gi python3-urwid
60
 
    pkg-config fping ssh-client
 
53
    python-gnutls avahi-daemon python python-avahi python-dbus
 
54
    python-gobject python-urwid ssh-client
61
55
    
62
56
*** Mandos Client
63
 
    + GNU C Library 2.17 https://gnu.org/software/libc/
64
 
    + GnuTLS 3.3        https://www.gnutls.org/
65
 
      (but not 3.6.0 or later, until 3.6.6 which works)
66
 
    + Avahi 0.6.16      https://www.avahi.org/
67
 
    + GnuPG 1.4.9       https://www.gnupg.org/
68
 
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
69
 
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
70
 
    + libnl-route 3     https://www.infradead.org/~tgr/libnl/
71
 
    + GLib 2.40         http://www.gtk.org/
72
 
    
73
 
    One of:
74
57
    + initramfs-tools 0.85i
75
 
                        https://tracker.debian.org/pkg/initramfs-tools
76
 
    + dracut 044+241
77
 
         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/
78
63
    
79
64
    Strongly recommended:
80
 
    + OpenSSH           http://www.openssh.com/
 
65
    + OpenSSH             http://www.openssh.com/
81
66
    
82
67
    Package names:
83
 
    initramfs-tools dracut libgnutls-dev gnutls-bin libavahi-core-dev
84
 
    gnupg libgpgme11-dev pkg-config ssh libnl-route-3-dev
85
 
    libglib2.0-dev
 
68
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
 
69
    libgpgme11-dev ssh
86
70
 
87
71
* Installing the Mandos server
88
72
  
90
74
  
91
75
  2. On the computer to run as a Mandos server, run the following
92
76
     command:
93
 
     For Debian: su - -c 'make install-server'
 
77
     For Debian: su -c 'make install-server'
94
78
     For Ubuntu: sudo make install-server
95
79
     
96
80
     (This creates a configuration without any clients configured; you
102
86
  
103
87
  2. On the computer to run as a Mandos client, run the following
104
88
     command:
105
 
     For Debian: su - -c 'make install-client'
 
89
     For Debian: su -c 'make install-client'
106
90
     For Ubuntu: sudo make install-client
107
91
     
108
92
     This will also create an OpenPGP key, which will take some time
109
93
     and entropy, so be patient.
110
94
  
111
95
  3. Run the following command:
112
 
     For Debian: su - -c 'mandos-keygen --password'
 
96
     For Debian: su -c 'mandos-keygen --password'
113
97
     For Ubuntu: sudo mandos-keygen --password
114
98
     
115
99
     When prompted, enter the password/passphrase for the encrypted
118
102
     and append this to the file "/etc/mandos/clients.conf" *on the
119
103
     server computer*.
120
104
  
121
 
  4. Configure the client to use any special configuration needed for
122
 
     your local system.  Note: This is not necessary if the server is
123
 
     present on the same wired local network as the client.  If you do
124
 
     make changes to /etc/mandos/plugin-runner.conf, the initrd.img
125
 
     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:
126
114
     
127
115
        # update-initramfs -k all -u
128
116
  
129
117
  5. On the server computer, start the server by running the command
130
 
     For Debian: su - -c 'invoke-rc.d mandos start'
 
118
     For Debian: su -c 'invoke-rc.d mandos start'
131
119
     For Ubuntu: sudo service mandos start
132
120
     
133
121
     At this point, it is possible to verify that the correct password
135
123
     
136
124
        # /usr/lib/mandos/plugins.d/mandos-client \
137
125
                --pubkey=/etc/keys/mandos/pubkey.txt \
138
 
                --seckey=/etc/keys/mandos/seckey.txt \
139
 
                --tls-privkey=/etc/keys/mandos/tls-privkey.pem \
140
 
                --tls-pubkey=/etc/keys/mandos/tls-pubkey.pem; echo
 
126
                --seckey=/etc/keys/mandos/seckey.txt; echo
141
127
     
142
128
     This command should retrieve the password from the server,
143
129
     decrypt it, and output it to standard output.
144
130
     
145
131
     After this, the client computer should be able to reboot without
146
132
     needing a password entered on the console, as long as it does not
147
 
     take more than five minutes to reboot.
 
133
     take more than an hour to reboot.
148
134
 
149
135
* Further customizations
150
136
  
153
139
  If IPsec is not used and SSH is not installed, it is suggested that
154
140
  a more cryptographically secure checker program is used and
155
141
  configured, since, without IPsec, ping packets can be faked.
156
 
 
157
 
#+STARTUP: showall