/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: 2015-01-25 00:02:51 UTC
  • Revision ID: teddy@recompile.se-20150125000251-j2bw50gfq9smqyxe
mandos.xml (SEE ALSO): Update links.

Update link to GnuPG home page, change reference from TLS 1.1 to TLS
1.2, and change to latest RFC for using OpenPGP keys with TLS (and use
its correct title).

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-2014 Teddy Hogeborn
 
6
# Copyright © 2008-2014 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
17
18
# You should have received a copy of the GNU General Public License
18
19
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
20
20
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
21
# Contact the authors at <mandos@recompile.se>.
21
22
22
23
 
23
 
VERSION="1.0"
 
24
VERSION="1.6.9"
24
25
 
25
26
KEYDIR="/etc/keys/mandos"
26
 
KEYTYPE=DSA
27
 
KEYLENGTH=2048
28
 
SUBKEYTYPE=ELG-E
29
 
SUBKEYLENGTH=2048
 
27
KEYTYPE=RSA
 
28
KEYLENGTH=4096
 
29
SUBKEYTYPE=RSA
 
30
SUBKEYLENGTH=4096
30
31
KEYNAME="`hostname --fqdn 2>/dev/null || hostname`"
31
32
KEYEMAIL=""
32
 
KEYCOMMENT="Mandos client key"
 
33
KEYCOMMENT=""
33
34
KEYEXPIRE=0
34
35
FORCE=no
 
36
SSH=yes
35
37
KEYCOMMENT_ORIG="$KEYCOMMENT"
36
38
mode=keygen
37
39
 
40
42
fi
41
43
 
42
44
# Parse options
43
 
TEMP=`getopt --options vhd:t:l:n:e:c:x:f \
44
 
    --longoptions version,help,password,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 \
45
47
    --name "$0" -- "$@"`
46
48
 
47
49
help(){
48
 
basename="`basename $0`"
 
50
basename="`basename "$0"`"
49
51
cat <<EOF
50
52
Usage: $basename [ -v | --version ]
51
53
       $basename [ -h | --help ]
53
55
       $basename [ OPTIONS ]
54
56
   Encrypted password creation:
55
57
       $basename { -p | --password } [ --name NAME ] [ --dir DIR]
 
58
       $basename { -F | --passfile } FILE [ --name NAME ] [ --dir DIR]
56
59
 
57
60
Key creation options:
58
61
  -v, --version         Show program's version number and exit
59
62
  -h, --help            Show this help message and exit
60
63
  -d DIR, --dir DIR     Target directory for key files
61
 
  -t TYPE, --type TYPE  Key type.  Default is DSA.
 
64
  -t TYPE, --type TYPE  Key type.  Default is RSA.
62
65
  -l BITS, --length BITS
63
 
                        Key length in bits.  Default is 2048.
 
66
                        Key length in bits.  Default is 4096.
64
67
  -s TYPE, --subtype TYPE
65
 
                        Subkey type.  Default is ELG-E.
 
68
                        Subkey type.  Default is RSA.
66
69
  -L BITS, --sublength BITS
67
 
                        Subkey length in bits.  Default is 2048.
 
70
                        Subkey length in bits.  Default is 4096.
68
71
  -n NAME, --name NAME  Name of key.  Default is the FQDN.
69
72
  -e ADDRESS, --email ADDRESS
70
73
                        Email address of key.  Default is empty.
71
74
  -c TEXT, --comment TEXT
72
 
                        Comment field for key.  The default value is
73
 
                        "Mandos client key".
 
75
                        Comment field for key.  The default is empty.
74
76
  -x TIME, --expire TIME
75
77
                        Key expire time.  Default is no expiration.
76
78
                        See gpg(1) for syntax.
77
 
  -f, --force           Force overwriting old keys.
 
79
  -f, --force           Force overwriting old key files.
78
80
 
79
81
Password creation options:
80
 
  -p, --password        Create an encrypted password using the keys in
81
 
                        the key directory.  All options other than
82
 
                        --dir and --name are ignored.
 
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.
83
90
EOF
84
91
}
85
92
 
87
94
while :; do
88
95
    case "$1" in
89
96
        -p|--password) mode=password; shift;;
 
97
        -F|--passfile) mode=password; PASSFILE="$2"; shift 2;;
90
98
        -d|--dir) KEYDIR="$2"; shift 2;;
91
99
        -t|--type) KEYTYPE="$2"; shift 2;;
92
100
        -s|--subtype) SUBKEYTYPE="$2"; shift 2;;
97
105
        -c|--comment) KEYCOMMENT="$2"; shift 2;;
98
106
        -x|--expire) KEYEXPIRE="$2"; shift 2;;
99
107
        -f|--force) FORCE=yes; shift;;
 
108
        -S|--no-ssh) SSH=no; shift;;
100
109
        -v|--version) echo "$0 $VERSION"; exit;;
