/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: 2017-02-21 21:42:08 UTC
  • Revision ID: teddy@recompile.se-20170221214208-09wu1p4l2hjhqfoj
Use "read -r" in shell scripts to avoid backslash escapes

* initramfs-tools-hook: Use "read -r" to read filenames from network
  hook given the "files" argument.
* initramfs-tools-script: Use "read -e" when parsing
  "/conf/conf.d/cryptroot".
* mandos-keygen (keygen): Use "read -r" when reading passphrase.

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 © 2008,2009 Teddy Hogeborn
6
 
# Copyright © 2008,2009 Björn Påhlsson
 
5
# Copyright © 2008-2016 Teddy Hogeborn
 
6
# Copyright © 2008-2016 Björn Påhlsson
7
7
# 
8
8
# This program is free software: you can redistribute it and/or modify
9
9
# it under the terms of the GNU General Public License as published by
18
18
# You should have received a copy of the GNU General Public License
19
19
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
20
20
# 
21
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
21
# Contact the authors at <mandos@recompile.se>.
22
22
# 
23
23
 
24
 
VERSION="1.0.3"
 
24
VERSION="1.7.14"
25
25
 
26
26
KEYDIR="/etc/keys/mandos"
27
 
KEYTYPE=DSA
28
 
KEYLENGTH=2048
29
 
SUBKEYTYPE=ELG-E
30
 
SUBKEYLENGTH=2048
 
27
KEYTYPE=RSA
 
28
KEYLENGTH=4096
 
29
SUBKEYTYPE=RSA
 
30
SUBKEYLENGTH=4096
31
31
KEYNAME="`hostname --fqdn 2>/dev/null || hostname`"
32
32
KEYEMAIL=""
33
 
KEYCOMMENT="Mandos client key"
 
33
KEYCOMMENT=""
34
34
KEYEXPIRE=0
35
35
FORCE=no
 
36
SSH=yes
36
37
KEYCOMMENT_ORIG="$KEYCOMMENT"
37
38
mode=keygen
38
39
 
41
42
fi
42
43
 
