3
# Mandos key generator - create new keys for a Mandos client
5
# Copyright © 2008-2019 Teddy Hogeborn
6
# Copyright © 2008-2019 Björn Påhlsson
8
# This file is part of Mandos.
10
# Mandos is free software: you can redistribute it and/or modify it
11
# under the terms of the GNU General Public License as published by
3
# Mandos key generator - create a new OpenPGP key for a Mandos client
5
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
7
# This program is free software: you can redistribute it and/or modify
8
# it under the terms of the GNU General Public License as published by
12
9
# the Free Software Foundation, either version 3 of the License, or
13
10
# (at your option) any later version.
15
# Mandos is distributed in the hope that it will be useful, but
16
# WITHOUT ANY WARRANTY; without even the implied warranty of
12
# This program is distributed in the hope that it will be useful,
13
# but WITHOUT ANY WARRANTY; without even the implied warranty of
17
14
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18
15
# GNU General Public License for more details.
20
17
# You should have received a copy of the GNU General Public License
21
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
23
# Contact the authors at <mandos@recompile.se>.
28
KEYDIR="/etc/keys/mandos"
33
KEYNAME="`hostname --fqdn 2>/dev/null || hostname`"
18
# along with this program. If not, see <http://www.gnu.org/licenses/>.
20
# Contact the authors at <mandos@fukt.bsnet.se>.
30
KEYNAME="`hostname --fqdn`"
32
KEYCOMMENT="Mandos client key"
40
35
KEYCOMMENT_ORIG="$KEYCOMMENT"
43
if [ ! -d "$KEYDIR" ]; then
44
KEYDIR="/etc/mandos/keys"
48
TEMP=`getopt --options vhpF:d:t:l:s:L:n:e:c:x:T:fS \
49
--longoptions version,help,password,passfile:,dir:,type:,length:,subtype:,sublength:,name:,email:,comment:,expire:,tls-keytype:,force,no-ssh \
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 \
50
41
--name "$0" -- "$@"`
53
basename="`basename "$0"`"
44
basename="`basename $0`"
55
46
Usage: $basename [ -v | --version ]
56
47
$basename [ -h | --help ]
58
49
$basename [ OPTIONS ]
59
50
Encrypted password creation:
60
51
$basename { -p | --password } [ --name NAME ] [ --dir DIR]
61
$basename { -F | --passfile } FILE [ --name NAME ] [ --dir DIR]
63
53
Key creation options:
64
54
-v, --version Show program's version number and exit
65
55
-h, --help Show this help message and exit
66
56
-d DIR, --dir DIR Target directory for key files
67
-t TYPE, --type TYPE OpenPGP key type. Default is RSA.
57
-t TYPE, --type TYPE Key type. Default is DSA.
68
58
-l BITS, --length BITS
69
OpenPGP key length in bits. Default is 4096.
59
Key length in bits. Default is 2048.
70
60
-s TYPE, --subtype TYPE
71
OpenPGP subkey type. Default is RSA.
61
Subkey type. Default is ELG-E.
72
62
-L BITS, --sublength BITS
73
OpenPGP subkey length in bits. Default 4096.
63
Subkey length in bits. Default is 2048.
74
64
-n NAME, --name NAME Name of key. Default is the FQDN.
75
65
-e ADDRESS, --email ADDRESS
76
Email address of OpenPGP key. Default empty.
77
-c TEXT, --comment TEXT
78
Comment field for OpenPGP key. Default empty.
66
Email address of key. Default is empty.
67
-c COMMENT, --comment COMMENT
68
Comment field for key. The default value is
79
70
-x TIME, --expire TIME
80
OpenPGP key expire time. Default is none.
71
Key expire time. Default is no expiration.
81
72
See gpg(1) for syntax.
82
-T TYPE, --tls-keytype TYPE
83
TLS key type. Default is ed25519.
84
-f, --force Force overwriting old key files.
73
-f, --force Force overwriting old keys.
86
75
Password creation options:
87
-p, --password Create an encrypted password using the key in
88
the key directory. All options other than
89
--dir and --name are ignored.
90
-F FILE, --passfile FILE
91
Encrypt a password from FILE using the key in
92
the key directory. All options other than
93
--dir and --name are ignored.
94
-S, --no-ssh Don't get SSH key or set "checker" option.
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.
121
102
if [ "$#" -gt 0 ]; then
122
echo "Unknown arguments: '$*'" >&2
103
echo "Unknown arguments: '$@'" >&2
126
107
SECKEYFILE="$KEYDIR/seckey.txt"
127
108
PUBKEYFILE="$KEYDIR/pubkey.txt"
128
TLS_PRIVKEYFILE="$KEYDIR/tls-privkey.pem"
129
TLS_PUBKEYFILE="$KEYDIR/tls-pubkey.pem"
131
110
# Check for some invalid values
132
if [ ! -d "$KEYDIR" ]; then
111
if [ -d "$KEYDIR" ]; then :; else
133
112
echo "$KEYDIR not a directory" >&2
136
if [ ! -r "$KEYDIR" ]; then
137
echo "Directory $KEYDIR not readable" >&2
115
if [ -w "$KEYDIR" ]; then :; else
116
echo "Directory $KEYDIR not writeable" >&2
120
if [ "$mode" = password -a -e "$KEYDIR/trustdb.gpg.lock" ]; then
121
echo "Key directory has locked trustdb; aborting." >&2
141
125
if [ "$mode" = keygen ]; then
142
if [ ! -w "$KEYDIR" ]; then
143
echo "Directory $KEYDIR not writeable" >&2
146
126
if [ -z "$KEYTYPE" ]; then
147
127
echo "Empty key type" >&2
184
162
if [ -n "$KEYEMAIL" ]; then
185
163
KEYEMAILLINE="Name-Email: $KEYEMAIL"
188
166
# Create temporary gpg batch file
189
BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
190
TLS_PRIVKEYTMP="`mktemp -t mandos-keygen-privkey.XXXXXXXXXX`"
167
BATCHFILE="`mktemp -t mandos-gpg-batch.XXXXXXXXXX`"
193
170
if [ "$mode" = password ]; then
194
171
# Create temporary encrypted password file
195
SECFILE="`mktemp -t mandos-keygen-secfile.XXXXXXXXXX`"
198
# Create temporary key ring directory
199
RINGDIR="`mktemp -d -t mandos-keygen-keyrings.XXXXXXXXXX`"
172
SECFILE="`mktemp -t mandos-gpg-secfile.XXXXXXXXXX`"
175
# Create temporary key rings
176
SECRING="`mktemp -t mandos-gpg-secring.XXXXXXXXXX`"
177
PUBRING="`mktemp -t mandos-gpg-pubring.XXXXXXXXXX`"
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"
201
187
# Remove temporary files on exit
204
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
205
test -n \"$TLS_PRIVKEYTMP\" && shred --remove \"$TLS_PRIVKEYTMP\"; \
206
shred --remove \"$RINGDIR\"/sec* 2>/dev/null;
207
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
208
rm --recursive --force \"$RINGDIR\";
209
tty --quiet && stty echo; \
190
rm --force $PUBRING ${PUBRING}~ $BATCHFILE $TRUSTDB; \
191
shred --remove $SECRING $SECFILE; \
216
197
if [ "$mode" = keygen ]; then
217
198
# Create batch file for GnuPG
218
199
cat >"$BATCHFILE" <<-EOF
219
200
Key-Type: $KEYTYPE
220
201
Key-Length: $KEYLENGTH
202
#Key-Usage: encrypt,sign,auth
222
203
Subkey-Type: $SUBKEYTYPE
223
204
Subkey-Length: $SUBKEYLENGTH
224
Subkey-Usage: encrypt
205
#Subkey-Usage: encrypt,sign,auth
225
206
Name-Real: $KEYNAME
228
209
Expire-Date: $KEYEXPIRE
229
210
#Preferences: <string>
230
211
#Handle: <no-spaces>
231
#%pubring pubring.gpg
232
#%secring secring.gpg
239
Note: Due to entropy requirements, key generation could take
240
anything from a few minutes to SEVERAL HOURS. Please be
241
patient and/or supply the system with more entropy if needed.
247
# Generate TLS private key
248
if certtool --generate-privkey --password='' \
249
--outfile "$TLS_PRIVKEYTMP" --sec-param ultra \
250
--key-type="$TLS_KEYTYPE" --pkcs8 --no-text 2>/dev/null; then
252
# Backup any old key files
253
if cp --backup=numbered --force "$TLS_PRIVKEYFILE" "$TLS_PRIVKEYFILE" \
255
shred --remove "$TLS_PRIVKEYFILE" 2>/dev/null || :
257
if cp --backup=numbered --force "$TLS_PUBKEYFILE" "$TLS_PUBKEYFILE" \
259
rm --force "$TLS_PUBKEYFILE"
261
cp --archive "$TLS_PRIVKEYTMP" "$TLS_PRIVKEYFILE"
262
shred --remove "$TLS_PRIVKEYTMP" 2>/dev/null || :
266
# First try certtool from GnuTLS
267
if ! certtool --password='' --load-privkey="$TLS_PRIVKEYFILE" \
268
--outfile="$TLS_PUBKEYFILE" --pubkey-info --no-text \
270
# Otherwise try OpenSSL
271
if ! openssl pkey -in "$TLS_PRIVKEYFILE" \
272
-out "$TLS_PUBKEYFILE" -pubout; then
273
rm --force "$TLS_PUBKEYFILE"
274
# None of the commands succeded; give up
280
# Make sure trustdb.gpg exists;
281
# this is a workaround for Debian bug #737128
282
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
283
--homedir "$RINGDIR" \
284
--import-ownertrust < /dev/null
285
217
# Generate a new key in the key rings
286
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
287
--homedir "$RINGDIR" --trust-model always \
218
gpg --no-random-seed-file --quiet --batch --no-tty \
219
--no-default-keyring --no-options --enable-dsa2 \
220
--secret-keyring "$SECRING" --keyring "$PUBRING" \
288
221
--gen-key "$BATCHFILE"
289
222
rm --force "$BATCHFILE"
296
224
# Backup any old key files
297
225
if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
298
226
2>/dev/null; then
299
shred --remove "$SECKEYFILE" 2>/dev/null || :
227
shred --remove "$SECKEYFILE"
301
229
if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
302
230
2>/dev/null; then
312
240
FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
315
# Export key from key rings to key files
316
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
317
--homedir "$RINGDIR" --armor --export-options export-minimal \
318
--comment "$FILECOMMENT" --output "$SECKEYFILE" \
320
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
321
--homedir "$RINGDIR" --armor --export-options export-minimal \
322
--comment "$FILECOMMENT" --output "$PUBKEYFILE" --export
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
325
256
if [ "$mode" = password ]; then
329
[Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) SSH=1;;
330
[Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) SSH=0;;
333
if [ $SSH -eq 1 ]; then
334
for ssh_keytype in ecdsa-sha2-nistp256 ed25519 rsa; do
336
ssh_fingerprint="`ssh-keyscan -t $ssh_keytype localhost 2>/dev/null`"
339
if [ $err -ne 0 ]; then
343
if [ -n "$ssh_fingerprint" ]; then
344
ssh_fingerprint="${ssh_fingerprint#localhost }"
350
# Import key into temporary key rings
351
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
352
--homedir "$RINGDIR" --trust-model always --armor \
353
--import "$SECKEYFILE"
354
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
355
--homedir "$RINGDIR" --trust-model always --armor \
356
--import "$PUBKEYFILE"
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"
358
269
# Get fingerprint of key
359
FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
360
--enable-dsa2 --homedir "$RINGDIR" --trust-model always \
361
--fingerprint --with-colons \
363
--expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
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}'`"
365
277
test -n "$FINGERPRINT"
367
if [ -r "$TLS_PUBKEYFILE" ]; then
368
KEY_ID="$(certtool --key-id --hash=sha256 \
369
--infile="$TLS_PUBKEYFILE" 2>/dev/null || :)"
371
if [ -z "$KEY_ID" ]; then
372
KEY_ID=$(openssl pkey -pubin -in "$TLS_PUBKEYFILE" \
375
| sed --expression='s/^.*[^[:xdigit:]]//')
380
279
FILECOMMENT="Encrypted password for a Mandos client"
382
while [ ! -s "$SECFILE" ]; do
383
if [ -n "$PASSFILE" ]; then
386
tty --quiet && stty -echo
387
echo -n "Enter passphrase: " >/dev/tty
389
tty --quiet && echo >&2
390
echo -n "Repeat passphrase: " >/dev/tty
396
if [ "$first" != "$second" ]; then
397
echo "Passphrase mismatch" >&2
398
touch "$RINGDIR"/mismatch
402
fi | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
403
--homedir "$RINGDIR" --trust-model always --armor \
404
--encrypt --sign --recipient "$FINGERPRINT" --comment \
405
"$FILECOMMENT" > "$SECFILE"
406
if [ -e "$RINGDIR"/mismatch ]; then
407
rm --force "$RINGDIR"/mismatch
282
echo -n "Enter passphrase: " >&2
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" \
420
if [ -n "$KEY_ID" ]; then
421
echo "key_id = $KEY_ID"
424
297
fingerprint = $FINGERPRINT
427
sed --quiet --expression='
428
301
/^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
430
303
# Remove 24-bit Radix-64 checksum
added
removed
mandos-keygen
