/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 debian/mandos-client.postinst

  • Committer: Teddy Hogeborn
  • Date: 2019-02-09 23:23:26 UTC
  • Revision ID: teddy@recompile.se-20190209232326-z1z2kzpgfixz7iaj
Add support for using raw public keys in TLS (RFC 7250)

Since GnuTLS removed support for OpenPGP keys in TLS (RFC 6091), and
no other library supports it, we have to change the protocol to use
something else.  We choose to use "raw public keys" (RFC 7250).  Since
we still use OpenPGP keys to decrypt the secret password, this means
that each client will have two keys: One OpenPGP key and one TLS
public/private key, and the key ID of the latter key is used to
identify clients instead of the fingerprint of the OpenPGP key.

Note that this code is still compatible with GnuTLS before version
3.6.0 (when OpenPGP key support was removed).  This commit merely adds
support for using raw pulic keys instead with GnuTLS 3.6.6. or later.

* DBUS-API (Signals/ClientNotFound): Change name of first parameter
                                     from "Fingerprint" to "KeyID".
  (Mandos Client Interface/Properties/KeyID): New.
* INSTALL: Document conflict with GnuTLS 3.6.0 (which removed OpenPGP
           key support) up until 3.6.6, when support for raw public
           keys was added.  Also document new dependency of client on
           "gnutls-bin" package (for certtool).
* Makefile (run-client): Depend on TLS key files, and also pass them
                         as arguments to client.
  (keydir/tls-privkey.pem, keydir/tls-pubkey.pem): New.
  (confdir/clients.conf): Add dependency on TLS public key.
  (purge-client): Add removal of TLS key files.
* clients.conf ([foo]/key_id, [bar]/key_id): New.
* debian/control (Source: mandos/Build-Depends): Also allow
                                                 libgnutls30 (>= 3.6.6)
  (Package: mandos/Depends): - '' -
  (Package: mandos/Description): Alter description to match new
                                 design.
  (Package: mandos-client/Description): - '' -
  (Package: mandos-client/Depends): Move "gnutls-bin | openssl" to
                                    here from "Recommends".
* debian/mandos-client.README.Debian: Add --tls-privkey and
                                      --tls-pubkey options to test
                                      command.
* debian/mandos-client.postinst (create_key): Renamed to "create_keys"
                                             (all callers changed),
                                             and also create TLS key.
* debian/mandos-client.postrm (purge): Also remove TLS key files.
* intro.xml (DESCRIPTION): Describe new dual-key design.
* mandos (GnuTLS): Define different functions depending on whether
                   support for raw public keys is detected.
  (Client.key_id): New attribute.
  (ClientDBus.KeyID_dbus_property): New method.
  (ProxyClient.__init__): Take new "key_id" parameter.
  (ClientHandler.handle): Use key IDs when using raw public keys and
                          use fingerprints when using OpenPGP keys.
  (ClientHandler.peer_certificate): Also handle raw public keys.
  (ClientHandler.key_id): New.
  (MandosServer.handle_ipc): Pass key ID over the pipe IPC.  Also
                             check for key ID matches when looking up
                             clients.
  (main): Default GnuTLS priority string depends on whether we are
          using raw public keys or not.  When unpickling clients, set
          key_id if not set in the pickle.
  (main/MandosDBusService.ClientNotFound): Change name of first
                                           parameter from
                                           "Fingerprint" to "KeyID".
* mandos-clients.conf.xml (OPTIONS): Document new "key_id" option.
  (OPTIONS/secret): Mention new key ID matchning.
  (EXPANSION/RUNTIME EXPANSION): Add new "key_id" option.
  (EXAMPLE): - '' -
* mandos-ctl (tablewords, main/keywords): Add new "KeyID" property.
* mandos-keygen: Create TLS key files.  New "--tls-keytype" (-T)
                 option.  Alter help text to be more clear about key
                 types.  When in password mode, also output "key_id"
                 option.
* mandos-keygen.xml (SYNOPSIS): Add new "--tls-keytype" (-T) option.
  (DESCRIPTION): Alter to match new dual-key design.
  (OVERVIEW): - '' -
  (FILES): Add TLS key files.
* mandos-options.xml (priority): Document new default priority string
                                 when using raw public keys.
* mandos.xml (NETWORK PROTOCOL): Describe new protocol using key ID.
  (BUGS): Remove issue about checking expire times of OpenPGP keys,
          since TLS public keys do not have expiration times.
  (SECURITY/CLIENT): Alter description to match new design.
  (SEE ALSO/GnuTLS): - '' -
  (SEE ALSO): Add reference to RFC 7250, and alter description of when
              RFC 6091 is used.
