3
# Mandos key generator - create a new OpenPGP key for a Mandos client
5
# Copyright © 2008,2009 Teddy Hogeborn
6
# Copyright © 2008,2009 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
# Contact the authors at <mandos@fukt.bsnet.se>.
23
# Contact the authors at <mandos@recompile.se>.
26
28
KEYDIR="/etc/keys/mandos"
31
33
KEYNAME="`hostname --fqdn 2>/dev/null || hostname`"
33
KEYCOMMENT="Mandos client key"
36
40
KEYCOMMENT_ORIG="$KEYCOMMENT"
44
TEMP=`getopt --options vhpF:d:t:l:s:L:n:e:c:x:f \
45
--longoptions version,help,password,passfile:,dir:,type:,length:,subtype:,sublength:,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 \
46
50
--name "$0" -- "$@"`
49
basename="`basename $0`"
53
basename="`basename "$0"`"
51
55
Usage: $basename [ -v | --version ]
52
56
$basename [ -h | --help ]
60
64
-v, --version Show program's version number and exit
61
65
-h, --help Show this help message and exit
62
66
-d DIR, --dir DIR Target directory for key files
63
-t TYPE, --type TYPE Key type. Default is DSA.
67
-t TYPE, --type TYPE OpenPGP key type. Default is RSA.
64
68
-l BITS, --length BITS
65
Key length in bits. Default is 2048.
69
OpenPGP key length in bits. Default is 4096.
66
70
-s TYPE, --subtype TYPE
67
Subkey type. Default is ELG-E.
71
OpenPGP subkey type. Default is RSA.
68
72
-L BITS, --sublength BITS
69
Subkey length in bits. Default is 2048.
73
OpenPGP subkey length in bits. Default 4096.
70
74
-n NAME, --name NAME Name of key. Default is the FQDN.
71
75
-e ADDRESS, --email ADDRESS
72
Email address of key. Default is empty.
76
Email address of OpenPGP key. Default empty.
73
77
-c TEXT, --comment TEXT
74
Comment field for key. The default value is
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:
103
109
-e|--email) KEYEMAIL="$2"; shift 2;;
104
110
-c|--comment) KEYCOMMENT="$2"; shift 2;;
105
111
-x|--expire) KEYEXPIRE="$2"; shift 2;;
112
-T|--tls-keytype) TLS_KEYTYPE="$2"; shift 2;;
106
113
-f|--force) FORCE=yes; shift;;
114
-S|--no-ssh) SSH=no; shift;;
107
115
-v|--version) echo "$0 $VERSION"; exit;;
108
116
-h|--help) help; exit;;
109
117
--) shift; break;;
113
121
if [ "$#" -gt 0 ]; then
114
echo "Unknown arguments: '$@'" >&2
122
echo "Unknown arguments: '$*'" >&2
118
126
SECKEYFILE="$KEYDIR/seckey.txt"
119
127
PUBKEYFILE="$KEYDIR/pubkey.txt"
128
TLS_PRIVKEYFILE="$KEYDIR/tls-privkey.pem"
129
TLS_PUBKEYFILE="$KEYDIR/tls-pubkey.pem"
121
131
# Check for some invalid values
122
132
if [ ! -d "$KEYDIR" ]; then
137
147
echo "Empty key type" >&2
141
151
if [ -z "$KEYNAME" ]; then
142
152
echo "Empty key name" >&2
146
156
if [ -z "$KEYLENGTH" ] || [ "$KEYLENGTH" -lt 512 ]; then
147
157
echo "Invalid key length" >&2
151
161
if [ -z "$KEYEXPIRE" ]; then
152
162
echo "Empty key expiration" >&2
156
166
# Make FORCE be 0 or 1
158
168
[Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) FORCE=1;;
159
169
[Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
162
if [ \( -e "$SECKEYFILE" -o -e "$PUBKEYFILE" \) \
163
-a "$FORCE" -eq 0 ]; then
172
if { [ -e "$SECKEYFILE" ] || [ -e "$PUBKEYFILE" ] \
173
|| [ -e "$TLS_PRIVKEYFILE" ] \
174
|| [ -e "$TLS_PUBKEYFILE" ]; } \
175
&& [ "$FORCE" -eq 0 ]; then
164
176
echo "Refusing to overwrite old key files; use --force" >&2
168
180
# Set lines for GnuPG batch file
169
181
if [ -n "$KEYCOMMENT" ]; then
170
182
KEYCOMMENTLINE="Name-Comment: $KEYCOMMENT"
172
184
if [ -n "$KEYEMAIL" ]; then
173
185
KEYEMAILLINE="Name-Email: $KEYEMAIL"
176
188
# Create temporary gpg batch file
177
189
BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
190
TLS_PRIVKEYTMP="`mktemp -t mandos-keygen-privkey.XXXXXXXXXX`"
180
193
if [ "$mode" = password ]; then
191
204
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
192
shred --remove \"$RINGDIR\"/sec*;
205
test -n \"$TLS_PRIVKEYTMP\" && shred --remove \"$TLS_PRIVKEYTMP\"; \
206
shred --remove \"$RINGDIR\"/sec* 2>/dev/null;
193
207
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
194
208
rm --recursive --force \"$RINGDIR\";
209
tty --quiet && stty echo; \
200
216
if [ "$mode" = keygen ]; then
214
230
#Handle: <no-spaces>
215
231
#%pubring pubring.gpg
216
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" 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
220
285
# Generate a new key in the key rings
221
286
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
222
287
--homedir "$RINGDIR" --trust-model always \
223
288
--gen-key "$BATCHFILE"
224
289
rm --force "$BATCHFILE"
226
296
# Backup any old key files
227
297
if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
228
298
2>/dev/null; then
229
shred --remove "$SECKEYFILE"
299
shred --remove "$SECKEYFILE" 2>/dev/null || :
231
301
if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
232
302
2>/dev/null; then
233
303
rm --force "$PUBKEYFILE"
236
306
FILECOMMENT="Mandos client key for $KEYNAME"
237
307
if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
238
308
FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
241
311
if [ -n "$KEYEMAIL" ]; then
242
312
FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
245
315
# Export key from key rings to key files
246
316
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
247
317
--homedir "$RINGDIR" --armor --export-options export-minimal \
255
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
# 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 }"
256
353
# Import key into temporary key rings
257
354
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
258
355
--homedir "$RINGDIR" --trust-model always --armor \
260
357
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
261
358
--homedir "$RINGDIR" --trust-model always --armor \
262
359
--import "$PUBKEYFILE"
264
361
# Get fingerprint of key
265
362
FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
266
--enable-dsa2 --homedir \"$RINGDIR\" --trust-model always \
363
--enable-dsa2 --homedir "$RINGDIR" --trust-model always \
267
364
--fingerprint --with-colons \
269
366
--expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
271
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:]]//')
273
383
FILECOMMENT="Encrypted password for a Mandos client"
275
if [ -n "$PASSFILE" ]; then
279
echo -n "Enter passphrase: " >&2
280
first="$(head --lines=1 | tr --delete '\n')"
281
echo -n -e "\nRepeat passphrase: " >&2
282
second="$(head --lines=1 | tr --delete '\n')"
285
if [ "$first" != "$second" ]; then
286
echo -e "Passphrase mismatch" >&2
287
touch "$RINGDIR"/mismatch
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
291
fi | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
292
--homedir "$RINGDIR" --trust-model always --armor --encrypt \
293
--sign --recipient "$FINGERPRINT" --comment "$FILECOMMENT" \
295
if [ -e "$RINGDIR"/mismatch ]; then
296
rm --force "$RINGDIR"/mismatch
423
if [ -n "$KEY_ID" ]; then
424
echo "key_id = $KEY_ID"
303
427
fingerprint = $FINGERPRINT
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}"
320
452
# Remove the password file, if any
321
453
if [ -n "$SECFILE" ]; then
322
shred --remove "$SECFILE"
454
shred --remove "$SECFILE" 2>/dev/null
324
456
# Remove the key rings
325
shred --remove "$RINGDIR"/sec*
457
shred --remove "$RINGDIR"/sec* 2>/dev/null
326
458
rm --recursive --force "$RINGDIR"
added
removed
mandos-keygen
