/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-keygen

  • Committer: Teddy Hogeborn
  • Date: 2014-06-22 02:19:30 UTC
  • Revision ID: teddy@recompile.se-20140622021930-icl7h4cm97blhjml
mandos-keygen: Generate "checker" option to use SSH fingerprints.

To turn this off, use a new "--no-ssh" option to mandos-keygen.

* INSTALL (Mandos Server, Mandos Client): Document new suggested
                                          installation of SSH.
* Makefile (confdir/clients.conf): Use new "--no-ssh" option to
                                   "mandos-keygen".
* debian/control (mandos/Depends): Changed to "fping | ssh-client".
  (mandos-client/Recommends): New; set to "ssh".
* intro.xml (FREQUENTLY ASKED QUESTIONS): Rename and rewrite section
                                          called "Faking ping
                                          replies?" to address new
                                          default behavior.
* mandos-clients.conf.xml (OPTIONS/checker): Briefly discuss new
                                             behavior of
                                             mandos-keygen.
* mandos-keygen: Bug fix: Suppress failure output of "shred" to remove
                 "sec*", since no such files may exist.
 (password mode): Scan for SSH key fingerprints and output as new
                  "checker" and "ssh_fingerprint" options, unless new
                  "--no-ssh" option is given.
* mandos-keygen.xml (SYNOPSIS/--force): Bug fix: Document short form.
  (OPTIONS/--no-ssh): New.
  (SEE ALSO): Add reference "ssh-keyscan(1)".
* plugins.d/mandos-client.xml (SECURITY): Briefly mention the
                                          possibility of using SSH key
                                          fingerprints for checking.

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
3
3
# Mandos key generator - create a new OpenPGP key for a Mandos client
4
4
5
 
# Copyright © 2008,2009 Teddy Hogeborn
6
 
# Copyright © 2008,2009 Björn Påhlsson
 
5
# Copyright © 2008-2014 Teddy Hogeborn
 
6
# Copyright © 2008-2014 Björn Påhlsson
7
7
8
8
# This program is free software: you can redistribute it and/or modify
9
9
# it under the terms of the GNU General Public License as published by
18
18
# You should have received a copy of the GNU General Public License
19
19
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
20
20
21
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
21
# Contact the authors at <mandos@recompile.se>.
22
22
23
23
 
24
 
VERSION="1.0.5"
 
24
VERSION="1.6.5"
25
25
 
26
26
KEYDIR="/etc/keys/mandos"
27
 
KEYTYPE=DSA
28
 
KEYLENGTH=2048
29
 
SUBKEYTYPE=ELG-E
30
 
SUBKEYLENGTH=2048
 
27
KEYTYPE=RSA
 
28
KEYLENGTH=4096
 
29
SUBKEYTYPE=RSA
 
30
SUBKEYLENGTH=4096
31
31
KEYNAME="`hostname --fqdn 2>/dev/null || hostname`"
32
32
KEYEMAIL=""
33
 
KEYCOMMENT="Mandos client key"
 
33
KEYCOMMENT=""
34
34
KEYEXPIRE=0
35
35
FORCE=no
 
36
SSH=yes
36
37
KEYCOMMENT_ORIG="$KEYCOMMENT"
37
38
mode=keygen
38
39
 
41
42
fi
42
43
 
