/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: 2022-04-23 21:24:26 UTC
  • mto: This revision was merged to the branch mainline in revision 406.
  • Revision ID: teddy@recompile.se-20220423212426-b30ysw54gtpacvny
Server: Fix minor style issue

* mandos: Consistently use double quotes instead of single quotes.

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.7          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/
 
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/
49
51
    + Urwid 1.0.1         http://urwid.org/
50
52
      (Only needed by the "mandos-monitor" tool.)
51
53
    
54
56
    + ssh-keyscan from OpenSSH http://www.openssh.com/
55
57
    
56
58
    Package names:
57
 
    python-gnutls avahi-daemon python python-avahi python-dbus
58
 
    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
59
61
    
60
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:
61
74
    + initramfs-tools 0.85i
62
75
                        https://tracker.debian.org/pkg/initramfs-tools
63
 
    + GnuTLS 2.4        http://www.gnutls.org/
64
 
    + Avahi 0.6.16      http://www.avahi.org/
65
 
    + GnuPG 1.4.9       https://www.gnupg.org/
66
 
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
67
 
    + 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
68
78
    
69
79
    Strongly recommended:
70
80
    + OpenSSH           http://www.openssh.com/
71
81
    
72
82
    Package names:
73
 
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
74
 
    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
75
86
 
76
87
* Installing the Mandos server
77
88
  
79
90
  
80
91
  2. On the computer to run as a Mandos server, run the following
81
92
     command:
82
 
     For Debian: su -c 'make install-server'
 
93
     For Debian: su - -c 'make install-server'
83
94
     For Ubuntu: sudo make install-server
84
95
     
85
96
     (This creates a configuration without any clients configured; you
91
102
  
92
103
  2. On the computer to run as a Mandos client, run the following
93
104
     command:
94
 
     For Debian: su -c 'make install-client'
 
105
     For Debian: su - -c 'make install-client'
95
106
     For Ubuntu: sudo make install-client
96
107
     
97
108
     This will also create an OpenPGP key, which will take some time
98
109
     and entropy, so be patient.
99
110
  
100
111
  3. Run the following command:
101
 
     For Debian: su -c 'mandos-keygen --password'
 
112
     For Debian: su - -c 'mandos-keygen --password'
102
113
     For Ubuntu: sudo mandos-keygen --password
103
114
     
104
115
     When prompted, enter the password/passphrase for the encrypted
116
127
        # update-initramfs -k all -u
117
128
  
118
129
  5. On the server computer, start the server by running the command
119
 
     For Debian: su -c 'invoke-rc.d mandos start'
 
130
     For Debian: su - -c 'invoke-rc.d mandos start'
120
131
     For Ubuntu: sudo service mandos start
121
132
     
122
133
     At this point, it is possible to verify that the correct password
124
135
     
125
136
        # /usr/lib/mandos/plugins.d/mandos-client \
126
137
                --pubkey=/etc/keys/mandos/pubkey.txt \
127
 
                --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
128
141
     
129
142
     This command should retrieve the password from the server,
130
143
     decrypt it, and output it to standard output.