/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: 2014-01-20 20:54:47 UTC
  • Revision ID: teddy@recompile.se-20140120205447-z5fwrk7r2y9gkbfg
Documentation change to clarify support of --connect option.

* plugins.d/mandos.xml (OPTIONS): Clarify support of --connect option.

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-2013 Teddy Hogeborn
 
6
# Copyright © 2008-2013 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.2"
24
25
 
25
 
KEYDIR="/etc/mandos"
26
 
KEYTYPE=DSA
27
 
KEYLENGTH=2048
28
 
SUBKEYTYPE=ELG-E
29
 
SUBKEYLENGTH=2048
30
 
KEYNAME="`hostname --fqdn`"
 
26
KEYDIR="/etc/keys/mandos"
 
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
35
36
KEYCOMMENT_ORIG="$KEYCOMMENT"
36
37
mode=keygen
37
38
 
 
39
if [ ! -d "$KEYDIR" ]; then
 
40
    KEYDIR="/etc/mandos/keys"
 
41
fi
 
42
 
38
43
# 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 \
 
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 \
41
46
    --name "$0" -- "$@"`
42
47
 
43
48
help(){
49
54
       $basename [ OPTIONS ]
50
55
   Encrypted password creation:
51
56
       $basename { -p | --password } [ --name NAME ] [ --dir DIR]
 
57
       $basename { -F | --passfile } FILE [ --name NAME ] [ --dir DIR]
52
58
 
53
59
Key creation options:
54
60
  -v, --version         Show program's version number and exit
55
61
  -h, --help            Show this help message and exit
56
62
  -d DIR, --dir DIR     Target directory for key files
57
 
  -t TYPE, --type TYPE  Key type.  Default is DSA.
 
63
  -t TYPE, --type TYPE  Key type.  Default is RSA.
58
64
  -l BITS, --length BITS
59
 
                        Key length in bits.  Default is 2048.
 
65
                        Key length in bits.  Default is 4096.
60
66
  -s TYPE, --subtype TYPE
61
 
                        Subkey type.  Default is ELG-E.
 
67
                        Subkey type.  Default is RSA.
62
68
  -L BITS, --sublength BITS
63
 
                        Subkey length in bits.  Default is 2048.
 
69
                        Subkey length in bits.  Default is 4096.
64
70
  -n NAME, --name NAME  Name of key.  Default is the FQDN.
65
71
  -e ADDRESS, --email ADDRESS
66
72
                        Email address of key.  Default is empty.
67
73
  -c TEXT, --comment TEXT
68
 
                        Comment field for key.  The default value is
69
 
                        "Mandos client key".
 
74
                        Comment field for key.  The default is empty.
70
75
  -x TIME, --expire TIME
71
76
                        Key expire time.  Default is no expiration.
72
77
                        See gpg(1) for syntax.
73
 
  -f, --force           Force overwriting old keys.
 
78
  -f, --force           Force overwriting old key files.
74
79
 
75
80
Password creation options:
76
 
  -p, --password        Create an encrypted password using the keys in
 
81
  -p, --password        Create an encrypted password using the key in
 
82
                        the key directory.  All options other than
 
83
                        --dir and --name are ignored.
 
84
  -F FILE, --passfile FILE
 
85
                        Encrypt a password from FILE using the key in
77
86
                        the key directory.  All options other than
78
87
                        --dir and --name are ignored.
79
88
EOF
83
92
while :; do
84
93
    case "$1" in
85
94
        -p|--password) mode=password; shift;;
 
95
        -F|--passfile) mode=password; PASSFILE="$2"; shift 2;;
86
96
        -d|--dir) KEYDIR="$2"; shift 2;;
87
97
        -t|--type) KEYTYPE="$2"; shift 2;;
88
98
        -s|--subtype) SUBKEYTYPE="$2"; shift 2;;
108
118
PUBKEYFILE="$KEYDIR/pubkey.txt"
109
119
 
110
120
# Check for some invalid values
111
 
if [ -d "$KEYDIR" ]; then :; else
 
121
if [ ! -d "$KEYDIR" ]; then
112
122
    echo "$KEYDIR not a directory" >&2
113
123
    exit 1
114
124
fi
115
 
if [ -w "$KEYDIR" ]; then :; else
116
 
    echo "Directory $KEYDIR not writeable" >&2
117
 
    exit 1
118
 
fi
119
 
 
120
 
if [ "$mode" = password -a -e "$KEYDIR/trustdb.gpg.lock" ]; then
121
 
    echo "Key directory has locked trustdb; aborting." >&2
 
125
if [ ! -r "$KEYDIR" ]; then
 
126
    echo "Directory $KEYDIR not readable" >&2
122
127
    exit 1
123
128
fi
124
129
 
125
130
if [ "$mode" = keygen ]; then
 
131
    if [ ! -w "$KEYDIR" ]; then
 
132
        echo "Directory $KEYDIR not writeable" >&2
 
133
        exit 1
 
134
    fi
126
135
    if [ -z "$KEYTYPE" ]; then
127
136
        echo "Empty key type" >&2
128
137
        exit 1
137
146
        echo "Invalid key length" >&2
138
147
        exit 1
139
148
    fi
140
 
 
 
149
    
141
150
    if [ -z "$KEYEXPIRE" ]; then
142
151
        echo "Empty key expiration" >&2
143
152
        exit 1
149
158
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
150
159
    esac
151
160
    
152
 
    if { [ -e "$SECKEYFILE" ] || [ -e "$PUBKEYFILE" ]; } \
153
 
        && [ "$FORCE" -eq 0 ]; then
 
161
    if [ \( -e "$SECKEYFILE" -o -e "$PUBKEYFILE" \) \
 
162
        -a "$FORCE" -eq 0 ]; then
154
163
        echo "Refusing to overwrite old key files; use --force" >&2
155
164
        exit 1
156
165
    fi
162
171
    if [ -n "$KEYEMAIL" ]; then
163
172
        KEYEMAILLINE="Name-Email: $KEYEMAIL"
164
173
    fi
165
 
 
 
174
    
166
175
    # Create temporary gpg batch file
167
 
    BATCHFILE="`mktemp -t mandos-gpg-batch.XXXXXXXXXX`"
 
176
    BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
168
177
fi
169
178
 
170
179
if [ "$mode" = password ]; then
171
180
    # Create temporary encrypted password file
172
 
    SECFILE="`mktemp -t mandos-gpg-secfile.XXXXXXXXXX`"
173
 
fi
174
 
 
175
 
# Create temporary key rings
176
 
SECRING="`mktemp -t mandos-gpg-secring.XXXXXXXXXX`"
177
 
PUBRING="`mktemp -t mandos-gpg-pubring.XXXXXXXXXX`"
178
 
 
179
 
if [ "$mode" = password ]; then
180
 
    # If a trustdb.gpg file does not already exist, schedule it for
181
 
    # deletion when we are done.
182
 
    if ! [ -e "$KEYDIR/trustdb.gpg" ]; then
183
 
        TRUSTDB="$KEYDIR/trustdb.gpg"
184
 
    fi
185
 
fi
 
181
    SECFILE="`mktemp -t mandos-keygen-secfile.XXXXXXXXXX`"
 
182
fi
 
183
 
 
184
# Create temporary key ring directory
 
185
RINGDIR="`mktemp -d -t mandos-keygen-keyrings.XXXXXXXXXX`"
186
186
 
187
187
# Remove temporary files on exit
188
188
trap "
189
189
set +e; \
190
 
rm --force $PUBRING ${PUBRING}~ $BATCHFILE $TRUSTDB; \
191
 
shred --remove $SECRING $SECFILE; \
192
 
stty echo; \
 
190
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
 
191
shred --remove \"$RINGDIR\"/sec*;
 
192
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
 
193
rm --recursive --force \"$RINGDIR\";
 
194
tty --quiet && stty echo; \
193
195
" EXIT
194
196
 
195
 
umask 027
 
197
set -e
 
198
 
 
199
umask 077
196
200
 
197
201
if [ "$mode" = keygen ]; then
198
202
    # Create batch file for GnuPG
199
203
    cat >"$BATCHFILE" <<-EOF
200
204
        Key-Type: $KEYTYPE
201
205
        Key-Length: $KEYLENGTH
202
 
        #Key-Usage: encrypt,sign,auth
 
206
        Key-Usage: sign,auth
203
207
        Subkey-Type: $SUBKEYTYPE
204
208
        Subkey-Length: $SUBKEYLENGTH
205
 
        #Subkey-Usage: encrypt,sign,auth
 
209
        Subkey-Usage: encrypt
206
210
        Name-Real: $KEYNAME
207
211
        $KEYCOMMENTLINE
208
212
        $KEYEMAILLINE
209
213
        Expire-Date: $KEYEXPIRE
210
214
        #Preferences: <string>
211
215
        #Handle: <no-spaces>
212
 
        %pubring $PUBRING
213
 
        %secring $SECRING
 
216
        #%pubring pubring.gpg
 
217
        #%secring secring.gpg
214
218
        %commit
215
219
        EOF
216
220
    
 
221
    if tty --quiet; then
 
222
        cat <<-EOF
 
223
        Note: Due to entropy requirements, key generation could take
 
224
        anything from a few minutes to SEVERAL HOURS.  Please be
 
225
        patient and/or supply the system with more entropy if needed.
 
226
        EOF
 
227
        echo -n "Started: "
 
228
        date
 
229
    fi
 
230
    
217
231
    # Generate a new key in the key rings
218
 
    gpg --no-random-seed-file --quiet --batch --no-tty \
219
 
        --no-default-keyring --no-options --enable-dsa2 \
220
 
        --secret-keyring "$SECRING" --keyring "$PUBRING" \
 
232
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
233
        --homedir "$RINGDIR" --trust-model always \
221
234
        --gen-key "$BATCHFILE"
222
235
    rm --force "$BATCHFILE"
223
 
 
 
236
    
 
237
    if tty --quiet; then
 
238
        echo -n "Finished: "
 
239
        date
 
240
    fi
 
241
    
224
242
    # Backup any old key files
225
243
    if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
226
244
        2>/dev/null; then
240
258
        FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
241
259
    fi
242
260
    
243
 
    # Export keys from key rings to key files
244
 
    gpg --no-random-seed-file --quiet --batch --no-tty --armor \
245
 
        --no-default-keyring --no-options --enable-dsa2 \
246
 
        --secret-keyring "$SECRING" --keyring "$PUBRING" \
247
 
        --export-options export-minimal --comment "$FILECOMMENT" \
248
 
        --output "$SECKEYFILE" --export-secret-keys
249
 
    gpg --no-random-seed-file --quiet --batch --no-tty --armor \
250
 
        --no-default-keyring --no-options --enable-dsa2 \
251
 
        --secret-keyring "$SECRING" --keyring "$PUBRING" \
252
 
        --export-options export-minimal --comment "$FILECOMMENT" \
253
 
        --output "$PUBKEYFILE" --export
 
261
    # Export key from key rings to key files
 
262
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
263
        --homedir "$RINGDIR" --armor --export-options export-minimal \
 
264
        --comment "$FILECOMMENT" --output "$SECKEYFILE" \
 
265
        --export-secret-keys
 
266
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
267
        --homedir "$RINGDIR" --armor --export-options export-minimal \
 
268
        --comment "$FILECOMMENT" --output "$PUBKEYFILE" --export
254
269
fi
255
270
 
256
271
if [ "$mode" = password ]; then
257
 
    # Import keys into temporary key rings
258
 
    gpg --no-random-seed-file --quiet --batch --no-tty --armor \
259
 
        --no-default-keyring --no-options --enable-dsa2 \
260
 
        --homedir "$KEYDIR" --no-permission-warning \
261
 
        --secret-keyring "$SECRING" --keyring "$PUBRING" \
262
 
        --trust-model always --import "$SECKEYFILE"
263
 
    gpg --no-random-seed-file --quiet --batch --no-tty --armor \
264
 
        --no-default-keyring --no-options --enable-dsa2 \
265
 
        --homedir "$KEYDIR" --no-permission-warning \
266
 
        --secret-keyring "$SECRING" --keyring "$PUBRING" \
267
 
        --trust-model always --import "$PUBKEYFILE"
268
 
 
 
272
    # Import key into temporary key rings
 
273
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
274
        --homedir "$RINGDIR" --trust-model always --armor \
 
275
        --import "$SECKEYFILE"
 
276
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
277
        --homedir "$RINGDIR" --trust-model always --armor \
 
278
        --import "$PUBKEYFILE"
 
279
    
269
280
    # Get fingerprint of key
270
 
    FINGERPRINT="`gpg --no-random-seed-file --quiet --batch --no-tty \
