/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 initramfs-tools-hook

  • Committer: Teddy Hogeborn
  • Date: 2015-05-23 20:18:34 UTC
  • mto: This revision was merged to the branch mainline in revision 756.
  • Revision ID: teddy@recompile.se-20150523201834-e89ex4ito93yni8x
mandos: Use multiprocessing module to run checkers.

For a long time, the Mandos server has occasionally logged the message
"ERROR: Child process vanished".  This was never a fatal error, but it
has been annoying and slightly worrying, since a definite cause was
not found.  One potential cause could be the "multiprocessing" and
"subprocess" modules conflicting w.r.t. SIGCHLD.  To avoid this,
change the running of checkers from using subprocess.Popen
asynchronously to instead first create a multiprocessing.Process()
(which is asynchronous) calling a function, and have that function
then call subprocess.call() (which is synchronous).  In this way, the
only thing using any asynchronous subprocesses is the multiprocessing
module.

This makes it necessary to change one small thing in the D-Bus API,
since the subprocesses.call() function does not expose the raw wait(2)
status value.

DBUS-API (CheckerCompleted): Change the second value provided by this
                             D-Bus signal from the raw wait(2) status
                             to the actual terminating signal number.
mandos (subprocess_call_pipe): New function to be called by
                               multiprocessing.Process (starting a
                               separate process).
(Client.last_checker signal): New attribute for signal which
                              terminated last checker.  Like
                              last_checker_status, only not accessible
                              via D-Bus.
(Client.checker_callback): Take new "connection" argument and use it
                           to get returncode; set last_checker_signal.
                           Return False so gobject does not call this
                           callback again.
(Client.start_checker): Start checker using a multiprocessing.Process
                        instead of a subprocess.Popen.
(ClientDBus.checker_callback): Take new "connection" argument.        Call
                               Client.checker_callback early to have
                               it set last_checker_status and
                               last_checker_signal; use those.  Change
                               second value provided to D-Bus signal
                               CheckerCompleted to use
                               last_checker_signal if checker was
                               terminated by signal.
mandos-monitor: Update to reflect DBus API change.
(MandosClientWidget.checker_completed): Take "signal" instead of
                                        "condition" argument.  Use it
                                        accordingly.  Remove dead code
                                        (os.WCOREDUMP case).

Show diffs side-by-side

added added

removed removed

Lines of Context:
initramfs-tools-hook
1
1
#!/bin/sh
2
2
 
3
 
#
4
 
# This is an example hook script.  It will be run by 'mkinitramfs'
5
 
# when it creates the image.  It's job is to decide which files to
6
 
# install, then install them into the staging area, where the
7
 
# initramfs is being created.  This happens when a new 'linux-image'
8
 
# package is installed, or when the administrator runs 'mkinitramfs'
9
 
# by hand to update an initramfs image.
10
 
#
11
 
# TODO: What about the case where you install something that should be
12
 
#       added to the initramfs, but the linux-image it relates to has
13
 
#       already been installed previously?  Does this happen often
14
 
#       enough that it needs to be handled?  How can it be handled?
15
 
#
16
 
#       * Think about the 'usplash'.  The initramfs will need to be
17
 
#        updated if a theme change or update is desired.  Maybe it
18
 
#        should not be totally automatic, but offered on upgrade
19
 
#        predicated on a user response to a debconf question?  That
20
 
#        issue needs to be explored and a solution specified.
21
 
#
22
 
#  * Do not assume that any needed subdirectories have been created
23
 
#       yet, but don't bail out if they are already there.
24
 
#
25
 
#  * All of the standard system tools are available, of course, since
26
 
#       this hook is running in the real system, not the initramfs.
27
 
#
28
 
#  * TODO: ... ?  Anything else to tell them in this bullet-list?
29
 
#
 
3
# This script will be run by 'mkinitramfs' when it creates the image.
 
4
# Its job is to decide which files to install, then install them into
 
5
# the staging area, where the initramfs is being created.  This
 
6
# happens when a new 'linux-image' package is installed, or when an
 
7
# administrator runs 'update-initramfs' by hand to update an initramfs
 
8
# image.
30
9
 
31
 
#
32
10
# The environment contains at least:
33
11
#
34
 
#  CONFDIR -- usually /etc/mkinitramfs, can be set on mkinitramfs
35
 
#                command line.
36
 
#
37
 
#  DESTDIR -- The staging directory where we are building the image.
38
 
#
39
 
# TODO: Decide what environment variables are meaningful and defined
40
 
