/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
2
2
# 
3
3
# Mandos key generator - create a new OpenPGP key for a Mandos client
4
4
# 
5
 
# Copyright © 2008-2018 Teddy Hogeborn
6
 
# Copyright © 2008-2018 Björn Påhlsson
 
5
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
7
6
# 
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
 
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.16"
 
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
34
FORCE=no
38
 
SSH=yes
39
35
KEYCOMMENT_ORIG="$KEYCOMMENT"
40
36
mode=keygen
41
37
 
42
 
if [ ! -d "$KEYDIR" ]; then
43
 
    KEYDIR="/etc/mandos/keys"
44
 
fi
45
 
 
46
38
# Parse options
47
 
TEMP=`getopt --options vhpF:d:t:l:s:L:n:e:c:x:fS \
48
 
    --longoptions version,help,password,passfile:,dir:,type:,length:,subtype:,sublength:,name:,email:,comment:,expire:,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 \
49
41
    --name "$0" -- "$@"`
50
42
 
51
43
help(){
52
 
basename="`basename "$0"`"
 
44
basename="`basename $0`"
53
45
cat <<EOF
54
46
Usage: $basename [ -v | --version ]
55
47
       $basename [ -h | --help ]
57
49
       $basename [ OPTIONS ]
58
50
   Encrypted password creation:
59
51
       $basename { -p | --password } [ --name NAME ] [ --dir DIR]
60
 
       $basename { -F | --passfile } FILE [ --name NAME ] [ --dir DIR]
61
52
 
62
53
Key creation options:
63
54
  -v, --version         Show program's version number and exit
64
55
  -h, --help            Show this help message and exit
65
56
  -d DIR, --dir DIR     Target directory for key files
66
 
  -t TYPE, --type TYPE  Key type.  Default is RSA.
 
57
  -t TYPE, --type TYPE  Key type.  Default is DSA.
67
58
  -l BITS, --length BITS
68
 
                        Key length in bits.  Default is 4096.
 
59
                        Key length in bits.  Default is 2048.
69
60
  -s TYPE, --subtype TYPE
70
 
                        Subkey type.  Default is RSA.
 
61
                        Subkey type.  Default is ELG-E.
71
62
  -L BITS, --sublength BITS
72
 
                        Subkey length in bits.  Default is 4096.
 
63
                        Subkey length in bits.  Default is 2048.
73
64
  -n NAME, --name NAME  Name of key.  Default is the FQDN.
74
65
  -e ADDRESS, --email ADDRESS
75
66
                        Email address of key.  Default is empty.
76
67
  -c TEXT, --comment TEXT
77
 
                        Comment field for key.  The default is empty.
 
68
                        Comment field for key.  The default value is
 
69
                        "Mandos client key".
78
70
  -x TIME, --expire TIME
79
71
                        Key expire time.  Default is no expiration.
80
72
                        See gpg(1) for syntax.
81
 
  -f, --force           Force overwriting old key files.
 
73
  -f, --force           Force overwriting old keys.
82
74
 
83
75
Password creation options:
84
 
  -p, --password        Create an encrypted password using the key in
85
 
                        the key directory.  All options other than
86
 
                        --dir and --name are ignored.
87
 
  -F FILE, --passfile FILE
88
 
                        Encrypt a password from FILE using the key in
89
 
                        the key directory.  All options other than
90
 
                        --dir and --name are ignored.
91
 
  -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.
92
79
EOF
93
80
}
94
81
 
96
83
while :; do
97
84
    case "$1" in
98
85
        -p|--password) mode=password; shift;;
99
 
        -F|--passfile) mode=password; PASSFILE="$2"; shift 2;;
100
86
        -d|--dir) KEYDIR="$2"; shift 2;;
101
87
        -t|--type) KEYTYPE="$2"; shift 2;;
102
88
        -s|--subtype) SUBKEYTYPE="$2"; shift 2;;
107
93
        -c|--comment) KEYCOMMENT="$2"; shift 2;;
108
94
        -x|--expire) KEYEXPIRE="$2"; shift 2;;
109
95
        -f|--force) FORCE=yes; shift;;
110
 
        -S|--no-ssh) SSH=no; shift;;
111
96
        -v|--version) echo "$0 $VERSION"; exit;;