271
 
        --armor --no-default-keyring --no-options --enable-dsa2 \
272
 
        --homedir \"$KEYDIR\" --no-permission-warning \
273
 
        --secret-keyring \"$SECRING\" --keyring \"$PUBRING\" \
274
 
        --trust-model always --fingerprint --with-colons \
275
 
        | sed -n -e '/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
 
281
    FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
 
282
        --enable-dsa2 --homedir \"$RINGDIR\" --trust-model always \
 
283
        --fingerprint --with-colons \
 
284
        | sed --quiet \
 
285
        --expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
276
286
    
277
287
    test -n "$FINGERPRINT"
278
288
    
279
289
    FILECOMMENT="Encrypted password for a Mandos client"
280
290
    
281
 
    stty -echo
282
 
    echo -n "Enter passphrase: " >&2
283
 
    sed -e '1q' \
284
 
        | gpg --no-random-seed-file --batch --no-tty --armor \
285
 
        --no-default-keyring --no-options --enable-dsa2 \
286
 
        --homedir "$KEYDIR" --no-permission-warning \
287
 
        --secret-keyring "$SECRING" --keyring "$PUBRING" \
288
 
        --trust-model always --encrypt --recipient "$FINGERPRINT" \
289
 
        --comment "$FILECOMMENT" \
