/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 07:23:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930072339-jn15gyrtfpdk2dhx
* .bzrignore: Added "man" directory (created by "make install-html").

* Makefile: Add "common.ent" dependency to all manual pages.
  (htmldir, version, SED): New variables.
  (CFLAGS): Add -D option to define VERSION to $(version).
  (MANPOST, HTMLPOST): Use $(SED).
  (PROGS): Use $(CPROGS)
  (CPROGS): New; C-only programs.
  (objects): Use $(CPROGS).
  (common.ent, mandos, mandos-keygen): New targets; update version
                                       number to $(version).
  (clean): Use $(CPROGS).
  (check): Depend on "all".
  (install-html): Install to $(htmldir).

* common.ent: New file with "version" entity.

* mandos-clients.conf.xml: Use "common.ent".
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.xml: - '' -

* plugin-runner.c (argp_program_version): Use VERSION.
* plugins.d/mandos-client.c (argp_program_version): - '' -
* plugins.d/password-prompt.c (argp_program_version): - '' -

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" (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 2.4          http://www.gnutls.org/
42
 
      Note: GnuTLS 3 will only work with Python-GnuTLS 2
 
40
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
43
41
    + Avahi 0.6.16        http://www.avahi.org/
44
 
    + Python 2.6          https://www.python.org/
45
 
    + Python-GnuTLS 1.1.5 https://pypi.python.org/pypi/python-gnutls/
 
42
    + Python 2.4          http://www.python.org/
 
43
    + Python-GnuTLS 1.1.5 http://pypi.python.org/pypi/python-gnutls/
46
44
    + dbus-python 0.82.4  http://dbus.freedesktop.org/doc/dbus-python/
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.)
 
45
    + python-ctypes 1.0.0 http://pypi.python.org/pypi/ctypes
52
46
    
53
47
    Strongly recommended:
54
 
    + fping 2.4b2-to-ipv6      http://www.fping.org/
55
 
    + ssh-keyscan from OpenSSH http://www.openssh.com/
 
48
    + fping 2.4b2-to-ipv6 http://www.fping.com/
56
49
    
57
50
    Package names:
58
51
    python-gnutls avahi-daemon python python-avahi python-dbus
59
 
    python-gobject python-urwid pkg-config fping ssh-client
60
 
    
 
52
    python-ctypes
 
53
   
61
54
*** Mandos Client
62
55
    + initramfs-tools 0.85i
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/
 
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/
72
61
    
73
62
    Package names:
74
63
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
75
 
    libgpgme11-dev pkg-config ssh
 
64
    libgpgme11-dev
76
65
 
77
66
* Installing the Mandos server
78
67
  
108
97
     and append this to the file "/etc/mandos/clients.conf" *on the
109
98
     server computer*.
110
99
  
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
 
100
  4. On the server computer, start the server by running the command
120
101
     For Debian: su -c '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.
 
102
     For Ubuntu: sudo invoke-rc.d mandos start
132
103
     
133
104
     After this, the client computer should be able to reboot without
134
105
     needing a password entered on the console, as long as it does not
135
 
     take more than five minutes to reboot.
 
106
     take more than an hour to reboot.
136
107
 
137
108
* Further customizations
138
109
  
139
110
  You may want to tighten or loosen the timeouts in the server
140
111
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
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.
 
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.