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