/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk
73 by Teddy Hogeborn
* Makefile (COVERAGE): Change back to "--coverage".
1
#!/bin/sh -e
67 by Teddy Hogeborn
* mandos-keygen: New program to generate new client keys on
2
# 
73 by Teddy Hogeborn
* Makefile (COVERAGE): Change back to "--coverage".
3
# Mandos key generator - create a new OpenPGP key for a Mandos client
67 by Teddy Hogeborn
* mandos-keygen: New program to generate new client keys on
4
# 
24.1.102 by Björn Påhlsson
changed 2007-2008 copyright notice to 2008
5
# Copyright © 2008 Teddy Hogeborn & Björn Påhlsson
67 by Teddy Hogeborn
* mandos-keygen: New program to generate new client keys on
6
# 
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
9
# the Free Software Foundation, either version 3 of the License, or
10
# (at your option) any later version.
11
#
12
#     This program is distributed in the hope that it will be useful,
13
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
14
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15
#     GNU General Public License for more details.
16
# 
17
# 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/>.
19
# 
20
# Contact the authors at <mandos@fukt.bsnet.se>.
21
# 
22
73 by Teddy Hogeborn
* Makefile (COVERAGE): Change back to "--coverage".
23
VERSION="1.0"
24
163 by Teddy Hogeborn
* Makefile (PIDDIR, USER, GROUP): Removed.
25
KEYDIR="/etc/keys/mandos"
67 by Teddy Hogeborn
* mandos-keygen: New program to generate new client keys on
26
KEYTYPE=DSA
104 by Teddy Hogeborn
* Makefile (maintainer-clean): Also remove "confdir".
27
KEYLENGTH=2048
96 by Teddy Hogeborn
* Makefile (PREFIX, CONFDIR, MANDIR): Use $(DESTDIR).
28
SUBKEYTYPE=ELG-E
29
SUBKEYLENGTH=2048
196 by Teddy Hogeborn
* mandos-keygen (KEYNAME): Fall back to plain "hostname" if the
30
KEYNAME="`hostname --fqdn 2>/dev/null || hostname`"
67 by Teddy Hogeborn
* mandos-keygen: New program to generate new client keys on
31
KEYEMAIL=""
32
KEYCOMMENT="Mandos client key"
33
KEYEXPIRE=0
34
FORCE=no
35
KEYCOMMENT_ORIG="$KEYCOMMENT"
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
36
mode=keygen
67 by Teddy Hogeborn
* mandos-keygen: New program to generate new client keys on
37
179 by Teddy Hogeborn
* INSTALL: New file.
38
if [ ! -d "$KEYDIR" ]; then
39
    KEYDIR="/etc/mandos/keys"
40
fi
41
67 by Teddy Hogeborn
* mandos-keygen: New program to generate new client keys on
42
# Parse options
73 by Teddy Hogeborn
* Makefile (COVERAGE): Change back to "--coverage".
43
TEMP=`getopt --options vhd:t:l:n:e:c:x:f \
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
44
    --longoptions version,help,password,dir:,type:,length:,subtype:,sublength:,name:,email:,comment:,expire:,force \
67 by Teddy Hogeborn
* mandos-keygen: New program to generate new client keys on
45
    --name "$0" -- "$@"`
