3
 
# Mandos key generator - create a new OpenPGP key for a Mandos client
 
5
 
# Copyright © 2008-2016 Teddy Hogeborn
 
6
 
# Copyright © 2008-2016 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`"
 
37
 
KEYCOMMENT_ORIG="$KEYCOMMENT"
 
40
 
if [ ! -d "$KEYDIR" ]; then
 
41
 
    KEYDIR="/etc/mandos/keys"
 
45
 
TEMP=`getopt --options vhpF:d:t:l:s:L:n:e:c:x:fS \
 
46
 
    --longoptions version,help,password,passfile:,dir:,type:,length:,subtype:,sublength:,name:,email:,comment:,expire:,force,no-ssh \
 
50
 
basename="`basename "$0"`"
 
52
 
Usage: $basename [ -v | --version ]
 
53
 
       $basename [ -h | --help ]
 
56
 
   Encrypted password creation:
 
57
 
       $basename { -p | --password } [ --name NAME ] [ --dir DIR]
 
58
 
       $basename { -F | --passfile } FILE [ --name NAME ] [ --dir DIR]
 
61
 
  -v, --version         Show program's version number and exit
 
62
 
  -h, --help            Show this help message and exit
 
63
 
  -d DIR, --dir DIR     Target directory for key files
 
64
 
  -t TYPE, --type TYPE  Key type.  Default is RSA.
 
65
 
  -l BITS, --length BITS
 
66
 
                        Key length in bits.  Default is 4096.
 
67
 
  -s TYPE, --subtype TYPE
 
68
 
                        Subkey type.  Default is RSA.
 
69
 
  -L BITS, --sublength BITS
 
70
 
                        Subkey length in bits.  Default is 4096.
 
71
 
  -n NAME, --name NAME  Name of key.  Default is the FQDN.
 
72
 
  -e ADDRESS, --email ADDRESS
 
73
 
                        Email address of key.  Default is empty.
 
74
 
  -c TEXT, --comment TEXT
 
75
 
                        Comment field for key.  The default is empty.
 
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.
 
89
 
  -S, --no-ssh          Don't get SSH key or set "checker" option.
 
96
 
        -p|--password) mode=password; shift;;
 
97
 
        -F|--passfile) mode=password; PASSFILE="$2"; shift 2;;
 
98
 
        -d|--dir) KEYDIR="$2"; shift 2;;
 
99
 
        -t|--type) KEYTYPE="$2"; shift 2;;
 
100
 
        -s|--subtype) SUBKEYTYPE="$2"; shift 2;;
 
101
 
        -l|--length) KEYLENGTH="$2"; shift 2;;
 
102
 
        -L|--sublength) SUBKEYLENGTH="$2"; shift 2;;
 
103
 
        -n|--name) KEYNAME="$2"; shift 2;;
 
104
 
        -e|--email) KEYEMAIL="$2"; shift 2;;
 
105
 
        -c|--comment) KEYCOMMENT="$2"; shift 2;;
 
106
 
        -x|--expire) KEYEXPIRE="$2"; shift 2;;
 
107
 
        -f|--force) FORCE=yes; shift;;
 
108
 
        -S|--no-ssh) SSH=no; shift;;
 
109
 
        -v|--version) echo "$0 $VERSION"; exit;;
 
110
 
        -h|--help) help; exit;;
 
112
 
        *) echo "Internal error" >&2; exit 1;;
 
115
 
if [ "$#" -gt 0 ]; then
 
116
 
    echo "Unknown arguments: '$*'" >&2
 
120
 
SECKEYFILE="$KEYDIR/seckey.txt"
 
121
 
PUBKEYFILE="$KEYDIR/pubkey.txt"
 
123
 
# Check for some invalid values
 
124
 
if [ ! -d "$KEYDIR" ]; then
 
125
 
    echo "$KEYDIR not a directory" >&2
 
128
 
if [ ! -r "$KEYDIR" ]; then
 
129
 
    echo "Directory $KEYDIR not readable" >&2
 
133
 
if [ "$mode" = keygen ]; then
 
134
 
    if [ ! -w "$KEYDIR" ]; then
 
135
 
        echo "Directory $KEYDIR not writeable" >&2
 
138
 
    if [ -z "$KEYTYPE" ]; then
 
139
 
        echo "Empty key type" >&2
 
143
 
    if [ -z "$KEYNAME" ]; then
 
144
 
        echo "Empty key name" >&2
 
148
 
    if [ -z "$KEYLENGTH" ] || [ "$KEYLENGTH" -lt 512 ]; then
 
149
 
        echo "Invalid key length" >&2
 
153
 
    if [ -z "$KEYEXPIRE" ]; then
 
154
 
        echo "Empty key expiration" >&2
 
158
 
    # Make FORCE be 0 or 1
 
160
 
        [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) FORCE=1;;
 
161
 
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
 
164
 
    if [ \( -e "$SECKEYFILE" -o -e "$PUBKEYFILE" \) \
 
165
 
        -a "$FORCE" -eq 0 ]; then
 
166
 
        echo "Refusing to overwrite old key files; use --force" >&2
 
170
 
    # Set lines for GnuPG batch file
 
171
 
    if [ -n "$KEYCOMMENT" ]; then
 
172
 
        KEYCOMMENTLINE="Name-Comment: $KEYCOMMENT"
 
174
 
    if [ -n "$KEYEMAIL" ]; then
 
175
 
        KEYEMAILLINE="Name-Email: $KEYEMAIL"
 
178
 
    # Create temporary gpg batch file
 
179
 
    BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
 
182
 
if [ "$mode" = password ]; then
 
183
 
    # Create temporary encrypted password file
 
184
 
    SECFILE="`mktemp -t mandos-keygen-secfile.XXXXXXXXXX`"
 
187
 
# Create temporary key ring directory
 
188
 
RINGDIR="`mktemp -d -t mandos-keygen-keyrings.XXXXXXXXXX`"
 
190
 
# Remove temporary files on exit
 
193
 
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
 
194
 
shred --remove \"$RINGDIR\"/sec* 2>/dev/null;
 
195
 
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
 
196
 
rm --recursive --force \"$RINGDIR\";
 
197
 
tty --quiet && stty echo; \
 
204
 
if [ "$mode" = keygen ]; then
 
205
 
    # Create batch file for GnuPG
 
206
 
    cat >"$BATCHFILE" <<-EOF
 
208
 
        Key-Length: $KEYLENGTH
 
210
 
        Subkey-Type: $SUBKEYTYPE
 
211
 
        Subkey-Length: $SUBKEYLENGTH
 
212
 
        Subkey-Usage: encrypt
 
216
 
        Expire-Date: $KEYEXPIRE
 
217
 
        #Preferences: <string>
 
219
 
        #%pubring pubring.gpg
 
220
 
        #%secring secring.gpg
 
226
 
        Note: Due to entropy requirements, key generation could take
 
227
 
        anything from a few minutes to SEVERAL HOURS.  Please be
 
228
 
        patient and/or supply the system with more entropy if needed.
 
234
 
    # Make sure trustdb.gpg exists;
 
235
 
    # this is a workaround for Debian bug #737128
 
236
 
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
237
 
        --homedir "$RINGDIR" \
 
238
 
        --import-ownertrust < /dev/null
 
239
 
    # Generate a new key in the key rings
 
240
 
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
241
 
        --homedir "$RINGDIR" --trust-model always \
 
242
 
        --gen-key "$BATCHFILE"
 
243
 
    rm --force "$BATCHFILE"
 
250
 
    # Backup any old key files
 
251
 
    if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
 
253
 
        shred --remove "$SECKEYFILE"
 
255
 
    if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
 
257
 
        rm --force "$PUBKEYFILE"
 
260
 
    FILECOMMENT="Mandos client key for $KEYNAME"
 
261
 
    if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
 
262
 
        FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
 
265
 
    if [ -n "$KEYEMAIL" ]; then
 
266
 
        FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
 
269
 
    # Export key from key rings to key files
 
270
 
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
271
 
        --homedir "$RINGDIR" --armor --export-options export-minimal \
 
272
 
        --comment "$FILECOMMENT" --output "$SECKEYFILE" \
 
274
 
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
275
 
        --homedir "$RINGDIR" --armor --export-options export-minimal \
 
276
 
        --comment "$FILECOMMENT" --output "$PUBKEYFILE" --export
 
279
 
if [ "$mode" = password ]; then
 
283
 
        [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) SSH=1;;
 
284
 
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) SSH=0;;
 
287
 
    if [ $SSH -eq 1 ]; then
 
288
 
        for ssh_keytype in ed25519 rsa; do
 
290
 
            ssh_fingerprint="`ssh-keyscan -t $ssh_keytype localhost 2>/dev/null`"
 
292
 
            if [ $? -ne 0 ]; then
 
296
 
            if [ -n "$ssh_fingerprint" ]; then
 
297
 
                ssh_fingerprint="${ssh_fingerprint#localhost }"
 
303
 
    # Import key into temporary key rings
 
304
 
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
305
 
        --homedir "$RINGDIR" --trust-model always --armor \
 
306
 
        --import "$SECKEYFILE"
 
307
 
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
308
 
        --homedir "$RINGDIR" --trust-model always --armor \
 
309
 
        --import "$PUBKEYFILE"
 
311
 
    # Get fingerprint of key
 
312
 
    FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
 
313
 
        --enable-dsa2 --homedir "$RINGDIR" --trust-model always \
 
314
 
        --fingerprint --with-colons \
 
316
 
        --expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
 
318
 
    test -n "$FINGERPRINT"
 
320
 
    FILECOMMENT="Encrypted password for a Mandos client"
 
322
 
    while [ ! -s "$SECFILE" ]; do
 
323
 
        if [ -n "$PASSFILE" ]; then
 
326
 
            tty --quiet && stty -echo
 
327
 
            echo -n "Enter passphrase: " >&2
 
329
 
            tty --quiet && echo >&2
 
330
 
            echo -n "Repeat passphrase: " >&2
 
336
 
            if [ "$first" != "$second" ]; then
 
337
 
                echo "Passphrase mismatch" >&2
 
338
 
                touch "$RINGDIR"/mismatch
 
342
 
        fi | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
343
 
            --homedir "$RINGDIR" --trust-model always --armor \
 
344
 
            --encrypt --sign --recipient "$FINGERPRINT" --comment \
 
345
 
            "$FILECOMMENT" > "$SECFILE"
 
346
 
        if [ -e "$RINGDIR"/mismatch ]; then
 
347
 
            rm --force "$RINGDIR"/mismatch
 
359
 
        fingerprint = $FINGERPRINT
 
362
 
    sed --quiet --expression='
 
363
 
        /^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
 
365
 
                # Remove 24-bit Radix-64 checksum
 
371
 
    if [ -n "$ssh_fingerprint" ]; then
 
372
 
        echo 'checker = ssh-keyscan -t '"$ssh_keytype"' %%(host)s 2>/dev/null | grep --fixed-strings --line-regexp --quiet --regexp=%%(host)s" %(ssh_fingerprint)s"'
 
373
 
        echo "ssh_fingerprint = ${ssh_fingerprint}"
 
380
 
# Remove the password file, if any
 
381
 
if [ -n "$SECFILE" ]; then
 
382
 
    shred --remove "$SECFILE"
 
384
 
# Remove the key rings
 
385
 
shred --remove "$RINGDIR"/sec* 2>/dev/null
 
386
 
rm --recursive --force "$RINGDIR"