/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: 2008-09-30 19:05:13 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930190513-2adrracmfgwmbjs0
* debian/mandos-client.lintian-overrides: Ignore permissions on
                                          "/etc/mandos/plugins.d".

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.4          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
53
46
    
54
47
    Strongly recommended:
55
 
    + fping 2.4b2-to-ipv6      http://www.fping.org/
56
 
    + ssh-keyscan from OpenSSH http://www.openssh.com/
 
48
    + fping 2.4b2-to-ipv6 http://www.fping.com/
57
49
    
58
50
    Package names:
59
 
    avahi-daemon python3 python3-dbus python3-gi python3-urwid
60
 
    pkg-config fping ssh-client
61
 
    
 
51
    python-gnutls avahi-daemon python python-avahi python-dbus
 
52
    python-ctypes
 
53
   
62
54
*** 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
55
    + 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/
 
56
                  http://packages.qa.debian.org/i/initramfs-tools.html
 
57
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
 
58
    + Avahi 0.6.16        http://www.avahi.org/
 
59
    + GnuPG 1.4.9         http://www.gnupg.org/
 
60
    + GPGME 1.1.6         http://www.gnupg.org/related_software/gpgme/
81
61
    
82
62
    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
 
63
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
 
64
    libgpgme11-dev
86
65
 
87
66
* Installing the Mandos server
88
67
  
90
69
  
91
70
  2. On the computer to run as a Mandos server, run the following
92
71
     command:
93
 
     For Debian: su - -c 'make install-server'
 
72
     For Debian: su -c 'make install-server'
94
73
     For Ubuntu: sudo make install-server
95
74
     
96
75
     (This creates a configuration without any clients configured; you
102
81
  
103
82
  2. On the computer to run as a Mandos client, run the following
104
83
     command:
105
 
     For Debian: su - -c 'make install-client'
 
84
     For Debian: su -c 'make install-client'
106
85
     For Ubuntu: sudo make install-client
107
86
     
108
87
     This will also create an OpenPGP key, which will take some time
109
88
     and entropy, so be patient.
110
89
  
111
90
  3. Run the following command:
112
 
     For Debian: su - -c 'mandos-keygen --password'
 
91
     For Debian: su -c 'mandos-keygen --password'
113
92
     For Ubuntu: sudo mandos-keygen --password
114
93
     
115
94
     When prompted, enter the password/passphrase for the encrypted
118
97
     and append this to the file "/etc/mandos/clients.conf" *on the
119
98
     server computer*.
120
99
  
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:
126
 
     
127
 
        # update-initramfs -k all -u
128
 
  
129
 
  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
132
 
     
133
 
     At this point, it is possible to verify that the correct password
134
 
     will be received by the client by running the command:
135
 
     
136
 
        # /usr/lib/mandos/plugins.d/mandos-client \
137
 
                --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
141
 
     
142
 
     This command should retrieve the password from the server,
143
 
     decrypt it, and output it to standard output.
 
100
  4. On the server computer, start the server by running the command
 
101
     For Debian: su -c 'invoke-rc.d mandos start'
 
102
     For Ubuntu: sudo invoke-rc.d mandos start
144
103
     
145
104
     After this, the client computer should be able to reboot without
146
105
     needing a password entered on the console, as long as it does not
147
 
     take more than five minutes to reboot.
 
106
     take more than an hour to reboot.
148
107
 
149
108
* Further customizations
150
109
  
151
110
  You may want to tighten or loosen the timeouts in the server
152
111
  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
 
112
  Is IPsec is not used, it is suggested that a more cryptographically
 
113
  secure checker program is used and configured, since without IPsec
 
114
  ping packets can be faked.