/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: Björn Påhlsson
  • Date: 2008-07-20 02:52:20 UTC
  • Revision ID: belorn@braxen-20080720025220-r5u0388uy9iu23h6
Added following support:
Pluginbased client handler
rewritten Mandos client
       Avahi instead of udp server discovery
       openpgp encrypted key support
Passprompt stand alone application for direct console input
Added logging for Mandos server

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen
1
 
#!/bin/sh -e
2
 
# 
3
 
# Mandos key generator - create a new OpenPGP key for a Mandos client
4
 
# 
5
 
# Copyright © 2008-2014 Teddy Hogeborn
6
 
# Copyright © 2008-2014 Björn Påhlsson
7
 
# 
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.
12
 
#
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.
17
 
# 
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/>.
20
 
# 
21
 
# Contact the authors at <mandos@recompile.se>.
22
 
# 
23
 
 
24
 
VERSION="1.6.4"
25
 
 
26
 
KEYDIR="/etc/keys/mandos"
27
 
KEYTYPE=RSA
28
 
KEYLENGTH=4096
29
 
SUBKEYTYPE=RSA
30
 
SUBKEYLENGTH=4096
31
 
KEYNAME="`hostname --fqdn 2>/dev/null || hostname`"
32
 
KEYEMAIL=""
33
 
KEYCOMMENT=""
34
 
KEYEXPIRE=0
35
 
FORCE=no
36
 
KEYCOMMENT_ORIG="$KEYCOMMENT"
37
 
mode=keygen
38
 
 
39
 
if [ ! -d "$KEYDIR" ]; then
40
 
    KEYDIR="/etc/mandos/keys"
41
 
fi
42
 
 
43
 