101
110
        -h|--help) help; exit;;
102
111
        --) shift; break;;
104
113
    esac
105
114
done
106
115
if [ "$#" -gt 0 ]; then
107
 
    echo "Unknown arguments: '$@'" >&2
 
116
    echo "Unknown arguments: '$*'" >&2
108
117
    exit 1
109
118
fi
110
119
 
140
149
        echo "Invalid key length" >&2
141
150
        exit 1
142
151
    fi
143
 
 
 
152
    
144
153
    if [ -z "$KEYEXPIRE" ]; then
145
154
        echo "Empty key expiration" >&2
146
155
        exit 1
165
174
    if [ -n "$KEYEMAIL" ]; then
166
175
        KEYEMAILLINE="Name-Email: $KEYEMAIL"
167
176
    fi
168
 
 
 
177
    
169
178
    # Create temporary gpg batch file
170
179
    BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
171
180
fi
182
191
trap "
183
192
set +e; \
184
193
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
185
 
shred --remove \"$RINGDIR\"/sec*;
 
194
shred --remove \"$RINGDIR\"/sec* 2>/dev/null;
186
195
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
187
196
rm --recursive --force \"$RINGDIR\";
188
 
stty echo; \
 
197
tty --quiet && stty echo; \
189
198
" EXIT
190
199
 
 
200
set -e
 
201
 
191
202
umask 077
192
203
 
193
204
if [ "$mode" = keygen ]; then
195
206
    cat >"$BATCHFILE" <<-EOF
196
207
        Key-Type: $KEYTYPE
197
208
        Key-Length: $KEYLENGTH
198
 
        #Key-Usage: encrypt,sign,auth
 
209
        Key-Usage: sign,auth
199
210
        Subkey-Type: $SUBKEYTYPE
200
211
        Subkey-Length: $SUBKEYLENGTH
201
 
        #Subkey-Usage: encrypt,sign,auth
 
212
        Subkey-Usage: encrypt
202
213
        Name-Real: $KEYNAME
203
214
        $KEYCOMMENTLINE
204
215
        $KEYEMAILLINE
210
221
        %commit
211
222
        EOF
212
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
213
239
    # Generate a new key in the key rings
214
240
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
215
241
        --homedir "$RINGDIR" --trust-model always \
216
242
        --gen-key "$BATCHFILE"
217
243
    rm --force "$BATCHFILE"
218
244
    
 
245
    if tty --quiet; then
 
246
        echo -n "Finished: "
 
247
        date
 
248
    fi
 
249
    
219
250
    # Backup any old key files
220
251
    if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
221
252
        2>/dev/null; then
235
266
        FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
236
267
    fi
237
268
    
238
 
    # Export keys from key rings to key files
 
269
    # Export key from key rings to key files
239
270
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
240
271
        --homedir "$RINGDIR" --armor --export-options export-minimal \
241
272
        --comment "$FILECOMMENT" --output "$SECKEYFILE" \
246
277
fi
247
278
 
248
279
if [ "$mode" = password ]; then
249
 
    # Import keys into temporary key rings
 
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
250
298
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
251
299
        --homedir "$RINGDIR" --trust-model always --armor \
252
300
        --import "$SECKEYFILE"
256
304
    
257
305
    # Get fingerprint of key
258
306
    FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
259
 
        --enable-dsa2 --homedir \"$RINGDIR\" --trust-model always \
 
307
        --enable-dsa2 --homedir "$RINGDIR" --trust-model always \
260
308
        --fingerprint --with-colons \
261
309
        | sed --quiet \
262
310
        --expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
265
313
    
266
314
    FILECOMMENT="Encrypted password for a Mandos client"
267
315
    
268
 
    stty -echo
269
 
    echo -n "Enter passphrase: " >&2
270
 
    head --lines=1 | tr --delete '\n' \
271
 
        | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
272
 
        --homedir "$RINGDIR" --trust-model always --armor --encrypt \
273
 
        --recipient "$FINGERPRINT" --comment "$FILECOMMENT" \
274
 
        > "$SECFILE"
275
 
    echo >&2
276
 
    stty echo
 
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
277
349
    
278
350
    cat <<-EOF
279
351
        [$KEYNAME]
280
352
        host = $KEYNAME
281
353
        fingerprint = $FINGERPRINT
282
354
        secret =
283
 
EOF
 
355
        EOF
284
356
    sed --quiet --expression='
285
357
        /^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
286
358
            /^$/,${
290
362
                /^[^-]/s/^/    /p
291
363
            }
292
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
293
369
fi
294
370
 
295
371
trap - EXIT
300
376
    shred --remove "$SECFILE"
301
377
fi
302
378
# Remove the key rings
303
 
shred --remove "$RINGDIR"/sec*
 
379
shred --remove "$RINGDIR"/sec* 2>/dev/null
304
380
rm --recursive --force "$RINGDIR"