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

Tags: version-1.2-1
* Makefile (version): Changed to "1.2".
* NEWS (Version 1.2): New entry.
* debian/changelog (1.2): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen
2
2
# 
3
3
# Mandos key generator - create a new OpenPGP key for a Mandos client
4
4
# 
5
 
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
 
5
# Copyright © 2008-2010 Teddy Hogeborn
 
6
# Copyright © 2008-2010 Björn Påhlsson
6
7
# 
7
8
# This program is free software: you can redistribute it and/or modify
8
9
# it under the terms of the GNU General Public License as published by
20
21
# Contact the authors at <mandos@fukt.bsnet.se>.
21
22
# 
22
23
 
23
 
VERSION="1.0"
 
24
VERSION="1.2"
24
25
 
25
 
KEYDIR="/etc/mandos"
 
26
KEYDIR="/etc/keys/mandos"
26
27
KEYTYPE=DSA
27
28
KEYLENGTH=2048
28
29
SUBKEYTYPE=ELG-E
29
30
SUBKEYLENGTH=2048
30
 
KEYNAME="`hostname --fqdn`"
 
31
KEYNAME="`hostname --fqdn 2>/dev/null || hostname`"
31
32
KEYEMAIL=""
32
33
KEYCOMMENT="Mandos client key"
33
34
KEYEXPIRE=0
35
36
KEYCOMMENT_ORIG="$KEYCOMMENT"
36
37
mode=keygen
37
38
 
 
39
if [ ! -d "$KEYDIR" ]; then
 
40
    KEYDIR="/etc/mandos/keys"
 
41
fi
 
42
 
38
43
# Parse options
39
 
TEMP=`getopt --options vhd:t:l:n:e:c:x:f \
40
 
    --longoptions version,help,password,dir:,type:,length:,subtype:,sublength:,name:,email:,comment:,expire:,force \
 
44
TEMP=`getopt --options vhpF:d:t:l:s:L:n:e:c:x:f \
 
45
    --longoptions version,help,password,passfile:,dir:,type:,length:,subtype:,sublength:,name:,email:,comment:,expire:,force \