43
44
# Parse options
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 \
 
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 \
46
47
    --name "$0" -- "$@"`
47
48
 
48
49
help(){
49
 
basename="`basename $0`"
 
50
basename="`basename "$0"`"
50
51
cat <<EOF
51
52
Usage: $basename [ -v | --version ]
52
53
       $basename [ -h | --help ]
60
61
  -v, --version         Show program's version number and exit
61
62
  -h, --help            Show this help message and exit
62
63
  -d DIR, --dir DIR     Target directory for key files
63
 
  -t TYPE, --type TYPE  Key type.  Default is DSA.
 
64
  -t TYPE, --type TYPE  Key type.  Default is RSA.
64
65
  -l BITS, --length BITS
65
 
                        Key length in bits.  Default is 2048.
 
66
                        Key length in bits.  Default is 4096.
66
67
  -s TYPE, --subtype TYPE
67
 
                        Subkey type.  Default is ELG-E.
 
68
                        Subkey type.  Default is RSA.
68
69
  -L BITS, --sublength BITS
69
 
                        Subkey length in bits.  Default is 2048.
 
70
                        Subkey length in bits.  Default is 4096.
70
71
  -n NAME, --name NAME  Name of key.  Default is the FQDN.
71
72
  -e ADDRESS, --email ADDRESS
72
73
                        Email address of key.  Default is empty.
73
74
  -c TEXT, --comment TEXT
74
 
                        Comment field for key.  The default value is
75
 
                        "Mandos client key".
 
75
                        Comment field for key.  The default is empty.
76
76
  -x TIME, --expire TIME
77
77
                        Key expire time.  Default is no expiration.
78
78
                        See gpg(1) for syntax.
86
86
                        Encrypt a password from FILE using the key in
87
87
                        the key directory.  All options other than
88
88
                        --dir and --name are ignored.
 
89
  -S, --no-ssh          Don't get SSH key or set "checker" option.
89
90
EOF
90
91
}
91
92
 
104
105
        -c|--comment) KEYCOMMENT="$2"; shift 2;;
105
106
        -x|--expire) KEYEXPIRE="$2"; shift 2;;
106
107
        -f|--force) FORCE=yes; shift;;
 
108
        -S|--no-ssh) SSH=no; shift;;
107
109
        -v|--version) echo "$0 $VERSION"; exit;;
108
110
        -h|--help) help; exit;;
109
111
        --) shift; break;;
111
113
    esac
112
114
done
113
115
if [ "$#" -gt 0 ]; then
114
 
    echo "Unknown arguments: '$@'" >&2
 
116
    echo "Unknown arguments: '$*'" >&2
115
117
    exit 1
116
118
fi
117
119
 
147
149
        echo "Invalid key length" >&2
148
150
        exit 1
149
151
    fi
150
 
 
 
152
    
151
153
    if [ -z "$KEYEXPIRE" ]; then
152
154
        echo "Empty key expiration" >&2
153
155
        exit 1
172
174
    if [ -n "$KEYEMAIL" ]; then
173
175
        KEYEMAILLINE="Name-Email: $KEYEMAIL"
174
176
    fi
175
 
 
 
177
    
176
178
    # Create temporary gpg batch file
177
179
    BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
178
180
fi
189
191
trap "
190
192
set +e; \
191
193
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
192
 
shred --remove \"$RINGDIR\"/sec*;
 
194
shred --remove \"$RINGDIR\"/sec* 2>/dev/null;
193
195
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
194
196
rm --recursive --force \"$RINGDIR\";
195
 
stty echo; \
 
197
tty --quiet && stty echo; \
196
198
" EXIT
197
199
 
 
200
set -e
 
201
 
198
202
umask 077
199
203
 
200
204
if [ "$mode" = keygen ]; then
202
206
    cat >"$BATCHFILE" <<-EOF
203
207
        Key-Type: $KEYTYPE
204
208
        Key-Length: $KEYLENGTH
205
 
        #Key-Usage: encrypt,sign,auth
 
209
        Key-Usage: sign,auth
206
210
        Subkey-Type: $SUBKEYTYPE
207
211
        Subkey-Length: $SUBKEYLENGTH
208
 
        #Subkey-Usage: encrypt,sign,auth
 
212
        Subkey-Usage: encrypt
209
213
        Name-Real: $KEYNAME
210
214
        $KEYCOMMENTLINE
211
215
        $KEYEMAILLINE
214
218
        #Handle: <no-spaces>
215
219
        #%pubring pubring.gpg
216
220
        #%secring secring.gpg
 
221
        %no-protection
217
222
        %commit
218
223
        EOF
219
224
    
 
225
    if tty --quiet; then
 
226
        cat <<-EOF
 
227
        Note: Due to entropy requirements, key generation could take
 
228
        anything from a few minutes to SEVERAL HOURS.  Please be
 
229
        patient and/or supply the system with more entropy if needed.
 
230
        EOF
 
231
        echo -n "Started: "
 
232
        date
 
233
    fi
 
234
    
 
235
    # Make sure trustdb.gpg exists;
 
236
    # this is a workaround for Debian bug #737128
 
237
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
238
        --homedir "$RINGDIR" \
 
239
        --import-ownertrust < /dev/null
220
240
    # Generate a new key in the key rings
221
241
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
222
242
        --homedir "$RINGDIR" --trust-model always \
223
243
        --gen-key "$BATCHFILE"
224
244
    rm --force "$BATCHFILE"
225
245
    
 
246
    if tty --quiet; then
 
247
        echo -n "Finished: "
 
248
        date
 
249
    fi
 
250
    
226
251
    # Backup any old key files
227
252
    if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
228
253
        2>/dev/null; then
253
278
fi
254
279
 
255
280
if [ "$mode" = password ]; then
 
281
    
 
282
    # Make SSH be 0 or 1
 
283
    case "$SSH" in
 
284
        [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) SSH=1;;
 
285
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) SSH=0;;
 
286
    esac
 
287
    
 
288
    if [ $SSH -eq 1 ]; then
 
289
        for ssh_keytype in ecdsa-sha2-nistp256 ed25519 rsa; do
 
290
            set +e
 
291
            ssh_fingerprint="`ssh-keyscan -t $ssh_keytype localhost 2>/dev/null`"
 
292
            set -e
 
293
            if [ $? -ne 0 ]; then
 
294
                ssh_fingerprint=""
 
295
                continue
 
296
            fi
 
297
            if [ -n "$ssh_fingerprint" ]; then
 
298
                ssh_fingerprint="${ssh_fingerprint#localhost }"
 
299
                break
 
300
            fi
 
301
        done
 
302
    fi
 
303
    
256
304
    # Import key into temporary key rings
257
305
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
258
306
        --homedir "$RINGDIR" --trust-model always --armor \
263
311
    
264
312
    # Get fingerprint of key
265
313
    FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
266
 
        --enable-dsa2 --homedir \"$RINGDIR\" --trust-model always \
 
314
        --enable-dsa2 --homedir "$RINGDIR" --trust-model always \
267
315
        --fingerprint --with-colons \
268
316
        | sed --quiet \
269
317
        --expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
272
320
    
273
321
    FILECOMMENT="Encrypted password for a Mandos client"
274
322
    
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
 
323
    while [ ! -s "$SECFILE" ]; do
 
324
        if [ -n "$PASSFILE" ]; then
 
325
            cat "$PASSFILE"
288
326
        else
289
 
            echo -n "$first"
 
327
            tty --quiet && stty -echo
 
328
            echo -n "Enter passphrase: " >/dev/tty
 
329
            read -r first
 
330
            tty --quiet && echo >&2
 
331
            echo -n "Repeat passphrase: " >/dev/tty
 
332
            read -r second
 
333
            if tty --quiet; then
 
334
                echo >&2
 
335
                stty echo
 
336
            fi
 
337
            if [ "$first" != "$second" ]; then
 
338
                echo "Passphrase mismatch" >&2
 
339
                touch "$RINGDIR"/mismatch
 
340
            else
 
341
                echo -n "$first"
 
342
            fi
 
343
        fi | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
344
            --homedir "$RINGDIR" --trust-model always --armor \
 
345
            --encrypt --sign --recipient "$FINGERPRINT" --comment \
 
346
            "$FILECOMMENT" > "$SECFILE"
 
347
        if [ -e "$RINGDIR"/mismatch ]; then
 
348
            rm --force "$RINGDIR"/mismatch
 
349
            if tty --quiet; then
 
350
                > "$SECFILE"
 
351
            else
 
352
                exit 1
 
353
            fi
290
354
        fi
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
 
355
    done
299
356
    
300
357
    cat <<-EOF
301
358
        [$KEYNAME]
312
369
                /^[^-]/s/^/    /p
313
370
            }
314
371
        }' < "$SECFILE"
 
372
    if [ -n "$ssh_fingerprint" ]; then
 
373
        echo 'checker = ssh-keyscan -t '"$ssh_keytype"' %%(host)s 2>/dev/null | grep --fixed-strings --line-regexp --quiet --regexp=%%(host)s" %(ssh_fingerprint)s"'
 
374
        echo "ssh_fingerprint = ${ssh_fingerprint}"
 
375
    fi
315
376
fi
316
377
 
317
378
trap - EXIT
322
383
    shred --remove "$SECFILE"
323
384
fi
324
385
# Remove the key rings
325
 
shred --remove "$RINGDIR"/sec*
 
386
shred --remove "$RINGDIR"/sec* 2>/dev/null
326
387
rm --recursive --force "$RINGDIR"