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

Four new interrelated features:

1. Support using a different network interface via both initramfs.conf
   (the DEVICE setting) and the kernel command line (sixth field of
   the "ip=" option as in Linux' Documentation/nfsroot.txt).

2. Support connecting to a specified Mandos server directly using a
   kernel command line option ("mandos=connect:<ADDRESS>:<PORT>").

3. Support connecting directly to an IPv4 address (and port) using the
   "--connect" option of mandos-client.

4. Support an empty string to the --interface option to mandos-client.

* Makefile (WARN): Increase strictness by changing to
                   "-Wstrict-aliasing=1".

* debian/mandos-client.README.Debian (Use the Correct Network
  Interface): Changed to refer to initramfs.conf and nfsroot.txt.
  (Test the Server): Improve wording.
  (Non-local Connection): New section.
* initramfs-tools-script: Obey DEVICE environment variable and setting
                          from "/conf/initramfs.conf".  Also let any
                          "ip=" kernel command line option override
                          it.  Support new "mandos=connect" option.
                          Call "configure_networking" to set up IP
                          address on interface if necessary.
* plugin-runner.conf: Change example.
* plugins.d/mandos-client.c: Some whitespace and comment changes.
  (start_mandos_communication): Take an additional argument for
                                address family, all callers changed.
                                Connect to an IPv4 address if address
                                family is AF_INET.  Only set IPv6
                                scope_id for link-local addresses.
  (main): Accept empty interface name; this will not bring up any
         interface and leave the interface as unspecified.  Also do
         not restore kernel log level if lowering it failed.
* plugins.d/mandos-client.xml (OPTIONS): Document that the
                                         "--interface" option accepts
                                         an empty string.
  (EXAMPLE): Change example IPv6 address to a link-local address.

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 the
 
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 /usr/local; do
 
33
    if [ -d "$d"/lib/mandos ]; then
 
34
        prefix="$d"
 
35
        break
 
36
    fi
 
37
done
 
38
if [ -z "$prefix" ]; then
 
39
    # Mandos not found
 
40
    exit 1
 
41
fi
 
42
 
 
43
for d in /etc/keys/mandos /etc/mandos/keys; do
 
44
    if [ -d "$d" ]; then
 
45
        keydir="$d"
 
46
        break
 
47
    fi
 
48
done
 
49
if [ -z "$keydir" ]; then
 
50
    # Mandos key directory not found
 
51
    exit 1
 
52
fi
 
53
 
 
54
mandos_user="`{ getent passwd _mandos \
 
55
                || getent passwd mandos \
 
56
                || getent passwd nobody \
 
57
                || echo ::65534::::; } \
 
58
        | awk --field-separator=: '{ print $3 }'`" 
 
59
mandos_group="`{ getent group _mandos \
 
60
                || getent group mandos \
 
61
                || getent group nogroup \
 
62
                || echo ::65534:; } \
 
63
        | awk --field-separator=: '{ print $3 }'`"
 
64
 
 
65
# The Mandos network client uses the network
76
66
auto_add_modules net
77
 
# force_load tg3
 
67
# The Mandos network client uses IPv6
78
68
force_load ipv6
79
69
 
 
70
# These are directories inside the initrd
80
71
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
 
72
MANDOSDIR="/lib/mandos"
 
73
PLUGINDIR="${MANDOSDIR}/plugins.d"
 
74
 
 
75
# Make directories
 
76
install --directory --mode=u=rwx,go=rx "${DESTDIR}${CONFDIR}" \
 
77
        "${DESTDIR}${MANDOSDIR}"
 
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 "$prefix"/lib/mandos/plugin-runner "${MANDOSDIR}"
 
83
 
 
84
# Copy the plugins
 
85
 
 
86
# Copy the packaged plugins
 
87
for file in "$prefix"/lib/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) : ;;
 
94
        *~|.*|\#*\#|*.dpkg-old|*.dpkg-bak|*.dpkg-new|*.dpkg-divert) : ;;
 
95
        "*") :;;
98
96
        *) copy_exec "$file" "${PLUGINDIR}";;
99
97
    esac
100
98
done
101
99
 
102
 
# Any user-supplied plugins
 
100
# Copy any user-supplied plugins
103
101
for file in /etc/mandos/plugins.d/*; do
104
102
    base="`basename \"$file\"`"
105
103
    case "$base" in
106
 
        *~|.*|*.dpkg-old|*.dpkg-new|*.dpkg-divert) : ;;
 
