/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

  • Committer: Teddy Hogeborn
  • Date: 2009-01-06 02:42:53 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090106024253-7w4mfestd9sgk4rw
Merge release from release branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen
1
1
#!/bin/sh -e
2
2
# 
3
 
# Mandos key generator - create new keys for a Mandos client
4
 
# 
5
 
# Copyright © 2008-2019 Teddy Hogeborn
6
 
# Copyright © 2008-2019 Björn Påhlsson
7
 
# 
8
 
# This file is part of Mandos.
9
 
#
10
 
# Mandos is free software: you can redistribute it and/or modify it
11
 
# under the terms of the GNU General Public License as published by
 
3
# Mandos key generator - create a new OpenPGP key for a Mandos client
 
4
# 
 
5
# Copyright © 2008,2009 Teddy Hogeborn
 
6
# Copyright © 2008,2009 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
12
10
# the Free Software Foundation, either version 3 of the License, or
13
11
# (at your option) any later version.
14
12
#
15
 
#     Mandos is distributed in the hope that it will be useful, but
16
 
#     WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
#     This program is distributed in the hope that it will be useful,
 
14
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
17
15
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
16
#     GNU General Public License for more details.
19
17
# 
20
18
# You should have received a copy of the GNU General Public License
21
 
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
19
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
20
# 
23
 
# Contact the authors at <mandos@recompile.se>.
 
21
# Contact the authors at <mandos@fukt.bsnet.se>.
24
22
# 
25
23
 
26
 
VERSION="1.8.17"
 
24
VERSION="1.0.3"
27
25
 
28
26
KEYDIR="/etc/keys/mandos"
29
 
KEYTYPE=RSA
30
 
KEYLENGTH=4096
31
 
SUBKEYTYPE=RSA
32
 
SUBKEYLENGTH=4096
 
27
KEYTYPE=DSA
 
28
KEYLENGTH=2048
 
29
SUBKEYTYPE=ELG-E
 
30
SUBKEYLENGTH=2048
33
31
KEYNAME="`hostname --fqdn 2>/dev/null || hostname`"
34
32
KEYEMAIL=""
35
 
KEYCOMMENT=""
 
33
KEYCOMMENT="Mandos client key"
36
34
KEYEXPIRE=0
37
 
TLS_KEYTYPE=ed25519
38
35
FORCE=no
39
 
SSH=yes
40
36
KEYCOMMENT_ORIG="$KEYCOMMENT"
41
37
mode=keygen
42
38
 
45
41
fi
46
42
 
47
43
# Parse options
48
 
TEMP=`getopt --options vhpF:d:t:l:s:L:n:e:c:x:T:fS \
49
 
    --longoptions version,help,password,passfile:,dir:,type:,length:,subtype:,sublength:,name:,email:,comment:,expire:,tls-keytype:,force,no-ssh \
 
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 \
50
46
    --name "$0" -- "$@"`
51
47
 
52
48
help(){
53
 
basename="`basename "$0"`"
 
49
basename="`basename $0`"
54
50
cat <<EOF
55
51
Usage: $basename [ -v | --version ]
56
52
       $basename [ -h | --help ]
64
60
  -v, --version         Show program's version number and exit
65
61
  -h, --help            Show this help message and exit
66
62
  -d DIR, --dir DIR     Target directory for key files
67
 
  -t TYPE, --type TYPE  OpenPGP key type.  Default is RSA.
 
63
  -t TYPE, --type TYPE  Key type.  Default is DSA.
68
64
  -l BITS, --length BITS
69
 
                        OpenPGP key length in bits.  Default is 4096.
 
65
                        Key length in bits.  Default is 2048.
70
66
  -s TYPE, --subtype TYPE
71
 
                        OpenPGP subkey type.  Default is RSA.
 
67
                        Subkey type.  Default is ELG-E.
72
68
  -L BITS, --sublength BITS
73
 
                        OpenPGP subkey length in bits.  Default 4096.
 
69
                        Subkey length in bits.  Default is 2048.
74
70
  -n NAME, --name NAME  Name of key.  Default is the FQDN.
75
71
  -e ADDRESS, --email ADDRESS
76
 
                        Email address of OpenPGP key.  Default empty.
 
72
                        Email address of key.  Default is empty.
77
73
  -c TEXT, --comment TEXT
78
 
                        Comment field for OpenPGP key.  Default empty.
 
74
                        Comment field for key.  The default value is
 
75
                        "Mandos client key".
79
76
  -x TIME, --expire TIME
80
 
                        OpenPGP key expire time.  Default is none.
 
77
                        Key expire time.  Default is no expiration.
81
78
                        See gpg(1) for syntax.
82
 
  -T TYPE, --tls-keytype TYPE
83
 
                        TLS key type.  Default is ed25519.
84
79
  -f, --force           Force overwriting old key files.
85
80
 
86
81
Password creation options:
91
86
                        Encrypt a password from FILE using the key in
92
87
                        the key directory.  All options other than
93
88
                        --dir and --name are ignored.
94
 
  -S, --no-ssh          Don't get SSH key or set "checker" option.
95
89
EOF
96
90
}
97
91
 
