/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-13 15:36:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080913153618-atp386q2bqj0ku99
* Makefile (install-client-nokey): Do "&&" instead of ";" to catch
                                   errors.

* README: Kill the straight quotes.  Add copyright notice.

* overview.xml: Improved wording.

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 © 2008-2017 Teddy Hogeborn
6
 
# Copyright © 2008-2017 Björn Påhlsson
 
5
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
7
6
8
7
# This program is free software: you can redistribute it and/or modify
9
8
# it under the terms of the GNU General Public License as published by
18
17
# You should have received a copy of the GNU General Public License
19
18
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
20
19
21
 
# Contact the authors at <mandos@recompile.se>.
 
20
# Contact the authors at <mandos@fukt.bsnet.se>.
22
21
23
22
 
24
 
VERSION="1.7.15"
 
23
VERSION="1.0"
25
24
 
26
25
KEYDIR="/etc/keys/mandos"
27
 
KEYTYPE=RSA
28
 
KEYLENGTH=4096
29
 
SUBKEYTYPE=RSA
30
 
SUBKEYLENGTH=4096
31
 
KEYNAME="`hostname --fqdn 2>/dev/null || hostname`"
 
26
KEYTYPE=DSA
 
27
KEYLENGTH=2048
 
28
SUBKEYTYPE=ELG-E
 
29
SUBKEYLENGTH=2048
 
30
KEYNAME="`hostname --fqdn`"
32
31
KEYEMAIL=""
33
 
KEYCOMMENT=""
 
32
KEYCOMMENT="Mandos client key"
34
33
KEYEXPIRE=0
35
34
FORCE=no
36
 
SSH=yes
37
35
KEYCOMMENT_ORIG="$KEYCOMMENT"
38
36
mode=keygen
39
37
 
42
40
fi
43
41
 
