/mandos/trunk

To get this branch, use:
bzr branch /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
868 by Teddy Hogeborn
Change all http:// URLs to https:// wherever possible.
41
    + GnuTLS 3.3          https://www.gnutls.org/
962 by Teddy Hogeborn
Add support for using raw public keys in TLS (RFC 7250)
42
      (but not 3.6.0 or later, until 3.6.6, which works)
1121 by Teddy Hogeborn
Change URL for Avahi to use HTTPS
43
    + Avahi 0.6.16        https://www.avahi.org/
1171 by Teddy Hogeborn
Use Python 3 by default
44
    + Python 3           https://www.python.org/
45
      Note: Python 2.7 is still supported, if the "mandos",
46
      "mandos-ctl", and "mandos-monitor" files are edited to contain
47
      "#!/usr/bin/python" instead of python3.
868 by Teddy Hogeborn
Change all http:// URLs to https:// wherever possible.
48
    + dbus-python 0.82.4 https://dbus.freedesktop.org/doc/dbus-python/
1167 by Teddy Hogeborn
Server: Use new GLib.io_add_watch() call signature
49
    + PyGObject 3.8      https://wiki.gnome.org/Projects/PyGObject
868 by Teddy Hogeborn
Change all http:// URLs to https:// wherever possible.
50
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
719 by Teddy Hogeborn
Update non-package install instructions.
51
    + Urwid 1.0.1         http://urwid.org/
52
      (Only needed by the "mandos-monitor" tool.)
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
53
    
54
    Strongly recommended:
719 by Teddy Hogeborn
Update non-package install instructions.
55
    + fping 2.4b2-to-ipv6      http://www.fping.org/
708 by Teddy Hogeborn
mandos-keygen: Generate "checker" option to use SSH fingerprints.
56
    + ssh-keyscan from OpenSSH http://www.openssh.com/
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
57
    
58
    Package names:
1171 by Teddy Hogeborn
Use Python 3 by default
59
    avahi-daemon python3 python3-dbus python3-gi python3-urwid
60
    pkg-config fping ssh-client
618 by Teddy Hogeborn
* mandos: Bug fix: Make boolean options work from the config file
61
    
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
62
*** Mandos Client
1114 by Teddy Hogeborn
Stop linking to librt
63
    + GNU C Library 2.17 https://gnu.org/software/libc/
868 by Teddy Hogeborn
Change all http:// URLs to https:// wherever possible.
64
    + GnuTLS 3.3        https://www.gnutls.org/
962 by Teddy Hogeborn
Add support for using raw public keys in TLS (RFC 7250)
65
      (but not 3.6.0 or later, until 3.6.6 which works)
1121 by Teddy Hogeborn
Change URL for Avahi to use HTTPS
66
    + Avahi 0.6.16      https://www.avahi.org/
719 by Teddy Hogeborn
Update non-package install instructions.
67
    + GnuPG 1.4.9       https://www.gnupg.org/
68
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
868 by Teddy Hogeborn
Change all http:// URLs to https:// wherever possible.
69
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
1118 by Teddy Hogeborn
Client: Document requirement of libnl-route library
70
    + libnl-route 3     https://www.infradead.org/~tgr/libnl/
1127 by Teddy Hogeborn
Add dracut(8) support
71
    + GLib 2.40         http://www.gtk.org/
72
    
73
    One of:
74
    + initramfs-tools 0.85i
75
                        https://tracker.debian.org/pkg/initramfs-tools
76
    + dracut 044+241
77
         http://www.kernel.org/pub/linux/utils/boot/dracut/dracut.html
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
78
    
708 by Teddy Hogeborn
mandos-keygen: Generate "checker" option to use SSH fingerprints.
79
    Strongly recommended:
719 by Teddy Hogeborn
Update non-package install instructions.
80
    + OpenSSH           http://www.openssh.com/
708 by Teddy Hogeborn
mandos-keygen: Generate "checker" option to use SSH fingerprints.
81
    
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
82
    Package names:
1127 by Teddy Hogeborn
Add dracut(8) support
83
    initramfs-tools dracut libgnutls-dev gnutls-bin libavahi-core-dev
84
    gnupg libgpgme11-dev pkg-config ssh libnl-route-3-dev
