/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: 2024-09-16 21:01:52 UTC
  • Revision ID: teddy@recompile.se-20240916210152-0xbv4b15jyho9ydk
Override lintian experimental tag "executable-in-usr-lib"

Lintian reports executable files in /usr/lib, since binaries which are
executed internally are supposed to be stored in /usr/libexec.  But
the executables we store in /usr/lib are all files to be copied into
the initial RAM disk image, and are never executed from their storage
location in /usr/lib.  Except one; the Dracut module-setup.sh file.
But that file seems to be required to be executable; the
module-setup.sh file of every other Dracut module is also an
executable file.

* debian/mandos-client.lintian-overrides: Override experimental tag
  "executable-in-usr-lib" about files which are not actually executed
  from this location, and only exist to be copied to the initial RAM
  disk image.  Also the Dracut module-setup.sh file, which merely
  follows the pattern of all other Dracut module-setup.sh files from
  other Dracut modules.

Show diffs side-by-side

added added

removed removed

Lines of Context:
INSTALL
4
4
  
5
5
** Operating System
6
6
   
7
 
   Debian 6.0 "squeeze" or Ubuntu 10.10 "Maverick Meerkat" (or later).
 
7
   Debian 8.0 "jessie" or Ubuntu 15.10 "Wily Werewolf" (or later).
8
8
   
9
9
   This is mostly for the support scripts which make sure that the
10
10
   client is installed and started in the initial RAM disk environment
38
38
    "man -l mandos.8".
39
39
    
40
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.6          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
 
    + Python-argparse     https://pypi.python.org/pypi/argparse
 
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 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.
 
48
    + dbus-python 0.82.4 https://dbus.freedesktop.org/doc/dbus-python/
 
49
    + PyGObject 3.8      https://wiki.gnome.org/Projects/PyGObject
 
50
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
50
51
    + Urwid 1.0.1         http://urwid.org/
51
52
      (Only needed by the "mandos-monitor" tool.)
52
53
    
55
56
    + ssh-keyscan from OpenSSH http://www.openssh.com/
56
57
    
57
58
    Package names:
58
 
    python-gnutls avahi-daemon python python-avahi python-dbus
59
 
    python-gobject python-urwid pkg-config fping ssh-client
 
59
    avahi-daemon python3 python3-dbus python3-gi python3-urwid
 
60
    pkg-config fping ssh-client
60
61
    
61
62
*** Mandos Client
 
63
    + GNU C Library 2.17 https://gnu.org/software/libc/
 
64
    + GnuTLS 3.3        https://www.gnutls.org/
 
65
      (but not 3.6.0 or later, until 3.6.6 which works)
 
66
    + Avahi 0.6.16      https://www.avahi.org/
 
67
    + GnuPG 1.4.9       https://www.gnupg.org/
 
68
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
 
69
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
 
70
    + libnl-route 3     https://www.infradead.org/~tgr/libnl/
 
71
    + GLib 2.40         http://www.gtk.org/
 
72
    
 
73
    One of:
62
74
    + initramfs-tools 0.85i
63
75
                        https://tracker.debian.org/pkg/initramfs-tools
64
 
    + GnuTLS 2.4        http://www.gnutls.org/
65
 
    + Avahi 0.6.16      http://www.avahi.org/
66
 
    + GnuPG 1.4.9       https://www.gnupg.org/
67
 
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
68
 
    + pkg-config  http://www.freedesktop.org/wiki/Software/pkg-config/
 
76
    + dracut 044+241
 
77
         http://www.kernel.org/pub/linux/utils/boot/dracut/dracut.html
69
78
    
70
79
    Strongly recommended:
71
80
    + OpenSSH           http://www.openssh.com/
72
81
    
73
82
    Package names:
74
 
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
75
 
    libgpgme11-dev pkg-config ssh
 
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
76
86
 
77
87
* Installing the Mandos server
78
88
  
80
90
  
81
91
  2. On the computer to run as a Mandos server, run the following
82
92
     command:
83
 
     For Debian: su -c 'make install-server'
 
93
     For Debian: su - -c 'make install-server'
84
94
     For Ubuntu: sudo make install-server
85
95
     
86
96
     (This creates a configuration without any clients configured; you
92
102
  
93
103
  2. On the computer to run as a Mandos client, run the following
94
104
     command:
95
 
     For Debian: su -c 'make install-client'
 
105
     For Debian: su - -c 'make install-client'
96
106
     For Ubuntu: sudo make install-client
97
107
     
98
108
     This will also create an OpenPGP key, which will take some time
99
109
     and entropy, so be patient.
100
110
  
101
111
  3. Run the following command:
102
 
     For Debian: su -c 'mandos-keygen --password'
 
112
     For Debian: su - -c 'mandos-keygen --password'
103
113
     For Ubuntu: sudo mandos-keygen --password
104
114
     
105
115
     When prompted, enter the password/passphrase for the encrypted
117
127
        # update-initramfs -k all -u
118
128
  
119
129
  5. On the server computer, start the server by running the command
120
 
     For Debian: su -c 'invoke-rc.d mandos start'
 
130
     For Debian: su - -c 'invoke-rc.d mandos start'
121
131
     For Ubuntu: sudo service mandos start
122
132
     
123
133
     At this point, it is possible to verify that the correct password
125
135
     
126
136
        # /usr/lib/mandos/plugins.d/mandos-client \
127
137
                --pubkey=/etc/keys/mandos/pubkey.txt \
128
 
                --seckey=/etc/keys/mandos/seckey.txt; echo
 
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
129
141
     
130
142
     This command should retrieve the password from the server,
131
143
     decrypt it, and output it to standard output.
141
153
  If IPsec is not used and SSH is not installed, it is suggested that
142
154
  a more cryptographically secure checker program is used and
143
155
  configured, since, without IPsec, ping packets can be faked.
 
156
 
 
157
#+STARTUP: showall