/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: 2008-09-06 17:24:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080906172458-2x5wlfkn7oqckt1y
* legalnotice.xml: Copy DocBook 4.4-formatted text from
                   <http://www.gnu.org/licenses/gpl-3.0.dbk>.

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