/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 mandos-keygen

  • Committer: Teddy Hogeborn
  • Date: 2015-06-28 16:35:27 UTC
  • mto: (237.7.307 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • 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:
mandos-keygen
 
1
#!/bin/sh -e
 
2
# 
 
3
# Mandos key generator - create a new OpenPGP key for a Mandos client
 
4
# 
 
5
# Copyright © 2008-2014 Teddy Hogeborn
 
6
# Copyright © 2008-2014 Björn Påhlsson
 
7
# 
 
8
# This program is free software: you can redistribute it and/or modify
 
9
# it under the terms of the GNU General Public License as published by
 
10
# the Free Software Foundation, either version 3 of the License, or
 
11
# (at your option) any later version.
 
12
#
 
13
#     This program is distributed in the hope that it will be useful,
 
14
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
15
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
16
#     GNU General Public License for more details.
 
17
# 
 
18
# You should have received a copy of the GNU General Public License
 
19
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
20
# 
 
21
# Contact the authors at <mandos@recompile.se>.
 
22
# 
 
23
 
 
24
VERSION="1.6.9"
 
25
 
 
26
KEYDIR="/etc/keys/mandos"
 
27
KEYTYPE=RSA
 
28
KEYLENGTH=4096
 
29
SUBKEYTYPE=RSA
 
30
SUBKEYLENGTH=4096
 
31
KEYNAME="`hostname --fqdn 2>/dev/null || hostname`"
 
32
KEYEMAIL=""
 
33
KEYCOMMENT=""
 
34
KEYEXPIRE=0
 
35
FORCE=no
 
36
SSH=yes
 
37
KEYCOMMENT_ORIG="$KEYCOMMENT"
 
38
mode=keygen
 
39
 
 
40
if [ ! -d "$KEYDIR" ]; then
 
41
    KEYDIR="/etc/mandos/keys"
 
42
fi
 
43
 
 
44
# Parse options
 
45
TEMP=`getopt --options vhpF:d:t:l:s:L:n:e:c:x:fS \
 
46
    --longoptions version,help,password,passfile:,dir:,type:,length:,subtype:,sublength:,name:,email:,comment:,expire:,force,no-ssh \
 
47
    --name "$0" -- "$@"`
 
48
 
 
49
help(){
 
50
basename="`basename $0`"
 
51
cat <<EOF
 
52
Usage: $basename [ -v | --version ]
 
53
       $basename [ -h | --help ]
 
54
   Key creation:
 
55
       $basename [ OPTIONS ]
 
56
   Encrypted password creation:
 
57
       $basename { -p | --password } [ --name NAME ] [ --dir DIR]
 
58
       $basename { -F | --passfile } FILE [ --name NAME ] [ --dir DIR]
 
59
 
 
60
Key creation options:
 
61
  -v, --version         Show program's version number and exit
 
62
  -h, --help            Show this help message and exit
 
63
  -d DIR, --dir DIR     Target directory for key files
 
64
  -t TYPE, --type TYPE  Key type.  Default is RSA.
 
65
  -l BITS, --length BITS
 
66
                        Key length in bits.  Default is 4096.
 
67
  -s TYPE, --subtype TYPE
 
68
                        Subkey type.  Default is RSA.
 
69
  -L BITS, --sublength BITS
 
70
                        Subkey length in bits.  Default is 4096.
 
71
  -n NAME, --name NAME  Name of key.  Default is the FQDN.
 
72
  -e ADDRESS, --email ADDRESS
 
73
                        Email address of key.  Default is empty.
 
74
  -c TEXT, --comment TEXT
 
75
                        Comment field for key.  The default is empty.
 
76
  -x TIME, --expire TIME
 
77
                        Key expire time.  Default is no expiration.
 
78
                        See gpg(1) for syntax.
 
79
  -f, --force           Force overwriting old key files.
 
80
 
 
81
Password creation options:
 
82
  -p, --password        Create an encrypted password using the key in
 
83
                        the key directory.  All options other than
 
84
                        --dir and --name are ignored.
 
85
  -F FILE, --passfile FILE
 
86
                        Encrypt a password from FILE using the key in
 
87
                        the key directory.  All options other than
 
88
                        --dir and --name are ignored.
 
89
  -S, --no-ssh          Don't get SSH key or set "checker" option.
 
90
EOF
 
91
}
 
92
 
 
93
eval set -- "$TEMP"
 
94
while :; do
 
95
    case "$1" in
 
96
        -p|--password) mode=password; shift;;
 