# 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 \
46
 
    --name "$0" -- "$@"`
47
 
 
48
 
help(){
49
 
basename="`basename $0`"
50
 
cat <<EOF
51
 
Usage: $basename [ -v | --version ]
52
 
       $basename [ -h | --help ]
53
 
   Key creation:
54
 
       $basename [ OPTIONS ]
55
 
   Encrypted password creation:
56
 
       $basename { -p | --password } [ --name NAME ] [ --dir DIR]
57
 
       $basename { -F | --passfile } FILE [ --name NAME ] [ --dir DIR]
58
 
 
59
 
Key creation options:
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 RSA.
64
 
  -l BITS, --length BITS
65
 
                        Key length in bits.  Default is 4096.
66
 
  -s TYPE, --subtype TYPE
67
 
                        Subkey type.  Default is RSA.
68
 
  -L BITS, --sublength BITS
69
 
                        Subkey length in bits.  Default is 4096.
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 is empty.
75
 
  -x TIME, --expire TIME
76
 
                        Key expire time.  Default is no expiration.
77
 
                        See gpg(1) for syntax.
78
 
  -f, --force           Force overwriting old key files.
79
 
 
80
 
Password creation options:
81
 
  -p, --password        Create an encrypted password using the key in
82
 
                        the key directory.  All options other than
83
 
                        --dir and --name are ignored.
84
 
  -F FILE, --passfile FILE
85
 
                        Encrypt a password from FILE using the key in
86
 
                        the key directory.  All options other than
87
 
                        --dir and --name are ignored.
88
 
EOF
89
 
}
90
 
 
91
 
eval set -- "$TEMP"
92
 
while :; do
93
 
    case "$1" in
94
 
        -p|--password) mode=password; shift;;
95
 
        -F|--passfile) mode=password; PASSFILE="$2"; shift 2;;
96
 
        -d|--dir) KEYDIR="$2"; shift 2;;
97
 
        -t|--type) KEYTYPE="$2"; shift 2;;
98
 
        -s|--subtype) SUBKEYTYPE="$2"; shift 2;;
99
 
        -l|--length) KEYLENGTH="$2"; shift 2;;
100
 
        -L|--sublength) SUBKEYLENGTH="$2"; shift 2;;
101
 
        -n|--name) KEYNAME="$2"; shift 2;;
102
 
        -e|--email) KEYEMAIL="$2"; shift 2;;
103
 
        -c|--comment) KEYCOMMENT="$2"; shift 2;;
104
 
        -x|--expire) KEYEXPIRE="$2"; shift 2;;
105
 
        -f|--force) FORCE=yes; shift;;
106
 
        -v|--version) echo "$0 $VERSION"; exit;;
107
 
        -h|--help) help; exit;;
108
 
        --) shift; break;;
109
 
        *) echo "Internal error" >&2; exit 1;;
110
 
    esac
111
 
done
112
 
if [ "$#" -gt 0 ]; then
113
 
    echo "Unknown arguments: '$@'" >&2
114
 
    exit 1
115
 
fi
116
 
 
117
 
SECKEYFILE="$KEYDIR/seckey.txt"
118
 
PUBKEYFILE="$KEYDIR/pubkey.txt"
119
 
 
120
 
# Check for some invalid values
121
 
if [ ! -d "$KEYDIR" ]; then
122
 
    echo "$KEYDIR not a directory" >&2
123
 
    exit 1
124
 
fi
125
 
if [ ! -r "$KEYDIR" ]; then
126
 
    echo "Directory $KEYDIR not readable" >&2
127
 
    exit 1
128
 
fi
129
 
 
130
 
if [ "$mode" = keygen ]; then
131
 
    if [ ! -w "$KEYDIR" ]; then
132
 
        echo "Directory $KEYDIR not writeable" >&2
133
 
        exit 1
134
 
    fi
135
 
    if [ -z "$KEYTYPE" ]; then
136
 
        echo "Empty key type" >&2
137
 
        exit 1
138
 
    fi
139
 
    
140
 
    if [ -z "$KEYNAME" ]; then
141
 
        echo "Empty key name" >&2
142
 
        exit 1
143
 
    fi
144
 
    
145
 
    if [ -z "$KEYLENGTH" ] || [ "$KEYLENGTH" -lt 512 ]; then
146
 
        echo "Invalid key length" >&2
147
 
        exit 1
148
 
    fi
149
 
    
150
 
    if [ -z "$KEYEXPIRE" ]; then
151
 
        echo "Empty key expiration" >&2
152
 
        exit 1
153
 
    fi
154
 
    
155
 
    # Make FORCE be 0 or 1
156
 
    case "$FORCE" in
157
 
        [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) FORCE=1;;
158
 
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
159
 
    esac
160
 
    
161
 
    if [ \( -e "$SECKEYFILE" -o -e "$PUBKEYFILE" \) \
162
 
        -a "$FORCE" -eq 0 ]; then
163
 
        echo "Refusing to overwrite old key files; use --force" >&2
164
 
        exit 1
165
 
    fi
166
 
    
167
 
    # Set lines for GnuPG batch file
168
 
    if [ -n "$KEYCOMMENT" ]; then
169
 
        KEYCOMMENTLINE="Name-Comment: $KEYCOMMENT"
170
 
    fi
171
 
    if [ -n "$KEYEMAIL" ]; then
172
 
        KEYEMAILLINE="Name-Email: $KEYEMAIL"
173
 
    fi
174
 
    
175
 
    # Create temporary gpg batch file
176
 
    BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
177
 
fi
178
 
 
179
 
if [ "$mode" = password ]; then
180
 
    # Create temporary encrypted password file
181
 
    SECFILE="`mktemp -t mandos-keygen-secfile.XXXXXXXXXX`"
182
 
fi
183
 
 
184
 
# Create temporary key ring directory
185
 
RINGDIR="`mktemp -d -t mandos-keygen-keyrings.XXXXXXXXXX`"
186
 
 
187
 
# Remove temporary files on exit
188
 
trap "
189
 
set +e; \
190
 
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
191
 
shred --remove \"$RINGDIR\"/sec*;
192
 
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
193
 
rm --recursive --force \"$RINGDIR\";
194
 
tty --quiet && stty echo; \
195
 
" EXIT
196
 
 
197
 
set -e
198
 
 
199
 
umask 077
200
 
 
201
 
if [ "$mode" = keygen ]; then
202
 
    # Create batch file for GnuPG
203
 
    cat >"$BATCHFILE" <<-EOF
204
 
        Key-Type: $KEYTYPE
205
 
        Key-Length: $KEYLENGTH
206
 
        Key-Usage: sign,auth
207
 
        Subkey-Type: $SUBKEYTYPE
208
 
        Subkey-Length: $SUBKEYLENGTH
209
 
        Subkey-Usage: encrypt
210
 
        Name-Real: $KEYNAME
211
 
        $KEYCOMMENTLINE
212
 
        $KEYEMAILLINE
213
 
        Expire-Date: $KEYEXPIRE
214
 
        #Preferences: <string>
215
 
        #Handle: <no-spaces>
216
 
        #%pubring pubring.gpg
217
 
        #%secring secring.gpg
218
 
        %commit
219
 
        EOF
220
 
    
221
 
    if tty --quiet; then
222
 
        cat <<-EOF
223
 
        Note: Due to entropy requirements, key generation could take
224
 
        anything from a few minutes to SEVERAL HOURS.  Please be
225
 
        patient and/or supply the system with more entropy if needed.
226
 
        EOF
227
 
        echo -n "Started: "
228
 
        date
229
 
    fi
230
 
    
231
 
    # Make sure trustdb.gpg exists;
232
 
    # this is a workaround for Debian bug #737128
233
 
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
234
 
        --homedir "$RINGDIR" \
235
 
        --import-ownertrust < /dev/null
236
 
    # Generate a new key in the key rings
237
 
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
238
 
        --homedir "$RINGDIR" --trust-model always \
239
 
        --gen-key "$BATCHFILE"
240
 
    rm --force "$BATCHFILE"
241
 
    
242
 
    if tty --quiet; then
243
 
        echo -n "Finished: "
244
 
        date
245
 
    fi
246
 
    
247
 
    # Backup any old key files
248
 
    if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
249
 
        2>/dev/null; then
250
 
        shred --remove "$SECKEYFILE"
251
 
    fi
252
 
    if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
253
 
        2>/dev/null; then
254
 
        rm --force "$PUBKEYFILE"
255
 
    fi
256
 
    
257
 
    FILECOMMENT="Mandos client key for $KEYNAME"
258
 
    if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
259
 
        FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
260
 
    fi
261
 
    
262
 
    if [ -n "$KEYEMAIL" ]; then
263
 
        FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
264
 
    fi
265
 
    
266
 
    # Export key from key rings to key files
267
 
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
268
 
        --homedir "$RINGDIR" --armor --export-options export-minimal \
269
 
        --comment "$FILECOMMENT" --output "$SECKEYFILE" \
270
 
        --export-secret-keys
271
 
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
272
 
        --homedir "$RINGDIR" --armor --export-options export-minimal \
273
 
        --comment "$FILECOMMENT" --output "$PUBKEYFILE" --export
274
 
fi
275
 
 
276
 
if [ "$mode" = password ]; then
277
 
    # Import key into temporary key rings
278
 
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
279
 
        --homedir "$RINGDIR" --trust-model always --armor \
280
 
        --import "$SECKEYFILE"
281
 
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
282
 
        --homedir "$RINGDIR" --trust-model always --armor \
283
 
        --import "$PUBKEYFILE"
284
 
    
285
 
    # Get fingerprint of key
286
 
    FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
287
 
        --enable-dsa2 --homedir \"$RINGDIR\" --trust-model always \
288
 
        --fingerprint --with-colons \
289
 
        | sed --quiet \
290
 
        --expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
291
 
    
292
 
    test -n "$FINGERPRINT"
293
 
    
294
 
    FILECOMMENT="Encrypted password for a Mandos client"
295
 
    
296
 
    while [ ! -s "$SECFILE" ]; do
297
 
        if [ -n "$PASSFILE" ]; then
298
 
            cat "$PASSFILE"
299
 
        else
300
 
            tty --quiet && stty -echo
301
 
            echo -n "Enter passphrase: " >&2
302
 
            read first
303
 
            tty --quiet && echo >&2
304
 
            echo -n "Repeat passphrase: " >&2
305
 
            read second
306
 
            if tty --quiet; then
307
 
                echo >&2
308
 
                stty echo
309
 
            fi
310
 
            if [ "$first" != "$second" ]; then
311
 
                echo "Passphrase mismatch" >&2
312
 
                touch "$RINGDIR"/mismatch
313
 
            else
314
 
                echo -n "$first"
315
 
            fi
316
 
        fi | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
317
 
            --homedir "$RINGDIR" --trust-model always --armor \
318
 
            --encrypt --sign --recipient "$FINGERPRINT" --comment \
319
 
            "$FILECOMMENT" > "$SECFILE"
320
 
        if [ -e "$RINGDIR"/mismatch ]; then
321
 
            rm --force "$RINGDIR"/mismatch
322
 
            if tty --quiet; then
323
 
                > "$SECFILE"
324
 
            else
325
 
                exit 1
326
 
            fi
327
 
        fi
328
 
    done
329
 
    
330
 
    cat <<-EOF
331
 
        [$KEYNAME]
332
 
        host = $KEYNAME
333
 
        fingerprint = $FINGERPRINT
334
 
        secret =
335
 
        EOF
336
 
    sed --quiet --expression='
337
 
        /^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
338
 
            /^$/,${
339
 
                # Remove 24-bit Radix-64 checksum
340
 
                s/=....$//
341
 
                # Indent four spaces
342
 
                /^[^-]/s/^/    /p
343
 
            }
344
 
        }' < "$SECFILE"
345
 
fi
346
 
 
347
 
trap - EXIT
348
 
 
349
 
set +e
350
 
# Remove the password file, if any
351
 
if [ -n "$SECFILE" ]; then
352
 
    shred --remove "$SECFILE"
353
 
fi
354
 
# Remove the key rings
355
 
shred --remove "$RINGDIR"/sec*
356
 
rm --recursive --force "$RINGDIR"