85
    libglib2.0-dev
179 by Teddy Hogeborn
* INSTALL: New file.
86
87
* Installing the Mandos server
88
  
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
89
  1. Do "make doc".
179 by Teddy Hogeborn
* INSTALL: New file.
90
  
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
91
  2. On the computer to run as a Mandos server, run the following
181 by Teddy Hogeborn
* INSTALL: Even better text.
92
     command:
93
     For Debian: su -c 'make install-server'
94
     For Ubuntu: sudo make install-server
95
     
96
     (This creates a configuration without any clients configured; you
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
97
     need an actually configured client to do that; see below.)
179 by Teddy Hogeborn
* INSTALL: New file.
98
99
* Installing the Mandos client.
100
  
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
101
  1. Do "make all doc".
102
  
103
  2. On the computer to run as a Mandos client, run the following
181 by Teddy Hogeborn
* INSTALL: Even better text.
104
     command:
105
     For Debian: su -c 'make install-client'
106
     For Ubuntu: sudo make install-client
107
     
108
     This will also create an OpenPGP key, which will take some time
109
     and entropy, so be patient.
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
110
  
181 by Teddy Hogeborn
* INSTALL: Even better text.
111
  3. Run the following command:
112
     For Debian: su -c 'mandos-keygen --password'
113
     For Ubuntu: sudo mandos-keygen --password
114
     
115
     When prompted, enter the password/passphrase for the encrypted
116
     root file system on this client computer.  The command will
117
     output a section of text, starting with a [section header].  Copy
118
     and append this to the file "/etc/mandos/clients.conf" *on the
119
     server computer*.
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
120
  
719 by Teddy Hogeborn
Update non-package install instructions.
121
  4. Configure the client to use any special configuration needed for
122
     your local system.  Note: This is not necessary if the server is
123
     present on the same wired local network as the client.  If you do
124
     make changes to /etc/mandos/plugin-runner.conf, the initrd.img
125
     file must be updated, possibly using the following command:
228 by Teddy Hogeborn
* INSTALL: Add instructions on how to set the correct network
126
     
127
	# update-initramfs -k all -u
128
  
129
  5. On the server computer, start the server by running the command
181 by Teddy Hogeborn
* INSTALL: Even better text.
130
     For Debian: su -c 'invoke-rc.d mandos start'
472 by Teddy Hogeborn
* INSTALL: Updated.
131
     For Ubuntu: sudo service mandos start
181 by Teddy Hogeborn
* INSTALL: Even better text.
132
     
228 by Teddy Hogeborn
* INSTALL: Add instructions on how to set the correct network
133
     At this point, it is possible to verify that the correct password
134
     will be received by the client by running the command:
135
     
136
	# /usr/lib/mandos/plugins.d/mandos-client \
137
		--pubkey=/etc/keys/mandos/pubkey.txt \
962 by Teddy Hogeborn
Add support for using raw public keys in TLS (RFC 7250)
138
		--seckey=/etc/keys/mandos/seckey.txt \
139
		--tls-privkey=/etc/keys/mandos/tls-privkey.pem \
140
		--tls-pubkey=/etc/keys/mandos/tls-pubkey.pem; echo
228 by Teddy Hogeborn
* INSTALL: Add instructions on how to set the correct network
141
     
142
     This command should retrieve the password from the server,
143
     decrypt it, and output it to standard output.
144
     
181 by Teddy Hogeborn
* INSTALL: Even better text.
145
     After this, the client computer should be able to reboot without
146
     needing a password entered on the console, as long as it does not
719 by Teddy Hogeborn
Update non-package install instructions.
147
     take more than five minutes to reboot.
179 by Teddy Hogeborn
* INSTALL: New file.
148
149
* Further customizations
150
  
151
  You may want to tighten or loosen the timeouts in the server
152
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
708 by Teddy Hogeborn
mandos-keygen: Generate "checker" option to use SSH fingerprints.
153
  If IPsec is not used and SSH is not installed, it is suggested that
154
  a more cryptographically secure checker program is used and
155
  configured, since, without IPsec, ping packets can be faked.
723 by Teddy Hogeborn
INSTALL: Add org-mode setting to show all text when opening.
156

157
#+STARTUP: showall