/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-keygen

  • Committer: Teddy Hogeborn
  • Date: 2008-08-16 03:29:08 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080816032908-ihw7c05r2mnyk389
Add feature to specify custom environment variables for plugins.

* plugin-runner.c (plugin): New members "environ" and "envc" to
                            contain possible custom environment.
  (getplugin): Return NULL on failure instead of doing exit(); all
               callers changed.
  (add_to_char_array): New helper function for "add_argument" and
                       "add_environment".
  (addargument): Renamed to "add_argument".  Return bool.  Call
                 "add_to_char_array" to actually do things.
  (add_environment): New; analogous to "add_argument".
  (addcustomargument): Renamed to "add_to_argv" to avoid confusion
                       with "add_argument".
  (main): New options "--global-envs" and "--envs-for" to specify
          custom environment for plugins.  Print environment for
          plugins in debug mode.  Use asprintf instead of strcpy and
          strcat.  Use execve() for plugins with custom environments.
          Free environment for plugin when freeing plugin list.

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