/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: 2008-10-05 17:38:31 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081005173831-fysrfayl4yvhlo6x
* INSTALL: Add instructions on how to set the correct network
           interface on the cient, and also how to test the server and
           verify the password.

* TODO: Clean up old stuff.

* debian/mandos-client.README.Debian: Separate into sections with
                                      headlines.  Add instructions on
                                      how to test the server and
                                      verify the password.

* plugin-runner.conf: Add reminder to update initrd image.

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-2017 Teddy Hogeborn
6
 
# Copyright © 2008-2017 Björn Påhlsson
 
5
# Copyright © 2008 Teddy Hogeborn & Björn Påhlsson
7
6
8
 
# This file is part of Mandos.
9
 
#
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
 
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
12
9
# the Free Software Foundation, either version 3 of the License, or
13
10
# (at your option) any later version.
14
11
#
15
 
#     Mandos is distributed in the hope that it will be useful, but
16
 
#     WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
#     This program is distributed in the hope that it will be useful,
 
13
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
17
14
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
15
#     GNU General Public License for more details.
19
16
20
17
# You should have received a copy of the GNU General Public License
21
 
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
18
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
19
23
 
# Contact the authors at <mandos@recompile.se>.
 
20
# Contact the authors at <mandos@fukt.bsnet.se>.
24
21
25
22
 
26
 
VERSION="1.7.16"
 
23
VERSION="1.0"
27
24
 
28
25
KEYDIR="/etc/keys/mandos"
29
 
KEYTYPE=RSA
30
 
KEYLENGTH=4096
31
 
SUBKEYTYPE=RSA
32
 
SUBKEYLENGTH=4096
 
26
KEYTYPE=DSA
 
27
KEYLENGTH=2048
 
28
SUBKEYTYPE=ELG-E
 
29
SUBKEYLENGTH=2048
33
30
KEYNAME="`hostname --fqdn 2>/dev/null || hostname`"
34
31
KEYEMAIL=""
35
 
KEYCOMMENT=""
 
32
KEYCOMMENT="Mandos client key"
36
33
KEYEXPIRE=0
37
34
FORCE=no
38
 
SSH=yes
39
35
KEYCOMMENT_ORIG="$KEYCOMMENT"
40
36
mode=keygen
41
37
 
44
40
fi
45
41
 
46
42
# Parse options
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 \
 
43
TEMP=`getopt --options vhpF:d:t:l:s:L:n:e:c:x:f \
 
44
    --longoptions version,help,password,passfile:,dir:,type:,length:,subtype:,sublength:,name:,email:,comment:,expire:,force \
49
45
    --name "$0" -- "$@"`
50
46
 
51
47
help(){
52
 
basename="`basename "$0"`"
 
48
basename="`basename $0`"
53
49
cat <<EOF
54
50
Usage: $basename [ -v | --version ]
55
51
       $basename [ -h | --help ]
63
59
  -v, --version         Show program's version number and exit
64
60
  -h, --help            Show this help message and exit
65
61
  -d DIR, --dir DIR     Target directory for key files
66
 
  -t TYPE, --type TYPE  Key type.  Default is RSA.
 
62
  -t TYPE, --type TYPE  Key type.  Default is DSA.
67
63
  -l BITS, --length BITS
68
 
                        Key length in bits.  Default is 4096.
 
64
                        Key length in bits.  Default is 2048.
69
65
  -s TYPE, --subtype TYPE
70
 
                        Subkey type.  Default is RSA.
 
66
                        Subkey type.  Default is ELG-E.
71
67
  -L BITS, --sublength BITS
72
 
                        Subkey length in bits.  Default is 4096.
 
68
                        Subkey length in bits.  Default is 2048.
73
69
  -n NAME, --name NAME  Name of key.  Default is the FQDN.
74
70
  -e ADDRESS, --email ADDRESS
75
71
                        Email address of key.  Default is empty.
76
72
  -c TEXT, --comment TEXT
77
 
                        Comment field for key.  The default is empty.
 
73
                        Comment field for key.  The default value is
 
74
                        "Mandos client key".
78
75
  -x TIME, --expire TIME
79
76
                        Key expire time.  Default is no expiration.
80
77
                        See gpg(1) for syntax.
88
85
                        Encrypt a password from FILE using the key in
89
86
                        the key directory.  All options other than
90
87
                        --dir and --name are ignored.
91
 
  -S, --no-ssh          Don't get SSH key or set "checker" option.
92
88
EOF
93
89
}
94
90
 