112
97
        -h|--help) help; exit;;
113
98
        --) shift; break;;
115
100
    esac
116
101
done
117
102
if [ "$#" -gt 0 ]; then
118
 
    echo "Unknown arguments: '$*'" >&2
 
103
    echo "Unknown arguments: '$@'" >&2
119
104
    exit 1
120
105
fi
121
106
 
151
136
        echo "Invalid key length" >&2
152
137
        exit 1
153
138
    fi
154
 
    
 
139
 
155
140
    if [ -z "$KEYEXPIRE" ]; then
156
141
        echo "Empty key expiration" >&2
157
142
        exit 1
163
148
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
164
149
    esac
165
150
    
166
 
    if { [ -e "$SECKEYFILE" ] || [ -e "$PUBKEYFILE" ]; } \
167
 
        && [ "$FORCE" -eq 0 ]; then
 
151
    if [ \( -e "$SECKEYFILE" -o -e "$PUBKEYFILE" \) \
 
152
        -a "$FORCE" -eq 0 ]; then
168
153
        echo "Refusing to overwrite old key files; use --force" >&2
169
154
        exit 1
170
155
    fi
176
161
    if [ -n "$KEYEMAIL" ]; then
177
162
        KEYEMAILLINE="Name-Email: $KEYEMAIL"
178
163
    fi
179
 
    
 
164
 
180
165
    # Create temporary gpg batch file
181
166
    BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
182
167
fi
193
178
trap "
194
179
set +e; \
195
180
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
196
 
shred --remove \"$RINGDIR\"/sec* 2>/dev/null;
 
181
shred --remove \"$RINGDIR\"/sec*;
197
182
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
198
183
rm --recursive --force \"$RINGDIR\";
199
 
tty --quiet && stty echo; \
 
184
stty echo; \
200
185
" EXIT
201
186
 
202
 
set -e
203
 
 
204
187
umask 077
205
188
 
206
189
if [ "$mode" = keygen ]; then
208
191
    cat >"$BATCHFILE" <<-EOF
209
192
        Key-Type: $KEYTYPE
210
193
        Key-Length: $KEYLENGTH
211
 
        Key-Usage: sign,auth
 
194
        #Key-Usage: encrypt,sign,auth
212
195
        Subkey-Type: $SUBKEYTYPE
213
196
        Subkey-Length: $SUBKEYLENGTH
214
 
        Subkey-Usage: encrypt
 
197
        #Subkey-Usage: encrypt,sign,auth
215
198
        Name-Real: $KEYNAME
216
199
        $KEYCOMMENTLINE
217
200
        $KEYEMAILLINE
220
203
        #Handle: <no-spaces>
221
204
        #%pubring pubring.gpg
222
205
        #%secring secring.gpg
223
 
        %no-protection
224
206
        %commit
225
207
        EOF
226
208
    
227
 
    if tty --quiet; then
228
 
        cat <<-EOF
229
 
        Note: Due to entropy requirements, key generation could take
230
 
        anything from a few minutes to SEVERAL HOURS.  Please be
231
 
        patient and/or supply the system with more entropy if needed.
232
 
        EOF
233
 
        echo -n "Started: "
234
 
        date
235
 
    fi
236
 
    
237
 
    # Make sure trustdb.gpg exists;
238
 
    # this is a workaround for Debian bug #737128
239
 
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
240
 
        --homedir "$RINGDIR" \
241
 
        --import-ownertrust < /dev/null
242
209
    # Generate a new key in the key rings
243
210
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
244
211
        --homedir "$RINGDIR" --trust-model always \
245
212
        --gen-key "$BATCHFILE"
246
213
    rm --force "$BATCHFILE"
247
214
    
248
 
    if tty --quiet; then
249
 
        echo -n "Finished: "
250
 
        date
251
 
    fi
252
 
    
253
215
    # Backup any old key files
254
216
    if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
255
217
        2>/dev/null; then
269
231
        FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
270
232
    fi
271
233
    
272
 
    # Export key from key rings to key files
 
234
    # Export keys from key rings to key files
273
235
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
274
236
        --homedir "$RINGDIR" --armor --export-options export-minimal \
275
237
        --comment "$FILECOMMENT" --output "$SECKEYFILE" \
280
242
fi
281
243
 
