3
# Mandos key generator - create new OpenPGP keys for Mandos clients
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-2018 Teddy Hogeborn
6
# Copyright © 2008-2018 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>.
26
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`"
28
KEYCOMMENT="Mandos client key"
31
40
KEYCOMMENT_ORIG="$KEYCOMMENT"
43
if [ ! -d "$KEYDIR" ]; then
44
KEYDIR="/etc/mandos/keys"
34
TEMP=`getopt --options d:t:l:n:e:c:x:f \
35
--longoptions 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 \
36
50
--name "$0" -- "$@"`
53
basename="`basename "$0"`"
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]
64
-v, --version Show program's version number and exit
65
-h, --help Show this help message and exit
66
-d DIR, --dir DIR Target directory for key files
67
-t TYPE, --type TYPE OpenPGP key type. Default is RSA.
68
-l BITS, --length BITS
69
OpenPGP key length in bits. Default is 4096.
70
-s TYPE, --subtype TYPE
71
OpenPGP subkey type. Default is RSA.
72
-L BITS, --sublength BITS
73
OpenPGP subkey length in bits. Default 4096.
74
-n NAME, --name NAME Name of key. Default is the FQDN.
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.
79
-x TIME, --expire TIME
80
OpenPGP key expire time. Default is none.
81
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.
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.
38
98
eval set -- "$TEMP"
101
-p|--password) mode=password; shift;;
102
-F|--passfile) mode=password; PASSFILE="$2"; shift 2;;
41
103
-d|--dir) KEYDIR="$2"; shift 2;;
42
104
-t|--type) KEYTYPE="$2"; shift 2;;
105
-s|--subtype) SUBKEYTYPE="$2"; shift 2;;
43
106
-l|--length) KEYLENGTH="$2"; shift 2;;
107
-L|--sublength) SUBKEYLENGTH="$2"; shift 2;;
44
108
-n|--name) KEYNAME="$2"; shift 2;;
45
109
-e|--email) KEYEMAIL="$2"; shift 2;;
46
110
-c|--comment) KEYCOMMENT="$2"; shift 2;;
47
-x|--expire) KEYCOMMENT="$2"; shift 2;;
111
-x|--expire) KEYEXPIRE="$2"; shift 2;;
112
-T|--tls-keytype) TLS_KEYTYPE="$2"; shift 2;;
48
113
-f|--force) FORCE=yes; shift;;
114
-S|--no-ssh) SSH=no; shift;;
115
-v|--version) echo "$0 $VERSION"; exit;;
116
-h|--help) help; exit;;
49
117
--) shift; break;;
50
118
*) echo "Internal error" >&2; exit 1;;
53
121
if [ "$#" -gt 0 ]; then
54
echo "Unknown arguments: '$@'" >&2
122
echo "Unknown arguments: '$*'" >&2
58
126
SECKEYFILE="$KEYDIR/seckey.txt"
59
127
PUBKEYFILE="$KEYDIR/pubkey.txt"
128
TLS_PRIVKEYFILE="$KEYDIR/tls-privkey.pem"
129
TLS_PUBKEYFILE="$KEYDIR/tls-pubkey.pem"
61
131
# Check for some invalid values
62
if [ -d "$KEYDIR" ]; then :; else
132
if [ ! -d "$KEYDIR" ]; then
63
133
echo "$KEYDIR not a directory" >&2
66
if [ -w "$KEYDIR" ]; then :; else
67
echo "Directory $KEYDIR not writeable" >&2
71
if [ -z "$KEYTYPE" ]; then
72
echo "Empty key type" >&2
76
if [ -z "$KEYNAME" ]; then
77
echo "Empty key name" >&2
81
if [ -z "$KEYLENGTH" ] || [ "$KEYLENGTH" -lt 512 ]; then
82
echo "Invalid key length" >&2
86
if [ -z "$KEYEXPIRE" ]; then
87
echo "Empty key expiration" >&2
91
# Make FORCE be 0 or 1
93
[Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) FORCE=1;;
94
[Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
97
if { [ -e "$SECKEYFILE" ] || [ -e "$PUBKEYFILE" ]; } \
98
&& [ "$FORCE" -eq 0 ]; then
99
echo "Refusing to overwrite old key files; use --force" >&2
103
# Set lines for GPG batch file
104
if [ -n "$KEYCOMMENT" ]; then
105
KEYCOMMENTLINE="Name-Comment: $KEYCOMMENT"
107
if [ -n "$KEYEMAIL" ]; then
108
KEYEMAILLINE="Name-Email: $KEYEMAIL"
112
BATCHFILE="`mktemp -t mandos-gpg-batch.XXXXXXXXXX`"
113
SECRING="`mktemp -t mandos-gpg-secring.XXXXXXXXXX`"
114
PUBRING="`mktemp -t mandos-gpg-pubring.XXXXXXXXXX`"
116
trap "rm --force $PUBRING $BATCHFILE; shred --remove $SECRING" EXIT
118
# Create batch file for GPG
119
cat >"$BATCHFILE" <<EOF
121
Key-Length: $KEYLENGTH
122
#Key-Usage: encrypt,sign,auth
126
Expire-Date: $KEYEXPIRE
133
gpg --no-random-seed-file --quiet --batch --no-tty \
134
--no-default-keyring --no-options --batch \
135
--secret-keyring "$SECRING" --keyring "$PUBRING" \
136
--gen-key "$BATCHFILE"
137
rm --force "$BATCHFILE"
139
if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
141
shred --remove "$SECKEYFILE"
143
if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
145
rm --force "$PUBKEYFILE"
148
FILECOMMENT="Mandos client key for $KEYNAME"
149
if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
150
FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
153
if [ -n "$KEYEMAIL" ]; then
154
FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
157
gpg --no-random-seed-file --quiet --batch --no-tty --armor \
158
--no-default-keyring --secret-keyring "$SECRING" \
159
--keyring "$PUBRING" --export-options export-minimal \
160
--comment "$FILECOMMENT" --output "$SECKEYFILE" \
162
gpg --no-random-seed-file --quiet --batch --no-tty --armor \
163
--no-default-keyring --secret-keyring "$SECRING" \
164
--keyring "$PUBRING" --export-options export-minimal \
165
--comment "$FILECOMMENT" --output "$PUBKEYFILE" \
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`"
192
if [ "$mode" = password ]; then
193
# Create temporary encrypted password file
194
SECFILE="`mktemp -t mandos-keygen-secfile.XXXXXXXXXX`"
197
# Create temporary key ring directory
198
RINGDIR="`mktemp -d -t mandos-keygen-keyrings.XXXXXXXXXX`"
200
# Remove temporary files on exit
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; \
214
if [ "$mode" = keygen ]; then
215
# Create batch file for GnuPG
216
cat >"$BATCHFILE" <<-EOF
218
Key-Length: $KEYLENGTH
220
Subkey-Type: $SUBKEYTYPE
221
Subkey-Length: $SUBKEYLENGTH
222
Subkey-Usage: encrypt
226
Expire-Date: $KEYEXPIRE
227
#Preferences: <string>
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
290
# Generate a new key in the key rings
291
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
292
--homedir "$RINGDIR" --trust-model always \
293
--gen-key "$BATCHFILE"
294
rm --force "$BATCHFILE"
301
# Backup any old key files
302
if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
304
shred --remove "$SECKEYFILE"
306
if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
308
rm --force "$PUBKEYFILE"
311
FILECOMMENT="Mandos client key for $KEYNAME"
312
if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
313
FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
316
if [ -n "$KEYEMAIL" ]; then
317
FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
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
330
if [ "$mode" = password ]; then
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"
363
# Get fingerprint of key
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}'`"
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:]]//')
383
FILECOMMENT="Encrypted password for a Mandos client"
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
423
fingerprint = $FINGERPRINT
426
sed --quiet --expression='
427
/^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
429
# Remove 24-bit Radix-64 checksum
435
if [ -n "$ssh_fingerprint" ]; then
436
echo 'checker = ssh-keyscan -t '"$ssh_keytype"' %%(host)s 2>/dev/null | grep --fixed-strings --line-regexp --quiet --regexp=%%(host)s" %(ssh_fingerprint)s"'
437
echo "ssh_fingerprint = ${ssh_fingerprint}"
444
# Remove the password file, if any
445
if [ -n "$SECFILE" ]; then
446
shred --remove "$SECFILE"
448
# Remove the key rings
449
shred --remove "$RINGDIR"/sec* 2>/dev/null
450
rm --recursive --force "$RINGDIR"