97
        -F|--passfile) mode=password; PASSFILE="$2"; shift 2;;
 
98
        -d|--dir) KEYDIR="$2"; shift 2;;
 
99
        -t|--type) KEYTYPE="$2"; shift 2;;
 
100
        -s|--subtype) SUBKEYTYPE="$2"; shift 2;;
 
101
        -l|--length) KEYLENGTH="$2"; shift 2;;
 
102
        -L|--sublength) SUBKEYLENGTH="$2"; shift 2;;
 
103
        -n|--name) KEYNAME="$2"; shift 2;;
 
104
        -e|--email) KEYEMAIL="$2"; shift 2;;
 
105
        -c|--comment) KEYCOMMENT="$2"; shift 2;;
 
106
        -x|--expire) KEYEXPIRE="$2"; shift 2;;
 
107
        -f|--force) FORCE=yes; shift;;
 
108
        -S|--no-ssh) SSH=no; shift;;
 
109
        -v|--version) echo "$0 $VERSION"; exit;;
 
110
        -h|--help) help; exit;;
 
111
        --) shift; break;;
 
112
        *) echo "Internal error" >&2; exit 1;;
 
113
    esac
 
114
done
 
115
if [ "$#" -gt 0 ]; then
 
116
    echo "Unknown arguments: '$@'" >&2
 
117
    exit 1
 
118
fi
 
119
 
 
120
SECKEYFILE="$KEYDIR/seckey.txt"
 
121
PUBKEYFILE="$KEYDIR/pubkey.txt"
 
122
 
 
123
# Check for some invalid values
 
124
if [ ! -d "$KEYDIR" ]; then
 
125
    echo "$KEYDIR not a directory" >&2
 
126
    exit 1
 
127
fi
 
128
if [ ! -r "$KEYDIR" ]; then
 
129
    echo "Directory $KEYDIR not readable" >&2
 
130
    exit 1
 
131
fi
 
132
 
 
133
if [ "$mode" = keygen ]; then
 
134
    if [ ! -w "$KEYDIR" ]; then
 
135
        echo "Directory $KEYDIR not writeable" >&2
 
136
        exit 1
 
137
    fi
 
138
    if [ -z "$KEYTYPE" ]; then
 
139
        echo "Empty key type" >&2
 
140
        exit 1
 
141
    fi
 
142
    
 
143
    if [ -z "$KEYNAME" ]; then
 
144
        echo "Empty key name" >&2
 
145
        exit 1
 
146
    fi
 
147
    
 
148
    if [ -z "$KEYLENGTH" ] || [ "$KEYLENGTH" -lt 512 ]; then
 
149
        echo "Invalid key length" >&2
 
150
        exit 1
 
151
    fi
 
152
    
 
153
    if [ -z "$KEYEXPIRE" ]; then
 
154
        echo "Empty key expiration" >&2
 
155
        exit 1
 
156
    fi
 
157
    
 
158
    # Make FORCE be 0 or 1
 
159
    case "$FORCE" in
 
160
        [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) FORCE=1;;
 
161
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
 
162
    esac
 
163
    
 
164
    if [ \( -e "$SECKEYFILE" -o -e "$PUBKEYFILE" \) \
 
165
        -a "$FORCE" -eq 0 ]; then
 
166
        echo "Refusing to overwrite old key files; use --force" >&2
 
167
        exit 1
 
168
    fi
 
169
    
 
170
    # Set lines for GnuPG batch file
 
171
    if [ -n "$KEYCOMMENT" ]; then
 
172
        KEYCOMMENTLINE="Name-Comment: $KEYCOMMENT"
 
173
    fi
 
