/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-12 06:46:11 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080812064611-7wfjg391ypmff085
* mandos-keygen: New program to generate new client keys on
                 installation.

* Makefile (all): No longer build documentation.
  (doc): New; build documentation.
  (maintainer-clean): Remove build-local client keydir.
  (run-client): Make build-local keydir with keys.
  (run-server): Do not depend on "all".
  (install, install-server, install-client, uninstall,
  uninstall-server, uninstall-client, purge, purge-server,
  purge-client): New.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen
1
 
#!/bin/sh -e
 
1
#!/bin/sh
2
2
# 
3
 
# Mandos key generator - create a new OpenPGP key for a Mandos client
 
3
# Mandos key generator - create new OpenPGP keys for Mandos clients
4
4
# 
5
5
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
6
6
# 
20
20
# Contact the authors at <mandos@fukt.bsnet.se>.
21
21
# 
22
22
 
23
 
VERSION="1.0"
24
 
 
25
23
KEYDIR="/etc/mandos"
26
24
KEYTYPE=DSA
27
 
KEYLENGTH=2048
28
 
SUBKEYTYPE=ELG-E
29
 
SUBKEYLENGTH=2048
 
25
KEYLENGTH=1024
30
26
KEYNAME="`hostname --fqdn`"
31
27
KEYEMAIL=""
32
28
KEYCOMMENT="Mandos client key"
33
29
KEYEXPIRE=0
34
30
FORCE=no
35
31
KEYCOMMENT_ORIG="$KEYCOMMENT"
36
 
mode=keygen
37
32
 
38
33
# 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 \
 
34
TEMP=`getopt --options d:t:l:n:e:c:x:f \
 
35
    --longoptions dir:,type:,length:,name:,email:,comment:,expire:,force \
41
36
    --name "$0" -- "$@"`
42
37
 
43
 
help(){
44
 
basename="`basename $0`"
45
 
cat <<EOF
46
 
Usage: $basename [ -v | --version ]
47
 
       $basename [ -h | --help ]
48
 
   Key creation:
49
 
       $basename [ OPTIONS ]
50
 
   Encrypted password creation:
51
 
       $basename { -p | --password } [ --name NAME ] [ --dir DIR]
52
 
 
53
 
Key creation options:
54
 
  -v, --version         Show program's version number and exit
55
 
  -h, --help            Show this help message and exit
56
 
  -d DIR, --dir DIR     Target directory for key files
57
 
  -t TYPE, --type TYPE  Key type.  Default is DSA.
58
 
  -l BITS, --length BITS
59
 
                        Key length in bits.  Default is 2048.
60
 
  -s TYPE, --subtype TYPE
61
 
                        Subkey type.  Default is ELG-E.
62
 
  -L BITS, --sublength BITS
63
 
                        Subkey length in bits.  Default is 2048.
64
 
  -n NAME, --name NAME  Name of key.  Default is the FQDN.
65
 
  -e ADDRESS, --email ADDRESS
66
 
                        Email address of key.  Default is empty.
67
 
  -c TEXT, --comment TEXT
68
 
                        Comment field for key.  The default value is
69
 
                        "Mandos client key".
70
 
  -x TIME, --expire TIME
71
 
                        Key expire time.  Default is no expiration.
72
 
                        See gpg(1) for syntax.
73
 
  -f, --force           Force overwriting old keys.
74
 
 
75
 
Password creation options:
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.
79
 
EOF
80
 
}
81
 
 
82
38
eval set -- "$TEMP"
83
39
while :; do
84
40
    case "$1" in
85
 
        -p|--password) mode=password; shift;;
86
41
        -d|--dir) KEYDIR="$2"; shift 2;;
87
42
        -t|--type) KEYTYPE="$2"; shift 2;;
88
 
        -s|--subtype) SUBKEYTYPE="$2"; shift 2;;
89
43
        -l|--length) KEYLENGTH="$2"; shift 2;;
90
 
        -L|--sublength) SUBKEYLENGTH="$2"; shift 2;;
91
44
        -n|--name) KEYNAME="$2"; shift 2;;
92
45
        -e|--email) KEYEMAIL="$2"; shift 2;;
93
46
        -c|--comment) KEYCOMMENT="$2"; shift 2;;
94
 
        -x|--expire) KEYEXPIRE="$2"; shift 2;;
 
47
        -x|--expire) KEYCOMMENT="$2"; shift 2;;
95
48
        -f|--force) FORCE=yes; shift;;
96
 
        -v|--version) echo "$0 $VERSION"; exit;;
97
 
        -h|--help) help; exit;;
98
49
        --) shift; break;;
99
50
        *) echo "Internal error" >&2; exit 1;;
100
51
    esac
117
68
    exit 1
118
69
fi
119
70
 
120
 
