/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: 2024-09-08 00:08:15 UTC
  • mto: This revision was merged to the branch mainline in revision 410.
  • Revision ID: teddy@recompile.se-20240908000815-x3gr5xion3kyyoio
Improve documentation

* mandos.conf.xml (DESCRIPTION): Remove the unnecessary word "simple".
* plugin-runner.xml (PLUGINS): Remove the unnecessary word "simply",
  and add the "executable" qualifier to the description of plugins.
* mandos-client.xml (DESCRIPTION, OPTIONS): Do not refer to
  "plugin-runner"; instead refer to the section "OVERVIEW".
  (OVERVIEW): Don't only describe plugin-runner; also describe
  how password-agent can start mandos-client.
  (EXAMPLE): Do not refer to "plugin-runner"; instead refer to the
  section "OVERVIEW".
  (SEE ALSO): Replace reference to "password-prompt" with
  "password-agent".

Show diffs side-by-side

added added

removed removed

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