109
103
        -e|--email) KEYEMAIL="$2"; shift 2;;
110
104
        -c|--comment) KEYCOMMENT="$2"; shift 2;;
111
105
        -x|--expire) KEYEXPIRE="$2"; shift 2;;
112
 
        -T|--tls-keytype) TLS_KEYTYPE="$2"; shift 2;;
113
106
        -f|--force) FORCE=yes; shift;;
114
 
        -S|--no-ssh) SSH=no; shift;;
115
107
        -v|--version) echo "$0 $VERSION"; exit;;
116
108
        -h|--help) help; exit;;
117
109
        --) shift; break;;
119
111
    esac
120
112
done
121
113
if [ "$#" -gt 0 ]; then
122
 
    echo "Unknown arguments: '$*'" >&2
 
114
    echo "Unknown arguments: '$@'" >&2
123
115
    exit 1
124
116
fi
125
117
 
126
118
SECKEYFILE="$KEYDIR/seckey.txt"
127
119
PUBKEYFILE="$KEYDIR/pubkey.txt"
128
 
TLS_PRIVKEYFILE="$KEYDIR/tls-privkey.pem"
129
 
TLS_PUBKEYFILE="$KEYDIR/tls-pubkey.pem"
130
120
 
131
121
# Check for some invalid values
132
122
if [ ! -d "$KEYDIR" ]; then
147
137
        echo "Empty key type" >&2
148
138
        exit 1
149
139
    fi
150
 
 
 
140
    
151
141
    if [ -z "$KEYNAME" ]; then
152
142
        echo "Empty key name" >&2
153
143
        exit 1
154
144
    fi
155
 
 
 
145
    
156
146
    if [ -z "$KEYLENGTH" ] || [ "$KEYLENGTH" -lt 512 ]; then
157
147
        echo "Invalid key length" >&2
158
148
        exit 1
162
152
        echo "Empty key expiration" >&2
163
153
        exit 1
164
154
    fi
165
 
 
 
155
    
166
156
    # Make FORCE be 0 or 1
167
157
    case "$FORCE" in
168
158
        [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) FORCE=1;;
169
159
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
170
160
    esac
171
 
 
172
 
    if { [ -e "$SECKEYFILE" ] || [ -e "$PUBKEYFILE" ] \
173
 
             || [ -e "$TLS_PRIVKEYFILE" ] \
174
 
             || [ -e "$TLS_PUBKEYFILE" ]; } \
175
 
        && [ "$FORCE" -eq 0 ]; then
 
161
    
 
162
    if [ \( -e "$SECKEYFILE" -o -e "$PUBKEYFILE" \) \
 
163
        -a "$FORCE" -eq 0 ]; then
176
164
        echo "Refusing to overwrite old key files; use --force" >&2
177
165
        exit 1
178
166
    fi
179
 
 
 
167
    
180
168
    # Set lines for GnuPG batch file
181
169
    if [ -n "$KEYCOMMENT" ]; then