41
46
    --name "$0" -- "$@"`
42
47
 
43
48
help(){
49
54
       $basename [ OPTIONS ]
50
55
   Encrypted password creation:
51
56
       $basename { -p | --password } [ --name NAME ] [ --dir DIR]
 
57
       $basename { -F | --passfile } FILE [ --name NAME ] [ --dir DIR]
52
58
 
53
59
Key creation options:
54
60
  -v, --version         Show program's version number and exit
70
76
  -x TIME, --expire TIME
71
77
                        Key expire time.  Default is no expiration.
72
78
                        See gpg(1) for syntax.
73
 
  -f, --force           Force overwriting old keys.
 
79
  -f, --force           Force overwriting old key files.
74
80
 
75
81
Password creation options:
76
 
  -p, --password        Create an encrypted password using the keys in
 
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
77
87
                        the key directory.  All options other than
78
88
                        --dir and --name are ignored.
79
89
EOF
83
93
while :; do
84
94
    case "$1" in
85
95
        -p|--password) mode=password; shift;;
 
96
        -F|--passfile) mode=password; PASSFILE="$2"; shift 2;;
86
97
        -d|--dir) KEYDIR="$2"; shift 2;;
87
98
        -t|--type) KEYTYPE="$2"; shift 2;;
88
99
        -s|--subtype) SUBKEYTYPE="$2"; shift 2;;
108
119
PUBKEYFILE="$KEYDIR/pubkey.txt"
109
120
 
110
121
# Check for some invalid values
111
 
if [ -d "$KEYDIR" ]; then :; else
 
122
if [ ! -d "$KEYDIR" ]; then
112
123
    echo "$KEYDIR not a directory" >&2
113
124
    exit 1
114
125
fi
115
 
if [ -w "$KEYDIR" ]; then :; else
116
 
    echo "Directory $KEYDIR not writeable" >&2
117
 
    exit 1
118
 
fi
119
 
 
120
 
if [ "$mode" = password -a -e "$KEYDIR/trustdb.gpg.lock" ]; then
121
 
    echo "Key directory has locked trustdb; aborting." >&2
 
126
if [ ! -r "$KEYDIR" ]; then
 
127
    echo "Directory $KEYDIR not readable" >&2
122
128
    exit 1
123
129
fi
124
130
 
125
131
if [ "$mode" = keygen ]; then
 
132
    if [ ! -w "$KEYDIR" ]; then
 
133
        echo "Directory $KEYDIR not writeable" >&2
 
134
        exit 1
 
135
    fi
126
136
    if [ -z "$KEYTYPE" ]; then
127
137
        echo "Empty key type" >&2
128
138
        exit 1
137
147
        echo "Invalid key length" >&2
138
148
        exit 1
139
149
    fi
140
 
 
 
150
    
141
151
    if [ -z "$KEYEXPIRE" ]; then
142
152
        echo "Empty key expiration" >&2
143
153
        exit 1
149
159
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
150
160
    esac
151
161
    
152
 
    if { [ -e "$SECKEYFILE" ] || [ -e "$PUBKEYFILE" ]; } \
153
 
        && [ "$FORCE" -eq 0 ]; then
 
162
    if [ \( -e "$SECKEYFILE" -o -e "$PUBKEYFILE" \) \
 
163
        -a "$FORCE" -eq 0 ]; then
154
164
        echo "Refusing to overwrite old key files; use --force" >&2
155
165
        exit 1
156
166
    fi
162
172
    if [ -n "$KEYEMAIL" ]; then
163
173
        KEYEMAILLINE="Name-Email: $KEYEMAIL"
164
174
    fi
165
 
 
 
175
    
166
176
    # Create temporary gpg batch file
167
 
    BATCHFILE="`mktemp -t mandos-gpg-batch.XXXXXXXXXX`"
 
177
    BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
168
178
fi
169
179
 
170
180
if [ "$mode" = password ]; then
171
181
    # Create temporary encrypted password file
172
 
    SECFILE="`mktemp -t mandos-gpg-secfile.XXXXXXXXXX`"
173
 
fi
174
 
 
175
 
# Create temporary key rings
176
 
SECRING="`mktemp -t mandos-gpg-secring.XXXXXXXXXX`"
177
 
PUBRING="`mktemp -t mandos-gpg-pubring.XXXXXXXXXX`"
178
 
 
179
 
if [ "$mode" = password ]; then
180
 
    # If a trustdb.gpg file does not already exist, schedule it for
181
 
    # deletion when we are done.
182
 
    if ! [ -e "$KEYDIR/trustdb.gpg" ]; then
183
 
        TRUSTDB="$KEYDIR/trustdb.gpg"
184
 
    fi
185
 
fi
 
182
    SECFILE="`mktemp -t mandos-keygen-secfile.XXXXXXXXXX`"
 
183
fi
 
184
 
 
185
# Create temporary key ring directory
 
186
RINGDIR="`mktemp -d -t mandos-keygen-keyrings.XXXXXXXXXX`"
186
187
 
187
188
# Remove temporary files on exit
188
189
trap "
189
190
set +e; \
190
 
rm --force $PUBRING ${PUBRING}~ $BATCHFILE $TRUSTDB; \
191
 
shred --remove $SECRING $SECFILE; \
 
191
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
 
192
shred --remove \"$RINGDIR\"/sec*;
 
193
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
 
194
rm --recursive --force \"$RINGDIR\";
192
195
stty echo; \
193
196
" EXIT
194
197
 
195
 
umask 027
 
198
umask 077
196
199
 
197
200
if [ "$mode" = keygen ]; then
198
201
    # Create batch file for GnuPG
209
212
        Expire-Date: $KEYEXPIRE
210
213
        #Preferences: <string>
211
214
        #Handle: <no-spaces>
212
 
        %pubring $PUBRING
213
 
        %secring $SECRING
 
215
        #%pubring pubring.gpg
 
216
        #%secring secring.gpg
214
217
        %commit
215
218
        EOF
216
219
    
 
220
    if tty --quiet; then
 
221
        cat <<-EOF
 
222
        Note: Due to entropy requirements, key generation could take
 
223
        anything from a few minutes to SEVERAL HOURS.  Please be
 
224
        patient and/or supply the system with more entropy if needed.
 
225
        EOF
 
226
        echo -n "Started: "
 
227
        date
 
228
    fi
 
229
    
217
230
    # Generate a new key in the key rings
218
 
    gpg --no-random-seed-file --quiet --batch --no-tty \
219
 
        --no-default-keyring --no-options --enable-dsa2 \
220
 
        --secret-keyring "$SECRING" --keyring "$PUBRING" \
 
231
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
232
        --homedir "$RINGDIR" --trust-model always \
221
233
        --gen-key "$BATCHFILE"
222
234
    rm --force "$BATCHFILE"
223
 
 
 
235
    
 
236
    if tty --quiet; then
 
237
        echo -n "Finished: "
 
238
        date
 
239
    fi
 
240
    
224
241
    # Backup any old key files
225
242
    if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
226
243
        2>/dev/null; then
240
257
        FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
241
258
    fi
242
259
    
243
 
    # Export keys from key rings to key files
244
 
    gpg --no-random-seed-file --quiet --batch --no-tty --armor \
245
 
        --no-default-keyring --no-options --enable-dsa2 \
246
 
        --secret-keyring "$SECRING" --keyring "$PUBRING" \
247
 
        --export-options export-minimal --comment "$FILECOMMENT" \
248
 
        --output "$SECKEYFILE" --export-secret-keys
249
 
    gpg --no-random-seed-file --quiet --batch --no-tty --armor \
250
 
        --no-default-keyring --no-options --enable-dsa2 \
251
 
        --secret-keyring "$SECRING" --keyring "$PUBRING" \
252
 
        --export-options export-minimal --comment "$FILECOMMENT" \
253
 
        --output "$PUBKEYFILE" --export
 
260
    # Export key from key rings to key files
 
261
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
262
        --homedir "$RINGDIR" --armor --export-options export-minimal \
 
263
        --comment "$FILECOMMENT" --output "$SECKEYFILE" \
 
264
        --export-secret-keys
 
265
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
266
        --homedir "$RINGDIR" --armor --export-options export-minimal \
 
267
        --comment "$FILECOMMENT" --output "$PUBKEYFILE" --export
254
268
fi
255
269
 
256
270
if [ "$mode" = password ]; then
257
 
    # Import keys into temporary key rings
258
 
    gpg --no-random-seed-file --quiet --batch --no-tty --armor \
259
 
        --no-default-keyring --no-options --enable-dsa2 \
260
 
        --homedir "$KEYDIR" --no-permission-warning \
261
 
        --secret-keyring "$SECRING" --keyring "$PUBRING" \
262
 
        --trust-model always --import "$SECKEYFILE"
263
 
    gpg --no-random-seed-file --quiet --batch --no-tty --armor \
264
 
        --no-default-keyring --no-options --enable-dsa2 \
265
 
        --homedir "$KEYDIR" --no-permission-warning \
266
 
        --secret-keyring "$SECRING" --keyring "$PUBRING" \
267
 
        --trust-model always --import "$PUBKEYFILE"
268
 
 
 
271
    # Import key into temporary key rings
 
272
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
273
        --homedir "$RINGDIR" --trust-model always --armor \
 
274
        --import "$SECKEYFILE"
 
275
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
276
        --homedir "$RINGDIR" --trust-model always --armor \
 
277
        --import "$PUBKEYFILE"
 
278
    
269
279
    # Get fingerprint of key
270
 
    FINGERPRINT="`gpg --no-random-seed-file --quiet --batch --no-tty \