46
73 by Teddy Hogeborn
* Makefile (COVERAGE): Change back to "--coverage".
47
help(){
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
48
basename="`basename $0`"
73 by Teddy Hogeborn
* Makefile (COVERAGE): Change back to "--coverage".
49
cat <<EOF
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
50
Usage: $basename [ -v | --version ]
51
       $basename [ -h | --help ]
52
   Key creation:
53
       $basename [ OPTIONS ]
54
   Encrypted password creation:
55
       $basename { -p | --password } [ --name NAME ] [ --dir DIR]
73 by Teddy Hogeborn
* Makefile (COVERAGE): Change back to "--coverage".
56
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
57
Key creation options:
73 by Teddy Hogeborn
* Makefile (COVERAGE): Change back to "--coverage".
58
  -v, --version         Show program's version number and exit
59
  -h, --help            Show this help message and exit
60
  -d DIR, --dir DIR     Target directory for key files
61
  -t TYPE, --type TYPE  Key type.  Default is DSA.
62
  -l BITS, --length BITS
104 by Teddy Hogeborn
* Makefile (maintainer-clean): Also remove "confdir".
63
                        Key length in bits.  Default is 2048.
96 by Teddy Hogeborn
* Makefile (PREFIX, CONFDIR, MANDIR): Use $(DESTDIR).
64
  -s TYPE, --subtype TYPE
65
                        Subkey type.  Default is ELG-E.
66
  -L BITS, --sublength BITS
67
                        Subkey length in bits.  Default is 2048.
73 by Teddy Hogeborn
* Makefile (COVERAGE): Change back to "--coverage".
68
  -n NAME, --name NAME  Name of key.  Default is the FQDN.
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
69
  -e ADDRESS, --email ADDRESS
73 by Teddy Hogeborn
* Makefile (COVERAGE): Change back to "--coverage".
70
                        Email address of key.  Default is empty.
123 by Teddy Hogeborn
* mandos-keygen: Minor help text change.
71
  -c TEXT, --comment TEXT
73 by Teddy Hogeborn
* Makefile (COVERAGE): Change back to "--coverage".
72
                        Comment field for key.  The default value is
73
                        "Mandos client key".
74
  -x TIME, --expire TIME
75
                        Key expire time.  Default is no expiration.
76
                        See gpg(1) for syntax.
77
  -f, --force           Force overwriting old keys.
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
78
79
Password creation options:
80
  -p, --password        Create an encrypted password using the keys in
81
                        the key directory.  All options other than
123 by Teddy Hogeborn
* mandos-keygen: Minor help text change.
82
                        --dir and --name are ignored.
73 by Teddy Hogeborn
* Makefile (COVERAGE): Change back to "--coverage".
83
EOF
84
}
85
67 by Teddy Hogeborn
* mandos-keygen: New program to generate new client keys on
86
eval set -- "$TEMP"
87
while :; do
88
    case "$1" in
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
89
	-p|--password) mode=password; shift;;
67 by Teddy Hogeborn
* mandos-keygen: New program to generate new client keys on
90
	-d|--dir) KEYDIR="$2"; shift 2;;
91
	-t|--type) KEYTYPE="$2"; shift 2;;
96 by Teddy Hogeborn
* Makefile (PREFIX, CONFDIR, MANDIR): Use $(DESTDIR).
92
	-s|--subtype) SUBKEYTYPE="$2"; shift 2;;
67 by Teddy Hogeborn
* mandos-keygen: New program to generate new client keys on
93
	-l|--length) KEYLENGTH="$2"; shift 2;;
96 by Teddy Hogeborn
* Makefile (PREFIX, CONFDIR, MANDIR): Use $(DESTDIR).
94
	-L|--sublength) SUBKEYLENGTH="$2"; shift 2;;
67 by Teddy Hogeborn
* mandos-keygen: New program to generate new client keys on
95
	-n|--name) KEYNAME="$2"; shift 2;;
96
	-e|--email) KEYEMAIL="$2"; shift 2;;
97
	-c|--comment) KEYCOMMENT="$2"; shift 2;;
87 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".
98
	-x|--expire) KEYEXPIRE="$2"; shift 2;;
67 by Teddy Hogeborn
* mandos-keygen: New program to generate new client keys on
99
	-f|--force) FORCE=yes; shift;;
73 by Teddy Hogeborn
* Makefile (COVERAGE): Change back to "--coverage".
100
	-v|--version) echo "$0 $VERSION"; exit;;
101
	-h|--help) help; exit;;
67 by Teddy Hogeborn
* mandos-keygen: New program to generate new client keys on
102
	--) shift; break;;
103
	*) echo "Internal error" >&2; exit 1;;
104
    esac
105
done
106
if [ "$#" -gt 0 ]; then
107
    echo "Unknown arguments: '$@'" >&2
108
    exit 1
109
fi
110
111
SECKEYFILE="$KEYDIR/seckey.txt"
112
PUBKEYFILE="$KEYDIR/pubkey.txt"
113
114
# Check for some invalid values
159 by Teddy Hogeborn
* Makefile (run-client): Do not depend on the key ring files.
115
if [ ! -d "$KEYDIR" ]; then
67 by Teddy Hogeborn
* mandos-keygen: New program to generate new client keys on
116
    echo "$KEYDIR not a directory" >&2
117
    exit 1
118
fi
159 by Teddy Hogeborn
* Makefile (run-client): Do not depend on the key ring files.
119
if [ ! -r "$KEYDIR" ]; then
120
    echo "Directory $KEYDIR not readable" >&2
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
121
    exit 1