* overview.xml: Alter text to match new design.
* plugin-runner.xml (EXAMPLE): Add --tls-pubkey and --tls-privkey
                               options to mandos-client options.
* plugins.d/mandos-client.c: Use raw public keys when compiling with
                             supporting GnuTLS versions. Add new
                             "--tls-pubkey" and "--tls-privkey"
                             options (which do nothing if GnuTLS
                             library does not support raw public
                             keys).  Alter text throughout to reflect
                             new design.  Only generate new DH
                             parameters (based on size of OpenPGP key)
                             when using OpenPGP in TLS.  Default
                             GnuTLS priority string depends on whether
                             we are using raw public keys or not.
* plugins.d/mandos-client.xml (SYNOPSIS): Add new "--tls-privkey" (-t)
                                          and "--tls-pubkey" (-T)
                                          options.
  (DESCRIPTION): Describe new dual-key design.
  (OPTIONS): Document new "--tls-privkey" (-t) and "--tls-pubkey" (-T)
             options.
  (OPTIONS/--dh-bits): No longer necessarily depends on OpenPGP key
                       size.
  (FILES): Add default locations for TLS public and private key files.
  (EXAMPLE): Use new --tls-pubkey and --tls-privkey options.
  (SECURITY): Alter wording slightly to reflect new dual-key design.
  (SEE ALSO/GnuTLS): Alter description to match new design.
  (SEE ALSO): Add reference to RFC 7250, and alter description of when
              RFC 6091 is used.

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/mandos-client.postinst
1
 
#!/bin/bash -e
 
1
#!/bin/sh
2
2
# This script can be called in the following ways:
3
3
#
4
4
# After the package was installed:
15
15
# If prerm fails during replacement due to conflict:
16
16
#       <postinst> abort-remove in-favour <new-package> <version>
17
17
 
18
 
. /usr/share/debconf/confmodule
 
18
set -e
19
19
 
20
20
# Update the initial RAM file system image
21
21
update_initramfs()
22
22
{
23
 
    if [ -x /usr/sbin/update-initramfs ]; then
24
 
        update-initramfs -u -k all
 
23
    update-initramfs -u -k all
 
24
    
 
25
    if dpkg --compare-versions "$2" lt-nl "1.0.10-1"; then
 
26
        # Make old initrd.img files unreadable too, in case they were
 
27
        # created with mandos-client 1.0.8 or older.
 
28
        find /boot -maxdepth 1 -type f -name "initrd.img-*.bak" \
 
29
            -print0 | xargs --null --no-run-if-empty chmod o-r
25
30
    fi
26
31
}
27
32
 
28
33
# Add user and group
29
34
add_mandos_user(){
30
35
    # Rename old "mandos" user and group
31
 
    case "$(getent passwd mandos)" in
32
 
        *:Mandos\ password\ system,,,:/nonexistent:/bin/false)
33
 
            usermod --login _mandos mandos
34
 
            groupmod --new-name _mandos mandos
35
 
            return
36
 
            ;;
37
 
    esac
 
36
    if dpkg --compare-versions "$2" lt "1.0.3-1"; then
 
37
        case "`getent passwd mandos`" in
 
38
            *:Mandos\ password\ system,,,:/nonexistent:/bin/false)
 
39
                usermod --login _mandos mandos
 
40
                groupmod --new-name _mandos mandos
 
41
                return
 
42
                ;;
 
43
        esac
 
44
    fi
38
45
    # Create new user and group
39
46
    if ! getent passwd _mandos >/dev/null; then
40
47
        adduser --system --force-badname --quiet --home /nonexistent \
43
50
    fi
44
51
}
45
52
 
46
 
# Create client key pair
47
 
