/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-08-24 07:42:14 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080824074214-odju7g3115le171c
* mandos-keygen: Bug fix: Recognize new options --subtype and
                 --sublength.  New option "--password" which prompts
                 for and encrypts a password with an already existing
                 key.

* mandos-keygen.xml (SYNOPSIS): Added separate synopsis for
                                "--password" option.
  (DESCRIPTION): Added text about password creation.
  (OPTIONS): Document default value for "--dir" option.  Document new
             "--password" option.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen
33
33
KEYEXPIRE=0
34
34
FORCE=no
35
35
KEYCOMMENT_ORIG="$KEYCOMMENT"
 
36
mode=keygen
36
37
 
37
38
# Parse options
38
39
TEMP=`getopt --options vhd:t:l:n:e:c:x:f \
39
 
    --longoptions version,help,dir:,type:,length:,name:,email:,comment:,expire:,force \
 
40
    --longoptions version,help,password,dir:,type:,length:,subtype:,sublength:,name:,email:,comment:,expire:,force \
40
41
    --name "$0" -- "$@"`
41
42
 
42
43
help(){
 
44
basename="`basename $0`"
43
45
cat <<EOF
44
 
Usage: `basename $0` [options]
 
46
Usage: $basename [ -v | --version ]
 
47
       $basename [ -h | --help ]
 
48
   Key creation:
 
49
       $basename [ OPTIONS ]
 
50
   Encrypted password creation:
 
51
       $basename { -p | --password } [ --name NAME ] [ --dir DIR]
45
52
 
46
 
Options:
 
53
Key creation options:
47
54
  -v, --version         Show program's version number and exit
48
55
  -h, --help            Show this help message and exit
49
56
  -d DIR, --dir DIR     Target directory for key files
55
62
  -L BITS, --sublength BITS
56
63
                        Subkey length in bits.  Default is 2048.
57
64
  -n NAME, --name NAME  Name of key.  Default is the FQDN.
58
 
  -e EMAIL, --email EMAIL
 
65
  -e ADDRESS, --email ADDRESS
59
66
                        Email address of key.  Default is empty.
60
67
  -c COMMENT, --comment COMMENT
61
68
                        Comment field for key.  The default value is
64
71
                        Key expire time.  Default is no expiration.
65
72
                        See gpg(1) for syntax.
66
73
  -f, --force           Force overwriting old keys.
 
74
 
 
75
Password creation options:
 
76
  -p, --password        Create an encrypted password using the keys in
 
77
                        the key directory.  All options other than
 
78
                        --keydir and --name are ignored.
67
79
EOF
68
80
}
69
81
 
70
82
eval set -- "$TEMP"
71
83
while :; do
72
84
    case "$1" in
 
85
        -p|--password) mode=password; shift;;
73
86
        -d|--dir) KEYDIR="$2"; shift 2;;
74
87
        -t|--type) KEYTYPE="$2"; shift 2;;
75
88
        -s|--subtype) SUBKEYTYPE="$2"; shift 2;;
104
117
    exit 1
105
118
fi
106
119
 
107
 
if [ -z "$KEYTYPE" ]; then
108
 
    echo "Empty key type" >&2
109
 
    exit 1
110
 
fi
111
 
 
112
 
if [ -z "$KEYNAME" ]; then
113
 
    echo "Empty key name" >&2
114
 
    exit 1
115
 
fi
116
 
 
117
 
if [ -z "$KEYLENGTH" ] || [ "$KEYLENGTH" -lt 512 ]; then
118
 
    echo "Invalid key length" >&2
119
 
    exit 1
120
 
fi
121
 
 
122
 
if [ -z "$KEYEXPIRE" ]; then
123
 
    echo "Empty key expiration" >&2
124
 
    exit 1
125
 
fi
126
 
 
127
 
# Make FORCE be 0 or 1
128
 
case "$FORCE" in
129
 
    [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) FORCE=1;;