182
170
        KEYCOMMENTLINE="Name-Comment: $KEYCOMMENT"
187
175
 
188
176
    # Create temporary gpg batch file
189
177
    BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
190
 
    TLS_PRIVKEYTMP="`mktemp -t mandos-keygen-privkey.XXXXXXXXXX`"
191
178
fi
192
179
 
193
180
if [ "$mode" = password ]; then
202
189
trap "
203
190
set +e; \
204
191
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
205
 
test -n \"$TLS_PRIVKEYTMP\" && shred --remove \"$TLS_PRIVKEYTMP\"; \
206
 
shred --remove \"$RINGDIR\"/sec* 2>/dev/null;
 
192
shred --remove \"$RINGDIR\"/sec*;
207
193
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
208
194
rm --recursive --force \"$RINGDIR\";
209
 
tty --quiet && stty echo; \
 
195
stty echo; \
210
196
" EXIT
211
197
 
212
 
set -e
213
 
 
214
198
umask 077
215
199
 
216
200
if [ "$mode" = keygen ]; then
218
202
    cat >"$BATCHFILE" <<-EOF
219
203
        Key-Type: $KEYTYPE
220
204
        Key-Length: $KEYLENGTH
221
 
        Key-Usage: sign,auth
 
205
        #Key-Usage: encrypt,sign,auth
222
206
        Subkey-Type: $SUBKEYTYPE
223
207
        Subkey-Length: $SUBKEYLENGTH
224
 
        Subkey-Usage: encrypt
 
208
        #Subkey-Usage: encrypt,sign,auth
225
209
        Name-Real: $KEYNAME
226
210
        $KEYCOMMENTLINE
227
211
        $KEYEMAILLINE
230
214
        #Handle: <no-spaces>
231
215
        #%pubring pubring.gpg
232
216
        #%secring secring.gpg
233
 
        %no-protection
234
217
        %commit
235
218
        EOF
236
 
 
237
 
    if tty --quiet; then
238
 
        cat <<-EOF
239
 
        Note: Due to entropy requirements, key generation could take
240
 
        anything from a few minutes to SEVERAL HOURS.  Please be
241
 
        patient and/or supply the system with more entropy if needed.
242
 
        EOF
243
 
        echo -n "Started: "
244
 
        date
245
 
    fi
246
 
 
247
 
    # Generate TLS private key
248
 
    if certtool --generate-privkey --password='' \
249
 
                --outfile "$TLS_PRIVKEYTMP" --sec-param ultra \
250
 
                --key-type="$TLS_KEYTYPE" --pkcs8 --no-text 2>/dev/null; then
251
 
        
252
 
        # Backup any old key files
253
 
        if cp --backup=numbered --force "$TLS_PRIVKEYFILE" "$TLS_PRIVKEYFILE" \
254
 
              2>/dev/null; then
255
 
            shred --remove "$TLS_PRIVKEYFILE" 2>/dev/null || :
256
 
        fi
257
 
        if cp --backup=numbered --force "$TLS_PUBKEYFILE" "$TLS_PUBKEYFILE" \
258
 
              2>/dev/null; then
259
 
            rm --force "$TLS_PUBKEYFILE"
260
 
        fi
261
 
        cp --archive "$TLS_PRIVKEYTMP" "$TLS_PRIVKEYFILE"
262
 
        shred --remove "$TLS_PRIVKEYTMP" 2>/dev/null || :
263
 
 
264
 
        ## TLS public key
265
 
 
266
 
        # First try certtool from GnuTLS
267
 
        if ! certtool --password='' --load-privkey="$TLS_PRIVKEYFILE" \
268
 
             --outfile="$TLS_PUBKEYFILE" --pubkey-info --no-text \
269
 
             2>/dev/null; then
270
 
            # Otherwise try OpenSSL
271
 
            if ! openssl pkey -in "$TLS_PRIVKEYFILE" \
272
 
                 -out "$TLS_PUBKEYFILE" -pubout; then
273
 
                rm --force "$TLS_PUBKEYFILE"
