/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to INSTALL

  • Committer: Teddy Hogeborn
  • Date: 2018-08-19 14:58:40 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 368.
  • Revision ID: teddy@recompile.se-20180819145840-s1a3xar41lyoq4ty
Set executable permissions on new files

* initramfs-tools-script-stop: Did "chmod +x".
* mandos-to-cryptroot-unlock: - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
  
5
5
** Operating System
6
6
   
7
 
   Debian 5.0 "lenny" or Ubuntu 8.04 "Hardy Heron".
8
 
   
9
 
   This is mostly for scripts to make sure that the client is
10
 
   installed and started in the initial RAM disk environment and that
11
 
   the initrd.img file is automatically made unreadable.  The programs
12
 
   themselves *could* be run in other distributions, but they *are*
13
 
   specific to GNU/Linux systems, and not intended to be portable to
14
 
   other Unix systems.
15
 
  
 
7
   Debian 8.0 "jessie" or Ubuntu 15.10 "Wily Werewolf" (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
   
16
17
** Libraries
17
18
   
18
19
   The following libraries and packages are needed.  (It is possible
25
26
    and client:
26
27
    
27
28
    + DocBook 4.5         http://www.docbook.org/
 
29
      Note: DocBook 5.0 is not compatible.
28
30
    + DocBook XSL stylesheets 1.71.0
29
 
                   http://wiki.docbook.org/topic/DocBookXslStylesheets
 
31
                         http://wiki.docbook.org/DocBookXslStylesheets
30
32
    
31
33
    Package names:
32
34
    docbook docbook-xsl
33
 
   
 
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
    
34
40
*** Mandos Server
35
 
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
 
41
    + GnuTLS 3.3          https://www.gnutls.org/
36
42
    + Avahi 0.6.16        http://www.avahi.org/
37
 
    + Python 2.4          http://www.python.org/
38
 
    + Python-GnuTLS 1.1.5 http://pypi.python.org/pypi/python-gnutls/
39
 
    + dbus-python 0.82.4  http://dbus.freedesktop.org/doc/dbus-python/
40
 
    + python-ctypes 1.0.0 http://pypi.python.org/pypi/ctypes
 
43
    + Python 2.7          https://www.python.org/
 
44
    + dbus-python 0.82.4 https://dbus.freedesktop.org/doc/dbus-python/
 
45
    + PyGObject 3.7.1     https://wiki.gnome.org/Projects/PyGObject
 
46
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
 
47
    + Urwid 1.0.1         http://urwid.org/
 
48
      (Only needed by the "mandos-monitor" tool.)
41
49
    
42
50
    Strongly recommended:
43
 
    + fping 2.4b2-to-ipv6 http://www.fping.com/
 
51
    + fping 2.4b2-to-ipv6      http://www.fping.org/
 
52
    + ssh-keyscan from OpenSSH http://www.openssh.com/
44
53
    
45
54
    Package names:
46
 
    python-gnutls avahi-daemon python2.5 python-avahi python-dbus
47
 
    python-ctypes
48
 
   
 
55
    avahi-daemon python python-dbus python-gi python-urwid pkg-config
 
56
    fping ssh-client
 
57
    
49
58
*** Mandos Client
 
59
    + GNU C Library 2.16 https://gnu.org/software/libc/
50
60
    + initramfs-tools 0.85i
51
 
                  http://packages.qa.debian.org/i/initramfs-tools.html
52
 
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
53
 
    + Avahi 0.6.16        http://www.avahi.org/
54
 
    + GnuPG 1.4.9         http://www.gnupg.org/
55
 
    + GPGME 1.1.6         http://www.gnupg.org/related_software/gpgme/
 
61
                        https://tracker.debian.org/pkg/initramfs-tools
 
62
    + GnuTLS 3.3        https://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 https://www.freedesktop.org/wiki/Software/pkg-config/
 
67
    
 
68
    Strongly recommended:
 
69
    + OpenSSH           http://www.openssh.com/
56
70
    
57
71
    Package names:
58
72
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
59
 
    libgpgme11-dev
 
73
    libgpgme11-dev pkg-config ssh
60
74
 
61
75
* Installing the Mandos server
62
76
  
63
77
  1. Do "make doc".
64
78
  
65
79
  2. On the computer to run as a Mandos server, run the following
66
 
     command: "sudo make install-server".
67
 
    
68
 
     (This creates a configuration without any clients configured; we
 
80
     command:
 
81
     For Debian: su -c 'make install-server'
 
82
     For Ubuntu: sudo make install-server
 
83
     
 
84
     (This creates a configuration without any clients configured; you
69
85
     need an actually configured client to do that; see below.)
70
86
 
71
87
* Installing the Mandos client.
73
89
  1. Do "make all doc".
74
90
  
75
91
  2. On the computer to run as a Mandos client, run the following
76
 
     command: "sudo make install-client".  This will also create an
77
 
     OpenPGP key, which will take some time and entropy, so either
78
 
     wait patiently or frob your mouse until it's done.
79
 
  
80
 
  3. Run "mandos-keygen --password".  When prompted, enter the
81
 
     password/passphrase for the encrypted root file system on this
82
 
     client computer.  It will output a section of text, starting with
83
 
     a [section header].  Copy and paste this into the file
84
 
     "/etc/mandos/clients.conf" *on the server computer*.
85
 
  
86
 
  4. On the server computer, start the server by running the command
87
 
     "invoke-rc.d mandos start".
 
92
     command:
 
93
     For Debian: su -c 'make install-client'
 
94
     For Ubuntu: sudo make install-client
 
95
     
 
96
     This will also create an OpenPGP key, which will take some time
 
97
     and entropy, so be patient.
 
98
  
 
99
  3. Run the following command:
 
100
     For Debian: su -c 'mandos-keygen --password'
 
101
     For Ubuntu: sudo mandos-keygen --password
 
102
     
 
103
     When prompted, enter the password/passphrase for the encrypted
 
104
     root file system on this client computer.  The command will
 
105
     output a section of text, starting with a [section header].  Copy
 
106
     and append this to the file "/etc/mandos/clients.conf" *on the
 
107
     server computer*.
 
108
  
 
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
 
118
     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.
 
130
     
 
131
     After this, the client computer should be able to reboot without
 
132
     needing a password entered on the console, as long as it does not
 
133
     take more than five minutes to reboot.
88
134
 
89
135
* Further customizations
90
136
  
91
137
  You may want to tighten or loosen the timeouts in the server
92
138
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
93
 
  Is IPsec is not used, it is suggested that a more cryptographically
94
 
  secure checker program is used and configured, since without IPsec
95
 
  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.
 
142
 
 
143
#+STARTUP: showall