create_key(){
48
 
    if [ -r /etc/keys/mandos/pubkey.txt \
49
 
        -a -r /etc/keys/mandos/seckey.txt ]; then
50
 
        return 0
51
 
    fi
52
 
    if [ -x /usr/sbin/mandos-keygen ]; then
 
53
# Create client key pairs
 
54
create_keys(){
 
55
    # If the OpenPGP key files do not exist, generate all keys using
 
56
    # mandos-keygen
 
57
    if ! [ -r /etc/keys/mandos/pubkey.txt \
 
58
              -a -r /etc/keys/mandos/seckey.txt ]; then
53
59
        mandos-keygen
54
 
    fi
 
60
        gpg-connect-agent KILLAGENT /bye || :
 
61
        return 0
 
62
    fi
 
63
 
 
64
    # If the TLS keys already exists, do nothing
 
65
    if [ -r /etc/keys/mandos/tls-privkey.pem \
 
66
            -a -r /etc/keys/mandos/tls-pubkey.pem ]; then
 
67
        return 0
 
68
    fi
 
69
 
 
70
    # If this is an upgrade from an old installation, the TLS keys
 
71
    # will not exist; create them.
 
72
 
 
73
    # First try certtool from GnuTLS
 
74
    if ! certtool --generate-privkey --password='' \
 
75
         --outfile /etc/keys/mandos/tls-privkey.pem \
 
76
         --sec-param ultra --key-type=ed25519 --pkcs8 --no-text \
 
77
         2>/dev/null; then
 
78
        # Otherwise try OpenSSL
 
79
        if ! openssl genpkey -algorithm X25519 \
 
80
             -out /etc/keys/mandos/tls-privkey.pem; then
 
81
            rm --force /etc/keys/mandos/tls-privkey.pem
 
82
            # None of the commands succeded; give up
 
83
            return 1
 
84
        fi
 
85
    fi
 
86
 
 
87
    local umask=$(umask)
 
88
    umask 077
 
89
    # First try certtool from GnuTLS
 
90
    if ! certtool --password='' \
 
91
         --load-privkey=/etc/keys/mandos/tls-privkey.pem \
 
92
         --outfile=/etc/keys/mandos/tls-pubkey.pem --pubkey-info \
 
93
         --no-text 2>/dev/null; then
 
94
        # Otherwise try OpenSSL
 
95
        if ! openssl pkey -in /etc/keys/mandos/tls-privkey.pem \
 
96
             -out /etc/keys/mandos/tls-pubkey.pem -pubout; then
 
97
            rm --force /etc/keys/mandos/tls-pubkey.pem
 
98
            # None of the commands succeded; give up
 
99
            umask $umask
 
100
            return 1
 
101
        fi
 
102
    fi
 
103
    umask $umask
 
104
}
 
105
 
 
106
create_dh_params(){
 
107
    if [ -r /etc/keys/mandos/dhparams.pem ]; then
 
108
        return 0
 
109
    fi
 
110
    # Create a Diffe-Hellman parameters file
 
111
    DHFILE="`mktemp -t mandos-client-dh-parameters.XXXXXXXXXX.pem`"
 
112
    # First try certtool from GnuTLS
 
113
    if ! certtool --generate-dh-params --sec-param high \
 
114
         --outfile "$DHFILE"; then
 
115
        # Otherwise try OpenSSL
 
116
        if ! openssl genpkey -genparam -algorithm DH -out "$DHFILE" \
 
117
             -pkeyopt dh_paramgen_prime_len:3072; then
 
118
            # None of the commands succeded; give up
 
119
            rm -- "$DHFILE"
 
120
            return 1
 
121
        fi
 
122
    fi
 
123
    sed --in-place --expression='0,/^-----BEGIN DH PARAMETERS-----$/d' \
 
124
        "$DHFILE"
 
125
    sed --in-place --expression='1i-----BEGIN DH PARAMETERS-----' \
 
126
            "$DHFILE"
 
127
    cp --archive "$DHFILE" /etc/keys/mandos/dhparams.pem
 
128
    rm -- "$DHFILE"
55
129
}
56
130
 
57
131
case "$1" in
58
132
    configure)
59
 
        add_mandos_user
60
 
        create_key
61
 
        update_initramfs
 
133
        add_mandos_user "$@"
 
134
        create_keys "$@"
 
135
        create_dh_params "$@" || :
 
136
        update_initramfs "$@"
 
137
        if dpkg --compare-versions "$2" lt-nl "1.7.10-1"; then
 
138
            PLUGINHELPERDIR=/usr/lib/$(dpkg-architecture -qDEB_HOST_MULTIARCH 2>/dev/null)/mandos/plugin-helpers
 
139
            if ! dpkg-statoverride --list "$PLUGINHELPERDIR" \
 
140
                 >/dev/null 2>&1; then
 
141
                chmod u=rwx,go= -- "$PLUGINHELPERDIR"
 
142
            fi
 
143
            if ! dpkg-statoverride --list /etc/mandos/plugin-helpers \
 
144
                 >/dev/null 2>&1; then
 
145
                chmod u=rwx,go= -- /etc/mandos/plugin-helpers
 
146
            fi
 
147
        fi
62
148
        ;;
63
149
    abort-upgrade|abort-deconfigure|abort-remove)
64
150
        ;;
65
151
 
66
152
    *)
67
 
        echo "$0 called with unknown argument \`$1'" 1>&2
 
153
        echo "$0 called with unknown argument '$1'" 1>&2
68
154
        exit 1
69
155
        ;;
70
156
esac