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