174
    if [ -n "$KEYEMAIL" ]; then
 
175
        KEYEMAILLINE="Name-Email: $KEYEMAIL"
 
176
    fi
 
177
    
 
178
    # Create temporary gpg batch file
 
179
    BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
 
180
fi
 
181
 
 
182
if [ "$mode" = password ]; then
 
183
    # Create temporary encrypted password file
 
184
    SECFILE="`mktemp -t mandos-keygen-secfile.XXXXXXXXXX`"
 
185
fi
 
186
 
 
187
# Create temporary key ring directory
 
188
RINGDIR="`mktemp -d -t mandos-keygen-keyrings.XXXXXXXXXX`"
 
189
 
 
190
# Remove temporary files on exit
 
191
trap "
 
192
set +e; \
 
193
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
 
194
shred --remove \"$RINGDIR\"/sec* 2>/dev/null;
 
195
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
 
196
rm --recursive --force \"$RINGDIR\";
 
197
tty --quiet && stty echo; \
 
198
" EXIT
 
199
 
 
200
set -e
 
201
 
 
202
umask 077
 
203
 
 
204
if [ "$mode" = keygen ]; then
 
205
    # Create batch file for GnuPG
 
206
    cat >"$BATCHFILE" <<-EOF
 
207
        Key-Type: $KEYTYPE
 
208
        Key-Length: $KEYLENGTH
 
209
        Key-Usage: sign,auth
 
210
        Subkey-Type: $SUBKEYTYPE
 
211
        Subkey-Length: $SUBKEYLENGTH
 
212
        Subkey-Usage: encrypt
 
213
        Name-Real: $KEYNAME
 
214
        $KEYCOMMENTLINE
 
215
        $KEYEMAILLINE
 
216
        Expire-Date: $KEYEXPIRE
 
217
        #Preferences: <string>
 
218
        #Handle: <no-spaces>
 
219
        #%pubring pubring.gpg
 
220
        #%secring secring.gpg
 
221
        %commit
 
222
        EOF
 
223
    
 
224
    if tty --quiet; then
 
225
        cat <<-EOF
 
226
        Note: Due to entropy requirements, key generation could take
 
227
        anything from a few minutes to SEVERAL HOURS.  Please be
 
228
        patient and/or supply the system with more entropy if needed.
 
229
        EOF
 
230
        echo -n "Started: "
 
231
        date
 
232
    fi
 
233
    
 
234
    # Make sure trustdb.gpg exists;
 
235
    # this is a workaround for Debian bug #737128
 
236
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
237
        --homedir "$RINGDIR" \
 
238
        --import-ownertrust < /dev/null
 
239
    # Generate a new key in the key rings
 
240
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
241
        --homedir "$RINGDIR" --trust-model always \
 
242
        --gen-key "$BATCHFILE"
 
243
    rm --force "$BATCHFILE"
 
244
    
 
245
    if tty --quiet; then
 
246
        echo -n "Finished: "
 
247
        date
 
248
    fi
 
249
    
 
250
    # Backup any old key files
 
251
    if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
 
252
        2>/dev/null; then
 
253
        shred --remove "$SECKEYFILE"
 
254
    fi
 
255
    if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
 
256
        2>/dev/null; then
 
257
        rm --force "$PUBKEYFILE"
 
258
    fi
 
259
    
 
260
    FILECOMMENT="Mandos client key for $KEYNAME"
 
261
    if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
 
262
        FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
 
263
    fi
 
264
    
 
265
    if [ -n "$KEYEMAIL" ]; then
 
266
        FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
 
267
    fi
 
268
    
 
269
    # Export key from key rings to key files
 
270
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
271
        --homedir "$RINGDIR" --armor --export-options export-minimal \
 
272
        --comment "$FILECOMMENT" --output "$SECKEYFILE" \
 
273
        --export-secret-keys
 
274
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
275
        --homedir "$RINGDIR" --armor --export-options export-minimal \
 
276
        --comment "$FILECOMMENT" --output "$PUBKEYFILE" --export
 
277
fi
 
278
 
 
279
if [ "$mode" = password ]; then
 