43
44
# Parse options
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 \
 
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 \
46
47
    --name "$0" -- "$@"`
47
48
 
48
49
help(){
60
61
  -v, --version         Show program's version number and exit
61
62
  -h, --help            Show this help message and exit
62
63
  -d DIR, --dir DIR     Target directory for key files
63
 
  -t TYPE, --type TYPE  Key type.  Default is DSA.
 
64
  -t TYPE, --type TYPE  Key type.  Default is RSA.
64
65
  -l BITS, --length BITS
65
 
                        Key length in bits.  Default is 2048.
 
66
                        Key length in bits.  Default is 4096.
66
67
  -s TYPE, --subtype TYPE
67
 
                        Subkey type.  Default is ELG-E.
 
68
                        Subkey type.  Default is RSA.
68
69
  -L BITS, --sublength BITS
69
 
                        Subkey length in bits.  Default is 2048.
 
70
                        Subkey length in bits.  Default is 4096.
70
71
  -n NAME, --name NAME  Name of key.  Default is the FQDN.
71
72
  -e ADDRESS, --email ADDRESS
72
73
                        Email address of key.  Default is empty.
73
74
  -c TEXT, --comment TEXT
74
 
                        Comment field for key.  The default value is
75
 
                        "Mandos client key".
 
75
                        Comment field for key.  The default is empty.
76
76
  -x TIME, --expire TIME
77
77
                        Key expire time.  Default is no expiration.
78
78
                        See gpg(1) for syntax.
86
86
                        Encrypt a password from FILE using the key in
87
87
                        the key directory.  All options other than
88
88
                        --dir and --name are ignored.
 
89
  -S, --no-ssh          Don't get SSH key or set "checker" option.
89
90
EOF
90
91
}
91
92
 
104
105
        -c|--comment) KEYCOMMENT="$2"; shift 2;;
105
106
        -x|--expire) KEYEXPIRE="$2"; shift 2;;
106
107
        -f|--force) FORCE=yes; shift;;
 
108
        -S|--no-ssh) SSH=no; shift;;
107
109
        -v|--version) echo "$0 $VERSION"; exit;;
108
110
        -h|--help) help; exit;;
109
111
        --) shift; break;;
147
149
        echo "Invalid key length" >&2
148
150
        exit 1
149
151
    fi
150
 
 
 
152
    
151
153
    if [ -z "$KEYEXPIRE" ]; then
152
154
        echo "Empty key expiration" >&2
153
155
        exit 1
172
174
    if [ -n "$KEYEMAIL" ]; then
173
175
        KEYEMAILLINE="Name-Email: $KEYEMAIL"
174
176
    fi
175
 
 
 
177
    
176
178
    # Create temporary gpg batch file
177
179
    BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
178
180
fi
189
191
trap "
190
192
set +e; \
191
193
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
192
 
shred --remove \"$RINGDIR\"/sec*;
 
194
shred --remove \"$RINGDIR\"/sec* 2>/dev/null;
193
195
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
194
196
rm --recursive --force \"$RINGDIR\";
195
 
stty echo; \
 
197
tty --quiet && stty echo; \
196
198
" EXIT
197
199
 
 
200
set -e
 
201
 
198
202
umask 077
199
203
 
200
204
if [ "$mode" = keygen ]; then
202
206
    cat >"$BATCHFILE" <<-EOF
203
207
        Key-Type: $KEYTYPE
204
208
        Key-Length: $KEYLENGTH
205
 
        #Key-Usage: encrypt,sign,auth
 
209
        Key-Usage: sign,auth
206
210
        Subkey-Type: $SUBKEYTYPE
207
211
        Subkey-Length: $SUBKEYLENGTH
208
 
        #Subkey-Usage: encrypt,sign,auth
 
212
        Subkey-Usage: encrypt
209
213
        Name-Real: $KEYNAME
210
214
        $KEYCOMMENTLINE
211
215
        $KEYEMAILLINE
217
221
        %commit
218
222
        EOF
219
223
    
 
224
    if tty --quiet; then
 
225
        cat <<-EOF
 
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.
 
229
        EOF
 
230
        echo -n "Started: "
 
231
        date
 
232
    fi
 
233
    
 
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
220
239
    # Generate a new key in the key rings
221
240
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
222
241
        --homedir "$RINGDIR" --trust-model always \
223
242
        --gen-key "$BATCHFILE"
224
243
    rm --force "$BATCHFILE"
225
244
    
 
245
    if tty --quiet; then
 
246
        echo -n "Finished: "
 
247
        date
 
248
    fi
 
249
    
226
250
    # Backup any old key files
227
251
    if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
228
252
        2>/dev/null; then
253
277
fi
254
278
 
255
279
if [ "$mode" = password ]; then
 
280
    
 
281
    # Make SSH be 0 or 1
 
282
    case "$SSH" in
 
283
        [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) SSH=1;;
 
284
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) SSH=0;;
 
285
    esac
 
286
    
 
287
    if [ $SSH -eq 1 ]; then
 
288
        set +e
 
289
        ssh_fingerprint="`ssh-keyscan localhost 2>/dev/null`"
 
290
        if [ $? -ne 0 ]; then
 
291
            ssh_fingerprint=""
 
292
        fi
 
293
        set -e
 
294
        ssh_fingerprint="${ssh_fingerprint#localhost }"
 
295
    fi
 
296
    
256
297
    # Import key into temporary key rings
257
298
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
258
299
        --homedir "$RINGDIR" --trust-model always --armor \
272
313
    
273
314
    FILECOMMENT="Encrypted password for a Mandos client"
274
315
    
275
 
    if [ -n "$PASSFILE" ]; then
276
 
        cat "$PASSFILE"
277
 
    else
278
 
        stty -echo
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')"
283
 
        echo >&2
284
 
        stty echo
285
 
        if [ "$first" != "$second" ]; then
286
 
            echo -e "Passphrase mismatch" >&2
287
 
            false
 
316
    while [ ! -s "$SECFILE" ]; do
 
317
        if [ -n "$PASSFILE" ]; then
 
318
            cat "$PASSFILE"
288
319
        else
289
 
            echo -n "$first"
 
320
            tty --quiet && stty -echo
 
321
            echo -n "Enter passphrase: " >&2
 
322
            read first
 
323
            tty --quiet && echo >&2
 
324
            echo -n "Repeat passphrase: " >&2
 
325
            read second
 
326
            if tty --quiet; then
 
327
                echo >&2
 
328
                stty echo
 
329
            fi
 
330
            if [ "$first" != "$second" ]; then
 
331
                echo "Passphrase mismatch" >&2
 
332
                touch "$RINGDIR"/mismatch
 
333
            else
 
334
                echo -n "$first"
 
335
            fi
 
336
        fi | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
337
            --homedir "$RINGDIR" --trust-model always --armor \
 
338
            --encrypt --sign --recipient "$FINGERPRINT" --comment \
 
339
            "$FILECOMMENT" > "$SECFILE"
 
340
        if [ -e "$RINGDIR"/mismatch ]; then
 
341
            rm --force "$RINGDIR"/mismatch
 
342
            if tty --quiet; then
 
343
                > "$SECFILE"
 
344
            else
 
345
                exit 1
 
346
            fi
290
347
        fi
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" \
294
 
        > "$SECFILE"
295
 
    status="${PIPESTATUS[0]}"
296
 
    if [ "$status" -ne 0 ]; then
297
 
        exit "$status"
298
 
    fi
 
348
    done
299
349
    
300
350
    cat <<-EOF
301
351
        [$KEYNAME]
312
362
                /^[^-]/s/^/    /p
313
363
            }
314
364
        }' < "$SECFILE"
 
365
    if [ -n "$ssh_fingerprint" ]; then
 
366
        echo 'checker = ssh-keyscan %%(host)s 2>/dev/null | grep --fixed-strings --line-regexp --quiet --regexp="%%(host)s %(ssh_fingerprint)s"'
 
367
        echo "ssh_fingerprint = ${ssh_fingerprint}"
 
368
    fi
315
369
fi
316
370
 
317
371
trap - EXIT
322
376
    shred --remove "$SECFILE"
323
377
fi
324
378
# Remove the key rings
325
 
shred --remove "$RINGDIR"/sec*
 
379
shred --remove "$RINGDIR"/sec* 2>/dev/null
326
380
rm --recursive --force "$RINGDIR"