122
fi
123
124
if [ "$mode" = keygen ]; then
159 by Teddy Hogeborn
* Makefile (run-client): Do not depend on the key ring files.
125
    if [ ! -w "$KEYDIR" ]; then
126
	echo "Directory $KEYDIR not writeable" >&2
127
	exit 1
128
    fi
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
129
    if [ -z "$KEYTYPE" ]; then
130
	echo "Empty key type" >&2
131
	exit 1
132
    fi
133
    
134
    if [ -z "$KEYNAME" ]; then
135
	echo "Empty key name" >&2
136
	exit 1
137
    fi
138
    
139
    if [ -z "$KEYLENGTH" ] || [ "$KEYLENGTH" -lt 512 ]; then
140
	echo "Invalid key length" >&2
141
	exit 1
142
    fi
143
144
    if [ -z "$KEYEXPIRE" ]; then
145
	echo "Empty key expiration" >&2
146
	exit 1
147
    fi
148
    
149
    # Make FORCE be 0 or 1
150
    case "$FORCE" in
151
	[Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) FORCE=1;;
152
	[Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
153
    esac
154
    
168 by Teddy Hogeborn
* initramfs-tools-hook: Use long options where available. Use only
155
    if [ \( -e "$SECKEYFILE" -o -e "$PUBKEYFILE" \) \
156
	-a "$FORCE" -eq 0 ]; then
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
157
	echo "Refusing to overwrite old key files; use --force" >&2
158
	exit 1
159
    fi
160
    
161
    # Set lines for GnuPG batch file
162
    if [ -n "$KEYCOMMENT" ]; then
163
	KEYCOMMENTLINE="Name-Comment: $KEYCOMMENT"
164
    fi
165
    if [ -n "$KEYEMAIL" ]; then
166
	KEYEMAILLINE="Name-Email: $KEYEMAIL"
167
    fi
168
169
    # Create temporary gpg batch file
159 by Teddy Hogeborn
* Makefile (run-client): Do not depend on the key ring files.
170
    BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
171
fi
172
173
if [ "$mode" = password ]; then
174
    # Create temporary encrypted password file
159 by Teddy Hogeborn
* Makefile (run-client): Do not depend on the key ring files.
175
    SECFILE="`mktemp -t mandos-keygen-secfile.XXXXXXXXXX`"
176
fi
177
178
# Create temporary key ring directory
179
RINGDIR="`mktemp -d -t mandos-keygen-keyrings.XXXXXXXXXX`"
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
180
73 by Teddy Hogeborn
* Makefile (COVERAGE): Change back to "--coverage".
181
# Remove temporary files on exit
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
182
trap "
96 by Teddy Hogeborn
* Makefile (PREFIX, CONFDIR, MANDIR): Use $(DESTDIR).
183
set +e; \
159 by Teddy Hogeborn
* Makefile (run-client): Do not depend on the key ring files.
184
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
185
shred --remove \"$RINGDIR\"/sec*;
186
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
187
rm --recursive --force \"$RINGDIR\";
96 by Teddy Hogeborn
* Makefile (PREFIX, CONFDIR, MANDIR): Use $(DESTDIR).
188
stty echo; \
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
189
" EXIT
67 by Teddy Hogeborn
* mandos-keygen: New program to generate new client keys on
190
166 by Teddy Hogeborn
* Makefile (confdir/clients.conf): Tighten permissions to "u=rw".
191
umask 077
73 by Teddy Hogeborn
* Makefile (COVERAGE): Change back to "--coverage".
192
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
193
if [ "$mode" = keygen ]; then
194
    # Create batch file for GnuPG
195
    cat >"$BATCHFILE" <<-EOF
196
	Key-Type: $KEYTYPE
197
	Key-Length: $KEYLENGTH
198
	#Key-Usage: encrypt,sign,auth
199
	Subkey-Type: $SUBKEYTYPE
200
	Subkey-Length: $SUBKEYLENGTH
201
	#Subkey-Usage: encrypt,sign,auth
202
	Name-Real: $KEYNAME
203
	$KEYCOMMENTLINE
204
	$KEYEMAILLINE
205
	Expire-Date: $KEYEXPIRE
206
	#Preferences: <string>
207
	#Handle: <no-spaces>
159 by Teddy Hogeborn
* Makefile (run-client): Do not depend on the key ring files.
208
	#%pubring pubring.gpg
209
	#%secring secring.gpg
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
210
	%commit
211
	EOF
212
    
213
    # Generate a new key in the key rings
159 by Teddy Hogeborn
* Makefile (run-client): Do not depend on the key ring files.
214
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
215
	--homedir "$RINGDIR" --trust-model always \
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
216
	--gen-key "$BATCHFILE"
217
    rm --force "$BATCHFILE"
159 by Teddy Hogeborn
* Makefile (run-client): Do not depend on the key ring files.
218
    
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
219
    # Backup any old key files
220
    if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
221
	2>/dev/null; then
222
	shred --remove "$SECKEYFILE"
223
    fi
224
    if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
225
	2>/dev/null; then
226
	rm --force "$PUBKEYFILE"
227
    fi
228
    
229
    FILECOMMENT="Mandos client key for $KEYNAME"
230
    if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
231
	FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
232
    fi
233
    
234
    if [ -n "$KEYEMAIL" ]; then
235
	FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
236
    fi
237
    
238
    # Export keys from key rings to key files
159 by Teddy Hogeborn
* Makefile (run-client): Do not depend on the key ring files.
239
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
240
	--homedir "$RINGDIR" --armor --export-options export-minimal \
241
	--comment "$FILECOMMENT" --output "$SECKEYFILE" \
242
	--export-secret-keys
243
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
244
	--homedir "$RINGDIR" --armor --export-options export-minimal \
245
	--comment "$FILECOMMENT" --output "$PUBKEYFILE" --export
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
246
fi
247
248
if [ "$mode" = password ]; then
249
    # Import keys into temporary key rings
159 by Teddy Hogeborn
* Makefile (run-client): Do not depend on the key ring files.
250
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
251
	--homedir "$RINGDIR" --trust-model always --armor \
252
	--import "$SECKEYFILE"
253
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
254
	--homedir "$RINGDIR" --trust-model always --armor \
255
	--import "$PUBKEYFILE"
256
    
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
257
    # Get fingerprint of key
159 by Teddy Hogeborn
* Makefile (run-client): Do not depend on the key ring files.
258
    FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
259
	--enable-dsa2 --homedir \"$RINGDIR\" --trust-model always \
260
	--fingerprint --with-colons \
168 by Teddy Hogeborn
* initramfs-tools-hook: Use long options where available. Use only
261
	| sed --quiet \
262
	--expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
263
    
264
    test -n "$FINGERPRINT"
265
    
266
    FILECOMMENT="Encrypted password for a Mandos client"
267
    
268
    stty -echo
269
    echo -n "Enter passphrase: " >&2
168 by Teddy Hogeborn
* initramfs-tools-hook: Use long options where available. Use only
270
    head --lines=1 | tr --delete '\n' \
159 by Teddy Hogeborn
* Makefile (run-client): Do not depend on the key ring files.
271
	| gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
272
	--homedir "$RINGDIR" --trust-model always --armor --encrypt \
273
	--recipient "$FINGERPRINT" --comment "$FILECOMMENT" \
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
274
	> "$SECFILE"
275
    echo >&2
276
    stty echo
277
    
278
    cat <<-EOF
279
	[$KEYNAME]
99 by Teddy Hogeborn
* mandos (fingerprint): Bug fix: Check crtverify.value, not crtverify.
280
	host = $KEYNAME
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
281
	fingerprint = $FINGERPRINT
282
	secret =
283
EOF
168 by Teddy Hogeborn
* initramfs-tools-hook: Use long options where available. Use only
284
    sed --quiet --expression='
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
285
	/^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
286
	    /^$/,${
103 by Teddy Hogeborn
* mandos-keygen: Strip 24-bit checksum of Radix-64 from output to make
287
		# Remove 24-bit Radix-64 checksum
288
		s/=....$//
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
289
		# Indent four spaces
290
		/^[^-]/s/^/    /p
291
	    }
292
	}' < "$SECFILE"
293
fi
73 by Teddy Hogeborn
* Makefile (COVERAGE): Change back to "--coverage".
294
295
trap - EXIT
296
97 by Teddy Hogeborn
* mandos-keygen: Bug fix: Recognize new options --subtype and
297
set +e
298
# Remove the password file, if any
299
if [ -n "$SECFILE" ]; then
300
    shred --remove "$SECFILE"
301
fi
73 by Teddy Hogeborn
* Makefile (COVERAGE): Change back to "--coverage".
302
# Remove the key rings
159 by Teddy Hogeborn
* Makefile (run-client): Do not depend on the key ring files.
303
shred --remove "$RINGDIR"/sec*
304
rm --recursive --force "$RINGDIR"