/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 03:19:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930031939-t72se4dhr632o9ct
* Makefile: Add HTML rules for manual pages.
  (DOCBOOKTOHTML, HTMLPOST): New commands.
  (htmldocs): New file list.
  (html, install-html): New targets.
  (.PHONY, clean): Added "html".

* README (The Plugin System): New section; describe plugin system.

* debian/control (Uploaders): New field.

* mandos-options.xml (servicename): Improve wording.

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