274
 
                # None of the commands succeded; give up
275
 
                return 1
276
 
            fi
277
 
        fi
278
 
    fi
279
 
 
280
 
    # Make sure trustdb.gpg exists;
281
 
    # this is a workaround for Debian bug #737128
282
 
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
283
 
        --homedir "$RINGDIR" \
284
 
        --import-ownertrust < /dev/null
 
219
    
285
220
    # Generate a new key in the key rings
286
221
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
287
222
        --homedir "$RINGDIR" --trust-model always \
288
223
        --gen-key "$BATCHFILE"
289
224
    rm --force "$BATCHFILE"
290
 
 
291
 
    if tty --quiet; then
292
 
        echo -n "Finished: "
293
 
        date
294
 
    fi
295
 
 
 
225
    
296
226
    # Backup any old key files
297
227
    if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
298
228
        2>/dev/null; then
299
 
        shred --remove "$SECKEYFILE" 2>/dev/null || :
 
229
        shred --remove "$SECKEYFILE"
300
230
    fi
301
231
    if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
302
232
        2>/dev/null; then
303
233
        rm --force "$PUBKEYFILE"
304
234
    fi
305
 
 
 
235
    
306
236
    FILECOMMENT="Mandos client key for $KEYNAME"
307
237
    if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
308
238
        FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
309
239
    fi
310
 
 
 
240
    
311
241
    if [ -n "$KEYEMAIL" ]; then
312
242
        FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
313
243
    fi
314
 
 
 
244
    
315
245
    # Export key from key rings to key files
316
246
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
317
247
        --homedir "$RINGDIR" --armor --export-options export-minimal \
323
253
fi
324
254
 
325
255
if [ "$mode" = password ]; then
326
 
 
327
 
    # Make SSH be 0 or 1
328
 
    case "$SSH" in
329
 
        [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) SSH=1;;
330
 
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) SSH=0;;
331
 
    esac
332
 
 
333
 
    if [ $SSH -eq 1 ]; then
334
 
        for ssh_keytype in ecdsa-sha2-nistp256 ed25519 rsa; do
335
 
            set +e
336
 
            ssh_fingerprint="`ssh-keyscan -t $ssh_keytype localhost 2>/dev/null`"
337
 
            err=$?
338
 
            set -e
339
 
            if [ $err -ne 0 ]; then
340
 
                ssh_fingerprint=""
341
 
                continue
342
 
            fi
343
 
            if [ -n "$ssh_fingerprint" ]; then
344
 
                ssh_fingerprint="${ssh_fingerprint#localhost }"
345
 
                break
346
 
            fi
347
 
        done
348
 
    fi
349
 
 
350
256
    # Import key into temporary key rings
351
257
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
352
258
        --homedir "$RINGDIR" --trust-model always --armor \
354
260
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
355
261
        --homedir "$RINGDIR" --trust-model always --armor \
356
262
        --import "$PUBKEYFILE"
357
 
 
 
263
    
358
264
    # Get fingerprint of key
359
265
    FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
360
 
        --enable-dsa2 --homedir "$RINGDIR" --trust-model always \
 
266
        --enable-dsa2 --homedir \"$RINGDIR\" --trust-model always \
361
267
        --fingerprint --with-colons \
362
268
        | sed --quiet \
363
269
        --expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
364
 
 
 
270
    
365
271
    test -n "$FINGERPRINT"
366
 
 
367
 
    if [ -r "$TLS_PUBKEYFILE" ]; then
368
 
       KEY_ID="$(certtool --key-id --hash=sha256 \
369
 
                       --infile="$TLS_PUBKEYFILE" 2>/dev/null || :)"
370
 
 
371
 
       if [ -z "$KEY_ID" ]; then
372
 
           KEY_ID=$(openssl pkey -pubin -in "$TLS_PUBKEYFILE" \
373
 
                            -outform der \
374
 
                        | openssl sha256 \
375
 
                        | sed --expression='s/^.*[^[:xdigit:]]//')
376
 
       fi
377
 
       test -n "$KEY_ID"
378
 
    fi
