/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-keygen

  • Committer: Teddy Hogeborn
  • Date: 2008-10-05 17:38:31 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081005173831-fysrfayl4yvhlo6x
* INSTALL: Add instructions on how to set the correct network
           interface on the cient, and also how to test the server and
           verify the password.

* TODO: Clean up old stuff.

* debian/mandos-client.README.Debian: Separate into sections with
                                      headlines.  Add instructions on
                                      how to test the server and
                                      verify the password.

* plugin-runner.conf: Add reminder to update initrd image.

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 Teddy Hogeborn & Björn Påhlsson
6
6
# 
7
7
# This program is free software: you can redistribute it and/or modify
8
8
# it under the terms of the GNU General Public License as published by
22
22
 
23
23
VERSION="1.0"
24
24
 
25
 
KEYDIR="/etc/mandos"
 
25
KEYDIR="/etc/keys/mandos"
26
26
KEYTYPE=DSA
27
 
KEYLENGTH=1024
 
27
KEYLENGTH=2048
28
28
SUBKEYTYPE=ELG-E
29
29
SUBKEYLENGTH=2048
30
 
KEYNAME="`hostname --fqdn`"
 
30
KEYNAME="`hostname --fqdn 2>/dev/null || hostname`"
31
31
KEYEMAIL=""
32
32
KEYCOMMENT="Mandos client key"
33
33
KEYEXPIRE=0
35
35
KEYCOMMENT_ORIG="$KEYCOMMENT"
36
36
mode=keygen
37
37
 
 
38
if [ ! -d "$KEYDIR" ]; then
 
39
    KEYDIR="/etc/mandos/keys"
 
40
fi
 
41
 
38
42
# 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 \
 
43
TEMP=`getopt --options vhpF:d:t:l:s:L:n:e:c:x:f \
 
44
    --longoptions version,help,password,passfile:,dir:,type:,length:,subtype:,sublength:,name:,email:,comment:,expire:,force \
41
45
    --name "$0" -- "$@"`
42
46
 
43
47
help(){
49
53
       $basename [ OPTIONS ]
50
54
   Encrypted password creation:
51
55
       $basename { -p | --password } [ --name NAME ] [ --dir DIR]
 
56
       $basename { -F | --passfile } FILE [ --name NAME ] [ --dir DIR]
52
57
 
53
58
Key creation options:
54
59
  -v, --version         Show program's version number and exit
56
61
  -d DIR, --dir DIR     Target directory for key files
57
62
  -t TYPE, --type TYPE  Key type.  Default is DSA.
58
63
  -l BITS, --length BITS
59
 
                        Key length in bits.  Default is 1024.
 
64
                        Key length in bits.  Default is 2048.
60
65
  -s TYPE, --subtype TYPE
61
66
                        Subkey type.  Default is ELG-E.
62
67
  -L BITS, --sublength BITS
64
69
  -n NAME, --name NAME  Name of key.  Default is the FQDN.
65
70
  -e ADDRESS, --email ADDRESS
66
71
                        Email address of key.  Default is empty.
67
 
  -c COMMENT, --comment COMMENT
 
72
  -c TEXT, --comment TEXT
68
73
                        Comment field for key.  The default value is
69
74
                        "Mandos client key".
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
77
 
                        the key directory.  All options other than
78
 
                        --keydir and --name are ignored.
 
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
 
86
                        the key directory.  All options other than
 
87
                        --dir and --name are ignored.
79
88
EOF
80
89
}
81
90
 
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
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
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; \
 
190
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
 
191
shred --remove \"$RINGDIR\"/sec*;
 
192
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
 
193
rm --recursive --force \"$RINGDIR\";
192
194
stty echo; \
193
195
" EXIT
194
196
 
195
 
umask 027
 
197
umask 077
196
198
 
197
199
if [ "$mode" = keygen ]; then
198
200
    # Create batch file for GnuPG
209
211
        Expire-Date: $KEYEXPIRE
210
212
        #Preferences: <string>
211
213
        #Handle: <no-spaces>
212
 
        %pubring $PUBRING
