/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: 2015-06-28 16:35:27 UTC
  • mto: This revision was merged to the branch mainline in revision 759.
  • Revision ID: teddy@recompile.se-20150628163527-cky0ec59zew7teua
Add a plugin helper directory, available to all plugins.

* Makefile (PLUGIN_HELPERS): New; list of plugin helpers.
  (CPROGS): Appended "$(PLUGIN_HELPERS)".
* initramfs-tools-hook: Create new plugin helper directory, and copy
                        plugin helpers provided by the system and/or
                        by the local administrator.
  (PLUGINHELPERDIR): New.
* plugin-runner.c: Take new --plugin-helper-dir option and provide
                   environment variable to all plugins.
  (PHDIR): New; set to "/lib/mandos/plugin-helpers".
  (main/pluginhelperdir): New.
  (main/options): New option "--plugin-helper-dir".
  (main/parse_opt, main/parse_opt_config_file): Accept new option.
  (main): Use new option to set MANDOSPLUGINHELPERDIR environment
          variable as if using --global-env MANDOSPLUGINHELPERDIR=...
* plugin-runner.xml: Document new --plugin-helper-dir option.
  (SYNOPSIS, OPTIONS): Add "--plugin-helper-dir" option.
  (PLUGINS/WRITING PLUGINS): Document new environment variable
                             available to plugins.
  (ENVIRONMENT): Document new environment variable
                 "MANDOSPLUGINHELPERDIR" affected by the new
                 --plugin-helper-dir option.

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
  
5
5
** Operating System
6
6
   
7
 
   Debian 8.0 "jessie" or Ubuntu 15.10 "Wily Werewolf" (or later).
 
7
   Debian 6.0 "squeeze" or Ubuntu 10.10 "Maverick Meerkat" (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 3.3          https://www.gnutls.org/
42
 
      (but not 3.6.0 or later, until 3.6.6, which works)
 
41
    + GnuTLS 2.4          http://www.gnutls.org/
 
42
      Note: GnuTLS 3 will only work with Python-GnuTLS 2
43
43
    + Avahi 0.6.16        http://www.avahi.org/
44
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/
 
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/
48
49
    + Urwid 1.0.1         http://urwid.org/
49
50
      (Only needed by the "mandos-monitor" tool.)
50
51
    
53
54
    + ssh-keyscan from OpenSSH http://www.openssh.com/
54
55
    
55
56
    Package names:
56
 
    avahi-daemon python python-dbus python-gi python-urwid pkg-config
57
 
    fping ssh-client
 
57
    python-gnutls avahi-daemon python python-avahi python-dbus
 
58
    python-gobject python-urwid pkg-config fping ssh-client
58
59
    
59
60
*** Mandos Client
60
 
    + GNU C Library 2.17 https://gnu.org/software/libc/
61
61
    + initramfs-tools 0.85i
62
62
                        https://tracker.debian.org/pkg/initramfs-tools
63
 
    + GnuTLS 3.3        https://www.gnutls.org/
64
 
      (but not 3.6.0 or later, until 3.6.6 which works)
 
63
    + GnuTLS 2.4        http://www.gnutls.org/
65
64
    + Avahi 0.6.16      http://www.avahi.org/
66
65
    + GnuPG 1.4.9       https://www.gnupg.org/
67
66
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
68
 
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
69
 
    + libnl-route 3     https://www.infradead.org/~tgr/libnl/
 
67
    + pkg-config  http://www.freedesktop.org/wiki/Software/pkg-config/
70
68
    
71
69
    Strongly recommended:
72
70
    + OpenSSH           http://www.openssh.com/
73
71
    
74
72
    Package names:
75
 
    initramfs-tools libgnutls-dev gnutls-bin libavahi-core-dev gnupg
76
 
    libgpgme11-dev pkg-config ssh libnl-route-3-dev
 
73
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
 
74
    libgpgme11-dev pkg-config ssh
77
75
 
78
76
* Installing the Mandos server
79
77
  
126
124
     
127
125
        # /usr/lib/mandos/plugins.d/mandos-client \
128
126
                --pubkey=/etc/keys/mandos/pubkey.txt \
129
 
                --seckey=/etc/keys/mandos/seckey.txt \
130
 
                --tls-privkey=/etc/keys/mandos/tls-privkey.pem \
131
 
                --tls-pubkey=/etc/keys/mandos/tls-pubkey.pem; echo
 
127
                --seckey=/etc/keys/mandos/seckey.txt; echo
132
128
     
133
129
     This command should retrieve the password from the server,
134
130
     decrypt it, and output it to standard output.