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"
38
TEMP=`getopt --options vhd:t:l:n:e:c:x:f \
39
--longoptions version,help,dir:,type:,length:,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 \
40
50
--name "$0" -- "$@"`
53
basename="`basename "$0"`"
44
Usage: `basename $0` [options]
55
Usage: $basename [ -v | --version ]
56
$basename [ -h | --help ]
59
Encrypted password creation:
60
$basename { -p | --password } [ --name NAME ] [ --dir DIR]
61
$basename { -F | --passfile } FILE [ --name NAME ] [ --dir DIR]
47
64
-v, --version Show program's version number and exit
48
65
-h, --help Show this help message and exit
49
66
-d DIR, --dir DIR Target directory for key files
50
-t TYPE, --type TYPE Key type. Default is DSA.
67
-t TYPE, --type TYPE OpenPGP key type. Default is RSA.
51
68
-l BITS, --length BITS
52
Key length in bits. Default is 1024.
69
OpenPGP key length in bits. Default is 4096.
53
70
-s TYPE, --subtype TYPE
54
Subkey type. Default is ELG-E.
71
OpenPGP subkey type. Default is RSA.
55
72
-L BITS, --sublength BITS
56
Subkey length in bits. Default is 2048.
73
OpenPGP subkey length in bits. Default 4096.
57
74
-n NAME, --name NAME Name of key. Default is the FQDN.
58
-e EMAIL, --email EMAIL
59
Email address of key. Default is empty.
60
-c COMMENT, --comment COMMENT
61
Comment field for key. The default value is
75
-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.
63
79
-x TIME, --expire TIME
64
Key expire time. Default is no expiration.
80
OpenPGP key expire time. Default is none.
65
81
See gpg(1) for syntax.
66
-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.
86
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.
70
98
eval set -- "$TEMP"
101
-p|--password) mode=password; shift;;
102
-F|--passfile) mode=password; PASSFILE="$2"; shift 2;;
73
103
-d|--dir) KEYDIR="$2"; shift 2;;
74
104
-t|--type) KEYTYPE="$2"; shift 2;;
75
105
-s|--subtype) SUBKEYTYPE="$2"; shift 2;;
89
121
if [ "$#" -gt 0 ]; then
90
echo "Unknown arguments: '$@'" >&2
122
echo "Unknown arguments: '$*'" >&2
94
126
SECKEYFILE="$KEYDIR/seckey.txt"
95
127
PUBKEYFILE="$KEYDIR/pubkey.txt"
128
TLS_PRIVKEYFILE="$KEYDIR/tls-privkey.pem"
129
TLS_PUBKEYFILE="$KEYDIR/tls-pubkey.pem"
97
131
# Check for some invalid values
98
if [ -d "$KEYDIR" ]; then :; else
132
if [ ! -d "$KEYDIR" ]; then
99
133
echo "$KEYDIR not a directory" >&2
102
if [ -w "$KEYDIR" ]; then :; else
103
echo "Directory $KEYDIR not writeable" >&2
107
if [ -z "$KEYTYPE" ]; then
108
echo "Empty key type" >&2
112
if [ -z "$KEYNAME" ]; then
113
echo "Empty key name" >&2
117
if [ -z "$KEYLENGTH" ] || [ "$KEYLENGTH" -lt 512 ]; then
118
echo "Invalid key length" >&2
122
if [ -z "$KEYEXPIRE" ]; then
123
echo "Empty key expiration" >&2
127
# Make FORCE be 0 or 1
129
[Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) FORCE=1;;
130
[Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
133
if { [ -e "$SECKEYFILE" ] || [ -e "$PUBKEYFILE" ]; } \
134
&& [ "$FORCE" -eq 0 ]; then
135
echo "Refusing to overwrite old key files; use --force" >&2
139
# Set lines for GnuPG batch file
140
if [ -n "$KEYCOMMENT" ]; then
141
KEYCOMMENTLINE="Name-Comment: $KEYCOMMENT"
143
if [ -n "$KEYEMAIL" ]; then
144
KEYEMAILLINE="Name-Email: $KEYEMAIL"
148
BATCHFILE="`mktemp -t mandos-gpg-batch.XXXXXXXXXX`"
149
SECRING="`mktemp -t mandos-gpg-secring.XXXXXXXXXX`"
150
PUBRING="`mktemp -t mandos-gpg-pubring.XXXXXXXXXX`"
136
if [ ! -r "$KEYDIR" ]; then
137
echo "Directory $KEYDIR not readable" >&2
141
if [ "$mode" = keygen ]; then
142
if [ ! -w "$KEYDIR" ]; then
143
echo "Directory $KEYDIR not writeable" >&2
146
if [ -z "$KEYTYPE" ]; then
147
echo "Empty key type" >&2
151
if [ -z "$KEYNAME" ]; then
152
echo "Empty key name" >&2
156
if [ -z "$KEYLENGTH" ] || [ "$KEYLENGTH" -lt 512 ]; then
157
echo "Invalid key length" >&2
161
if [ -z "$KEYEXPIRE" ]; then
162
echo "Empty key expiration" >&2
166
# Make FORCE be 0 or 1
168
[Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) FORCE=1;;
169
[Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
172
if { [ -e "$SECKEYFILE" ] || [ -e "$PUBKEYFILE" ] \
173
|| [ -e "$TLS_PRIVKEYFILE" ] \
174
|| [ -e "$TLS_PUBKEYFILE" ]; } \
175
&& [ "$FORCE" -eq 0 ]; then
176
echo "Refusing to overwrite old key files; use --force" >&2
180
# Set lines for GnuPG batch file
181
if [ -n "$KEYCOMMENT" ]; then
182
KEYCOMMENTLINE="Name-Comment: $KEYCOMMENT"
184
if [ -n "$KEYEMAIL" ]; then
185
KEYEMAILLINE="Name-Email: $KEYEMAIL"
188
# Create temporary gpg batch file
189
BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
190
TLS_PRIVKEYTMP="`mktemp -t mandos-keygen-privkey.XXXXXXXXXX`"
193
if [ "$mode" = password ]; then
194
# 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`"
152
201
# Remove temporary files on exit
155
rm --force $PUBRING $BATCHFILE; \
156
shred --remove $SECRING; \
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; \
160
# Create batch file for GnuPG
161
cat >"$BATCHFILE" <<EOF
163
Key-Length: $KEYLENGTH
164
#Key-Usage: encrypt,sign,auth
165
Subkey-Type: $SUBKEYTYPE
166
Subkey-Length: $SUBKEYLENGTH
167
#Subkey-Usage: encrypt,sign,auth
171
Expire-Date: $KEYEXPIRE
172
#Preferences: <string>
181
# Generate a new key in the key rings
182
gpg --no-random-seed-file --quiet --batch --no-tty \
183
--no-default-keyring --no-options --enable-dsa2 \
184
--secret-keyring "$SECRING" --keyring "$PUBRING" \
185
--gen-key "$BATCHFILE"
186
rm --force "$BATCHFILE"
188
# Backup any old key files
189
if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
191
shred --remove "$SECKEYFILE"
193
if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
195
rm --force "$PUBKEYFILE"
198
FILECOMMENT="Mandos client key for $KEYNAME"
199
if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
200
FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
203
if [ -n "$KEYEMAIL" ]; then
204
FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
207
# Export keys from key rings to key files
208
gpg --no-random-seed-file --quiet --batch --no-tty --armor \
209
--no-default-keyring --no-options --enable-dsa2 \
210
--secret-keyring "$SECRING" --keyring "$PUBRING" \
211
--export-options export-minimal --comment "$FILECOMMENT" \
212
--output "$SECKEYFILE" --export-secret-keys
213
gpg --no-random-seed-file --quiet --batch --no-tty --armor \
214
--no-default-keyring --no-options --enable-dsa2 \
215
--secret-keyring "$SECRING" --keyring "$PUBRING" \
216
--export-options export-minimal --comment "$FILECOMMENT" \
217
--output "$PUBKEYFILE" --export
216
if [ "$mode" = keygen ]; then
217
# Create batch file for GnuPG
218
cat >"$BATCHFILE" <<-EOF
220
Key-Length: $KEYLENGTH
222
Subkey-Type: $SUBKEYTYPE
223
Subkey-Length: $SUBKEYLENGTH
224
Subkey-Usage: encrypt
228
Expire-Date: $KEYEXPIRE
229
#Preferences: <string>
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"
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"
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
# Generate a new key in the key rings
286
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
287
--homedir "$RINGDIR" --trust-model always \
288
--gen-key "$BATCHFILE"
289
rm --force "$BATCHFILE"
296
# Backup any old key files
297
if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
299
shred --remove "$SECKEYFILE"
301
if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
303
rm --force "$PUBKEYFILE"
306
FILECOMMENT="Mandos client key for $KEYNAME"
307
if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
308
FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
311
if [ -n "$KEYEMAIL" ]; then
312
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
325
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"
358
# 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}'`"
365
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
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
420
if [ -n "$KEY_ID" ]; then
421
echo "key_id = $KEY_ID"
424
fingerprint = $FINGERPRINT
427
sed --quiet --expression='
428
/^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
430
# Remove 24-bit Radix-64 checksum
436
if [ -n "$ssh_fingerprint" ]; then
437
echo 'checker = ssh-keyscan -t '"$ssh_keytype"' %%(host)s 2>/dev/null | grep --fixed-strings --line-regexp --quiet --regexp=%%(host)s" %(ssh_fingerprint)s"'
438
echo "ssh_fingerprint = ${ssh_fingerprint}"
445
# Remove the password file, if any
446
if [ -n "$SECFILE" ]; then
447
shred --remove "$SECFILE"
221
449
# Remove the key rings
222
shred --remove "$SECRING"
223
rm --force "$PUBRING"
450
shred --remove "$RINGDIR"/sec* 2>/dev/null
451
rm --recursive --force "$RINGDIR"