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 © 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
12
9
# the Free Software Foundation, either version 3 of the License, or
13
10
# (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
12
# This program is distributed in the hope that it will be useful,
13
# but WITHOUT ANY WARRANTY; without even the implied warranty of
17
14
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18
15
# GNU General Public License for more details.
20
17
# You should have received a copy of the GNU General Public License
21
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
18
# along with this program. If not, see <http://www.gnu.org/licenses/>.
23
# Contact the authors at <mandos@recompile.se>.
20
# Contact the authors at <mandos@fukt.bsnet.se>.
28
25
KEYDIR="/etc/keys/mandos"
33
KEYNAME="`hostname --fqdn 2>/dev/null || hostname`"
30
KEYNAME="`hostname --fqdn`"
32
KEYCOMMENT="Mandos client key"
40
35
KEYCOMMENT_ORIG="$KEYCOMMENT"
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 \
43
TEMP=`getopt --options vhd:t:l:n:e:c:x:f \
44
--longoptions version,help,password,dir:,type:,length:,subtype:,sublength:,name:,email:,comment:,expire:,force \
50
45
--name "$0" -- "$@"`
53
basename="`basename "$0"`"
48
basename="`basename $0`"
55
50
Usage: $basename [ -v | --version ]
56
51
$basename [ -h | --help ]
58
53
$basename [ OPTIONS ]
59
54
Encrypted password creation:
60
55
$basename { -p | --password } [ --name NAME ] [ --dir DIR]
61
$basename { -F | --passfile } FILE [ --name NAME ] [ --dir DIR]
63
57
Key creation options:
64
58
-v, --version Show program's version number and exit
65
59
-h, --help Show this help message and exit
66
60
-d DIR, --dir DIR Target directory for key files
67
-t TYPE, --type TYPE OpenPGP key type. Default is RSA.
61
-t TYPE, --type TYPE Key type. Default is DSA.
68
62
-l BITS, --length BITS
69
OpenPGP key length in bits. Default is 4096.
63
Key length in bits. Default is 2048.
70
64
-s TYPE, --subtype TYPE
71
OpenPGP subkey type. Default is RSA.
65
Subkey type. Default is ELG-E.
72
66
-L BITS, --sublength BITS
73
OpenPGP subkey length in bits. Default 4096.
67
Subkey length in bits. Default is 2048.
74
68
-n NAME, --name NAME Name of key. Default is the FQDN.
75
69
-e ADDRESS, --email ADDRESS
76
Email address of OpenPGP key. Default empty.
70
Email address of key. Default is empty.
77
71
-c TEXT, --comment TEXT
78
Comment field for OpenPGP key. Default empty.
72
Comment field for key. The default value is
79
74
-x TIME, --expire TIME
80
OpenPGP key expire time. Default is none.
75
Key expire time. Default is no expiration.
81
76
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.
77
-f, --force Force overwriting old keys.
86
79
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.
80
-p, --password Create an encrypted password using the keys in
81
the key directory. All options other than
82
--dir and --name are ignored.
109
96
-e|--email) KEYEMAIL="$2"; shift 2;;
110
97
-c|--comment) KEYCOMMENT="$2"; shift 2;;
111
98
-x|--expire) KEYEXPIRE="$2"; shift 2;;
112
-T|--tls-keytype) TLS_KEYTYPE="$2"; shift 2;;
113
99
-f|--force) FORCE=yes; shift;;
114
-S|--no-ssh) SSH=no; shift;;
115
100
-v|--version) echo "$0 $VERSION"; exit;;
116
101
-h|--help) help; exit;;
117
102
--) shift; break;;
121
106
if [ "$#" -gt 0 ]; then
122
echo "Unknown arguments: '$*'" >&2
107
echo "Unknown arguments: '$@'" >&2
126
111
SECKEYFILE="$KEYDIR/seckey.txt"
127
112
PUBKEYFILE="$KEYDIR/pubkey.txt"
128
TLS_PRIVKEYFILE="$KEYDIR/tls-privkey.pem"
129
TLS_PUBKEYFILE="$KEYDIR/tls-pubkey.pem"
131
114
# Check for some invalid values
132
115
if [ ! -d "$KEYDIR" ]; then
162
145
echo "Empty key expiration" >&2
166
149
# Make FORCE be 0 or 1
168
151
[Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) FORCE=1;;
169
152
[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
155
if [ \( -e "$SECKEYFILE" -o -e "$PUBKEYFILE" \) \
156
-a "$FORCE" -eq 0 ]; then
176
157
echo "Refusing to overwrite old key files; use --force" >&2
180
161
# Set lines for GnuPG batch file
181
162
if [ -n "$KEYCOMMENT" ]; then
182
163
KEYCOMMENTLINE="Name-Comment: $KEYCOMMENT"
204
184
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
205
test -n \"$TLS_PRIVKEYTMP\" && shred --remove \"$TLS_PRIVKEYTMP\"; \
206
shred --remove \"$RINGDIR\"/sec* 2>/dev/null;
185
shred --remove \"$RINGDIR\"/sec*;
207
186
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
208
187
rm --recursive --force \"$RINGDIR\";
209
tty --quiet && stty echo; \
216
193
if [ "$mode" = keygen ]; then
230
207
#Handle: <no-spaces>
231
208
#%pubring pubring.gpg
232
209
#%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" 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
# 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
213
# Generate a new key in the key rings
286
214
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
287
215
--homedir "$RINGDIR" --trust-model always \
288
216
--gen-key "$BATCHFILE"
289
217
rm --force "$BATCHFILE"
296
219
# Backup any old key files
297
220
if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
298
221
2>/dev/null; then
299
shred --remove "$SECKEYFILE" 2>/dev/null || :
222
shred --remove "$SECKEYFILE"
301
224
if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
302
225
2>/dev/null; then
303
226
rm --force "$PUBKEYFILE"
306
229
FILECOMMENT="Mandos client key for $KEYNAME"
307
230
if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
308
231
FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
311
234
if [ -n "$KEYEMAIL" ]; then
312
235
FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
315
# Export key from key rings to key files
238
# Export keys from key rings to key files
316
239
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
317
240
--homedir "$RINGDIR" --armor --export-options export-minimal \
318
241
--comment "$FILECOMMENT" --output "$SECKEYFILE" \
325
248
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
# 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 }"
353
# Import key into temporary key rings
249
# Import keys into temporary key rings
354
250
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
355
251
--homedir "$RINGDIR" --trust-model always --armor \
356
252
--import "$SECKEYFILE"
357
253
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
358
254
--homedir "$RINGDIR" --trust-model always --armor \
359
255
--import "$PUBKEYFILE"
361
257
# Get fingerprint of key
362
258
FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
363
--enable-dsa2 --homedir "$RINGDIR" --trust-model always \
259
--enable-dsa2 --homedir \"$RINGDIR\" --trust-model always \
364
260
--fingerprint --with-colons \
366
262
--expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
368
264
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
266
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
269
echo -n "Enter passphrase: " >&2
270
head --lines=1 | tr --delete '\n' \
271
| gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
272
--homedir "$RINGDIR" --trust-model always --armor --encrypt \
273
--recipient "$FINGERPRINT" --comment "$FILECOMMENT" \
423
if [ -n "$KEY_ID" ]; then
424
echo "key_id = $KEY_ID"
427
281
fingerprint = $FINGERPRINT
430
284
sed --quiet --expression='
431
285
/^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
439
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"'
445
echo "ssh_fingerprint = ${ssh_fingerprint}"
452
298
# Remove the password file, if any
453
299
if [ -n "$SECFILE" ]; then
454
shred --remove "$SECFILE" 2>/dev/null
300
shred --remove "$SECFILE"
456
302
# Remove the key rings
457
shred --remove "$RINGDIR"/sec* 2>/dev/null
303
shred --remove "$RINGDIR"/sec*
458
304
rm --recursive --force "$RINGDIR"
added
removed
mandos-keygen
