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 © 2008-2014 Teddy Hogeborn
6
# Copyright © 2008-2014 Björn Påhlsson
8
# This program is free software: you can redistribute it and/or modify
9
# it under the terms of the GNU General Public License as published by
12
10
# the Free Software Foundation, either version 3 of the License, or
13
11
# (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
13
# This program is distributed in the hope that it will be useful,
14
# but WITHOUT ANY WARRANTY; without even the implied warranty of
17
15
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18
16
# GNU General Public License for more details.
20
18
# You should have received a copy of the GNU General Public License
21
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
19
# along with this program. If not, see <http://www.gnu.org/licenses/>.
23
21
# Contact the authors at <mandos@recompile.se>.
28
26
KEYDIR="/etc/keys/mandos"
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 \
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 \
50
47
--name "$0" -- "$@"`
64
61
-v, --version Show program's version number and exit
65
62
-h, --help Show this help message and exit
66
63
-d DIR, --dir DIR Target directory for key files
67
-t TYPE, --type TYPE OpenPGP key type. Default is RSA.
64
-t TYPE, --type TYPE Key type. Default is RSA.
68
65
-l BITS, --length BITS
69
OpenPGP key length in bits. Default is 4096.
66
Key length in bits. Default is 4096.
70
67
-s TYPE, --subtype TYPE
71
OpenPGP subkey type. Default is RSA.
68
Subkey type. Default is RSA.
72
69
-L BITS, --sublength BITS
73
OpenPGP subkey length in bits. Default 4096.
70
Subkey length in bits. Default is 4096.
74
71
-n NAME, --name NAME Name of key. Default is the FQDN.
75
72
-e ADDRESS, --email ADDRESS
76
Email address of OpenPGP key. Default empty.
73
Email address of key. Default is empty.
77
74
-c TEXT, --comment TEXT
78
Comment field for OpenPGP key. Default empty.
75
Comment field for key. The default is empty.
79
76
-x TIME, --expire TIME
80
OpenPGP key expire time. Default is none.
77
Key expire time. Default is no expiration.
81
78
See gpg(1) for syntax.
82
-T TYPE, --tls-keytype TYPE
83
TLS key type. Default is ed25519.
84
79
-f, --force Force overwriting old key files.
86
81
Password creation options:
109
104
-e|--email) KEYEMAIL="$2"; shift 2;;
110
105
-c|--comment) KEYCOMMENT="$2"; shift 2;;
111
106
-x|--expire) KEYEXPIRE="$2"; shift 2;;
112
-T|--tls-keytype) TLS_KEYTYPE="$2"; shift 2;;
113
107
-f|--force) FORCE=yes; shift;;
114
108
-S|--no-ssh) SSH=no; shift;;
115
109
-v|--version) echo "$0 $VERSION"; exit;;
126
120
SECKEYFILE="$KEYDIR/seckey.txt"
127
121
PUBKEYFILE="$KEYDIR/pubkey.txt"
128
TLS_PRIVKEYFILE="$KEYDIR/tls-privkey.pem"
129
TLS_PUBKEYFILE="$KEYDIR/tls-pubkey.pem"
131
123
# Check for some invalid values
132
124
if [ ! -d "$KEYDIR" ]; then
147
139
echo "Empty key type" >&2
151
143
if [ -z "$KEYNAME" ]; then
152
144
echo "Empty key name" >&2
156
148
if [ -z "$KEYLENGTH" ] || [ "$KEYLENGTH" -lt 512 ]; then
157
149
echo "Invalid key length" >&2
161
153
if [ -z "$KEYEXPIRE" ]; then
162
154
echo "Empty key expiration" >&2
166
158
# Make FORCE be 0 or 1
168
160
[Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) FORCE=1;;
169
161
[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
164
if [ \( -e "$SECKEYFILE" -o -e "$PUBKEYFILE" \) \
165
-a "$FORCE" -eq 0 ]; then
176
166
echo "Refusing to overwrite old key files; use --force" >&2
180
170
# Set lines for GnuPG batch file
181
171
if [ -n "$KEYCOMMENT" ]; then
182
172
KEYCOMMENTLINE="Name-Comment: $KEYCOMMENT"
184
174
if [ -n "$KEYEMAIL" ]; then
185
175
KEYEMAILLINE="Name-Email: $KEYEMAIL"
188
178
# Create temporary gpg batch file
189
179
BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
190
TLS_PRIVKEYTMP="`mktemp -t mandos-keygen-privkey.XXXXXXXXXX`"
193
182
if [ "$mode" = password ]; then
204
193
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
205
test -n \"$TLS_PRIVKEYTMP\" && shred --remove \"$TLS_PRIVKEYTMP\"; \
206
194
shred --remove \"$RINGDIR\"/sec* 2>/dev/null;
207
195
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
208
196
rm --recursive --force \"$RINGDIR\";
243
230
echo -n "Started: "
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
234
# Make sure trustdb.gpg exists;
281
235
# this is a workaround for Debian bug #737128
282
236
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
287
241
--homedir "$RINGDIR" --trust-model always \
288
242
--gen-key "$BATCHFILE"
289
243
rm --force "$BATCHFILE"
291
245
if tty --quiet; then
292
246
echo -n "Finished: "
296
250
# Backup any old key files
297
251
if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
298
252
2>/dev/null; then
299
shred --remove "$SECKEYFILE" 2>/dev/null || :
253
shred --remove "$SECKEYFILE"
301
255
if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
302
256
2>/dev/null; then
303
257
rm --force "$PUBKEYFILE"
306
260
FILECOMMENT="Mandos client key for $KEYNAME"
307
261
if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
308
262
FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
311
265
if [ -n "$KEYEMAIL" ]; then
312
266
FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
315
269
# Export key from key rings to key files
316
270
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
317
271
--homedir "$RINGDIR" --armor --export-options export-minimal \
325
279
if [ "$mode" = password ]; then
327
281
# Make SSH be 0 or 1
329
283
[Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) SSH=1;;
330
284
[Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) SSH=0;;
333
287
if [ $SSH -eq 1 ]; then
334
# The -q option is new in OpenSSH 9.8
335
for ssh_keyscan_quiet in "-q " ""; do
336
for ssh_keytype in ecdsa-sha2-nistp256 ed25519 rsa; do
338
ssh_fingerprint="`ssh-keyscan ${ssh_keyscan_quiet}-t $ssh_keytype localhost 2>/dev/null`"
341
if [ $err -ne 0 ]; then
345
if [ -n "$ssh_fingerprint" ]; then
346
ssh_fingerprint="${ssh_fingerprint#localhost }"
289
ssh_fingerprint="`ssh-keyscan localhost 2>/dev/null`"
290
if [ $? -ne 0 ]; then
294
ssh_fingerprint="${ssh_fingerprint#localhost }"
353
297
# Import key into temporary key rings
354
298
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
355
299
--homedir "$RINGDIR" --trust-model always --armor \
357
301
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
358
302
--homedir "$RINGDIR" --trust-model always --armor \
359
303
--import "$PUBKEYFILE"
361
305
# Get fingerprint of key
362
306
FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
363
307
--enable-dsa2 --homedir "$RINGDIR" --trust-model always \
364
308
--fingerprint --with-colons \
366
310
--expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
368
312
test -n "$FINGERPRINT"
370
if [ -r "$TLS_PUBKEYFILE" ]; then
371
KEY_ID="$(certtool --key-id --hash=sha256 \
372
--infile="$TLS_PUBKEYFILE" 2>/dev/null || :)"
374
if [ -z "$KEY_ID" ]; then
375
KEY_ID=$(openssl pkey -pubin -in "$TLS_PUBKEYFILE" \
378
| sed --expression='s/^.*[^[:xdigit:]]//')
383
314
FILECOMMENT="Encrypted password for a Mandos client"
385
316
while [ ! -s "$SECFILE" ]; do
386
317
if [ -n "$PASSFILE" ]; then
389
320
tty --quiet && stty -echo
390
echo -n "Enter passphrase: " >/dev/tty
321
echo -n "Enter passphrase: " >&2
392
323
tty --quiet && echo >&2
393
echo -n "Repeat passphrase: " >/dev/tty
324
echo -n "Repeat passphrase: " >&2
395
326
if tty --quiet; then
439
365
if [ -n "$ssh_fingerprint" ]; then
440
if [ -n "$ssh_keyscan_quiet" ]; then
441
echo "# Note: if the Mandos server has OpenSSH older than 9.8, the ${ssh_keyscan_quiet}"
442
echo "# option *must* be removed from the 'checker' setting below"
444
echo 'checker = ssh-keyscan '"$ssh_keyscan_quiet"'-t '"$ssh_keytype"' %%(host)s 2>/dev/null | grep --fixed-strings --line-regexp --quiet --regexp=%%(host)s" %(ssh_fingerprint)s"'
366
echo 'checker = ssh-keyscan %%(host)s 2>/dev/null | grep --fixed-strings --line-regexp --quiet --regexp=%%(host)s" %(ssh_fingerprint)s"'
445
367
echo "ssh_fingerprint = ${ssh_fingerprint}"
452
374
# Remove the password file, if any
453
375
if [ -n "$SECFILE" ]; then
454
shred --remove "$SECFILE" 2>/dev/null
376
shred --remove "$SECFILE"
456
378
# Remove the key rings
457
379
shred --remove "$RINGDIR"/sec* 2>/dev/null