44
42
# Parse options
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 \
 
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 \
47
45
    --name "$0" -- "$@"`
48
46
 
49
47
help(){
50
 
basename="`basename "$0"`"
 
48
basename="`basename $0`"
51
49
cat <<EOF
52
50
Usage: $basename [ -v | --version ]
53
51
       $basename [ -h | --help ]
55
53
       $basename [ OPTIONS ]
56
54
   Encrypted password creation:
57
55
       $basename { -p | --password } [ --name NAME ] [ --dir DIR]
58
 
       $basename { -F | --passfile } FILE [ --name NAME ] [ --dir DIR]
59
56
 
60
57
Key creation options:
61
58
  -v, --version         Show program's version number and exit
62
59
  -h, --help            Show this help message and exit
63
60
  -d DIR, --dir DIR     Target directory for key files
64
 
  -t TYPE, --type TYPE  Key type.  Default is RSA.
 
61
  -t TYPE, --type TYPE  Key type.  Default is DSA.
65
62
  -l BITS, --length BITS
66
 
                        Key length in bits.  Default is 4096.
 
63
                        Key length in bits.  Default is 2048.
67
64
  -s TYPE, --subtype TYPE
68
 
                        Subkey type.  Default is RSA.
 
65
                        Subkey type.  Default is ELG-E.
69
66
  -L BITS, --sublength BITS
70
 
                        Subkey length in bits.  Default is 4096.
 
67
                        Subkey length in bits.  Default is 2048.
71
68
  -n NAME, --name NAME  Name of key.  Default is the FQDN.
72
69
  -e ADDRESS, --email ADDRESS
73
70
                        Email address of key.  Default is empty.
74
71
  -c TEXT, --comment TEXT
75
 
                        Comment field for key.  The default is empty.
 
72
                        Comment field for key.  The default value is
 
73
                        "Mandos client key".
76
74
  -x TIME, --expire TIME
77
75
                        Key expire time.  Default is no expiration.
78
76
                        See gpg(1) for syntax.
79
 
  -f, --force           Force overwriting old key files.
 
77
  -f, --force           Force overwriting old keys.
80
78
 
81
79
Password creation options:
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.
 
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.
90
83
EOF
91
84
}
92
85
 
94
87
while :; do
95
88
    case "$1" in
96
89
        -p|--password) mode=password; shift;;
97
 
        -F|--passfile) mode=password; PASSFILE="$2"; shift 2;;
98
90
        -d|--dir) KEYDIR="$2"; shift 2;;
99
91
        -t|--type) KEYTYPE="$2"; shift 2;;
100
92
        -s|--subtype) SUBKEYTYPE="$2"; shift 2;;
105
97
        -c|--comment) KEYCOMMENT="$2"; shift 2;;
106
98
        -x|--expire) KEYEXPIRE="$2"; shift 2;;
107
99
        -f|--force) FORCE=yes; shift;;
108
 
        -S|--no-ssh) SSH=no; shift;;
109
100
        -v|--version) echo "$0 $VERSION"; exit;;
110
101
        -h|--help) help; exit;;
111
102
        --) shift; break;;
113
104
    esac
114
105
done
115
106
if [ "$#" -gt 0 ]; then
116
 
    echo "Unknown arguments: '$*'" >&2
 
107
    echo "Unknown arguments: '$@'" >&2
117
108
    exit 1
118
109
fi
119
110
 
149
140
        echo "Invalid key length" >&2
150
141
        exit 1
151
142
    fi
152
 
    
 
143
 
153
144
    if [ -z "$KEYEXPIRE" ]; then
154
145
        echo "Empty key expiration" >&2
155
146
        exit 1
161
152
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
162
153
    esac
163
154
    
164
 
    if { [ -e "$SECKEYFILE" ] || [ -e "$PUBKEYFILE" ]; } \
165
 
        && [ "$FORCE" -eq 0 ]; then
 
155
    if [ \( -e "$SECKEYFILE" -o -e "$PUBKEYFILE" \) \
 
156
        -a "$FORCE" -eq 0 ]; then
166
157
        echo "Refusing to overwrite old key files; use --force" >&2
167
158
        exit 1
168
159
    fi
174
165
    if [ -n "$KEYEMAIL" ]; then
175
166
        KEYEMAILLINE="Name-Email: $KEYEMAIL"
176
167
    fi
177
 
    
 
168
 
178
169
    # Create temporary gpg batch file
179
170
    BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
180
171
fi
191
182
trap "
192
183
set +e; \
193
184
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
194
 
shred --remove \"$RINGDIR\"/sec* 2>/dev/null;
 
185
shred --remove \"$RINGDIR\"/sec*;
195
186
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
196
187
rm --recursive --force \"$RINGDIR\";
197
 
tty --quiet && stty echo; \
 
188
stty echo; \
198
189
" EXIT
199
190
 
200
 
set -e
201
 
 
202
191
umask 077
203
192
 
204
193
if [ "$mode" = keygen ]; then
206
195
    cat >"$BATCHFILE" <<-EOF
207
196
        Key-Type: $KEYTYPE
208
197
        Key-Length: $KEYLENGTH
209
 
        Key-Usage: sign,auth
 
198
        #Key-Usage: encrypt,sign,auth
210
199
        Subkey-Type: $SUBKEYTYPE
211
200
        Subkey-Length: $SUBKEYLENGTH
212
 
        Subkey-Usage: encrypt
 
201
        #Subkey-Usage: encrypt,sign,auth
213
202
        Name-Real: $KEYNAME
214
203
        $KEYCOMMENTLINE
215
204
        $KEYEMAILLINE
218
207
        #Handle: <no-spaces>
219
208
        #%pubring pubring.gpg
220
209
        #%secring secring.gpg
221
 
        %no-protection
222
210
        %commit
223
211
        EOF
224
212
    
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
240
213
    # Generate a new key in the key rings
241
214
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
242
215
        --homedir "$RINGDIR" --trust-model always \
243
216
        --gen-key "$BATCHFILE"
244
217
    rm --force "$BATCHFILE"
245
218
    
246
 
    if tty --quiet; then
247
 
        echo -n "Finished: "
248
 
        date
249
 
    fi
250
 
    
251
219
    # Backup any old key files
252
220
    if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
253
221
        2>/dev/null; then
267
235
        FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
268
236
    fi
269
237
    
270
 
    # Export key from key rings to key files
 
238
    # Export keys from key rings to key files
271
239
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
272
240
        --homedir "$RINGDIR" --armor --export-options export-minimal \
273
241
        --comment "$FILECOMMENT" --output "$SECKEYFILE" \
278
246
fi
279
247
 
280
248
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
 
            err=$?
293
 
            set -e
294
 
            if [ $err -ne 0 ]; then
295
 
                ssh_fingerprint=""
296
 
                continue
297
 
            fi
298
 
            if [ -n "$ssh_fingerprint" ]; then
299
 
                ssh_fingerprint="${ssh_fingerprint#localhost }"
300
 
                break
301
 
            fi
302
 
        done
303
 
    fi
304
 
    
305
 
    # Import key into temporary key rings
 
249
    # Import keys into temporary key rings
306
250
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
307
251
        --homedir "$RINGDIR" --trust-model always --armor \
308
252
        --import "$SECKEYFILE"
312
256
    
313
257
    # Get fingerprint of key
314
258
    FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
315
 
        --enable-dsa2 --homedir "$RINGDIR" --trust-model always \
 
259
        --enable-dsa2 --homedir \"$RINGDIR\" --trust-model always \
316
260
        --fingerprint --with-colons \
317
261
        | sed --quiet \
318
262
        --expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
321
265
    
322
266
    FILECOMMENT="Encrypted password for a Mandos client"
323
267
    
324
 
    while [ ! -s "$SECFILE" ]; do
325
 
        if [ -n "$PASSFILE" ]; then
326
 
            cat "$PASSFILE"
327
 
        else
328
 
            tty --quiet && stty -echo
329
 
            echo -n "Enter passphrase: " >/dev/tty
330
 
            read -r first
331
 
            tty --quiet && echo >&2
332
 
            echo -n "Repeat passphrase: " >/dev/tty
333
 
            read -r second
334
 
            if tty --quiet; then
335
 
                echo >&2
336
 
                stty echo
337
 
            fi
338
 
            if [ "$first" != "$second" ]; then
339
 
                echo "Passphrase mismatch" >&2
340
 
                touch "$RINGDIR"/mismatch
341
 
            else
342
 
                echo -n "$first"
343
 
            fi
344
 
        fi | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
345
 
            --homedir "$RINGDIR" --trust-model always --armor \
346
 
            --encrypt --sign --recipient "$FINGERPRINT" --comment \
347
 
            "$FILECOMMENT" > "$SECFILE"
348
 
        if [ -e "$RINGDIR"/mismatch ]; then
349
 
            rm --force "$RINGDIR"/mismatch
350
 
            if tty --quiet; then
351
 
                > "$SECFILE"
352
 
            else
353
 
                exit 1
354
 
            fi
355
 
        fi
356
 
    done
 
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
357
277
    
358
278
    cat <<-EOF
359
279
        [$KEYNAME]
360
280
        host = $KEYNAME
361
281
        fingerprint = $FINGERPRINT
362
282
        secret =
363
 
        EOF
 
283
EOF
364
284
    sed --quiet --expression='
365
285
        /^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
366
286
            /^$/,${
370
290
                /^[^-]/s/^/    /p
371
291
            }
372
292
        }' < "$SECFILE"
373
 
    if [ -n "$ssh_fingerprint" ]; then
374
 
        echo 'checker = ssh-keyscan -t '"$ssh_keytype"' %%(host)s 2>/dev/null | grep --fixed-strings --line-regexp --quiet --regexp=%%(host)s" %(ssh_fingerprint)s"'
375
 
        echo "ssh_fingerprint = ${ssh_fingerprint}"
376
 
    fi
377
293
fi
378
294
 
379
295
trap - EXIT
384
300
    shred --remove "$SECFILE"
385
301
fi
386
302
# Remove the key rings
387
 
shred --remove "$RINGDIR"/sec* 2>/dev/null
 
303
shred --remove "$RINGDIR"/sec*
388
304
rm --recursive --force "$RINGDIR"