/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: 2015-07-20 03:03:33 UTC
  • Revision ID: teddy@recompile.se-20150720030333-203m2aeblypcsfte
Bug fix for GnuTLS 3: be compatible with old 2048-bit DSA keys.

The mandos-keygen program in Mandos version 1.6.0 and older generated
2048-bit DSA keys, and when GnuTLS uses these it has trouble
connecting using the Mandos default priority string.  This was
previously fixed in Mandos 1.6.2, but the bug reappeared when using
GnuTLS 3, so the default priority string has to change again; this
time also the Mandos client has to change its default, so now the
server and the client should use the same default priority string:

SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA:+SIGN-DSA-SHA256

* mandos (main/server_defaults): Changed default priority string.
* mandos-options.xml (/section/para[id="priority_compat"]): Removed.
  (/section/para[id="priority"]): Changed default priority string.
* mandos.conf ([DEFAULT]/priority): - '' -
* mandos.conf.xml (OPTIONS/priority): Refer to the id "priority"
                                      instead of "priority_compat".
* mandos.xml (OPTIONS/--priority): - '' -
* plugins.d/mandos-client.c (main): Changed default priority string.

Show diffs side-by-side

added added

removed removed

Lines of Context:
INSTALL
 
1
-*- org -*-
 
2
 
 
3
* Prerequisites
 
4
  
 
5
** Operating System
 
6
   
 
7
   Debian 6.0 "squeeze" or Ubuntu 10.10 "Maverick Meerkat" (or later).
 
8
   
 
9
   This is mostly for the support scripts which make sure that the
 
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
   
 
17
** Libraries
 
18
   
 
19
   The following libraries and packages are needed.  (It is possible
 
20
   that it might work with older versions of some of these, but these
 
21
   versions are confirmed to work.  Newer versions are almost
 
22
   certainly OK.)
 
23
   
 
24
*** Documentation
 
25
    These are required to build the manual pages for both the server
 
26
    and client:
 
27
    
 
28
    + DocBook 4.5         http://www.docbook.org/
 
29
      Note: DocBook 5.0 is not compatible.
 
30
    + DocBook XSL stylesheets 1.71.0
 
31
                         http://wiki.docbook.org/DocBookXslStylesheets
 
32
    
 
33
    Package names:
 
34
    docbook docbook-xsl
 
35
    
 
36
    To build just the documentation, run the command "make doc".  Then
 
37
    the manual page "mandos.8", for example, can be read by running
 
38
    "man -l mandos.8".
 
39
    
 
40
*** Mandos Server
 
41
    + GnuTLS 2.4          http://www.gnutls.org/
 
42
      Note: GnuTLS 3 will only work with Python-GnuTLS 2
 
43
    + Avahi 0.6.16        http://www.avahi.org/
 
44
    + Python 2.7          https://www.python.org/
 
45
    + Python-GnuTLS 1.1.5 https://pypi.python.org/pypi/python-gnutls/
 
46
    + 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
    + Urwid 1.0.1         http://urwid.org/
 
50
      (Only needed by the "mandos-monitor" tool.)
 
51
    
 
52
    Strongly recommended:
 
53
    + fping 2.4b2-to-ipv6      http://www.fping.org/
 
54
    + ssh-keyscan from OpenSSH http://www.openssh.com/
 
55
    
 
56
    Package names:
 
57
    python-gnutls avahi-daemon python python-avahi python-dbus
 
58
    python-gobject python-urwid pkg-config fping ssh-client
 
59
    
 
60
*** Mandos Client
 
61
    + initramfs-tools 0.85i
 
62
                        https://tracker.debian.org/pkg/initramfs-tools
 
63
    + GnuTLS 2.4        http://www.gnutls.org/
 
64
    + Avahi 0.6.16      http://www.avahi.org/
 
65
    + GnuPG 1.4.9       https://www.gnupg.org/
 
66
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
 
67
    + pkg-config  http://www.freedesktop.org/wiki/Software/pkg-config/
 
68
    
 
69
    Strongly recommended:
 
70
    + OpenSSH           http://www.openssh.com/
 
71
    
 
72
    Package names:
 
73
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
 
74
    libgpgme11-dev pkg-config ssh
 
75
 
 
76
* Installing the Mandos server
 
77
  
 
78
  1. Do "make doc".
 
79
  
 
80
  2. On the computer to run as a Mandos server, run the following
 
81
     command:
 
82
     For Debian: su -c 'make install-server'
 
83
     For Ubuntu: sudo make install-server
 
84
     
 
85
     (This creates a configuration without any clients configured; you
 
86
     need an actually configured client to do that; see below.)
 
87
 
 
88
* Installing the Mandos client.
 
89
  
 
90
  1. Do "make all doc".
 
91
  
 
92
  2. On the computer to run as a Mandos client, run the following
 
93
     command:
 
94
     For Debian: su -c 'make install-client'
 
95
     For Ubuntu: sudo make install-client
 
96
     
 
97
     This will also create an OpenPGP key, which will take some time
 
98
     and entropy, so be patient.
 
99
  
 
100
  3. Run the following command:
 
101
     For Debian: su -c 'mandos-keygen --password'
 
102
     For Ubuntu: sudo mandos-keygen --password
 
103
     
 
104
     When prompted, enter the password/passphrase for the encrypted
 
105
     root file system on this client computer.  The command will
 
106
     output a section of text, starting with a [section header].  Copy
 
107
     and append this to the file "/etc/mandos/clients.conf" *on the
 
108
     server computer*.
 
109
  
 
110
  4. Configure the client to use any special configuration needed for
 
111
     your local system.  Note: This is not necessary if the server is
 
112
     present on the same wired local network as the client.  If you do
 
113
     make changes to /etc/mandos/plugin-runner.conf, the initrd.img
 
114
     file must be updated, possibly using the following command:
 
115
     
 
116
        # update-initramfs -k all -u
 
117
  
 
118
  5. On the server computer, start the server by running the command
 
119
     For Debian: su -c 'invoke-rc.d mandos start'
 
120
     For Ubuntu: sudo service mandos start
 
121
     
 
122
     At this point, it is possible to verify that the correct password
 
123
     will be received by the client by running the command:
 
124
     
 
125
        # /usr/lib/mandos/plugins.d/mandos-client \
 
126
                --pubkey=/etc/keys/mandos/pubkey.txt \
 
127
                --seckey=/etc/keys/mandos/seckey.txt; echo
 
128
     
 
129
     This command should retrieve the password from the server,
 
130
     decrypt it, and output it to standard output.
 
131
     
 
132
     After this, the client computer should be able to reboot without
 
133
     needing a password entered on the console, as long as it does not
 
134
     take more than five minutes to reboot.
 
135
 
 
136
* Further customizations
 
137
  
 
138
  You may want to tighten or loosen the timeouts in the server
 
139
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
 
140
  If IPsec is not used and SSH is not installed, it is suggested that
 
141
  a more cryptographically secure checker program is used and
 
142
  configured, since, without IPsec, ping packets can be faked.
 
143
 
 
144
#+STARTUP: showall