130
 
    [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
131
 
esac
132
 
 
133
 
if { [ -e "$SECKEYFILE" ] || [ -e "$PUBKEYFILE" ]; } \
134
 
    && [ "$FORCE" -eq 0 ]; then
135
 
    echo "Refusing to overwrite old key files; use --force" >&2
136
 
    exit 1
137
 
fi
138
 
 
139
 
# Set lines for GnuPG batch file
140
 
if [ -n "$KEYCOMMENT" ]; then
141
 
    KEYCOMMENTLINE="Name-Comment: $KEYCOMMENT"
142
 
fi
143
 
if [ -n "$KEYEMAIL" ]; then
144
 
    KEYEMAILLINE="Name-Email: $KEYEMAIL"
145
 
fi
146
 
 
147
 
# Create temp files
148
 
BATCHFILE="`mktemp -t mandos-gpg-batch.XXXXXXXXXX`"
 
120
if [ "$mode" = password -a -e "$KEYDIR/trustdb.gpg.lock" ]; then
 
121
    echo "Key directory has locked trustdb; aborting." >&2
 
122
    exit 1
 
123
fi
 
124
 
 
125
if [ "$mode" = keygen ]; then
 
126
    if [ -z "$KEYTYPE" ]; then
 
127
        echo "Empty key type" >&2
 
128
        exit 1
 
129
    fi
 
130
    
 
131
    if [ -z "$KEYNAME" ]; then
 
132
        echo "Empty key name" >&2
 
133
        exit 1
 
134
    fi
 
135
    
 
136
    if [ -z "$KEYLENGTH" ] || [ "$KEYLENGTH" -lt 512 ]; then
 
137
        echo "Invalid key length" >&2
 
138
        exit 1
 
139
    fi
 
140
 
 
141
    if [ -z "$KEYEXPIRE" ]; then
 
142
        echo "Empty key expiration" >&2
 
143
        exit 1
 
144
    fi
 
145
    
 
146
    # Make FORCE be 0 or 1
 
147
    case "$FORCE" in
 
148
        [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) FORCE=1;;
 
149
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
 
150
    esac
 
151
    
 
152
    if { [ -e "$SECKEYFILE" ] || [ -e "$PUBKEYFILE" ]; } \
 
153
        && [ "$FORCE" -eq 0 ]; then
 
154
        echo "Refusing to overwrite old key files; use --force" >&2
 
155
        exit 1
 
156
    fi
 
157
    
 
158
    # Set lines for GnuPG batch file
 
159
    if [ -n "$KEYCOMMENT" ]; then
 
160
        KEYCOMMENTLINE="Name-Comment: $KEYCOMMENT"
 
161
    fi
 
162
    if [ -n "$KEYEMAIL" ]; then
 
163
        KEYEMAILLINE="Name-Email: $KEYEMAIL"
 
164
    fi
 
165
 
 
166
    # Create temporary gpg batch file
 
167
    BATCHFILE="`mktemp -t mandos-gpg-batch.XXXXXXXXXX`"
 
168
fi
 
169
 
 
170
if [ "$mode" = password ]; then
 
171
    # Create temporary encrypted password file
 
172
    SECFILE="`mktemp -t mandos-gpg-secfile.XXXXXXXXXX`"
 
173
fi
 
174
 
 
175
# Create temporary key rings
149
176
SECRING="`mktemp -t mandos-gpg-secring.XXXXXXXXXX`"
150
177
PUBRING="`mktemp -t mandos-gpg-pubring.XXXXXXXXXX`"
151
178
 
 
179
if [ "$mode" = password ]; then
 
180
    # If a trustdb.gpg file does not already exist, schedule it for
 
181
    # deletion when we are done.
 
182
    if ! [ -e "$KEYDIR/trustdb.gpg" ]; then
 
183
        TRUSTDB="$KEYDIR/trustdb.gpg"
 
184
    fi
 
185
fi
 
186
 
152
187
# Remove temporary files on exit
153
188
trap "
154
189
set +e; \
155
 
rm --force $PUBRING $BATCHFILE; \
156
 
shred --remove $SECRING; \
 
190
rm --force $PUBRING ${PUBRING}~ $BATCHFILE $TRUSTDB; \
 
191
shred --remove $SECRING $SECFILE; \
157
192
stty echo; \
158
193
" EXIT
159
194
 
160
 
# Create batch file for GnuPG
161
 
cat >"$BATCHFILE" <<EOF
162
 
Key-Type: $KEYTYPE
163
 
Key-Length: $KEYLENGTH
164
 
#Key-Usage: encrypt,sign,auth
165
 
Subkey-Type: $SUBKEYTYPE
166
 
Subkey-Length: $SUBKEYLENGTH
167
 
#Subkey-Usage: encrypt,sign,auth
168
 
Name-Real: $KEYNAME
169
 
$KEYCOMMENTLINE
170
 
$KEYEMAILLINE
171
 
Expire-Date: $KEYEXPIRE
172
 
#Preferences: <string>
173
 
#Handle: <no-spaces>
174
 
%pubring $PUBRING
175
 
%secring $SECRING
176
 
%commit
177
 
EOF
178
 
 
179
195
umask 027
180
196
 
181
 
# Generate a new key in the key rings
182
 
gpg --no-random-seed-file --quiet --batch --no-tty \
183
 
    --no-default-keyring --no-options --enable-dsa2 \
184
 
    --secret-keyring "$SECRING" --keyring "$PUBRING" \
185
 
    --gen-key "$BATCHFILE"
186
 
rm --force "$BATCHFILE"
187
 
 
188
 
# Backup any old key files
189
 
if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
190
 
    2>/dev/null; then
191
 
    shred --remove "$SECKEYFILE"
192
 
fi
193
 
if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
194
 
    2>/dev/null; then
195
 
    rm --force "$PUBKEYFILE"
196
 
fi
197
 
 
198
 
FILECOMMENT="Mandos client key for $KEYNAME"
199
 
if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
200
 
    FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
201
 
fi
202
 
 
203
 
if [ -n "$KEYEMAIL" ]; then
204
 
    FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
205
 
fi
206
 
 
207
 
# Export keys from key rings to key files
208
 
gpg --no-random-seed-file --quiet --batch --no-tty --armor \
209
 
    --no-default-keyring --no-options --enable-dsa2 \
210
 
    --secret-keyring "$SECRING" --keyring "$PUBRING" \
211
 
    --export-options export-minimal --comment "$FILECOMMENT" \
212
 
    --output "$SECKEYFILE" --export-secret-keys
213
 
gpg --no-random-seed-file --quiet --batch --no-tty --armor \
214
 
    --no-default-keyring --no-options --enable-dsa2 \
215
 
    --secret-keyring "$SECRING" --keyring "$PUBRING" \
216
 
    --export-options export-minimal --comment "$FILECOMMENT" \
217
 
    --output "$PUBKEYFILE" --export
 
197
if [ "$mode" = keygen ]; then
 
198
    # Create batch file for GnuPG
 
199
    cat >"$BATCHFILE" <<-EOF
 
200
        Key-Type: $KEYTYPE
 
201
        Key-Length: $KEYLENGTH
 
202
        #Key-Usage: encrypt,sign,auth
 
203
        Subkey-Type: $SUBKEYTYPE
 
204
        Subkey-Length: $SUBKEYLENGTH
 
205
        #Subkey-Usage: encrypt,sign,auth
 
206
        Name-Real: $KEYNAME
 
207
        $KEYCOMMENTLINE
 
208
        $KEYEMAILLINE
 
209
        Expire-Date: $KEYEXPIRE
 
210
        #Preferences: <string>
 
211
        #Handle: <no-spaces>
 
212
        %pubring $PUBRING
 
213
        %secring $SECRING
 
214
        %commit
 
215
        EOF
 
216
    
 
217
    # Generate a new key in the key rings
 
218
    gpg --no-random-seed-file --quiet --batch --no-tty \
 
219
        --no-default-keyring --no-options --enable-dsa2 \
 
220
        --secret-keyring "$SECRING" --keyring "$PUBRING" \
 
221
        --gen-key "$BATCHFILE"
 
222
    rm --force "$BATCHFILE"
 
223
 
 
224
    # Backup any old key files
 
225
    if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
 
226
        2>/dev/null; then
 
227
        shred --remove "$SECKEYFILE"
 
228
    fi
 
229
    if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
 
230
        2>/dev/null; then
 
231
        rm --force "$PUBKEYFILE"
 
232
    fi
 
233
    
 
234
    FILECOMMENT="Mandos client key for $KEYNAME"
 
235
    if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
 
236
        FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
 
237
    fi
 
238
    
 
239
    if [ -n "$KEYEMAIL" ]; then
 
240
        FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
 
241
    fi
 
242
    
 
243
    # Export keys from key rings to key files
 
244
    gpg --no-random-seed-file --quiet --batch --no-tty --armor \
 
245
        --no-default-keyring --no-options --enable-dsa2 \
 
246
        --secret-keyring "$SECRING" --keyring "$PUBRING" \
 
247
        --export-options export-minimal --comment "$FILECOMMENT" \
 
248
        --output "$SECKEYFILE" --export-secret-keys
 
249
    gpg --no-random-seed-file --quiet --batch --no-tty --armor \
 
250
        --no-default-keyring --no-options --enable-dsa2 \
 
251
        --secret-keyring "$SECRING" --keyring "$PUBRING" \
 
252
        --export-options export-minimal --comment "$FILECOMMENT" \
 
253
        --output "$PUBKEYFILE" --export
 
254
fi
 
255
 
 
256
if [ "$mode" = password ]; then
 
257
    # Import keys into temporary key rings
 
258
    gpg --no-random-seed-file --quiet --batch --no-tty --armor \
 
259
        --no-default-keyring --no-options --enable-dsa2 \
 
260
        --homedir "$KEYDIR" --no-permission-warning \
 
261
        --secret-keyring "$SECRING" --keyring "$PUBRING" \
 
262
        --trust-model always --import "$SECKEYFILE"
 
263
    gpg --no-random-seed-file --quiet --batch --no-tty --armor \
 
264
        --no-default-keyring --no-options --enable-dsa2 \
 
265
        --homedir "$KEYDIR" --no-permission-warning \
 
266
        --secret-keyring "$SECRING" --keyring "$PUBRING" \
 
267
        --trust-model always --import "$PUBKEYFILE"
 
268
 
 
269
    # Get fingerprint of key
 
270
    FINGERPRINT="`gpg --no-random-seed-file --quiet --batch --no-tty \
 
271
        --armor --no-default-keyring --no-options --enable-dsa2 \
 
272
        --homedir \"$KEYDIR\" --no-permission-warning \
 
273
        --secret-keyring \"$SECRING\" --keyring \"$PUBRING\" \
 
274
        --trust-model always --fingerprint --with-colons \
 
275
        | sed -n -e '/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
 
276
    
 
277
    test -n "$FINGERPRINT"
 
278
    
 
279
    FILECOMMENT="Encrypted password for a Mandos client"
 
280
    
 
281
    stty -echo
 
282
    echo -n "Enter passphrase: " >&2
 
283
    sed -e '1q' \
 
284
        | gpg --no-random-seed-file --batch --no-tty --armor \
 
285
        --no-default-keyring --no-options --enable-dsa2 \
 
286
        --homedir "$KEYDIR" --no-permission-warning \
 
287
        --secret-keyring "$SECRING" --keyring "$PUBRING" \
 
288
        --trust-model always --encrypt --recipient "$FINGERPRINT" \
 
289
        --comment "$FILECOMMENT" \
 
290
        > "$SECFILE"
 
291
    echo >&2
 
292
    stty echo
 
293
    
 
294
    cat <<-EOF
 
295
        [$KEYNAME]
 
296
        fingerprint = $FINGERPRINT
 
297
        secret =
 
298
EOF
 
299
    sed -n -e '
 
300
        /^-----BEGIN PGP MESSAGE-----$/,/^-----END PGP MESSAGE-----$/{
 
301
            /^$/,${
 
302
                # Indent four spaces
 
303
                /^[^-]/s/^/    /p
 
304
            }
 
305
        }' < "$SECFILE"
 
306
fi
218
307
 
219
308
trap - EXIT
220
309
 
 
310
set +e
 
311
# Remove the password file, if any
 
312
if [ -n "$SECFILE" ]; then
 
313
    shred --remove "$SECFILE"
 
314
fi
221
315
# Remove the key rings
222
316
shred --remove "$SECRING"
223
 
rm --force "$PUBRING"
 
317
rm --force "$PUBRING" "${PUBRING}~"
 
318
# Remove the trustdb, if one did not exist when we started
 
319
if [ -n "$TRUSTDB" ]; then
 
320
    rm --force "$TRUSTDB"
 
321
fi