if [ "$mode" = password -a -e "$KEYDIR/trustdb.gpg.lock" ]; then
121
 
    echo "Key directory has locked trustdb; aborting." >&2
122
 
    exit 1
123
 
fi
124
 
 
125
 
if [ "$mode" = keygen ]; then
126
 
    if [ -z "$KEYTYPE" ]; then
127
 
        echo "Empty key type" >&2
128
 
        exit 1
129
 
    fi
130
 
    
131
 
    if [ -z "$KEYNAME" ]; then
132
 
        echo "Empty key name" >&2
133
 
        exit 1
134
 
    fi
135
 
    
136
 
    if [ -z "$KEYLENGTH" ] || [ "$KEYLENGTH" -lt 512 ]; then
137
 
        echo "Invalid key length" >&2
138
 
        exit 1
139
 
    fi
140
 
 
141
 
    if [ -z "$KEYEXPIRE" ]; then
142
 
        echo "Empty key expiration" >&2
143
 
        exit 1
144
 
    fi
145
 
    
146
 
    # Make FORCE be 0 or 1
147
 
    case "$FORCE" in
148
 
        [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) FORCE=1;;
149
 
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
150
 
    esac
151
 
    
152
 
    if { [ -e "$SECKEYFILE" ] || [ -e "$PUBKEYFILE" ]; } \
153
 
        && [ "$FORCE" -eq 0 ]; then
154
 
        echo "Refusing to overwrite old key files; use --force" >&2
155
 
        exit 1
156
 
    fi
157
 
    
158
 
    # Set lines for GnuPG batch file
159
 
    if [ -n "$KEYCOMMENT" ]; then
160
 
        KEYCOMMENTLINE="Name-Comment: $KEYCOMMENT"
161
 
    fi
162
 
    if [ -n "$KEYEMAIL" ]; then
163
 
        KEYEMAILLINE="Name-Email: $KEYEMAIL"
164
 
    fi
165
 
 
166
 
    # Create temporary gpg batch file
167
 
    BATCHFILE="`mktemp -t mandos-gpg-batch.XXXXXXXXXX`"
168
 
fi
169
 
 
170
 
if [ "$mode" = password ]; then
171
 
    # Create temporary encrypted password file
172
 
    SECFILE="`mktemp -t mandos-gpg-secfile.XXXXXXXXXX`"
173
 
fi
174
 
 
175
 
# Create temporary key rings
 
71
if [ -z "$KEYTYPE" ]; then
 
72
    echo "Empty key type" >&2
 
73
    exit 1
 
74
fi
 
75
 
 
76
if [ -z "$KEYNAME" ]; then
 
77
    echo "Empty key name" >&2
 
78
    exit 1
 
79
fi
 
80
 
 
81
if [ -z "$KEYLENGTH" ] || [ "$KEYLENGTH" -lt 512 ]; then
 
82
    echo "Invalid key length" >&2
 
83
    exit 1
 
84
fi
 
85
 
 
86
if [ -z "$KEYEXPIRE" ]; then
 
87
    echo "Empty key expiration" >&2
 
88
    exit 1
 
89
fi
 
90
 
 
91
# Make FORCE be 0 or 1
 
92
case "$FORCE" in
 
93
    [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) FORCE=1;;
 