104
        *~|.*|\#*\#|*.dpkg-old|*.dpkg-bak|*.dpkg-new|*.dpkg-divert) : ;;
 
105
        "*") :;;
107
106
        *) copy_exec "$file" "${PLUGINDIR}";;
108
107
    esac
109
108
done
110
109
 
111
110
# GPGME needs /usr/bin/gpg
112
 
if [ -n "`ls \"${DESTDIR}\"/usr/lib/libgpgme.so* 2>/dev/null`" ]; then
 
111
if [ ! -e "${DESTDIR}/usr/bin/gpg" \
 
112
    -a -n "`ls \"${DESTDIR}\"/usr/lib/libgpgme.so* \
 
113
                2>/dev/null`" ]; then
113
114
    copy_exec /usr/bin/gpg
114
115
fi
115
116
 
116
 
# Key files
 
117
# Config files
117
118
for file in /etc/mandos/*; do
118
119
    if [ -d "$file" ]; then
119
120
        continue
120
121
    fi
121
 
    cp --archive --sparse=always "$file" "${DESTCONFDIR}"
122
 
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
 
 
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.
 
122
    cp --archive --sparse=always "$file" "${DESTDIR}${CONFDIR}"
 
123
done
 
124
 
 
125
if [ ${mandos_user} != 65534 ]; then
 
126
    PLUGINRUNNERCONF="${DESTDIR}${CONFDIR}/plugin-runner.conf"
 
127
    cat <<-EOF >> "$PLUGINRUNNERCONF"
 
128
        
 
129
        --userid=${mandos_user}
 
130
EOF
 
131
fi
 
132
 
 
133
if [ ${mandos_group} != 65534 ]; then
 
134
    PLUGINRUNNERCONF="${DESTDIR}${CONFDIR}/plugin-runner.conf"
 
135
    cat <<-EOF >> "$PLUGINRUNNERCONF"
 
136
        
 
137
        --groupid=${mandos_group}
 
138
EOF
 
139
fi
 
140
 
 
141
# Key files 
 
142
for file in  "$keydir"/*; do
 
143
    if [ -d "$file" ]; then
 
144
        continue
 
145
    fi
 
146
    cp --archive --sparse=always "$file" "${DESTDIR}${CONFDIR}"
 
147
    chown ${mandos_user}:${mandos_group} \
 
148
        "${DESTDIR}${CONFDIR}/`basename \"$file\"`"
 
149
done
 
150
 
 
151
# /lib/mandos/plugin-runner will drop priviliges, but needs access to
 
152
# its plugin directory and its config file.  However, since almost all
 
153
# files in initrd have been created with umask 027, this opening of
 
154
# permissions is needed.
133
155
# 
134
156
# (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".)
 
157
# initrd; it is intended to affect the initrd.img file itself, since
 
158
# it now contains secret key files.  There is, however, no other way
 
159
# to set the permission of the initrd.img file without a race
 
160
# condition.  This umask is set by "initramfs-tools-hook-conf",
 
161
# installed as "/usr/share/initramfs-tools/conf-hooks.d/mandos".)
139
162
# 
140
 
full="${PLUGINDIR}"
141
 
while [ "$full" != "/" ]; do
142
 
    chmod a+rX "${DESTDIR}$full"
143
 
    full="`dirname \"$full\"`"
 
163
for full in "${MANDOSDIR}" "${CONFDIR}"; do
 
164
    while [ "$full" != "/" ]; do
 
165
        chmod a+rX "${DESTDIR}$full"
 
166
        full="`dirname \"$full\"`"
 
167
    done
144
168
done
 
169
 
 
170
# Reset some other things to sane permissions which we have
 
171
# inadvertently affected with our umask setting.
145
172
for dir in / /bin /etc /keyscripts /sbin /scripts /usr /usr/bin; do
146
 
    chmod a+rX "${DESTDIR}$dir"
 
173
    if [ -d "${DESTDIR}$dir" ]; then
 
174
        chmod a+rX "${DESTDIR}$dir"
 
175
    fi
147
176
done
148
 
for dir in /lib /usr/lib; do
149
 
    chmod --recursive a+rX "${DESTDIR}$dir"
 
177
for dir in "${DESTDIR}"/lib* "${DESTDIR}"/usr/lib*; do
 
178
    if [ -d "$dir" ]; then
 
179
        find "$dir" \! -perm -u+rw,g+r -prune -or -print0 \
 
180
            | xargs --null --no-run-if-empty chmod a+rX
 
181
    fi
150
182
done