/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: 2016-11-26 23:21:16 UTC
  • Revision ID: teddy@recompile.se-20161126232116-nhqk9x1qij09b7cx
Add comment in documentation source with clarifying text.

* intro.xml (INTRODUCTION): Add comment with clarification.

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-2016 Teddy Hogeborn
 
6
# Copyright © 2008-2016 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.7.13"
24
25
 
25
26
KEYDIR="/etc/keys/mandos"
26
 
KEYTYPE=DSA
27
 
KEYLENGTH=2048
28
 
SUBKEYTYPE=ELG-E
29
 
SUBKEYLENGTH=2048
30
 
KEYNAME="`hostname --fqdn`"
 
27
KEYTYPE=RSA
 
28
KEYLENGTH=4096
 
29
SUBKEYTYPE=RSA
 
30
SUBKEYLENGTH=4096
 
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
if [ ! -d "$KEYDIR" ]; then
 
41
    KEYDIR="/etc/mandos/keys"
 
42
fi
 
43
 
38
44
# 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 \
 
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 \
41
47
    --name "$0" -- "$@"`
42
48
 
43
49
help(){
44
 
basename="`basename $0`"
 
50
basename="`basename "$0"`"
45
51
cat <<EOF
46
52
Usage: $basename [ -v | --version ]
47
53
       $basename [ -h | --help ]
49
55
       $basename [ OPTIONS ]
50
56
   Encrypted password creation:
51
57
       $basename { -p | --password } [ --name NAME ] [ --dir DIR]
 
58
       $basename { -F | --passfile } FILE [ --name NAME ] [ --dir DIR]
52
59
 
53
60
Key creation options:
54
61
  -v, --version         Show program's version number and exit
55
62
  -h, --help            Show this help message and exit
56
63
  -d DIR, --dir DIR     Target directory for key files
57
 
  -t TYPE, --type TYPE  Key type.  Default is DSA.
 
64
  -t TYPE, --type TYPE  Key type.  Default is RSA.
58
65
  -l BITS, --length BITS
59
 
                        Key length in bits.  Default is 2048.
 
66
                        Key length in bits.  Default is 4096.
60
67
  -s TYPE, --subtype TYPE
61
 
                        Subkey type.  Default is ELG-E.
 
68
                        Subkey type.  Default is RSA.
62
69
  -L BITS, --sublength BITS
63
 
                        Subkey length in bits.  Default is 2048.
 
70
                        Subkey length in bits.  Default is 4096.
64
71
  -n NAME, --name NAME  Name of key.  Default is the FQDN.
65
72
  -e ADDRESS, --email ADDRESS
66
73
                        Email address of key.  Default is empty.
67
74
  -c TEXT, --comment TEXT
68
 
                        Comment field for key.  The default value is
69
 
                        "Mandos client key".
 
75
                        Comment field for key.  The default is empty.
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
77
 
                        the key directory.  All options other than
78
 
                        --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.
79
90
EOF
80
91
}
81
92
 
83
94
while :; do
84
95
    case "$1" in
85
96
        -p|--password) mode=password; shift;;
 
97
        -F|--passfile) mode=password; PASSFILE="$2"; shift 2;;
86
98
        -d|--dir) KEYDIR="$2"; shift 2;;
87
99
        -t|--type) KEYTYPE="$2"; shift 2;;
88
100
        -s|--subtype) SUBKEYTYPE="$2"; shift 2;;
93
105
        -c|--comment) KEYCOMMENT="$2"; shift 2;;
94
106
        -x|--expire) KEYEXPIRE="$2"; shift 2;;
95
107
        -f|--force) FORCE=yes; shift;;
 
108
        -S|--no-ssh) SSH=no; shift;;
96
109
        -v|--version) echo "$0 $VERSION"; exit;;
97
110
        -h|--help) help; exit;;
98
111
        --) shift; break;;
100
113
    esac
101
114
done
102
115
if [ "$#" -gt 0 ]; then
103
 
    echo "Unknown arguments: '$@'" >&2
 
116
    echo "Unknown arguments: '$*'" >&2
104
117
    exit 1
105
118
fi
106
119
 
136
149
        echo "Invalid key length" >&2
137
150
        exit 1
138
151
    fi
139
 
 
 
152
    
140
153
    if [ -z "$KEYEXPIRE" ]; then
141
154
        echo "Empty key expiration" >&2
142
155
        exit 1
161
174
    if [ -n "$KEYEMAIL" ]; then
162
175
        KEYEMAILLINE="Name-Email: $KEYEMAIL"
163
176
    fi
164
 
 
 
177
    
165
178
    # Create temporary gpg batch file
166
179
    BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
167
180
fi
178
191
trap "
179
192
set +e; \
180
193
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
181
 
shred --remove \"$RINGDIR\"/sec*;
 
194
shred --remove \"$RINGDIR\"/sec* 2>/dev/null;
182
195
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
183
196
rm --recursive --force \"$RINGDIR\";
184
 
stty echo; \
 
197
tty --quiet && stty echo; \
185
198
" EXIT
186
199
 
 
200
set -e
 
201
 
187
202
umask 077
188
203
 
189
204
if [ "$mode" = keygen ]; then
191
206
    cat >"$BATCHFILE" <<-EOF
192
207
        Key-Type: $KEYTYPE
193
208
        Key-Length: $KEYLENGTH
194
 
        #Key-Usage: encrypt,sign,auth
 
209
        Key-Usage: sign,auth
195
210
        Subkey-Type: $SUBKEYTYPE
196
211
        Subkey-Length: $SUBKEYLENGTH
197
 
        #Subkey-Usage: encrypt,sign,auth
 
212
        Subkey-Usage: encrypt
198
213
        Name-Real: $KEYNAME
199
214
        $KEYCOMMENTLINE
200
215
        $KEYEMAILLINE
203
218
        #Handle: <no-spaces>
204
219
        #%pubring pubring.gpg
205
220
        #%secring secring.gpg
 
221
        %no-protection
206
222
        %commit
207
223
        EOF
208
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
209
240
    # Generate a new key in the key rings
210
241
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
211
242
        --homedir "$RINGDIR" --trust-model always \
212
243
        --gen-key "$BATCHFILE"
213
244
    rm --force "$BATCHFILE"
214
245
    
 
246
    if tty --quiet; then
 
247
        echo -n "Finished: "
 
248
        date
 
249
    fi
 
250
    
215
251
    # Backup any old key files
216
252
    if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
217
253
        2>/dev/null; then
231
267
        FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
232
268
    fi
233
269
    
234
 
    # Export keys from key rings to key files
 
270
    # Export key from key rings to key files
235
271
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
236
272
        --homedir "$RINGDIR" --armor --export-options export-minimal \
237
273
        --comment "$FILECOMMENT" --output "$SECKEYFILE" \
242
278
fi
243
279
 
244
280
if [ "$mode" = password ]; then
245
 
    # Import keys into temporary key rings
 
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
    
 
304
    # Import key into temporary key rings
246
305
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
247
306
        --homedir "$RINGDIR" --trust-model always --armor \
248
307
        --import "$SECKEYFILE"
252
311
    
253
312
    # Get fingerprint of key
254
313
    FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
255
 
        --enable-dsa2 --homedir \"$RINGDIR\" --trust-model always \
 
314
        --enable-dsa2 --homedir "$RINGDIR" --trust-model always \
256
315
        --fingerprint --with-colons \
257
316
        | sed --quiet \
258
317
        --expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
261
320
    
262
321
    FILECOMMENT="Encrypted password for a Mandos client"
263
322
    
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
 
323
    while [ ! -s "$SECFILE" ]; do
 
324
        if [ -n "$PASSFILE" ]; then
 
325
            cat "$PASSFILE"
 
326
        else
 
327
            tty --quiet && stty -echo
 
328
            echo -n "Enter passphrase: " >/dev/tty
 
329
            read first
 
330
            tty --quiet && echo >&2
 
331
            echo -n "Repeat passphrase: " >/dev/tty
 
332
            read 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
 
354
        fi
 
355
    done
273
356
    
274
357
    cat <<-EOF
275
358
        [$KEYNAME]
276
359
        host = $KEYNAME
277
360
        fingerprint = $FINGERPRINT
278
361
        secret =
279
 
EOF
 
362
        EOF
280
363
    sed --quiet --expression='
281
364
        /^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
282
365
            /^$/,${
286
369
                /^[^-]/s/^/    /p
287
370
            }
288
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
289
376
fi
290
377
 
291
378
trap - EXIT
296
383
    shred --remove "$SECFILE"
297
384
fi
298
385
# Remove the key rings
299
 
shred --remove "$RINGDIR"/sec*
 
386
shred --remove "$RINGDIR"/sec* 2>/dev/null
300
387
rm --recursive --force "$RINGDIR"