#       in this context, then document them as part of the interface.
41
 
#
42
 
# TODO: May need a version_compare function for comparison of VERSION?
43
 
 
44
 
 
45
 
#
46
 
# List the soft prerequisites here.  This is a space separated list of
47
 
# names, of scripts that are in the same directory as this one, that
48
 
# must be run before this one can be.
49
 
#
 
12
#  DESTDIR -- The staging directory where the image is being built.
 
13
 
 
14
# No initramfs pre-requirements
50
15
PREREQ="cryptroot"
51
16
 
52
17
prereqs()
62
27
        ;;
63
28
esac
64
29
 
65
 
 
66
 
# You can do anything you need to from here on.
67
 
#
68
 
 
69
 
# Source the optional 'hook-functions' scriptlet, if you need the
70
 
# functions defined within it.  Read it to see what is available to
71
 
# you.  It contains functions for copying dynamically linked program
72
 
# binaries, and kernel modules into the DESTDIR.
73
 
#
74
30
. /usr/share/initramfs-tools/hook-functions
75
31
 
 
32
for d in /usr/lib \
 
33
    "/usr/lib/`dpkg-architecture -qDEB_HOST_MULTIARCH 2>/dev/null`" \
 
34
    "`rpm --eval='%{_libdir}' 2>/dev/null`" /usr/local/lib; do
 
35
    if [ -d "$d"/mandos ]; then
 
36
        libdir="$d"
 
37
        break
 
38
    fi
 
39
done
 
40
if [ -z "$libdir" ]; then
 
41
    # Mandos not found
 
42
    exit 1
 
43
fi
 
44
 
 
45
for d in /etc/keys/mandos /etc/mandos/keys; do
 
46
    if [ -d "$d" ]; then
 
47
        keydir="$d"
 
48
        break
 
49
    fi
 
50
done
 
51
if [ -z "$keydir" ]; then
 
52
    # Mandos key directory not found
 
53
    exit 1
 
54
fi
 
55
 
 
56
set `{ getent passwd _mandos \
 
57
    || getent passwd nobody \
 
58
    || echo ::65534:65534:::; } \
 
59
    | cut --delimiter=: --fields=3,4 --only-delimited \
 
60
    --output-delimiter=" "`
 
61
mandos_user="$1"
 
62
mandos_group="$2"
 
63
 
 
64
# The Mandos network client uses the network
76
65
auto_add_modules net
77
 
# force_load tg3
 
66
# The Mandos network client uses IPv6
78
67
force_load ipv6
79
68
 
 
69
# These are directories inside the initrd
80
70
CONFDIR="/conf/conf.d/mandos"
81
 
DESTCONFDIR="${DESTDIR}${CONFDIR}"
82
 
mkdir --parents "${DESTCONFDIR}"
83
 
PLUGINDIR="${CONFDIR}/plugins.d"
84
 
mkdir --parents "${DESTDIR}${PLUGINDIR}"
85
 
 
86
 
# We don't need to copy_exec mandos-client, hooks/cryptroot will do
87
 
# that.  That will not copy the plugins, however, so we do that here.
88
 
 
89
 
# The standard plugins
90
 
