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
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
9
12
# the Free Software Foundation, either version 3 of the License, or
10
13
# (at your option) any later version.
12
# This program is distributed in the hope that it will be useful,
13
# but WITHOUT ANY WARRANTY; without even the implied warranty of
15
# Mandos is distributed in the hope that it will be useful, but
16
# WITHOUT ANY WARRANTY; without even the implied warranty of
14
17
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15
18
# GNU General Public License for more details.
17
20
# You should have received a copy of the GNU General Public License
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`"
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`"
32
KEYCOMMENT="Mandos client key"
35
40
KEYCOMMENT_ORIG="$KEYCOMMENT"
43
if [ ! -d "$KEYDIR" ]; then
44
KEYDIR="/etc/mandos/keys"
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 \
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 \
41
50
--name "$0" -- "$@"`
44
basename="`basename $0`"
53
basename="`basename "$0"`"
46
55
Usage: $basename [ -v | --version ]
47
56
$basename [ -h | --help ]
49
58
$basename [ OPTIONS ]
50
59
Encrypted password creation:
51
60
$basename { -p | --password } [ --name NAME ] [ --dir DIR]
61
$basename { -F | --passfile } FILE [ --name NAME ] [ --dir DIR]
53
63
Key creation options:
54
64
-v, --version Show program's version number and exit
55
65
-h, --help Show this help message and exit
56
66
-d DIR, --dir DIR Target directory for key files
57
-t TYPE, --type TYPE Key type. Default is DSA.
67
-t TYPE, --type TYPE OpenPGP key type. Default is RSA.
58
68
-l BITS, --length BITS
59
Key length in bits. Default is 1024.
69
OpenPGP key length in bits. Default is 4096.
60
70
-s TYPE, --subtype TYPE
61
Subkey type. Default is ELG-E.
71
OpenPGP subkey type. Default is RSA.
62
72
-L BITS, --sublength BITS
63
Subkey length in bits. Default is 2048.
73
OpenPGP subkey length in bits. Default 4096.
64
74
-n NAME, --name NAME Name of key. Default is the FQDN.
65
75
-e ADDRESS, --email ADDRESS
66
Email address of key. Default is empty.
67
-c COMMENT, --comment COMMENT
68
Comment field for key. The default value is
76
Email address of OpenPGP key. Default empty.
77
-c TEXT, --comment TEXT
78
Comment field for OpenPGP key. Default empty.
70
79
-x TIME, --expire TIME
71
Key expire time. Default is no expiration.
80
OpenPGP key expire time. Default is none.
72
81
See gpg(1) for syntax.
73
-f, --force Force overwriting old keys.
82
-T TYPE, --tls-keytype TYPE
83
TLS key type. Default is ed25519.
84
-f, --force Force overwriting old key files.
75
86
Password creation options:
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.
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.
102
121
if [ "$#" -gt 0 ]; then
103
echo "Unknown arguments: '$@'" >&2
122
echo "Unknown arguments: '$*'" >&2
107
126
SECKEYFILE="$KEYDIR/seckey.txt"
108
127
PUBKEYFILE="$KEYDIR/pubkey.txt"
128
TLS_PRIVKEYFILE="$KEYDIR/tls-privkey.pem"
129
TLS_PUBKEYFILE="$KEYDIR/tls-pubkey.pem"
110
131
# Check for some invalid values
111
if [ -d "$KEYDIR" ]; then :; else
132
if [ ! -d "$KEYDIR" ]; then
112
133
echo "$KEYDIR not a directory" >&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
136
if [ ! -r "$KEYDIR" ]; then
137
echo "Directory $KEYDIR not readable" >&2
125
141
if [ "$mode" = keygen ]; then
142
if [ ! -w "$KEYDIR" ]; then
143
echo "Directory $KEYDIR not writeable" >&2
126
146
if [ -z "$KEYTYPE" ]; then
127
147
echo "Empty key type" >&2
162
184
if [ -n "$KEYEMAIL" ]; then
163
185
KEYEMAILLINE="Name-Email: $KEYEMAIL"
166
188
# Create temporary gpg batch file
167
BATCHFILE="`mktemp -t mandos-gpg-batch.XXXXXXXXXX`"
189
BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
170
192
if [ "$mode" = password ]; then
171
193
# Create temporary encrypted password file
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"
194
SECFILE="`mktemp -t mandos-keygen-secfile.XXXXXXXXXX`"
197
# Create temporary key ring directory
198
RINGDIR="`mktemp -d -t mandos-keygen-keyrings.XXXXXXXXXX`"
187
200
# Remove temporary files on exit
190
rm --force $PUBRING ${PUBRING}~ $BATCHFILE $TRUSTDB; \
191
shred --remove $SECRING $SECFILE; \
203
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
204
shred --remove \"$RINGDIR\"/sec* 2>/dev/null;
205
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
206
rm --recursive --force \"$RINGDIR\";
207
tty --quiet && stty echo; \
197
214
if [ "$mode" = keygen ]; then
198
215
# Create batch file for GnuPG
199
216
cat >"$BATCHFILE" <<-EOF
200
217
Key-Type: $KEYTYPE
201
218
Key-Length: $KEYLENGTH
202
#Key-Usage: encrypt,sign,auth
203
220
Subkey-Type: $SUBKEYTYPE
204
221
Subkey-Length: $SUBKEYLENGTH
205
#Subkey-Usage: encrypt,sign,auth
222
Subkey-Usage: encrypt
206
223
Name-Real: $KEYNAME
209
226
Expire-Date: $KEYEXPIRE
210
227
#Preferences: <string>
211
228
#Handle: <no-spaces>
229
#%pubring pubring.gpg
230
#%secring secring.gpg
237
Note: Due to entropy requirements, key generation could take
238
anything from a few minutes to SEVERAL HOURS. Please be
239
patient and/or supply the system with more entropy if needed.
245
# Backup any old key files
246
if cp --backup=numbered --force "$TLS_PRIVKEYFILE" "$TLS_PRIVKEYFILE" \
248
shred --remove "$TLS_PRIVKEYFILE"
250
if cp --backup=numbered --force "$TLS_PUBKEYFILE" "$TLS_PUBKEYFILE" \
252
rm --force "$TLS_PUBKEYFILE"
255
## Generate TLS private key
257
# First try certtool from GnuTLS
258
if ! certtool --generate-privkey --password='' \
259
--outfile "$TLS_PRIVKEYFILE" --sec-param ultra \
260
--key-type="$TLS_KEYTYPE" --pkcs8 --no-text 2>/dev/null; then
261
# Otherwise try OpenSSL
262
if ! openssl genpkey -algorithm X25519 -out \
263
/etc/keys/mandos/tls-privkey.pem; then
264
rm --force /etc/keys/mandos/tls-privkey.pem
265
# None of the commands succeded; give up
272
# First try certtool from GnuTLS
273
if ! certtool --password='' --load-privkey="$TLS_PRIVKEYFILE" \
274
--outfile="$TLS_PUBKEYFILE" --pubkey-info --no-text \
276
# Otherwise try OpenSSL
277
if ! openssl pkey -in "$TLS_PRIVKEYFILE" \
278
-out "$TLS_PUBKEYFILE" -pubout; then
279
rm --force "$TLS_PUBKEYFILE"
280
# None of the commands succeded; give up
285
# Make sure trustdb.gpg exists;
286
# this is a workaround for Debian bug #737128
287
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
288
--homedir "$RINGDIR" \
289
--import-ownertrust < /dev/null
217
290
# 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" \
291
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
292
--homedir "$RINGDIR" --trust-model always \
221
293
--gen-key "$BATCHFILE"
222
294
rm --force "$BATCHFILE"
224
301
# Backup any old key files
225
302
if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
226
303
2>/dev/null; then
240
317
FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
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
320
# Export key from key rings to key files
321
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
322
--homedir "$RINGDIR" --armor --export-options export-minimal \
323
--comment "$FILECOMMENT" --output "$SECKEYFILE" \
325
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
326
--homedir "$RINGDIR" --armor --export-options export-minimal \
327
--comment "$FILECOMMENT" --output "$PUBKEYFILE" --export
256
330
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"
334
[Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) SSH=1;;
335
[Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) SSH=0;;
338
if [ $SSH -eq 1 ]; then
339
for ssh_keytype in ecdsa-sha2-nistp256 ed25519 rsa; do
341
ssh_fingerprint="`ssh-keyscan -t $ssh_keytype localhost 2>/dev/null`"
344
if [ $err -ne 0 ]; then
348
if [ -n "$ssh_fingerprint" ]; then
349
ssh_fingerprint="${ssh_fingerprint#localhost }"
355
# Import key into temporary key rings
356
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
357
--homedir "$RINGDIR" --trust-model always --armor \
358
--import "$SECKEYFILE"
359
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
360
--homedir "$RINGDIR" --trust-model always --armor \
361
--import "$PUBKEYFILE"
269
363
# 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}'`"
364
FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
365
--enable-dsa2 --homedir "$RINGDIR" --trust-model always \
366
--fingerprint --with-colons \
368
--expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
277
370
test -n "$FINGERPRINT"
372
KEY_ID="$(certtool --key-id --hash=sha256 \
373
--infile="$TLS_PUBKEYFILE" 2>/dev/null || :)"
375
if [ -z "$KEY_ID" ]; then
376
KEY_ID=$(openssl pkey -pubin -in /tmp/tls-pubkey.pem \
379
| sed --expression='s/^.*[^[:xdigit:]]//')
279
383
FILECOMMENT="Encrypted password for a Mandos client"
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" \
385
while [ ! -s "$SECFILE" ]; do
386
if [ -n "$PASSFILE" ]; then
389
tty --quiet && stty -echo
390
echo -n "Enter passphrase: " >/dev/tty
392
tty --quiet && echo >&2
393
echo -n "Repeat passphrase: " >/dev/tty
399
if [ "$first" != "$second" ]; then
400
echo "Passphrase mismatch" >&2
401
touch "$RINGDIR"/mismatch
405
fi | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
406
--homedir "$RINGDIR" --trust-model always --armor \
407
--encrypt --sign --recipient "$FINGERPRINT" --comment \
408
"$FILECOMMENT" > "$SECFILE"
409
if [ -e "$RINGDIR"/mismatch ]; then
410
rm --force "$RINGDIR"/mismatch
297
423
fingerprint = $FINGERPRINT
426
sed --quiet --expression='
301
427
/^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
303
429
# Remove 24-bit Radix-64 checksum