/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: 2019-08-01 17:35:45 UTC
  • Revision ID: teddy@recompile.se-20190801173545-swvm0c6e1e00qdwi
password-agent: Fix memory alignment issue

On many architectures (armel, armhf, mips, mips64el, mipsel, hppa,
ia64, sh4, and sparc64) GCC shows a warning when casting a "char *" to
a "struct inotify_event *"; The exact warning message from GCC is
"cast increases required alignment of target type [-Wcast-align]".

* dracut-module/password-agent.c (read_inotify_event): Change
  "ievent_buffer" to an anonymous struct instead of a char array.
  (test_read_inotify_event_IN_CLOSE_WRITE): - '' -
  (test_read_inotify_event_IN_MOVED_TO): - '' -
  (test_read_inotify_event_IN_DELETE): - '' -
  (test_read_inotify_event_IN_CLOSE_WRITE_badname): - '' -
  (test_read_inotify_event_IN_MOVED_TO_badname): - '' -
  (test_read_inotify_event_IN_DELETE_badname): - '' -

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