/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-06-22 02:19:30 UTC
  • Revision ID: teddy@recompile.se-20140622021930-icl7h4cm97blhjml
mandos-keygen: Generate "checker" option to use SSH fingerprints.

To turn this off, use a new "--no-ssh" option to mandos-keygen.

* INSTALL (Mandos Server, Mandos Client): Document new suggested
                                          installation of SSH.
* Makefile (confdir/clients.conf): Use new "--no-ssh" option to
                                   "mandos-keygen".
* debian/control (mandos/Depends): Changed to "fping | ssh-client".
  (mandos-client/Recommends): New; set to "ssh".
* intro.xml (FREQUENTLY ASKED QUESTIONS): Rename and rewrite section
                                          called "Faking ping
                                          replies?" to address new
                                          default behavior.
* mandos-clients.conf.xml (OPTIONS/checker): Briefly discuss new
                                             behavior of
                                             mandos-keygen.
* mandos-keygen: Bug fix: Suppress failure output of "shred" to remove
                 "sec*", since no such files may exist.
 (password mode): Scan for SSH key fingerprints and output as new
                  "checker" and "ssh_fingerprint" options, unless new
                  "--no-ssh" option is given.
* mandos-keygen.xml (SYNOPSIS/--force): Bug fix: Document short form.
  (OPTIONS/--no-ssh): New.
  (SEE ALSO): Add reference "ssh-keyscan(1)".
* plugins.d/mandos-client.xml (SECURITY): Briefly mention the
                                          possibility of using SSH key
                                          fingerprints for checking.

Show diffs side-by-side

added added

removed removed

Lines of Context:
INSTALL
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".
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 intended to be portable to other Unixes.
15
 
  
 
14
   are not written with portabillity to other Unixes in mind.
 
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.4          http://www.python.org/
 
42
    + Python 2.6          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
    + PyGObject 2.14.2    http://library.gnome.org/devel/pygobject/
 
46
    + Urwid 0.9.8.3       http://excess.org/urwid/
46
47
    
47
48
    Strongly recommended:
48
49
    + fping 2.4b2-to-ipv6 http://www.fping.com/
 
50
    + ssh-keyscan from OpenSSH http://www.openssh.com/
49
51
    
50
52
    Package names:
51
53
    python-gnutls avahi-daemon python python-avahi python-dbus
52
 
    python-ctypes
53
 
   
 
54
    python-gobject python-urwid ssh-client
 
55
    
54
56
*** Mandos Client
55
57
    + initramfs-tools 0.85i
56
58
                  http://packages.qa.debian.org/i/initramfs-tools.html
59
61
    + GnuPG 1.4.9         http://www.gnupg.org/
60
62
    + GPGME 1.1.6         http://www.gnupg.org/related_software/gpgme/
61
63
    
 
64
    Strongly recommended:
 
65
    + OpenSSH             http://www.openssh.com/
 
66
    
62
67
    Package names:
63
68
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
64
 
    libgpgme11-dev
 
69
    libgpgme11-dev ssh
65
70
 
66
71
* Installing the Mandos server
67
72
  
97
102
     and append this to the file "/etc/mandos/clients.conf" *on the
98
103
     server computer*.
99
104
  
100
 
  4. On the server computer, start the server by running the command
 
105
  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:
 
114
     
 
115
        # update-initramfs -k all -u
 
116
  
 
117
  5. On the server computer, start the server by running the command
101
118
     For Debian: su -c 'invoke-rc.d mandos start'
102
 
     For Ubuntu: sudo 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.
103
130
     
104
131
     After this, the client computer should be able to reboot without
105
132
     needing a password entered on the console, as long as it does not
109
136
  
110
137
  You may want to tighten or loosen the timeouts in the server
111
138
  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.
 
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.