282
244
if [ "$mode" = password ]; then
283
 
    
284
 
    # Make SSH be 0 or 1
285
 
    case "$SSH" in
286
 
        [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) SSH=1;;
287
 
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) SSH=0;;
288
 
    esac
289
 
    
290
 
    if [ $SSH -eq 1 ]; then
291
 
        for ssh_keytype in ecdsa-sha2-nistp256 ed25519 rsa; do
292
 
            set +e
293
 
            ssh_fingerprint="`ssh-keyscan -t $ssh_keytype localhost 2>/dev/null`"
294
 
            err=$?
295
 
            set -e
296
 
            if [ $err -ne 0 ]; then
297
 
                ssh_fingerprint=""
298
 
                continue
299
 
            fi
300
 
            if [ -n "$ssh_fingerprint" ]; then
301
 
                ssh_fingerprint="${ssh_fingerprint#localhost }"
302
 
                break
303
 
            fi
304
 
        done
305
 
    fi
306
 
    
307
 
    # Import key into temporary key rings
 
245
    # Import keys into temporary key rings
308
246
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
309
247
        --homedir "$RINGDIR" --trust-model always --armor \
310
248
        --import "$SECKEYFILE"
314
252
    
315
253
    # Get fingerprint of key
316
254
    FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
317
 
        --enable-dsa2 --homedir "$RINGDIR" --trust-model always \
 
255
        --enable-dsa2 --homedir \"$RINGDIR\" --trust-model always \
318
256
        --fingerprint --with-colons \
319
257
        | sed --quiet \
320
258
        --expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
323
261
    
324
262
    FILECOMMENT="Encrypted password for a Mandos client"
325
263
    
326
 
    while [ ! -s "$SECFILE" ]; do
327
 
        if [ -n "$PASSFILE" ]; then
328
 
            cat "$PASSFILE"
329
 
        else
330
 
            tty --quiet && stty -echo
331
 
            echo -n "Enter passphrase: " >/dev/tty
332
 
            read -r first
333
 
            tty --quiet && echo >&2
334
 
            echo -n "Repeat passphrase: " >/dev/tty
335
 
            read -r second
336
 
            if tty --quiet; then
337
 
                echo >&2
338
 
                stty echo
339
 
            fi
340
 
            if [ "$first" != "$second" ]; then
341
 
                echo "Passphrase mismatch" >&2
342
 
                touch "$RINGDIR"/mismatch
343
 
            else
344
 
                echo -n "$first"
345
 
            fi
346
 
        fi | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
347
 
            --homedir "$RINGDIR" --trust-model always --armor \
348
 
            --encrypt --sign --recipient "$FINGERPRINT" --comment \
349
 
            "$FILECOMMENT" > "$SECFILE"
350
 
        if [ -e "$RINGDIR"/mismatch ]; then
351
 
            rm --force "$RINGDIR"/mismatch
352
 
            if tty --quiet; then
353
 
                > "$SECFILE"
354
 
            else
355
 
                exit 1
356
 
            fi
357
 
        fi
358
 
    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
359
273
    
360
274
    cat <<-EOF
361
275
        [$KEYNAME]
362
276
        host = $KEYNAME
363
277
        fingerprint = $FINGERPRINT
364
278
        secret =
365
 
        EOF
 
279
EOF
366
280
    sed --quiet --expression='
367
281
        /^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
368
282
            /^$/,${
372
286
                /^[^-]/s/^/    /p
373
287
            }
374
288
        }' < "$SECFILE"
375
 
    if [ -n "$ssh_fingerprint" ]; then
376
 
        echo 'checker = ssh-keyscan -t '"$ssh_keytype"' %%(host)s 2>/dev/null | grep --fixed-strings --line-regexp --quiet --regexp=%%(host)s" %(ssh_fingerprint)s"'
377
 
        echo "ssh_fingerprint = ${ssh_fingerprint}"
378
 
    fi
379
289
fi
380
290
 
381
291
trap - EXIT
386
296
    shred --remove "$SECFILE"
387
297
fi
388
298
# Remove the key rings
389
 
shred --remove "$RINGDIR"/sec* 2>/dev/null
 
299
shred --remove "$RINGDIR"/sec*
390
300
rm --recursive --force "$RINGDIR"