94
    [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
 
95
esac
 
96
 
 
97
if { [ -e "$SECKEYFILE" ] || [ -e "$PUBKEYFILE" ]; } \
 
98
    && [ "$FORCE" -eq 0 ]; then
 
99
    echo "Refusing to overwrite old key files; use --force" >&2
 
100
    exit 1
 
101
fi
 
102
 
 
103
# Set lines for GPG batch file
 
104
if [ -n "$KEYCOMMENT" ]; then
 
105
    KEYCOMMENTLINE="Name-Comment: $KEYCOMMENT"
 
106
fi
 
107
if [ -n "$KEYEMAIL" ]; then
 
108
    KEYEMAILLINE="Name-Email: $KEYEMAIL"
 
109
fi
 
110
 
 
111
# Create temp files
 
112
BATCHFILE="`mktemp -t mandos-gpg-batch.XXXXXXXXXX`"
176
113
SECRING="`mktemp -t mandos-gpg-secring.XXXXXXXXXX`"
177
114
PUBRING="`mktemp -t mandos-gpg-pubring.XXXXXXXXXX`"
178
115
 
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
 
116
trap "rm --force $PUBRING $BATCHFILE; shred --remove $SECRING" EXIT
186
117
 
187
 
# Remove temporary files on exit
188
 
trap "
189
 
set +e; \
190
 
rm --force $PUBRING ${PUBRING}~ $BATCHFILE $TRUSTDB; \
191
 
shred --remove $SECRING $SECFILE; \
192
 
stty echo; \
193
 
" EXIT
 
118
# Create batch file for GPG
 
119
cat >"$BATCHFILE" <<EOF
 
120
Key-Type: $KEYTYPE
 
121
Key-Length: $KEYLENGTH
 
122
#Key-Usage: encrypt,sign,auth
 
123
Name-Real: $KEYNAME
 
124
$KEYCOMMENTLINE
 
125
$KEYEMAILLINE
 
126
Expire-Date: $KEYEXPIRE
 
127
%pubring $PUBRING
 
128
%secring $SECRING
 
129
%commit
 
130
EOF
194
131
 
195
132
umask 027
196
 
 
197
 
if [ "$mode" = keygen ]; then
198
 
    # Create batch file for GnuPG
199
 
    cat >"$BATCHFILE" <<-EOF
200
 
        Key-Type: $KEYTYPE
201
 
        Key-Length: $KEYLENGTH
202
 
        #Key-Usage: encrypt,sign,auth
203
 
        Subkey-Type: $SUBKEYTYPE
204
 
        Subkey-Length: $SUBKEYLENGTH
205
 
        #Subkey-Usage: encrypt,sign,auth
206
 
        Name-Real: $KEYNAME
207
 
        $KEYCOMMENTLINE
208
 
        $KEYEMAILLINE
209
 
        Expire-Date: $KEYEXPIRE
210
 
        #Preferences: <string>
211
 
        #Handle: <no-spaces>
212
 
        %pubring $PUBRING
213
 
        %secring $SECRING
214
 
        %commit
215
 
        EOF
216
 
    
217
 
    # 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" \
221
 
        --gen-key "$BATCHFILE"
222
 
    rm --force "$BATCHFILE"
223
 
 
224
 
    # Backup any old key files
225
 
    if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
226
 
        2>/dev/null; then
227
 
        shred --remove "$SECKEYFILE"
228
 
    fi
229
 
    if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
230
 
        2>/dev/null; then
231
 
        rm --force "$PUBKEYFILE"
232
 
    fi
233
 
    
234
 
    FILECOMMENT="Mandos client key for $KEYNAME"
235
 
    if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
236
 
        FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
237
 
    fi
238
 
    
239
 
    if [ -n "$KEYEMAIL" ]; then
240
 
        FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
241
 
    fi
242
 
    
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
254
 
fi
255
 
 
256
 
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
 
 
269
 
    # 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}'`"
276
 
    
277
 
    test -n "$FINGERPRINT"
278
 
    
279
 
    FILECOMMENT="Encrypted password for a Mandos client"
280
 
    
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
293
 
    
294
 
    cat <<-EOF
295
 
        [$KEYNAME]
296
 
        host = $KEYNAME
297
 
        fingerprint = $FINGERPRINT
298
 
        secret =
299
 
EOF
300
 
    sed -n -e '
301
 
        /^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
302
 
            /^$/,${
303
 
                # Remove 24-bit Radix-64 checksum
304
 
                s/=....$//
305
 
                # Indent four spaces
306
 
                /^[^-]/s/^/    /p
307
 
            }
308
 
        }' < "$SECFILE"
309
 
fi
310
 
 
311
 
trap - EXIT
312
 
 
313
 
set +e
314
 
# Remove the password file, if any
315
 
if [ -n "$SECFILE" ]; then
316
 
    shred --remove "$SECFILE"
317
 
fi
318
 
# 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
 
133
gpg --no-random-seed-file --quiet --batch --no-tty \
 
134
    --no-default-keyring --batch --secret-keyring "$SECRING" \
 
135
    --keyring "$PUBRING" --gen-key "$BATCHFILE"
 
136
rm --force "$BATCHFILE"
 
137
 
 
138
if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
 
139
    2>/dev/null; then
 
140
    shred --remove "$SECKEYFILE"
 
141
fi
 
142
if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
 
143
    2>/dev/null; then
 
144
    rm --force "$PUBKEYFILE"
 
145
fi
 
146
 
 
147
FILECOMMENT="Mandos client key for $KEYNAME"
 
148
if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
 
149
    FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
 
150
fi
 
151
 
 
152
if [ -n "$KEYEMAIL" ]; then
 
153
    FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
 
154
fi
 
155
 
 
156
gpg --no-random-seed-file --quiet --batch --no-tty --armor \
 
157
    --no-default-keyring --secret-keyring "$SECRING" \
 
158
    --keyring "$PUBRING" --export-options export-minimal \
 
159
    --comment "$FILECOMMENT" --output "$SECKEYFILE" \
 
160
    --export-secret-keys
 
161
gpg --no-random-seed-file --quiet --batch --no-tty --armor \
 
162
    --no-default-keyring --secret-keyring "$SECRING" \
 
163
    --keyring "$PUBRING" --export-options export-minimal \
 
164
    --comment "$FILECOMMENT" --output "$PUBKEYFILE" \
 
165
    --export