3
3
# Mandos key generator - create a new OpenPGP key for a Mandos client
5
# Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
5
# Copyright © 2008-2017 Teddy Hogeborn
6
# Copyright © 2008-2017 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
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>.
28
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`"
30
KEYCOMMENT="Mandos client key"
33
39
KEYCOMMENT_ORIG="$KEYCOMMENT"
42
if [ ! -d "$KEYDIR" ]; then
43
KEYDIR="/etc/mandos/keys"
36
TEMP=`getopt --options vhd:t:l:n:e:c:x:f \
37
--longoptions version,help,dir:,type:,length:,name:,email:,comment:,expire:,force \
47
TEMP=`getopt --options vhpF:d:t:l:s:L:n:e:c:x:fS \
48
--longoptions version,help,password,passfile:,dir:,type:,length:,subtype:,sublength:,name:,email:,comment:,expire:,force,no-ssh \
38
49
--name "$0" -- "$@"`
52
basename="`basename "$0"`"
42
Usage: `basename $0` [options]
54
Usage: $basename [ -v | --version ]
55
$basename [ -h | --help ]
58
Encrypted password creation:
59
$basename { -p | --password } [ --name NAME ] [ --dir DIR]
60
$basename { -F | --passfile } FILE [ --name NAME ] [ --dir DIR]
45
63
-v, --version Show program's version number and exit
46
64
-h, --help Show this help message and exit
47
65
-d DIR, --dir DIR Target directory for key files
48
-t TYPE, --type TYPE Key type. Default is DSA.
66
-t TYPE, --type TYPE Key type. Default is RSA.
49
67
-l BITS, --length BITS
50
Key length in bits. Default is 1024.
68
Key length in bits. Default is 4096.
69
-s TYPE, --subtype TYPE
70
Subkey type. Default is RSA.
71
-L BITS, --sublength BITS
72
Subkey length in bits. Default is 4096.
51
73
-n NAME, --name NAME Name of key. Default is the FQDN.
52
-e EMAIL, --email EMAIL
74
-e ADDRESS, --email ADDRESS
53
75
Email address of key. Default is empty.
54
-c COMMENT, --comment COMMENT
55
Comment field for key. The default value is
76
-c TEXT, --comment TEXT
77
Comment field for key. The default is empty.
57
78
-x TIME, --expire TIME
58
79
Key expire time. Default is no expiration.
59
80
See gpg(1) for syntax.
60
-f, --force Force overwriting old keys.
81
-f, --force Force overwriting old key files.
83
Password creation options:
84
-p, --password Create an encrypted password using the key in
85
the key directory. All options other than
86
--dir and --name are ignored.
87
-F FILE, --passfile FILE
88
Encrypt a password from FILE using the key in
89
the key directory. All options other than
90
--dir and --name are ignored.
91
-S, --no-ssh Don't get SSH key or set "checker" option.
64
95
eval set -- "$TEMP"
98
-p|--password) mode=password; shift;;
99
-F|--passfile) mode=password; PASSFILE="$2"; shift 2;;
67
100
-d|--dir) KEYDIR="$2"; shift 2;;
68
101
-t|--type) KEYTYPE="$2"; shift 2;;
102
-s|--subtype) SUBKEYTYPE="$2"; shift 2;;
69
103
-l|--length) KEYLENGTH="$2"; shift 2;;
104
-L|--sublength) SUBKEYLENGTH="$2"; shift 2;;
70
105
-n|--name) KEYNAME="$2"; shift 2;;
71
106
-e|--email) KEYEMAIL="$2"; shift 2;;
72
107
-c|--comment) KEYCOMMENT="$2"; shift 2;;
73
108
-x|--expire) KEYEXPIRE="$2"; shift 2;;
74
109
-f|--force) FORCE=yes; shift;;
110
-S|--no-ssh) SSH=no; shift;;
75
111
-v|--version) echo "$0 $VERSION"; exit;;
76
112
-h|--help) help; exit;;
77
113
--) shift; break;;
87
123
PUBKEYFILE="$KEYDIR/pubkey.txt"
89
125
# Check for some invalid values
90
if [ -d "$KEYDIR" ]; then :; else
126
if [ ! -d "$KEYDIR" ]; then
91
127
echo "$KEYDIR not a directory" >&2
94
if [ -w "$KEYDIR" ]; then :; else
95
echo "Directory $KEYDIR not writeable" >&2
99
if [ -z "$KEYTYPE" ]; then
100
echo "Empty key type" >&2
104
if [ -z "$KEYNAME" ]; then
105
echo "Empty key name" >&2
109
if [ -z "$KEYLENGTH" ] || [ "$KEYLENGTH" -lt 512 ]; then
110
echo "Invalid key length" >&2
114
if [ -z "$KEYEXPIRE" ]; then
115
echo "Empty key expiration" >&2
119
# Make FORCE be 0 or 1
121
[Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) FORCE=1;;
122
[Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
125
if { [ -e "$SECKEYFILE" ] || [ -e "$PUBKEYFILE" ]; } \
126
&& [ "$FORCE" -eq 0 ]; then
127
echo "Refusing to overwrite old key files; use --force" >&2
131
# Set lines for GnuPG batch file
132
if [ -n "$KEYCOMMENT" ]; then
133
KEYCOMMENTLINE="Name-Comment: $KEYCOMMENT"
135
if [ -n "$KEYEMAIL" ]; then
136
KEYEMAILLINE="Name-Email: $KEYEMAIL"
140
BATCHFILE="`mktemp -t mandos-gpg-batch.XXXXXXXXXX`"
141
SECRING="`mktemp -t mandos-gpg-secring.XXXXXXXXXX`"
142
PUBRING="`mktemp -t mandos-gpg-pubring.XXXXXXXXXX`"
130
if [ ! -r "$KEYDIR" ]; then
131
echo "Directory $KEYDIR not readable" >&2
135
if [ "$mode" = keygen ]; then
136
if [ ! -w "$KEYDIR" ]; then
137
echo "Directory $KEYDIR not writeable" >&2
140
if [ -z "$KEYTYPE" ]; then
141
echo "Empty key type" >&2
145
if [ -z "$KEYNAME" ]; then
146
echo "Empty key name" >&2
150
if [ -z "$KEYLENGTH" ] || [ "$KEYLENGTH" -lt 512 ]; then
151
echo "Invalid key length" >&2
155
if [ -z "$KEYEXPIRE" ]; then
156
echo "Empty key expiration" >&2
160
# Make FORCE be 0 or 1
162
[Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) FORCE=1;;
163
[Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
166
if { [ -e "$SECKEYFILE" ] || [ -e "$PUBKEYFILE" ]; } \
167
&& [ "$FORCE" -eq 0 ]; then
168
echo "Refusing to overwrite old key files; use --force" >&2
172
# Set lines for GnuPG batch file
173
if [ -n "$KEYCOMMENT" ]; then
174
KEYCOMMENTLINE="Name-Comment: $KEYCOMMENT"
176
if [ -n "$KEYEMAIL" ]; then
177
KEYEMAILLINE="Name-Email: $KEYEMAIL"
180
# Create temporary gpg batch file
181
BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
184
if [ "$mode" = password ]; then
185
# Create temporary encrypted password file
186
SECFILE="`mktemp -t mandos-keygen-secfile.XXXXXXXXXX`"
189
# Create temporary key ring directory
190
RINGDIR="`mktemp -d -t mandos-keygen-keyrings.XXXXXXXXXX`"
144
192
# Remove temporary files on exit
145
trap "rm --force $PUBRING $BATCHFILE; shred --remove $SECRING" EXIT
147
# Create batch file for GnuPG
148
cat >"$BATCHFILE" <<EOF
150
Key-Length: $KEYLENGTH
151
#Key-Usage: encrypt,sign,auth
155
Expire-Date: $KEYEXPIRE
163
# Generate a new key in the key rings
164
gpg --no-random-seed-file --quiet --batch --no-tty \
165
--no-default-keyring --no-options --batch \
166
--secret-keyring "$SECRING" --keyring "$PUBRING" \
167
--gen-key "$BATCHFILE"
168
rm --force "$BATCHFILE"
170
# Backup any old key files
171
if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
173
shred --remove "$SECKEYFILE"
175
if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
177
rm --force "$PUBKEYFILE"
180
FILECOMMENT="Mandos client key for $KEYNAME"
181
if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
182
FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
185
if [ -n "$KEYEMAIL" ]; then
186
FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
189
# Export keys from key rings to key files
190
gpg --no-random-seed-file --quiet --batch --no-tty --armor \
191
--no-default-keyring --no-options --secret-keyring "$SECRING" \
192
--keyring "$PUBRING" --export-options export-minimal \
193
--comment "$FILECOMMENT" --output "$SECKEYFILE" \
195
gpg --no-random-seed-file --quiet --batch --no-tty --armor \
196
--no-default-keyring --no-options --secret-keyring "$SECRING" \
197
--keyring "$PUBRING" --export-options export-minimal \
198
--comment "$FILECOMMENT" --output "$PUBKEYFILE" \
195
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
196
shred --remove \"$RINGDIR\"/sec* 2>/dev/null;
197
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
198
rm --recursive --force \"$RINGDIR\";
199
tty --quiet && stty echo; \
206
if [ "$mode" = keygen ]; then
207
# Create batch file for GnuPG
208
cat >"$BATCHFILE" <<-EOF
210
Key-Length: $KEYLENGTH
212
Subkey-Type: $SUBKEYTYPE
213
Subkey-Length: $SUBKEYLENGTH
214
Subkey-Usage: encrypt
218
Expire-Date: $KEYEXPIRE
219
#Preferences: <string>
221
#%pubring pubring.gpg
222
#%secring secring.gpg
229
Note: Due to entropy requirements, key generation could take
230
anything from a few minutes to SEVERAL HOURS. Please be
231
patient and/or supply the system with more entropy if needed.
237
# Make sure trustdb.gpg exists;
238
# this is a workaround for Debian bug #737128
239
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
240
--homedir "$RINGDIR" \
241
--import-ownertrust < /dev/null
242
# Generate a new key in the key rings
243
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
244
--homedir "$RINGDIR" --trust-model always \
245
--gen-key "$BATCHFILE"
246
rm --force "$BATCHFILE"
253
# Backup any old key files
254
if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
256
shred --remove "$SECKEYFILE"
258
if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
260
rm --force "$PUBKEYFILE"
263
FILECOMMENT="Mandos client key for $KEYNAME"
264
if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
265
FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
268
if [ -n "$KEYEMAIL" ]; then
269
FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
272
# Export key from key rings to key files
273
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
274
--homedir "$RINGDIR" --armor --export-options export-minimal \
275
--comment "$FILECOMMENT" --output "$SECKEYFILE" \
277
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
278
--homedir "$RINGDIR" --armor --export-options export-minimal \
279
--comment "$FILECOMMENT" --output "$PUBKEYFILE" --export
282
if [ "$mode" = password ]; then
286
[Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) SSH=1;;
287
[Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) SSH=0;;
290
if [ $SSH -eq 1 ]; then
291
for ssh_keytype in ecdsa-sha2-nistp256 ed25519 rsa; do
293
ssh_fingerprint="`ssh-keyscan -t $ssh_keytype localhost 2>/dev/null`"
296
if [ $err -ne 0 ]; then
300
if [ -n "$ssh_fingerprint" ]; then
301
ssh_fingerprint="${ssh_fingerprint#localhost }"
307
# Import key into temporary key rings
308
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
309
--homedir "$RINGDIR" --trust-model always --armor \
310
--import "$SECKEYFILE"
311
gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
312
--homedir "$RINGDIR" --trust-model always --armor \
313
--import "$PUBKEYFILE"
315
# Get fingerprint of key
316
FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
317
--enable-dsa2 --homedir "$RINGDIR" --trust-model always \
318
--fingerprint --with-colons \
320
--expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
322
test -n "$FINGERPRINT"
324
FILECOMMENT="Encrypted password for a Mandos client"
326
while [ ! -s "$SECFILE" ]; do
327
if [ -n "$PASSFILE" ]; then
330
tty --quiet && stty -echo
331
echo -n "Enter passphrase: " >/dev/tty
333
tty --quiet && echo >&2
334
echo -n "Repeat passphrase: " >/dev/tty
340
if [ "$first" != "$second" ]; then
341
echo "Passphrase mismatch" >&2
342
touch "$RINGDIR"/mismatch
346
fi | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
347
--homedir "$RINGDIR" --trust-model always --armor \
348
--encrypt --sign --recipient "$FINGERPRINT" --comment \
349
"$FILECOMMENT" > "$SECFILE"
350
if [ -e "$RINGDIR"/mismatch ]; then
351
rm --force "$RINGDIR"/mismatch
363
fingerprint = $FINGERPRINT
366
sed --quiet --expression='
367
/^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
369
# Remove 24-bit Radix-64 checksum
375
if [ -n "$ssh_fingerprint" ]; then
376
echo 'checker = ssh-keyscan -t '"$ssh_keytype"' %%(host)s 2>/dev/null | grep --fixed-strings --line-regexp --quiet --regexp=%%(host)s" %(ssh_fingerprint)s"'
377
echo "ssh_fingerprint = ${ssh_fingerprint}"
384
# Remove the password file, if any
385
if [ -n "$SECFILE" ]; then
386
shred --remove "$SECFILE"
203
388
# Remove the key rings
204
shred --remove "$SECRING"
205
rm --force "$PUBRING"
389
shred --remove "$RINGDIR"/sec* 2>/dev/null
390
rm --recursive --force "$RINGDIR"