/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-18 23:55:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818235528-dn628nlbrtzl7z4f
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.

* mandos (main): Changed from requiring "[server]" in mandos.conf(5)
                 to requiring "[DEFAULT]".

* mandos.conf ([server]): Renamed to "[DEFAULT]".

* mandos.conf.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
                   referring to "overview.xml".
  (DESCRIPTION): Updated to specify the syntax more precisely.  Use
                 <varname> around the option names.

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