/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: 2009-04-17 08:26:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090417082617-eltetak5lzjyz55o
* initramfs-tools-hook: Bug fix: Add "--userid" and "--groupid" to
                        start of "plugin-runner.conf" file instead of
                        appending, to allow any preexisting options to
                        override.
* plugin-runner.conf: Improved wording.

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 5.0 "lenny" or Ubuntu 8.04 "Hardy Heron".
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.
16
 
   
 
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 intended to be portable to other Unixes.
 
15
  
17
16
** Libraries
18
17
   
19
18
   The following libraries and packages are needed.  (It is possible
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
36
35
    To build just the documentation, run the command "make doc".  Then
37
36
    the manual page "mandos.8", for example, can be read by running
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.5          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
    + python-ctypes 1.0.0 http://pypi.python.org/pypi/ctypes
 
46
    + PyGObject 2.14.2    http://library.gnome.org/devel/pygobject/
53
47
    
54
48
    Strongly recommended:
55
 
    + fping 2.4b2-to-ipv6      http://www.fping.org/
56
 
    + ssh-keyscan from OpenSSH http://www.openssh.com/
 
49
    + fping 2.4b2-to-ipv6 http://www.fping.com/
57
50
    
58
51
    Package names:
59
 
    avahi-daemon python3 python3-dbus python3-gi python3-urwid
60
 
    pkg-config fping ssh-client
61
 
    
 
52
    python-gnutls avahi-daemon python python-avahi python-dbus
 
53
    python-ctypes python-gobject
 
54
   
62
55
*** 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
56
    + 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
78
 
    
79
 
    Strongly recommended:
80
 
    + OpenSSH           http://www.openssh.com/
 
57
                  http://packages.qa.debian.org/i/initramfs-tools.html
 
58
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
 
59
    + Avahi 0.6.16        http://www.avahi.org/
 
60
    + GnuPG 1.4.9         http://www.gnupg.org/
 
61
    + GPGME 1.1.6         http://www.gnupg.org/related_software/gpgme/
81
62
    
82
63
    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
 
64
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
 
65
    libgpgme11-dev
86
66
 
87
67
* Installing the Mandos server
88
68
  
90
70
  
91
71
  2. On the computer to run as a Mandos server, run the following
92
72
     command:
93
 
     For Debian: su - -c 'make install-server'
 
73
     For Debian: su -c 'make install-server'
94
74
     For Ubuntu: sudo make install-server
95
75
     
96
76
     (This creates a configuration without any clients configured; you
102
82
  
103
83
  2. On the computer to run as a Mandos client, run the following
104
84
     command:
105
 
     For Debian: su - -c 'make install-client'
 
85
     For Debian: su -c 'make install-client'
106
86
     For Ubuntu: sudo make install-client
107
87
     
108
88
     This will also create an OpenPGP key, which will take some time
109
89
     and entropy, so be patient.
110
90
  
111
91
  3. Run the following command:
112
 
     For Debian: su - -c 'mandos-keygen --password'
 
92
     For Debian: su -c 'mandos-keygen --password'
113
93
     For Ubuntu: sudo mandos-keygen --password
114
94
     
115
95
     When prompted, enter the password/passphrase for the encrypted
118
98
     and append this to the file "/etc/mandos/clients.conf" *on the
119
99
     server computer*.
120
100
  
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
 
101
  4. Configure the client to use the correct network interface.  The
 
102
     default is "eth0", and if this needs to be adjusted, it will be
 
103
     necessary to edit /etc/mandos/plugin-runner.conf to uncomment and
 
104
     change the line there.  If that file is changed, the initrd.img
125
105
     file must be updated, possibly using the following command:
126
106
     
127
107
        # update-initramfs -k all -u
128
108
  
129
109
  5. On the server computer, start the server by running the command
130
 
     For Debian: su - -c 'invoke-rc.d mandos start'
131
 
     For Ubuntu: sudo service mandos start
 
110
     For Debian: su -c 'invoke-rc.d mandos start'
 
111
     For Ubuntu: sudo invoke-rc.d mandos start
132
112
     
133
113
     At this point, it is possible to verify that the correct password
134
114
     will be received by the client by running the command:
135
115
     
136
116
        # /usr/lib/mandos/plugins.d/mandos-client \
137
117
                --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
 
118
                --seckey=/etc/keys/mandos/seckey.txt; echo
141
119
     
142
120
     This command should retrieve the password from the server,
143
121
     decrypt it, and output it to standard output.
144
122
     
145
123
     After this, the client computer should be able to reboot without
146
124
     needing a password entered on the console, as long as it does not
147
 
     take more than five minutes to reboot.
 
125
     take more than an hour to reboot.
148
126
 
149
127
* Further customizations
150
128
  
151
129
  You may want to tighten or loosen the timeouts in the server
152
130
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
153
 
  If IPsec is not used and SSH is not installed, it is suggested that
154
 
  a more cryptographically secure checker program is used and
155
 
  configured, since, without IPsec, ping packets can be faked.
156
 
 
157
 
#+STARTUP: showall
 
131
  If IPsec is not used, it is suggested that a more cryptographically
 
132
  secure checker program is used and configured, since without IPsec
 
133
  ping packets can be faked.