379
 
 
 
272
    
380
273
    FILECOMMENT="Encrypted password for a Mandos client"
381
 
 
382
 
    while [ ! -s "$SECFILE" ]; do
383
 
        if [ -n "$PASSFILE" ]; then
384
 
            cat -- "$PASSFILE"
 
274
    
 
275
    if [ -n "$PASSFILE" ]; then
 
276
        cat "$PASSFILE"
 
277
    else
 
278
        stty -echo
 
279
        echo -n "Enter passphrase: " >&2
 
280
        first="$(head --lines=1 | tr --delete '\n')"
 
281
        echo -n -e "\nRepeat passphrase: " >&2
 
282
        second="$(head --lines=1 | tr --delete '\n')"
 
283
        echo >&2
 
284
        stty echo
 
285
        if [ "$first" != "$second" ]; then
 
286
            echo -e "Passphrase mismatch" >&2
 
287
            false
385
288
        else
386
 
            tty --quiet && stty -echo
387
 
            echo -n "Enter passphrase: " >/dev/tty
388
 
            read -r first
389
 
            tty --quiet && echo >&2
390
 
            echo -n "Repeat passphrase: " >/dev/tty
391
 
            read -r second
392
 
            if tty --quiet; then
393
 
                echo >&2
394
 
                stty echo
395
 
            fi
396
 
            if [ "$first" != "$second" ]; then
397
 
                echo "Passphrase mismatch" >&2
398
 
                touch "$RINGDIR"/mismatch
399
 
            else
400
 
                printf "%s" "$first"
401
 
            fi
402
 
        fi | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
403
 
            --homedir "$RINGDIR" --trust-model always --armor \
404
 
            --encrypt --sign --recipient "$FINGERPRINT" --comment \
405
 
            "$FILECOMMENT" > "$SECFILE"
406
 
        if [ -e "$RINGDIR"/mismatch ]; then
407
 
            rm --force "$RINGDIR"/mismatch
408
 
            if tty --quiet; then
409
 
                > "$SECFILE"
410
 
            else
411
 
                exit 1
412
 
            fi
 
289
            echo -n "$first"
413
290
        fi
414
 
    done
415
 
 
 
291
    fi | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
292
        --homedir "$RINGDIR" --trust-model always --armor --encrypt \
 
293
        --sign --recipient "$FINGERPRINT" --comment "$FILECOMMENT" \
 
294
        > "$SECFILE"
 
295
    status="${PIPESTATUS[0]}"
 
296
    if [ "$status" -ne 0 ]; then
 
297
        exit "$status"
 
298
    fi
 
299
    
416
300
    cat <<-EOF
417
301
        [$KEYNAME]
418
302
        host = $KEYNAME
419
 
        EOF
420
 
    if [ -n "$KEY_ID" ]; then
421
 
        echo "key_id = $KEY_ID"
422
 
    fi
423
 
    cat <<-EOF
424
303
        fingerprint = $FINGERPRINT
425
304
        secret =
426
305
        EOF
433
312
                /^[^-]/s/^/    /p
434
313
            }
435
314
        }' < "$SECFILE"
436
 
    if [ -n "$ssh_fingerprint" ]; then
437
 
        echo 'checker = ssh-keyscan -t '"$ssh_keytype"' %%(host)s 2>/dev/null | grep --fixed-strings --line-regexp --quiet --regexp=%%(host)s" %(ssh_fingerprint)s"'
438
 
        echo "ssh_fingerprint = ${ssh_fingerprint}"
439
 
    fi
440
315
fi
441
316
 
442
317
trap - EXIT
444
319
set +e
445
320
# Remove the password file, if any
446
321
if [ -n "$SECFILE" ]; then
447
 
    shred --remove "$SECFILE" 2>/dev/null
 
322
    shred --remove "$SECFILE"
448
323
fi
449
324
# Remove the key rings
450
 
shred --remove "$RINGDIR"/sec* 2>/dev/null
 
325
shred --remove "$RINGDIR"/sec*
451
326
rm --recursive --force "$RINGDIR"