3
 
# Mandos key generator - create a new OpenPGP key for a Mandos client
 
5
 
# Copyright © 2008-2012 Teddy Hogeborn
 
6
 
# Copyright © 2008-2012 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
 
10
 
# the Free Software Foundation, either version 3 of the License, or
 
11
 
# (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
 
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
16
 
#     GNU General Public License for more details.
 
18
 
# 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
 
# Contact the authors at <mandos@recompile.se>.
 
26
 
KEYDIR="/etc/keys/mandos"
 
31
 
KEYNAME="`hostname --fqdn 2>/dev/null || hostname`"
 
33
 
KEYCOMMENT="Mandos client key"
 
36
 
KEYCOMMENT_ORIG="$KEYCOMMENT"
 
39
 
if [ ! -d "$KEYDIR" ]; then
 
40
 
    KEYDIR="/etc/mandos/keys"
 
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 \
 
49
 
basename="`basename $0`"
 
51
 
Usage: $basename [ -v | --version ]
 
52
 
       $basename [ -h | --help ]
 
55
 
   Encrypted password creation:
 
56
 
       $basename { -p | --password } [ --name NAME ] [ --dir DIR]
 
57
 
       $basename { -F | --passfile } FILE [ --name NAME ] [ --dir DIR]
 
60
 
  -v, --version         Show program's version number and exit
 
61
 
  -h, --help            Show this help message and exit
 
62
 
  -d DIR, --dir DIR     Target directory for key files
 
63
 
  -t TYPE, --type TYPE  Key type.  Default is DSA.
 
64
 
  -l BITS, --length BITS
 
65
 
                        Key length in bits.  Default is 2048.
 
66
 
  -s TYPE, --subtype TYPE
 
67
 
                        Subkey type.  Default is ELG-E.
 
68
 
  -L BITS, --sublength BITS
 
69
 
                        Subkey length in bits.  Default is 2048.
 
70
 
  -n NAME, --name NAME  Name of key.  Default is the FQDN.
 
71
 
  -e ADDRESS, --email ADDRESS
 
72
 
                        Email address of key.  Default is empty.
 
73
 
  -c TEXT, --comment TEXT
 
74
 
                        Comment field for key.  The default value is
 
76
 
  -x TIME, --expire TIME
 
77
 
                        Key expire time.  Default is no expiration.
 
78
 
                        See gpg(1) for syntax.
 
79
 
  -f, --force           Force overwriting old key files.
 
81
 
Password creation options:
 
82
 
  -p, --password        Create an encrypted password using the key in
 
83
 
                        the key directory.  All options other than
 
84
 
                        --dir and --name are ignored.
 
85
 
  -F FILE, --passfile FILE
 
86
 
                        Encrypt a password from FILE using the key in
 
87
 
                        the key directory.  All options other than
 
88
 
                        --dir and --name are ignored.
 
95
 
        -p|--password) mode=password; shift;;
 
96
 
        -F|--passfile) mode=password; PASSFILE="$2"; shift 2;;
 
97
 
        -d|--dir) KEYDIR="$2"; shift 2;;
 
98
 
        -t|--type) KEYTYPE="$2"; shift 2;;
 
99
 
        -s|--subtype) SUBKEYTYPE="$2"; shift 2;;
 
100
 
        -l|--length) KEYLENGTH="$2"; shift 2;;
 
101
 
        -L|--sublength) SUBKEYLENGTH="$2"; shift 2;;
 
102
 
        -n|--name) KEYNAME="$2"; shift 2;;
 
103
 
        -e|--email) KEYEMAIL="$2"; shift 2;;
 
104
 
        -c|--comment) KEYCOMMENT="$2"; shift 2;;
 
105
 
        -x|--expire) KEYEXPIRE="$2"; shift 2;;
 
106
 
        -f|--force) FORCE=yes; shift;;
 
107
 
        -v|--version) echo "$0 $VERSION"; exit;;
 
108
 
        -h|--help) help; exit;;
 
110
 
        *) echo "Internal error" >&2; exit 1;;
 
113
 
if [ "$#" -gt 0 ]; then
 
114
 
    echo "Unknown arguments: '$@'" >&2
 
118
 
SECKEYFILE="$KEYDIR/seckey.txt"
 
119
 
PUBKEYFILE="$KEYDIR/pubkey.txt"
 
121
 
# Check for some invalid values
 
122
 
if [ ! -d "$KEYDIR" ]; then
 
123
 
    echo "$KEYDIR not a directory" >&2
 
126
 
if [ ! -r "$KEYDIR" ]; then
 
127
 
    echo "Directory $KEYDIR not readable" >&2
 
131
 
if [ "$mode" = keygen ]; then
 
132
 
    if [ ! -w "$KEYDIR" ]; then
 
133
 
        echo "Directory $KEYDIR not writeable" >&2
 
136
 
    if [ -z "$KEYTYPE" ]; then
 
137
 
        echo "Empty key type" >&2
 
141
 
    if [ -z "$KEYNAME" ]; then
 
142
 
        echo "Empty key name" >&2
 
146
 
    if [ -z "$KEYLENGTH" ] || [ "$KEYLENGTH" -lt 512 ]; then
 
147
 
        echo "Invalid key length" >&2
 
151
 
    if [ -z "$KEYEXPIRE" ]; then
 
152
 
        echo "Empty key expiration" >&2
 
156
 
    # Make FORCE be 0 or 1
 
158
 
        [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) FORCE=1;;
 
159
 
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
 
