/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: 2010-09-12 03:00:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100912030040-b0uopyennste9fdh
Documentation changes:

* DBUS-API: New file documenting the server D-Bus interface.

* clients.conf: Add examples of new approval settings.

* debian/mandos.docs: Added "DBUS-API".

* mandos-clients.conf.xml (OPTIONS): Added "approved_by_default",
                                     "approval_delay", and
                                     "approval_duration".
* mandos.xml (D-BUS INTERFACE): Refer to the "DBUS-API" file.
  (BUGS): Remove mention of lack of a remote query interface.

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
  
5
5
** Operating System
6
6
   
7
 
   Debian 6.0 "squeeze" or Ubuntu 10.10 "Maverick Meerkat".
 
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
11
   and that the initrd.img file is automatically made unreadable.  The
12
12
   server and client programs themselves *could* be run in other
13
13
   distributions, but they *are* specific to GNU/Linux systems, and
14
 
   are not written with portabillity to other Unixes in mind.
15
 
   
 
14
   are not intended to be portable to other Unixes.
 
15
  
16
16
** Libraries
17
17
   
18
18
   The following libraries and packages are needed.  (It is possible
35
35
    To build just the documentation, run the command "make doc".  Then
36
36
    the manual page "mandos.8", for example, can be read by running
37
37
    "man -l mandos.8".
38
 
    
 
38
   
39
39
*** Mandos Server
40
40
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
41
41
    + Avahi 0.6.16        http://www.avahi.org/
42
 
    + Python 2.6          http://www.python.org/
 
42
    + Python 2.5          http://www.python.org/
43
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
    + python-ctypes 1.0.0 http://pypi.python.org/pypi/ctypes
45
46
    + PyGObject 2.14.2    http://library.gnome.org/devel/pygobject/
46
 
    + Urwid 0.9.8.3       http://excess.org/urwid/
47
47
    
48
48
    Strongly recommended:
49
49
    + fping 2.4b2-to-ipv6 http://www.fping.com/
50
 
    + ssh-keyscan from OpenSSH http://www.openssh.com/
51
50
    
52
51
    Package names:
53
52
    python-gnutls avahi-daemon python python-avahi python-dbus
54
 
    python-gobject python-urwid ssh-client
55
 
    
 
53
    python-ctypes python-gobject
 
54
   
56
55
*** Mandos Client
57
56
    + initramfs-tools 0.85i
58
57
                  http://packages.qa.debian.org/i/initramfs-tools.html
61
60
    + GnuPG 1.4.9         http://www.gnupg.org/
62
61
    + GPGME 1.1.6         http://www.gnupg.org/related_software/gpgme/
63
62
    
64
 
    Strongly recommended:
65
 
    + OpenSSH             http://www.openssh.com/
66
 
    
67
63
    Package names:
68
64
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
69
 
    libgpgme11-dev ssh
 
65
    libgpgme11-dev
70
66
 
71
67
* Installing the Mandos server
72
68
  
103
99
     server computer*.
104
100
  
105
101
  4. Configure the client to use the correct network interface.  The
106
 
     interface to use is automatically chosen at boot, and if this
107
 
     needs to be adjusted, it will be necessary to edit
108
 
     /etc/initramfs-tools/initramfs.conf to change the DEVICE setting
109
 
     there.  Alternatively, the file /etc/mandos/plugin-runner.conf
110
 
     can be edited to add a "--device" parameter for the
111
 
     mandos-client(8) plugin.  Please note: If any of those files are
112
 
     changed, the initrd.img file must be updated, possibly using the
113
 
     following command:
 
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
 
105
     file must be updated, possibly using the following command:
114
106
     
115
107
        # update-initramfs -k all -u
116
108
  
117
109
  5. On the server computer, start the server by running the command
118
110
     For Debian: su -c 'invoke-rc.d mandos start'
119
 
     For Ubuntu: sudo service mandos start
 
111
     For Ubuntu: sudo invoke-rc.d mandos start
120
112
     
121
113
     At this point, it is possible to verify that the correct password
122
114
     will be received by the client by running the command:
136
128
  
137
129
  You may want to tighten or loosen the timeouts in the server
138
130
  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.
 
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.