/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-08-24 06:17:02 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080824061702-zxrru4r1vxmx4tuq
* Makefile (PREFIX, CONFDIR, MANDIR): Use $(DESTDIR).
  (install-server, install-client): Use "install --directory" instead
                                    of mkdir.

* mandos-keygen: New options --subtype and --sublength.
  (trap): Added semicolons and backslashes.
  (gpg): Added "--enable-dsa2" to all invocations.

* mandos-keygen.xml: Changed single quotes to double quotes for
                     consistency.
  (/refentry/refentryinfo/copyright) Split copyright holders.
  (SYNOPSIS): Added "--subtype", "--sublength", "-s", and "-L".
  (OPTIONS): Document the subtype and sublength options.
  (SECURITY): Also note the "--subtype" and "--sublength" options.

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