271
 
        --armor --no-default-keyring --no-options --enable-dsa2 \
272
 
        --homedir \"$KEYDIR\" --no-permission-warning \
273
 
        --secret-keyring \"$SECRING\" --keyring \"$PUBRING\" \
274
 
        --trust-model always --fingerprint --with-colons \
275
 
        | sed -n -e '/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
 
280
    FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
 
281
        --enable-dsa2 --homedir \"$RINGDIR\" --trust-model always \
 
282
        --fingerprint --with-colons \
 
283
        | sed --quiet \
 
284
        --expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
276
285
    
277
286
    test -n "$FINGERPRINT"
278
287
    
279
288
    FILECOMMENT="Encrypted password for a Mandos client"
280
289
    
281
 
    stty -echo
282
 
    echo -n "Enter passphrase: " >&2
283
 
    sed -e '1q' \
284
 
        | gpg --no-random-seed-file --batch --no-tty --armor \
285
 
        --no-default-keyring --no-options --enable-dsa2 \
286
 
        --homedir "$KEYDIR" --no-permission-warning \
287
 
        --secret-keyring "$SECRING" --keyring "$PUBRING" \
288
 
        --trust-model always --encrypt --recipient "$FINGERPRINT" \
289
 
        --comment "$FILECOMMENT" \
 
290
    if [ -n "$PASSFILE" ]; then
 
291
        cat "$PASSFILE"
 
292
    else
 
293
        stty -echo
 
294
        echo -n "Enter passphrase: " >&2
 
295
        first="$(head --lines=1 | tr --delete '\n')"
 
296
        echo >&2
 
297
        echo -n "Repeat passphrase: " >&2
 
298
        second="$(head --lines=1 | tr --delete '\n')"
 
299
        echo >&2
 
300
        stty echo
 
301
        if [ "$first" != "$second" ]; then
 
302
            echo "Passphrase mismatch" >&2
 
303
            touch "$RINGDIR"/mismatch
 
304
        else
 
305
            echo -n "$first"
 
306
        fi
 
307
    fi | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
308
        --homedir "$RINGDIR" --trust-model always --armor --encrypt \
 
309
        --sign --recipient "$FINGERPRINT" --comment "$FILECOMMENT" \
290
310
        > "$SECFILE"
291
 
    echo >&2
292
 
    stty echo
 
311
    if [ -e "$RINGDIR"/mismatch ]; then
 
312
        rm --force "$RINGDIR"/mismatch
 
313
        exit 1
 
314
    fi
293
315
    
294
316
    cat <<-EOF
295
317
        [$KEYNAME]
296
318
        host = $KEYNAME
297
319
        fingerprint = $FINGERPRINT
298
320
        secret =
299
 
EOF
300
 
    sed -n -e '
 
321
        EOF
 
322
    sed --quiet --expression='
301
323
        /^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
302
324
            /^$/,${
303
325
                # Remove 24-bit Radix-64 checksum
316
338
    shred --remove "$SECFILE"
317
339
fi
318
340
# Remove the key rings
319
 
shred --remove "$SECRING"
320
 
rm --force "$PUBRING" "${PUBRING}~"
321
 
# Remove the trustdb, if one did not exist when we started
322
 
if [ -n "$TRUSTDB" ]; then
323
 
    rm --force "$TRUSTDB"
324
 
fi
 
341
shred --remove "$RINGDIR"/sec*
 
342
rm --recursive --force "$RINGDIR"