/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-25 22:17:55 UTC
  • Revision ID: teddy@recompile.se-20140725221755-7bak9szduz53wwtq
INSTALL: Add org-mode setting to show all text when opening.

* INSTALL (STARTUP): New org-mode setting; set to "showall".

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 6.0 "squeeze" or Ubuntu 10.10 "Maverick Meerkat" (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 2.4          http://www.gnutls.org/
 
42
      Note: GnuTLS 3 will only work with Python-GnuTLS 2
41
43
    + 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
    + Python 2.6          https://www.python.org/
 
45
    + Python-GnuTLS 1.1.5 https://pypi.python.org/pypi/python-gnutls/
44
46
    + dbus-python 0.82.4  http://dbus.freedesktop.org/doc/dbus-python/
45
 
    + python-ctypes 1.0.0 http://pypi.python.org/pypi/ctypes
 
47
    + PyGObject 2.14.2    https://developer.gnome.org/pygobject/
 
48
    + pkg-config  http://www.freedesktop.org/wiki/Software/pkg-config/
 
49
    + Python-argparse     https://pypi.python.org/pypi/argparse
 
50
    + Urwid 1.0.1         http://urwid.org/
 
51
      (Only needed by the "mandos-monitor" tool.)
46
52
    
47
53
    Strongly recommended:
48
 
    + fping 2.4b2-to-ipv6 http://www.fping.com/
 
54
    + fping 2.4b2-to-ipv6      http://www.fping.org/
 
55
    + ssh-keyscan from OpenSSH http://www.openssh.com/
49
56
    
50
57
    Package names:
51
58
    python-gnutls avahi-daemon python python-avahi python-dbus
52
 
    python-ctypes
53
 
   
 
59
    python-gobject python-urwid pkg-config fping ssh-client
 
60
    
54
61
*** Mandos Client
55
62
    + 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/
 
63
                        https://tracker.debian.org/pkg/initramfs-tools
 
64
    + GnuTLS 2.4        http://www.gnutls.org/
 
65
    + Avahi 0.6.16      http://www.avahi.org/
 
66
    + GnuPG 1.4.9       https://www.gnupg.org/
 
67
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
 
68
    + pkg-config  http://www.freedesktop.org/wiki/Software/pkg-config/
 
69
    
 
70
    Strongly recommended:
 
71
    + OpenSSH           http://www.openssh.com/
61
72
    
62
73
    Package names:
63
74
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
64
 
    libgpgme11-dev
 
75
    libgpgme11-dev pkg-config ssh
65
76
 
66
77
* Installing the Mandos server
67
78
  
97
108
     and append this to the file "/etc/mandos/clients.conf" *on the
98
109
     server computer*.
99
110
  
100
 
  4. On the server computer, start the server by running the command
 
111
  4. Configure the client to use any special configuration needed for
 
112
     your local system.  Note: This is not necessary if the server is
 
113
     present on the same wired local network as the client.  If you do
 
114
     make changes to /etc/mandos/plugin-runner.conf, the initrd.img
 
115
     file must be updated, possibly using the following command:
 
116
     
 
117
        # update-initramfs -k all -u
 
118
  
 
119
  5. On the server computer, start the server by running the command
101
120
     For Debian: su -c 'invoke-rc.d mandos start'
102
 
     For Ubuntu: sudo invoke-rc.d mandos start
 
121
     For Ubuntu: sudo service mandos start
 
122
     
 
123
     At this point, it is possible to verify that the correct password
 
124
     will be received by the client by running the command:
 
125
     
 
126
        # /usr/lib/mandos/plugins.d/mandos-client \
 
127
                --pubkey=/etc/keys/mandos/pubkey.txt \
 
128
                --seckey=/etc/keys/mandos/seckey.txt; echo
 
129
     
 
130
     This command should retrieve the password from the server,
 
131
     decrypt it, and output it to standard output.
103
132
     
104
133
     After this, the client computer should be able to reboot without
105
134
     needing a password entered on the console, as long as it does not
106
 
     take more than an hour to reboot.
 
135
     take more than five minutes to reboot.
107
136
 
108
137
* Further customizations
109
138
  
110
139
  You may want to tighten or loosen the timeouts in the server
111
140
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
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.
 
141
  If IPsec is not used and SSH is not installed, it is suggested that
 
142
  a more cryptographically secure checker program is used and
 
143
  configured, since, without IPsec, ping packets can be faked.
 
144
 
 
145
#+STARTUP: showall