for file in /usr/lib/mandos/plugins.d/*; do
 
71
MANDOSDIR="/lib/mandos"
 
72
PLUGINDIR="${MANDOSDIR}/plugins.d"
 
73
HOOKDIR="${MANDOSDIR}/network-hooks.d"
 
74
 
 
75
# Make directories
 
76
install --directory --mode=u=rwx,go=rx "${DESTDIR}${CONFDIR}" \
 
77
        "${DESTDIR}${MANDOSDIR}" "${DESTDIR}${HOOKDIR}"
 
78
install --owner=${mandos_user} --group=${mandos_group} --directory \
 
79
    --mode=u=rwx "${DESTDIR}${PLUGINDIR}"
 
80
 
 
81
# Copy the Mandos plugin runner
 
82
copy_exec "$libdir"/mandos/plugin-runner "${MANDOSDIR}"
 
83
 
 
84
# Copy the plugins
 
85
 
 
86
# Copy the packaged plugins
 
87
for file in "$libdir"/mandos/plugins.d/*; do
91
88
    base="`basename \"$file\"`"
92
89
    # Is this plugin overridden?
93
90
    if [ -e "/etc/mandos/plugins.d/$base" ]; then
94
91
        continue
95
92
    fi
96
93
    case "$base" in
97
 
        *~|.*|\#*\#|*.dpkg-old|*.dpkg-new|*.dpkg-divert) : ;;
98
 
        *) copy_exec "$file" "${PLUGINDIR}";;
 
94
        *~|.*|\#*\#|*.dpkg-old|*.dpkg-bak|*.dpkg-new|*.dpkg-divert)
 
95
            : ;;
 
96
        "*") echo "W: Mandos client plugin directory is empty." >&2 ;;
 
97
        *) copy_exec "$file" "${PLUGINDIR}" ;;
99
98
    esac
100
99
done
101
100
 
102
 
# Any user-supplied plugins
 
101
# Copy any user-supplied plugins
103
102
for file in /etc/mandos/plugins.d/*; do
104
103
    base="`basename \"$file\"`"
105
104
    case "$base" in
106
 
        *~|.*|*.dpkg-old|*.dpkg-new|*.dpkg-divert) : ;;
107
 
        *) copy_exec "$file" "${PLUGINDIR}";;
108
 
    esac
109
 
done
110
 
 
111
 
# GPGME needs /usr/bin/gpg
112
 
if [ -n "`ls \"${DESTDIR}\"/usr/lib/libgpgme.so* 2>/dev/null`" ]; then
113
 
    copy_exec /usr/bin/gpg
 
105
        *~|.*|\#*\#|*.dpkg-old|*.dpkg-bak|*.dpkg-new|*.dpkg-divert)
 
106
            : ;;
 
107
        "*") : ;;
 
108
        *) copy_exec "$file" "${PLUGINDIR}" ;;
 
109
    esac
 
110
done
 
111
 
 
112
# Get DEVICE from initramfs.conf and other files
 
113
. /etc/initramfs-tools/initramfs.conf
 
114
for conf in /etc/initramfs-tools/conf.d/*; do
 
115
    if [ -n `basename \"$conf\" | grep '^[[:alnum:]][[:alnum:]\._-]*$' \
 
116
        | grep -v '\.dpkg-.*$'` ]; then
 
117
        [ -f ${conf} ] && . ${conf}
 
118
    fi
 
119
done
 
120
export DEVICE
 
121
 
 
122
# Copy network hooks
 
123
for hook in /etc/mandos/network-hooks.d/*; do
 
124
    case "`basename \"$hook\"`" in
 
125
        "*") continue ;;
 
126
        *[!A-Za-z0-9_.-]*) continue ;;
 
127
        *) test -d "$hook" || copy_exec "$hook" "${HOOKDIR}" ;;
 
128
    esac
 
129
    if [ -x "$hook" ]; then
 
130
        # Copy any files needed by the network hook
 
131
        MANDOSNETHOOKDIR=/etc/mandos/network-hooks.d MODE=files \
 
132
            VERBOSITY=0 "$hook" files | while read file target; do
 
133
            if [ ! -e "${file}" ]; then
 
134
                echo "WARNING: file ${file} not found, requested by Mandos network hook '${hook##*/}'" >&2
 
135
            fi
 
136
            if [ -z "${target}" ]; then
 
137
                copy_exec "$file"
 
138
            else
 
139
                copy_exec "$file" "$target"
 
140
            fi
 
141
        done
 
142
        # Copy and load any modules needed by the network hook
 
143
        MANDOSNETHOOKDIR=/etc/mandos/network-hooks.d MODE=modules \
 
144
            VERBOSITY=0 "$hook" modules | while read module; do
 
145
            if [ -z "${target}" ]; then
 
146
                force_load "$module"
 
147
            fi
 
148
        done
 
149
    fi
 
150
done
 
151
 
 
152
# GPGME needs GnuPG
 
153
gpg=/usr/bin/gpg
 
154
libgpgme11_version="`dpkg-query --showformat='${Version}' --show libgpgme11`"
 
155
if dpkg --compare-versions "$libgpgme11_version" ge 1.5.0-0.1; then
 
156
    if [ -e /usr/bin/gpgconf ]; then
 
157
        if [ ! -e "${DESTDIR}/usr/bin/gpgconf" ]; then
 
158
            copy_exec /usr/bin/gpgconf
 
159
        fi
 
160
        gpg="`/usr/bin/gpgconf|sed --quiet --expression='s/^gpg:[^:]*://p'`"
 
161
    fi
 
162
elif dpkg --compare-versions "$libgpgme11_version" ge 1.4.1-0.1; then
 
163
    gpg=/usr/bin/gpg2
 
164
fi
 
165
if [ ! -e "${DESTDIR}$gpg" ]; then
 