280
    
 
281
    # Make SSH be 0 or 1
 
282
    case "$SSH" in
 
283
        [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) SSH=1;;
 
284
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) SSH=0;;
 
285
    esac
 
286
    
 
287
    if [ $SSH -eq 1 ]; then
 
288
        set +e
 
289
        ssh_fingerprint="`ssh-keyscan localhost 2>/dev/null`"
 
290
        if [ $? -ne 0 ]; then
 
291
            ssh_fingerprint=""
 
292
        fi
 
293
        set -e
 
294
        ssh_fingerprint="${ssh_fingerprint#localhost }"
 
295
    fi
 
296
    
 
297
    # Import key into temporary key rings
 
298
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
299
        --homedir "$RINGDIR" --trust-model always --armor \
 
300
        --import "$SECKEYFILE"
 
301
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
302
        --homedir "$RINGDIR" --trust-model always --armor \
 
303
        --import "$PUBKEYFILE"
 
304
    
 
305
    # Get fingerprint of key
 
306
    FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
 
307
        --enable-dsa2 --homedir \"$RINGDIR\" --trust-model always \
 
308
        --fingerprint --with-colons \
 
309
        | sed --quiet \
 
310
        --expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
 
311
    
 
312
    test -n "$FINGERPRINT"
 
313
    
 
314
    FILECOMMENT="Encrypted password for a Mandos client"
 
315
    
 
316
    while [ ! -s "$SECFILE" ]; do
 
317
        if [ -n "$PASSFILE" ]; then
 
318
            cat "$PASSFILE"
 
319
        else
 
320
            tty --quiet && stty -echo
 
321
            echo -n "Enter passphrase: " >&2
 
322
            read first
 
323
            tty --quiet && echo >&2
 
324
            echo -n "Repeat passphrase: " >&2
 
325
            read second
 
326
            if tty --quiet; then
 
327
                echo >&2
 
328
                stty echo
 
329
            fi
 
330
            if [ "$first" != "$second" ]; then
 
331
                echo "Passphrase mismatch" >&2
 
332
                touch "$RINGDIR"/mismatch
 
333
            else
 
334
                echo -n "$first"
 
335
            fi
 
336
        fi | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
337
            --homedir "$RINGDIR" --trust-model always --armor \
 
338
            --encrypt --sign --recipient "$FINGERPRINT" --comment \
 
339
            "$FILECOMMENT" > "$SECFILE"
 
340
        if [ -e "$RINGDIR"/mismatch ]; then
 
341
            rm --force "$RINGDIR"/mismatch
 
342
            if tty --quiet; then
 
343
                > "$SECFILE"
 
344
            else
 
345
                exit 1
 
346
            fi
 
347
        fi
 
348
    done
 
349
    
 
350
    cat <<-EOF
 
351
        [$KEYNAME]
 
352
        host = $KEYNAME
 
353
        fingerprint = $FINGERPRINT
 
354
        secret =
 
355
        EOF
 
356
    sed --quiet --expression='
 
357
        /^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
 
358
            /^$/,${
 
359
                # Remove 24-bit Radix-64 checksum
 
360
                s/=....$//
 
361
                # Indent four spaces
 
362
                /^[^-]/s/^/    /p
 
363
            }
 
364
        }' < "$SECFILE"
 
365
    if [ -n "$ssh_fingerprint" ]; then
 
366
        echo 'checker = ssh-keyscan %%(host)s 2>/dev/null | grep --fixed-strings --line-regexp --quiet --regexp=%%(host)s" %(ssh_fingerprint)s"'
 
367
        echo "ssh_fingerprint = ${ssh_fingerprint}"
 
368
    fi
 
369
fi
 
370
 
 
371
trap - EXIT
 
372
 
 
373
set +e
 
374
# Remove the password file, if any
 
375
if [ -n "$SECFILE" ]; then
 
376
    shred --remove "$SECFILE"
 
377
fi
 
378
# Remove the key rings
 
379
shred --remove "$RINGDIR"/sec* 2>/dev/null
 
380
rm --recursive --force "$RINGDIR"