107
103
        -c|--comment) KEYCOMMENT="$2"; shift 2;;
108
104
        -x|--expire) KEYEXPIRE="$2"; shift 2;;
109
105
        -f|--force) FORCE=yes; shift;;
110
 
        -S|--no-ssh) SSH=no; shift;;
111
106
        -v|--version) echo "$0 $VERSION"; exit;;
112
107
        -h|--help) help; exit;;
113
108
        --) shift; break;;
115
110
    esac
116
111
done
117
112
if [ "$#" -gt 0 ]; then
118
 
    echo "Unknown arguments: '$*'" >&2
 
113
    echo "Unknown arguments: '$@'" >&2
119
114
    exit 1
120
115
fi
121
116
 
151
146
        echo "Invalid key length" >&2
152
147
        exit 1
153
148
    fi
154
 
    
 
149
 
155
150
    if [ -z "$KEYEXPIRE" ]; then
156
151
        echo "Empty key expiration" >&2
157
152
        exit 1
163
158
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
164
159
    esac
165
160
    
166
 
    if { [ -e "$SECKEYFILE" ] || [ -e "$PUBKEYFILE" ]; } \
167
 
        && [ "$FORCE" -eq 0 ]; then
 
161
    if [ \( -e "$SECKEYFILE" -o -e "$PUBKEYFILE" \) \
 
162
        -a "$FORCE" -eq 0 ]; then
168
163
        echo "Refusing to overwrite old key files; use --force" >&2
169
164
        exit 1
170
165
    fi
176
171
    if [ -n "$KEYEMAIL" ]; then
177
172
        KEYEMAILLINE="Name-Email: $KEYEMAIL"
178
173
    fi
179
 
    
 
174
 
180
175
    # Create temporary gpg batch file
181
176
    BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
182
177
fi
193
188
trap "
194
189
set +e; \
195
190
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
196
 
shred --remove \"$RINGDIR\"/sec* 2>/dev/null;
 
191
shred --remove \"$RINGDIR\"/sec*;
197
192
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
198
193
rm --recursive --force \"$RINGDIR\";
199
 
tty --quiet && stty echo; \
 
194
stty echo; \
200
195
" EXIT
201
196
 
202
 
set -e
203
 
 
204
197
umask 077
205
198
 
206
199
if [ "$mode" = keygen ]; then
208
201
    cat >"$BATCHFILE" <<-EOF
209
202
        Key-Type: $KEYTYPE
210
203
        Key-Length: $KEYLENGTH
211
 
        Key-Usage: sign,auth
 
204
        #Key-Usage: encrypt,sign,auth
212
205
        Subkey-Type: $SUBKEYTYPE
213
206
        Subkey-Length: $SUBKEYLENGTH
214
 
        Subkey-Usage: encrypt
 
207
        #Subkey-Usage: encrypt,sign,auth
215
208
        Name-Real: $KEYNAME
216
209
        $KEYCOMMENTLINE
217
210
        $KEYEMAILLINE
220
213
        #Handle: <no-spaces>
221
214
        #%pubring pubring.gpg
222
215
        #%secring secring.gpg
223
 
        %no-protection
224
216
        %commit
225
217
        EOF
226
218
    
227
 
    if tty --quiet; then
228
 
        cat <<-EOF
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.
232
 
        EOF
233
 
        echo -n "Started: "
234
 
        date
235
 
    fi
236
 
    
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
219
    # Generate a new key in the key rings
243
220
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
244
221
        --homedir "$RINGDIR" --trust-model always \
245
222
        --gen-key "$BATCHFILE"
246
223
    rm --force "$BATCHFILE"
247
224
    
248
 
    if tty --quiet; then
249
 
        echo -n "Finished: "
250
 
        date
251
 
    fi
252
 
    
253
225
    # Backup any old key files
254
226
    if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
255
227
        2>/dev/null; then
280
252
fi
281
253
 