166
    copy_exec "$gpg"
 
167
fi
 
168
unset gpg
 
169
unset libgpgme11_version
 
170
 
 
171
# Config files
 
172
for file in /etc/mandos/plugin-runner.conf; do
 
173
    if [ -d "$file" ]; then
 
174
        continue
 
175
    fi
 
176
    cp --archive --sparse=always "$file" "${DESTDIR}${CONFDIR}"
 
177
done
 
178
 
 
179
if [ ${mandos_user} != 65534 ]; then
 
180
    sed --in-place --expression="1i--userid=${mandos_user}" \
 
181
        "${DESTDIR}${CONFDIR}/plugin-runner.conf"
 
182
fi
 
183
 
 
184
if [ ${mandos_group} != 65534 ]; then
 
185
    sed --in-place --expression="1i--groupid=${mandos_group}" \
 
186
        "${DESTDIR}${CONFDIR}/plugin-runner.conf"
114
187
fi
115
188
 
116
189
# Key files
117
 
for file in /etc/mandos/*; do
 
190
for file in "$keydir"/*; do
118
191
    if [ -d "$file" ]; then
119
192
        continue
120
193
    fi
121
 
    cp --archive --sparse=always "$file" "${DESTCONFDIR}"
 
194
    cp --archive --sparse=always "$file" "${DESTDIR}${CONFDIR}"
 
195
    chown ${mandos_user}:${mandos_group} \
 
196
        "${DESTDIR}${CONFDIR}/`basename \"$file\"`"
122
197
done
123
 
# Create key ring files
124
 
LANG=C gpg --quiet --batch --no-tty --no-options \
125
 
    --homedir "${DESTCONFDIR}" --no-permission-warning \
126
 
    --import "${DESTCONFDIR}/seckey.txt" \
127
 
    --import-options import-minimal
128
 
chown nobody "${DESTCONFDIR}/secring.gpg"
129
198
 
130
 
# /keyscripts/mandos-client will drop priviliges, but needs access to
131
 
# its plugin directory.  However, since almost all files in initrd
132
 
# have been created with umask 027, this opening of permissions is needed.
 
199
# /lib/mandos/plugin-runner will drop priviliges, but needs access to
 
200
# its plugin directory and its config file.  However, since almost all
 
201
# files in initrd have been created with umask 027, this opening of
 
202
# permissions is needed.
133
203
# 
134
204
# (The umask is not really intended to affect the files inside the
135
 
# initrd, but the initrd.img file itself, since it now contains secret
136
 
# key files.  There is, however, no other way to set the permission of
137
 
# the initrd.img file without a race condition. This umask is set by
138
 
# "/usr/share/initramfs-tools/conf-hooks.d/mandos".)
 
205
# initrd; it is intended to affect the initrd.img file itself, since
 
206
# it now contains secret key files.  There is, however, no other way
 
207
# to set the permission of the initrd.img file without a race
 
208
# condition.  This umask is set by "initramfs-tools-hook-conf",
 
209
# installed as "/usr/share/initramfs-tools/conf-hooks.d/mandos".)
139
210
# 
140
 
full="${PLUGINDIR}"
141
 
while [ "$full" != "/" ]; do
142
 
    chmod a+rX "${DESTDIR}$full"
143
 
    full="`dirname \"$full\"`"
 
211
for full in "${MANDOSDIR}" "${CONFDIR}"; do
 
212
    while [ "$full" != "/" ]; do
 
213
        chmod a+rX "${DESTDIR}$full"
 
214
        full="`dirname \"$full\"`"
 
215
    done
144
216
done
 
217
 
 
218
# Reset some other things to sane permissions which we have
 
219
# inadvertently affected with our umask setting.
145
220
for dir in / /bin /etc /keyscripts /sbin /scripts /usr /usr/bin; do
146
 
    chmod a+rX "${DESTDIR}$dir"
 
221
    if [ -d "${DESTDIR}$dir" ]; then
 
222
        chmod a+rX "${DESTDIR}$dir"
 
223
    fi
147
224
done
148
 
for dir in /lib /usr/lib; do
149
 
    chmod --recursive a+rX "${DESTDIR}$dir"
 
225
for dir in "${DESTDIR}"/lib* "${DESTDIR}"/usr/lib*; do
 
226
    if [ -d "$dir" ]; then
 
227
        find "$dir" \! -perm -u+rw,g+r -prune -or -print0 \
 
228
            | xargs --null --no-run-if-empty chmod a+rX
 
229
    fi
150
230
done