213
 
        %secring $SECRING
 
214
        #%pubring pubring.gpg
 
215
        #%secring secring.gpg
214
216
        %commit
215
217
        EOF
216
218
    
217
219
    # 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" \
 
220
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
221
        --homedir "$RINGDIR" --trust-model always \
221
222
        --gen-key "$BATCHFILE"
222
223
    rm --force "$BATCHFILE"
223
 
 
 
224
    
224
225
    # Backup any old key files
225
226
    if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
226
227
        2>/dev/null; then
240
241
        FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
241
242
    fi
242
243
    
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
 
244
    # Export key from key rings to key files
 
245
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
246
        --homedir "$RINGDIR" --armor --export-options export-minimal \
 
247
        --comment "$FILECOMMENT" --output "$SECKEYFILE" \
 
248
        --export-secret-keys
 
249
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
250
        --homedir "$RINGDIR" --armor --export-options export-minimal \
 
251
        --comment "$FILECOMMENT" --output "$PUBKEYFILE" --export
254
252
fi
255
253
 
256
254
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
 
 
 
255
    # Import key into temporary key rings
 
256
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
257
        --homedir "$RINGDIR" --trust-model always --armor \
 
258
        --import "$SECKEYFILE"
 
259
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
260
        --homedir "$RINGDIR" --trust-model always --armor \
 
261
        --import "$PUBKEYFILE"
 
262
    
269
263
    # 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}'`"
 
264
    FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
 
265
        --enable-dsa2 --homedir \"$RINGDIR\" --trust-model always \
 
266
        --fingerprint --with-colons \
 
267
        | sed --quiet \
 
268
        --expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
276
269
    
277
270
    test -n "$FINGERPRINT"
278
271
    
279
272
    FILECOMMENT="Encrypted password for a Mandos client"
280
273
    
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" \
 
274
    if [ -n "$PASSFILE" ]; then
 
275
        cat "$PASSFILE"
 
276
    else
 
277
        stty -echo
 
278
        echo -n "Enter passphrase: " >&2
 
279
        first="$(head --lines=1 | tr --delete '\n')"
 
280
        echo -n -e "\nRepeat passphrase: " >&2
 
281
        second="$(head --lines=1 | tr --delete '\n')"
 
282
        echo >&2
 
283
        stty echo
 
284
        if [ "$first" != "$second" ]; then
 
285
            echo -e "Passphrase mismatch" >&2
 
286
            false
 
287
        else
 
288
            echo -n "$first"
 
289
        fi
 
290
    fi | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
291
        --homedir "$RINGDIR" --trust-model always --armor --encrypt \
 
292
        --recipient "$FINGERPRINT" --comment "$FILECOMMENT" \
290
293
        > "$SECFILE"
291
 
    echo >&2
292
 
    stty echo
 
294
    status="${PIPESTATUS[0]}"
 
295
    if [ "$status" -ne 0 ]; then
 
296
        exit "$status"
 
297
    fi
293
298
    
294
299
    cat <<-EOF
295
300
        [$KEYNAME]
296
301
        host = $KEYNAME
297
302
        fingerprint = $FINGERPRINT
298
303
        secret =
299
 
EOF
300
 
    sed -n -e '
 
304
        EOF
 
305
    sed --quiet --expression='
301
306
        /^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
302
307
            /^$/,${
 
308
                # Remove 24-bit Radix-64 checksum
 
309
                s/=....$//
303
310
                # Indent four spaces
304
311
                /^[^-]/s/^/    /p
305
312
            }
314
321
    shred --remove "$SECFILE"
315
322
fi
316
323
# Remove the key rings
317
 
shred --remove "$SECRING"
318
 
rm --force "$PUBRING" "${PUBRING}~"
319
 
# Remove the trustdb, if one did not exist when we started
320
 
if [ -n "$TRUSTDB" ]; then
321
 
    rm --force "$TRUSTDB"
322
 
fi
 
324
shred --remove "$RINGDIR"/sec*
 
325
rm --recursive --force "$RINGDIR"