/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: 2016-02-28 14:22:10 UTC
  • Revision ID: teddy@recompile.se-20160228142210-2df89dih7mzxxr0h
Update copyright year.

* DBUS-API: Update copyright year.
* debian/copyright: - '' -
* intro.xml (COPYRIGHT): - '' -
* mandos: - '' -
* mandos-clients.conf.xml (COPYRIGHT): - '' -
* mandos-ctl: - '' -
* mandos-ctl.xml (COPYRIGHT): - '' -
* mandos-keygen: - '' -
* mandos-keygen.xml (COPYRIGHT): - '' -
* mandos-monitor: - '' -
* mandos-monitor.xml (COPYRIGHT): - '' -
* mandos.conf.xml (COPYRIGHT): - '' -
* mandos.xml (COPYRIGHT): - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugin-runner.xml (COPYRIGHT): - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/askpass-fifo.xml (COPYRIGHT): - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/mandos-client.xml (COPYRIGHT): - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/password-prompt.xml (COPYRIGHT): - ''
* plugins.d/plymouth.c: - '' -
* plugins.d/plymouth.xml (COPYRIGHT): - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/splashy.xml (COPYRIGHT): - '' -
* plugins.d/usplash.c: - '' -
* plugins.d/usplash.xml (COPYRIGHT): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
  
5
5
** Operating System
6
6
   
7
 
   Debian 5.0 "lenny" or Ubuntu 8.04 "Hardy Heron".
 
7
   Debian 8.0 "jessie" or Ubuntu 15.10 "Wily Werewolf" (or later).
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 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
 
  
 
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
   
16
17
** Libraries
17
18
   
18
19
   The following libraries and packages are needed.  (It is possible
27
28
    + DocBook 4.5         http://www.docbook.org/
28
29
      Note: DocBook 5.0 is not compatible.
29
30
    + DocBook XSL stylesheets 1.71.0
30
 
                   http://wiki.docbook.org/topic/DocBookXslStylesheets
 
31
                         http://wiki.docbook.org/DocBookXslStylesheets
31
32
    
32
33
    Package names:
33
34
    docbook docbook-xsl
35
36
    To build just the documentation, run the command "make doc".  Then
36
37
    the manual page "mandos.8", for example, can be read by running
37
38
    "man -l mandos.8".
38
 
   
 
39
    
39
40
*** Mandos Server
40
 
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
 
41
    + GnuTLS 3.3          http://www.gnutls.org/
41
42
    + 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/
 
43
    + Python 2.7          https://www.python.org/
44
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
 
45
    + PyGObject 2.14.2    https://developer.gnome.org/pygobject/
 
46
    + pkg-config  http://www.freedesktop.org/wiki/Software/pkg-config/
 
47
    + Urwid 1.0.1         http://urwid.org/
 
48
      (Only needed by the "mandos-monitor" tool.)
46
49
    
47
50
    Strongly recommended:
48
 
    + fping 2.4b2-to-ipv6 http://www.fping.com/
 
51
    + fping 2.4b2-to-ipv6      http://www.fping.org/
 
52
    + ssh-keyscan from OpenSSH http://www.openssh.com/
49
53
    
50
54
    Package names:
51
 
    python-gnutls avahi-daemon python python-avahi python-dbus
52
 
    python-ctypes
53
 
   
 
55
    avahi-daemon python python-avahi python-dbus python-gobject
 
56
    python-urwid pkg-config fping ssh-client
 
57
    
54
58
*** Mandos Client
55
59
    + initramfs-tools 0.85i
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/
 
60
                        https://tracker.debian.org/pkg/initramfs-tools
 
61
    + GnuTLS 3.3        http://www.gnutls.org/
 
62
    + Avahi 0.6.16      http://www.avahi.org/
 
63
    + GnuPG 1.4.9       https://www.gnupg.org/
 
64
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
 
65
    + pkg-config  http://www.freedesktop.org/wiki/Software/pkg-config/
 
66
    
 
67
    Strongly recommended:
 
68
    + OpenSSH           http://www.openssh.com/
61
69
    
62
70
    Package names:
63
71
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
64
 
    libgpgme11-dev
 
72
    libgpgme11-dev pkg-config ssh
65
73
 
66
74
* Installing the Mandos server
67
75
  
97
105
     and append this to the file "/etc/mandos/clients.conf" *on the
98
106
     server computer*.
99
107
  
100
 
  4. Configure the client to use the correct network interface.  The
101
 
     default is "eth0", and if this needs to be adjusted, it will be
102
 
     necessary to edit /etc/mandos/plugin-runner.conf to uncomment and
103
 
     change the line there.  If that file is changed, the initrd.img
 
108
  4. Configure the client to use any special configuration needed for
 
109
     your local system.  Note: This is not necessary if the server is
 
110
     present on the same wired local network as the client.  If you do
 
111
     make changes to /etc/mandos/plugin-runner.conf, the initrd.img
104
112
     file must be updated, possibly using the following command:
105
113
     
106
114
        # update-initramfs -k all -u
107
115
  
108
116
  5. On the server computer, start the server by running the command
109
117
     For Debian: su -c 'invoke-rc.d mandos start'
110
 
     For Ubuntu: sudo invoke-rc.d mandos start
 
118
     For Ubuntu: sudo service mandos start
111
119
     
112
120
     At this point, it is possible to verify that the correct password
113
121
     will be received by the client by running the command:
121
129
     
122
130
     After this, the client computer should be able to reboot without
123
131
     needing a password entered on the console, as long as it does not
124
 
     take more than an hour to reboot.
 
132
     take more than five minutes to reboot.
125
133
 
126
134
* Further customizations
127
135
  
128
136
  You may want to tighten or loosen the timeouts in the server
129
137
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
130
 
  Is IPsec is not used, it is suggested that a more cryptographically
131
 
  secure checker program is used and configured, since without IPsec
132
 
  ping packets can be faked.
 
138
  If IPsec is not used and SSH is not installed, it is suggested that
 
139
  a more cryptographically secure checker program is used and
 
140
  configured, since, without IPsec, ping packets can be faked.
 
141
 
 
142
#+STARTUP: showall