162
 
    if [ \( -e "$SECKEYFILE" -o -e "$PUBKEYFILE" \) \
 
163
 
        -a "$FORCE" -eq 0 ]; then
 
164
 
        echo "Refusing to overwrite old key files; use --force" >&2
 
168
 
    # Set lines for GnuPG batch file
 
169
 
    if [ -n "$KEYCOMMENT" ]; then
 
170
 
        KEYCOMMENTLINE="Name-Comment: $KEYCOMMENT"
 
172
 
    if [ -n "$KEYEMAIL" ]; then
 
173
 
        KEYEMAILLINE="Name-Email: $KEYEMAIL"
 
176
 
    # Create temporary gpg batch file
 
177
 
    BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
 
180
 
if [ "$mode" = password ]; then
 
181
 
    # Create temporary encrypted password file
 
182
 
    SECFILE="`mktemp -t mandos-keygen-secfile.XXXXXXXXXX`"
 
185
 
# Create temporary key ring directory
 
186
 
RINGDIR="`mktemp -d -t mandos-keygen-keyrings.XXXXXXXXXX`"
 
188
 
# Remove temporary files on exit
 
191
 
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
 
192
 
shred --remove \"$RINGDIR\"/sec*;
 
193
 
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
 
194
 
rm --recursive --force \"$RINGDIR\";
 
195
 
tty --quiet && stty echo; \
 
202
 
if [ "$mode" = keygen ]; then
 
203
 
    # Create batch file for GnuPG
 
204
 
    cat >"$BATCHFILE" <<-EOF
 
206
 
        Key-Length: $KEYLENGTH
 
207
 
        #Key-Usage: encrypt,sign,auth
 
208
 
        Subkey-Type: $SUBKEYTYPE
 
209
 
        Subkey-Length: $SUBKEYLENGTH
 
210
 
        #Subkey-Usage: encrypt,sign,auth
 
214
 
        Expire-Date: $KEYEXPIRE
 
215
 
        #Preferences: <string>
 
217
 
        #%pubring pubring.gpg
 
218
 
        #%secring secring.gpg
 
224
 
        Note: Due to entropy requirements, key generation could take
 
225
 
        anything from a few minutes to SEVERAL HOURS.  Please be
 
226
 
        patient and/or supply the system with more entropy if needed.
 
232
 
    # Generate a new key in the key rings
 
233
 
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
234
 
        --homedir "$RINGDIR" --trust-model always \
 
235
 
        --gen-key "$BATCHFILE"
 
236
 
    rm --force "$BATCHFILE"
 
243
 
    # Backup any old key files
 
244
 
    if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
 
246
 
        shred --remove "$SECKEYFILE"
 
248
 
    if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
 
250
 
        rm --force "$PUBKEYFILE"
 
253
 
    FILECOMMENT="Mandos client key for $KEYNAME"
 
254
 
    if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
 
255
 
        FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
 
258
 
    if [ -n "$KEYEMAIL" ]; then
 
259
 
        FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
 
262
 
    # Export key from key rings to key files
 
263
 
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
264
 
        --homedir "$RINGDIR" --armor --export-options export-minimal \
 
265
 
        --comment "$FILECOMMENT" --output "$SECKEYFILE" \
 
267
 
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
268
 
        --homedir "$RINGDIR" --armor --export-options export-minimal \
 
269
 
        --comment "$FILECOMMENT" --output "$PUBKEYFILE" --export
 
272
 
if [ "$mode" = password ]; then
 
273
 
    # Import key into temporary key rings
 
274
 
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
275
 
        --homedir "$RINGDIR" --trust-model always --armor \
 
276
 
        --import "$SECKEYFILE"
 
277
 
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
278
 
        --homedir "$RINGDIR" --trust-model always --armor \
 
279
 
        --import "$PUBKEYFILE"
 
281
 
    # Get fingerprint of key
 
282
 
    FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
 
283
 
        --enable-dsa2 --homedir \"$RINGDIR\" --trust-model always \
 
284
 
        --fingerprint --with-colons \
 
286
 
        --expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
 
288
 
    test -n "$FINGERPRINT"
 
290
 
    FILECOMMENT="Encrypted password for a Mandos client"
 
292
 
    while [ ! -s "$SECFILE" ]; do
 
293
 
        if [ -n "$PASSFILE" ]; then
 
296
 
            tty --quiet && stty -echo
 
297
 
            read -p "Enter passphrase: " first
 
298
 
            tty --quiet && echo >&2
 
299
 
            read -p "Repeat passphrase: " second
 
304
 
            if [ "$first" != "$second" ]; then
 
305
 
                echo "Passphrase mismatch" >&2
 
306
 
                touch "$RINGDIR"/mismatch
 
310
 
        fi | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
311
 
            --homedir "$RINGDIR" --trust-model always --armor \
 
312
 
            --encrypt --sign --recipient "$FINGERPRINT" --comment \
 
313
 
            "$FILECOMMENT" > "$SECFILE"
 
314
 
        if [ -e "$RINGDIR"/mismatch ]; then
 
315
 
            rm --force "$RINGDIR"/mismatch
 
327
 
        fingerprint = $FINGERPRINT
 
330
 
    sed --quiet --expression='
 
331
 
        /^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
 
333
 
                # Remove 24-bit Radix-64 checksum
 
344
 
# Remove the password file, if any
 
345
 
if [ -n "$SECFILE" ]; then
 
346
 
    shred --remove "$SECFILE"
 
348
 
# Remove the key rings
 
349
 
shred --remove "$RINGDIR"/sec*
 
350
 
rm --recursive --force "$RINGDIR"