290
 
        > "$SECFILE"
291
 
    echo >&2
292
 
    stty echo
 
291
    while [ ! -s "$SECFILE" ]; do
 
292
        if [ -n "$PASSFILE" ]; then
 
293
            cat "$PASSFILE"
 
294
        else
 
295
            tty --quiet && stty -echo
 
296
            echo -n "Enter passphrase: " >&2
 
297
            read first
 
298
            tty --quiet && echo >&2
 
299
            echo -n "Repeat passphrase: " >&2
 
300
            read second
 
301
            if tty --quiet; then
 
302
                echo >&2
 
303
                stty echo
 
304
            fi
 
305
            if [ "$first" != "$second" ]; then
 
306
                echo "Passphrase mismatch" >&2
 
307
                touch "$RINGDIR"/mismatch
 
308
            else
 
309
                echo -n "$first"
 
310
            fi
 
311
        fi | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
312
            --homedir "$RINGDIR" --trust-model always --armor \
 
313
            --encrypt --sign --recipient "$FINGERPRINT" --comment \
 
314
            "$FILECOMMENT" > "$SECFILE"
 
315
        if [ -e "$RINGDIR"/mismatch ]; then
 
316
            rm --force "$RINGDIR"/mismatch
 
317
            if tty --quiet; then
 
318
                > "$SECFILE"
 
319
            else
 
320
                exit 1
 
321
            fi
 
322
        fi
 
323
    done
293
324
    
294
325
    cat <<-EOF
295
326
        [$KEYNAME]
296
327
        host = $KEYNAME
297
328
        fingerprint = $FINGERPRINT
298
329
        secret =
299
 
EOF
300
 
    sed -n -e '
 
330
        EOF
 
331
    sed --quiet --expression='
301
332
        /^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
302
333
            /^$/,${
303
334
                # Remove 24-bit Radix-64 checksum
316
347
    shred --remove "$SECFILE"
317
348
fi
318
349
# Remove the key rings
319
 
shred --remove "$SECRING"
320
 
rm --force "$PUBRING" "${PUBRING}~"
321
 
# Remove the trustdb, if one did not exist when we started
322
 
if [ -n "$TRUSTDB" ]; then
323
 
    rm --force "$TRUSTDB"
324
 
fi
 
350
shred --remove "$RINGDIR"/sec*
 
351
rm --recursive --force "$RINGDIR"