/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: 2009-12-25 23:13:47 UTC
  • Revision ID: teddy@fukt.bsnet.se-20091225231347-gg9u9ru0wj0f24hh
More consistent terminology: Clients are no longer "invalid" - they
are "disabled".  All code and documentation changed to reflect this.

D=Bus API change: The "properties" argument was removed from the
"ClientAdded" signal on interface "se.bsnet.fukt.Mandos".  All code in
both "mandos" and "mandos-monitor" changed to reflect this.

* mandos: Replaced "with closing(F)" with simply "with F" in all
          places where F is a file object.
  (Client.still_valid): Removed.  All callers changed to look at
                        "Client.enabled" instead.
  (dbus_service_property): Check for unsupported signatures with the
                           "byte_arrays" option.
  (DBusObjectWithProperties.Set): - '' -
  (ClientHandler.handle): Use the reverse pipe to receive the
                          "Client.enabled" attribute instead of the
                          now-removed "Client.still_valid()" method.
  (ForkingMixInWithPipe): Renamed to "ForkingMixInWithPipes" (all
                          users changed).  Now also create a reverse
                          pipe for sending data to the child process.
  (ForkingMixInWithPipes.add_pipe): Now takes two pipe fd's as
                                    arguments.  All callers changed.
  (IPv6_TCPServer.handle_ipc): Take an additional "reply_fd" argument
                               (all callers changed).  Close the reply
                               pipe when the child data pipe is
                               closed.  New "GETATTR" IPC method; will
                               pickle client attribute and send it
                               over the reply pipe FD.
  (MandosDBusService.ClientAdded): Removed "properties" argument.  All
                                   emitters changed.
* mandos-clients.conf.xml (DESCRIPTION, OPTIONS): Use
                                                  "enabled/disabled"
                                                  terminology.
* mandos-ctl: Option "--is-valid" renamed to "--is-enabled".
* mandos-monitor: Enable user locale.  Try to log exceptions.
  (MandosClientPropertyCache.__init__): Removed "properties" argument.
                                        All callers changed.
  (UserInterface.add_new_client): Remove "properties" argument.  All
                                  callers changed.  Supply "logger"
                                  argument to MandosClientWidget().
  (UserInterface.add_client): New "logger" argument.  All callers
                              changed.
* mandos.xml (BUGS, SECURITY/CLIENTS): Use "enabled/disabled"
                                       terminology.

Show diffs side-by-side

added added

removed removed

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