/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk
179 by Teddy Hogeborn
* INSTALL: New file.
1
-*- org -*-
2
3
* Prerequisites
4
  
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
5
** Operating System
6
   
801 by Teddy Hogeborn
Stop using python-gnutls. Use GnuTLS 3.3 or later directly.
7
   Debian 8.0 "jessie" or Ubuntu 15.10 "Wily Werewolf" (or later).
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
8
   
181 by Teddy Hogeborn
* INSTALL: Even better text.
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
719 by Teddy Hogeborn
Update non-package install instructions.
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.
618 by Teddy Hogeborn
* mandos: Bug fix: Make boolean options work from the config file
16
   
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
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/
181 by Teddy Hogeborn
* INSTALL: Even better text.
29
      Note: DocBook 5.0 is not compatible.
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
30
    + DocBook XSL stylesheets 1.71.0
719 by Teddy Hogeborn
Update non-package install instructions.
31
                         http://wiki.docbook.org/DocBookXslStylesheets
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
32
    
33
    Package names:
34
    docbook docbook-xsl
181 by Teddy Hogeborn
* INSTALL: Even better text.
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".
618 by Teddy Hogeborn
* mandos: Bug fix: Make boolean options work from the config file
39
    
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
40
*** Mandos Server
801 by Teddy Hogeborn
Stop using python-gnutls. Use GnuTLS 3.3 or later directly.
41
    + GnuTLS 3.3          http://www.gnutls.org/
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
42
    + Avahi 0.6.16        http://www.avahi.org/
723.1.1 by Teddy Hogeborn
Require Python 2.7.
43
    + Python 2.7          https://www.python.org/
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
44
    + dbus-python 0.82.4  http://dbus.freedesktop.org/doc/dbus-python/
719 by Teddy Hogeborn
Update non-package install instructions.
45
    + PyGObject 2.14.2    https://developer.gnome.org/pygobject/
46
    + pkg-config  http://www.freedesktop.org/wiki/Software/pkg-config/
47
    + Urwid 1.0.1         http://urwid.org/
48
      (Only needed by the "mandos-monitor" tool.)
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
49
    
50
    Strongly recommended:
719 by Teddy Hogeborn
Update non-package install instructions.
51
    + fping 2.4b2-to-ipv6      http://www.fping.org/
708 by Teddy Hogeborn
mandos-keygen: Generate "checker" option to use SSH fingerprints.
52
    + ssh-keyscan from OpenSSH http://www.openssh.com/
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
53
    
54
    Package names:
801 by Teddy Hogeborn
Stop using python-gnutls. Use GnuTLS 3.3 or later directly.
55
    avahi-daemon python python-avahi python-dbus python-gobject
56
    python-urwid pkg-config fping ssh-client
618 by Teddy Hogeborn
* mandos: Bug fix: Make boolean options work from the config file
57
    
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
58
*** Mandos Client
810 by Teddy Hogeborn
Depend on the GNU C Library 2.16 or later
59
    + GNU C Library 2.16 https://gnu.org/software/libc/
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
60
    + initramfs-tools 0.85i
719 by Teddy Hogeborn
Update non-package install instructions.
61
                        https://tracker.debian.org/pkg/initramfs-tools
801 by Teddy Hogeborn
Stop using python-gnutls. Use GnuTLS 3.3 or later directly.
62
    + GnuTLS 3.3        http://www.gnutls.org/
719 by Teddy Hogeborn
Update non-package install instructions.
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  http://www.freedesktop.org/wiki/Software/pkg-config/
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
67
    
708 by Teddy Hogeborn
mandos-keygen: Generate "checker" option to use SSH fingerprints.
68
    Strongly recommended:
719 by Teddy Hogeborn
Update non-package install instructions.
69
    + OpenSSH           http://www.openssh.com/
708 by Teddy Hogeborn
mandos-keygen: Generate "checker" option to use SSH fingerprints.
70
    
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
71
    Package names:
72
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
719 by Teddy Hogeborn
Update non-package install instructions.
73
    libgpgme11-dev pkg-config ssh
179 by Teddy Hogeborn
* INSTALL: New file.
74
75
* Installing the Mandos server
76
  
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
77
  1. Do "make doc".
179 by Teddy Hogeborn
* INSTALL: New file.
78
  
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
79
  2. On the computer to run as a Mandos server, run the following
181 by Teddy Hogeborn
* INSTALL: Even better text.
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
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
85
     need an actually configured client to do that; see below.)
179 by Teddy Hogeborn
* INSTALL: New file.
86
87
* Installing the Mandos client.
88
  
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
89
  1. Do "make all doc".
90
  
91
  2. On the computer to run as a Mandos client, run the following
181 by Teddy Hogeborn
* INSTALL: Even better text.
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.
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
98
  
181 by Teddy Hogeborn
* INSTALL: Even better text.
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*.
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
108
  
719 by Teddy Hogeborn
Update non-package install instructions.
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:
228 by Teddy Hogeborn
* INSTALL: Add instructions on how to set the correct network
114
     
115
	# update-initramfs -k all -u
116
  
117
  5. On the server computer, start the server by running the command
181 by Teddy Hogeborn
* INSTALL: Even better text.
118
     For Debian: su -c 'invoke-rc.d mandos start'
472 by Teddy Hogeborn
* INSTALL: Updated.
119
     For Ubuntu: sudo service mandos start
181 by Teddy Hogeborn
* INSTALL: Even better text.
120
     
228 by Teddy Hogeborn
* INSTALL: Add instructions on how to set the correct network
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
     
181 by Teddy Hogeborn
* INSTALL: Even better text.
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
719 by Teddy Hogeborn
Update non-package install instructions.
133
     take more than five minutes to reboot.
179 by Teddy Hogeborn
* INSTALL: New file.
134
135
* Further customizations
136
  
137
  You may want to tighten or loosen the timeouts in the server
138
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
708 by Teddy Hogeborn
mandos-keygen: Generate "checker" option to use SSH fingerprints.
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.
723 by Teddy Hogeborn
INSTALL: Add org-mode setting to show all text when opening.
142

143
#+STARTUP: showall