282
254
if [ "$mode" = password ]; then
283
 
    
284
 
    # Make SSH be 0 or 1
285
 
    case "$SSH" in
286
 
        [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) SSH=1;;
287
 
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) SSH=0;;
288
 
    esac
289
 
    
290
 
    if [ $SSH -eq 1 ]; then
291
 
        for ssh_keytype in ecdsa-sha2-nistp256 ed25519 rsa; do
292
 
            set +e
293
 
            ssh_fingerprint="`ssh-keyscan -t $ssh_keytype localhost 2>/dev/null`"
294
 
            err=$?
295
 
            set -e
296
 
            if [ $err -ne 0 ]; then
297
 
                ssh_fingerprint=""
298
 
                continue
299
 
            fi
300
 
            if [ -n "$ssh_fingerprint" ]; then
301
 
                ssh_fingerprint="${ssh_fingerprint#localhost }"
302
 
                break
303
 
            fi
304
 
        done
305
 
    fi
306
 
    
307
255
    # Import key into temporary key rings
308
256
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
309
257
        --homedir "$RINGDIR" --trust-model always --armor \
314
262
    
315
263
    # Get fingerprint of key
316
264
    FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
317
 
        --enable-dsa2 --homedir "$RINGDIR" --trust-model always \
 
265
        --enable-dsa2 --homedir \"$RINGDIR\" --trust-model always \
318
266
        --fingerprint --with-colons \
319
267
        | sed --quiet \
320
268
        --expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
323
271
    
324
272
    FILECOMMENT="Encrypted password for a Mandos client"
325
273
    
326
 
    while [ ! -s "$SECFILE" ]; do
327
 
        if [ -n "$PASSFILE" ]; then
328
 
            cat "$PASSFILE"
 
274
    if [ -n "$PASSFILE" ]; then
 
275
        cat "$PASSFILE"
 
276
    else
 
277
        stty -echo
 
278
        echo -n "Enter passphrase: " >&2
 
279
        first="$(head --lines=1 | tr --delete '\n')"
 
280
        echo -n -e "\nRepeat passphrase: " >&2
 
281
        second="$(head --lines=1 | tr --delete '\n')"
 
282
        echo >&2
 
283
        stty echo
 
284
        if [ "$first" != "$second" ]; then
 
285
            echo -e "Passphrase mismatch" >&2
 
286
            false
329
287
        else
330
 
            tty --quiet && stty -echo
331
 
            echo -n "Enter passphrase: " >/dev/tty
332
 
            read -r first
333
 
            tty --quiet && echo >&2
334
 
            echo -n "Repeat passphrase: " >/dev/tty
335
 
            read -r second
336
 
            if tty --quiet; then
337
 
                echo >&2
338
 
                stty echo
339
 
            fi
340
 
            if [ "$first" != "$second" ]; then
341
 
                echo "Passphrase mismatch" >&2
342
 
                touch "$RINGDIR"/mismatch
343
 
            else
344
 
                echo -n "$first"
345
 
            fi
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
352
 
            if tty --quiet; then
353
 
                > "$SECFILE"
354
 
            else
355
 
                exit 1
356
 
            fi
 
288
            echo -n "$first"
357
289
        fi
358
 
    done
 
290
    fi | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
 
291
        --homedir "$RINGDIR" --trust-model always --armor --encrypt \
 
292
        --recipient "$FINGERPRINT" --comment "$FILECOMMENT" \
 
293
        > "$SECFILE"
 
294
    status="${PIPESTATUS[0]}"
 
295
    if [ "$status" -ne 0 ]; then
 
296
        exit "$status"
 
297
    fi
359
298
    
360
299
    cat <<-EOF
361
300
        [$KEYNAME]
372
311
                /^[^-]/s/^/    /p
373
312
            }
374
313
        }' < "$SECFILE"
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}"
378
 
    fi
379
314
fi
380
315
 
381
316
trap - EXIT
386
321
    shred --remove "$SECFILE"
387
322
fi
388
323
# Remove the key rings
389
 
shred --remove "$RINGDIR"/sec* 2>/dev/null
 
324
shred --remove "$RINGDIR"/sec*
390
325
rm --recursive --force "$RINGDIR"