/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: 2023-02-07 19:29:28 UTC
  • Revision ID: teddy@recompile.se-20230207192928-ueasjbsufb92o6ud
Clarify documentation and a comment about GnuTLS versions

* clients.conf ([foo]/secret): In the comment for the example client's
  "secret" setting, clarify GnuTLS version conditions.
* mandos-clients.conf.xml (OPTIONS/fingerprint, OPTIONS/key_id):
  Clarify required/optional status under different GnuTLS versions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen
23
23
# Contact the authors at <mandos@recompile.se>.
24
24
# 
25
25
 
26
 
VERSION="1.7.20"
 
26
VERSION="1.8.15"
27
27
 
28
28
KEYDIR="/etc/keys/mandos"
29
29
KEYTYPE=RSA
147
147
        echo "Empty key type" >&2
148
148
        exit 1
149
149
    fi
150
 
    
 
150
 
151
151
    if [ -z "$KEYNAME" ]; then
152
152
        echo "Empty key name" >&2
153
153
        exit 1
154
154
    fi
155
 
    
 
155
 
156
156
    if [ -z "$KEYLENGTH" ] || [ "$KEYLENGTH" -lt 512 ]; then
157
157
        echo "Invalid key length" >&2
158
158
        exit 1
159
159
    fi
160
 
    
 
160
 
161
161
    if [ -z "$KEYEXPIRE" ]; then
162
162
        echo "Empty key expiration" >&2
163
163
        exit 1
164
164
    fi
165
 
    
 
165
 
166
166
    # Make FORCE be 0 or 1
167
167
    case "$FORCE" in
168
168
        [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) FORCE=1;;
169
169
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) FORCE=0;;
170
170
    esac
171
 
    
 
171
 
172
172
    if { [ -e "$SECKEYFILE" ] || [ -e "$PUBKEYFILE" ] \
173
173
             || [ -e "$TLS_PRIVKEYFILE" ] \
174
174
             || [ -e "$TLS_PUBKEYFILE" ]; } \
176
176
        echo "Refusing to overwrite old key files; use --force" >&2
177
177
        exit 1
178
178
    fi
179
 
    
 
179
 
180
180
    # Set lines for GnuPG batch file
181
181
    if [ -n "$KEYCOMMENT" ]; then
182
182
        KEYCOMMENTLINE="Name-Comment: $KEYCOMMENT"
184
184
    if [ -n "$KEYEMAIL" ]; then
185
185
        KEYEMAILLINE="Name-Email: $KEYEMAIL"
186
186
    fi
187
 
    
 
187
 
188
188
    # Create temporary gpg batch file
189
189
    BATCHFILE="`mktemp -t mandos-keygen-batch.XXXXXXXXXX`"
 
190
    TLS_PRIVKEYTMP="`mktemp -t mandos-keygen-privkey.XXXXXXXXXX`"
190
191
fi
191
192
 
192
193
if [ "$mode" = password ]; then
201
202
trap "
202
203
set +e; \
203
204
test -n \"$SECFILE\" && shred --remove \"$SECFILE\"; \
 
205
test -n \"$TLS_PRIVKEYTMP\" && shred --remove \"$TLS_PRIVKEYTMP\"; \
204
206
shred --remove \"$RINGDIR\"/sec* 2>/dev/null;
205
207
test -n \"$BATCHFILE\" && rm --force \"$BATCHFILE\"; \
206
208
rm --recursive --force \"$RINGDIR\";
231
233
        %no-protection
232
234
        %commit
233
235
        EOF
234
 
    
 
236
 
235
237
    if tty --quiet; then
236
238
        cat <<-EOF
237
239
        Note: Due to entropy requirements, key generation could take
241
243
        echo -n "Started: "
242
244
        date
243
245
    fi
244
 
    
245
 
    # Backup any old key files
246
 
    if cp --backup=numbered --force "$TLS_PRIVKEYFILE" "$TLS_PRIVKEYFILE" \
247
 
        2>/dev/null; then
248
 
        shred --remove "$TLS_PRIVKEYFILE"
249
 
    fi
250
 
    if cp --backup=numbered --force "$TLS_PUBKEYFILE" "$TLS_PUBKEYFILE" \
251
 
        2>/dev/null; then
252
 
        rm --force "$TLS_PUBKEYFILE"
253
 
    fi
254
 
 
255
 
    ## Generate TLS private key
256
 
 
257
 
    # First try certtool from GnuTLS
258
 
    if ! certtool --generate-privkey --password='' \
259
 
         --outfile "$TLS_PRIVKEYFILE" --sec-param ultra \
260
 
         --key-type="$TLS_KEYTYPE" --pkcs8 --no-text 2>/dev/null; then
261
 
        # Otherwise try OpenSSL
262
 
        if ! openssl genpkey -algorithm X25519 -out \
263
 
             /etc/keys/mandos/tls-privkey.pem; then
264
 
            rm --force /etc/keys/mandos/tls-privkey.pem
265
 
            # None of the commands succeded; give up
266
 
            return 1
 
246
 
 
247
    # Generate TLS private key
 
248
    if certtool --generate-privkey --password='' \
 
249
                --outfile "$TLS_PRIVKEYTMP" --sec-param ultra \
 
250
                --key-type="$TLS_KEYTYPE" --pkcs8 --no-text 2>/dev/null; then
 
251
        
 
252
        # Backup any old key files
 
253
        if cp --backup=numbered --force "$TLS_PRIVKEYFILE" "$TLS_PRIVKEYFILE" \
 
254
              2>/dev/null; then
 
255
            shred --remove "$TLS_PRIVKEYFILE" 2>/dev/null || :
267
256
        fi
268
 
    fi
269
 
 
270
 
    ## TLS public key
271
 
 
272
 
    # First try certtool from GnuTLS
273
 
    if ! certtool --password='' --load-privkey="$TLS_PRIVKEYFILE" \
274
 
         --outfile="$TLS_PUBKEYFILE" --pubkey-info --no-text \
275
 
         2>/dev/null; then
276
 
        # Otherwise try OpenSSL
277
 
        if ! openssl pkey -in "$TLS_PRIVKEYFILE" \
278
 
             -out "$TLS_PUBKEYFILE" -pubout; then
 
257
        if cp --backup=numbered --force "$TLS_PUBKEYFILE" "$TLS_PUBKEYFILE" \
 
258
              2>/dev/null; then
279
259
            rm --force "$TLS_PUBKEYFILE"
280
 
            # None of the commands succeded; give up
281
 
            return 1
 
260
        fi
 
261
        cp --archive "$TLS_PRIVKEYTMP" "$TLS_PRIVKEYFILE"
 
262
        shred --remove "$TLS_PRIVKEYTMP" 2>/dev/null || :
 
263
 
 
264
        ## TLS public key
 
265
 
 
266
        # First try certtool from GnuTLS
 
267
        if ! certtool --password='' --load-privkey="$TLS_PRIVKEYFILE" \
 
268
             --outfile="$TLS_PUBKEYFILE" --pubkey-info --no-text \
 
269
             2>/dev/null; then
 
270
            # Otherwise try OpenSSL
 
271
            if ! openssl pkey -in "$TLS_PRIVKEYFILE" \
 
272
                 -out "$TLS_PUBKEYFILE" -pubout; then
 
273
                rm --force "$TLS_PUBKEYFILE"
 
274
                # None of the commands succeded; give up
 
275
                return 1
 
276
            fi
282
277
        fi
283
278
    fi
284
 
    
 
279
 
285
280
    # Make sure trustdb.gpg exists;
286
281
    # this is a workaround for Debian bug #737128
287
282
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
292
287
        --homedir "$RINGDIR" --trust-model always \
293
288
        --gen-key "$BATCHFILE"
294
289
    rm --force "$BATCHFILE"
295
 
    
 
290
 
296
291
    if tty --quiet; then
297
292
        echo -n "Finished: "
298
293
        date
299
294
    fi
300
 
    
 
295
 
301
296
    # Backup any old key files
302
297
    if cp --backup=numbered --force "$SECKEYFILE" "$SECKEYFILE" \
303
298
        2>/dev/null; then
304
 
        shred --remove "$SECKEYFILE"
 
299
        shred --remove "$SECKEYFILE" 2>/dev/null || :
305
300
    fi
306
301
    if cp --backup=numbered --force "$PUBKEYFILE" "$PUBKEYFILE" \
307
302
        2>/dev/null; then
308
303
        rm --force "$PUBKEYFILE"
309
304
    fi
310
 
    
 
305
 
311
306
    FILECOMMENT="Mandos client key for $KEYNAME"
312
307
    if [ "$KEYCOMMENT" != "$KEYCOMMENT_ORIG" ]; then
313
308
        FILECOMMENT="$FILECOMMENT ($KEYCOMMENT)"
314
309
    fi
315
 
    
 
310
 
316
311
    if [ -n "$KEYEMAIL" ]; then
317
312
        FILECOMMENT="$FILECOMMENT <$KEYEMAIL>"
318
313
    fi
319
 
    
 
314
 
320
315
    # Export key from key rings to key files
321
316
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
322
317
        --homedir "$RINGDIR" --armor --export-options export-minimal \
328
323
fi
329
324
 
330
325
if [ "$mode" = password ]; then
331
 
    
 
326
 
332
327
    # Make SSH be 0 or 1
333
328
    case "$SSH" in
334
329
        [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]) SSH=1;;
335
330
        [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|*) SSH=0;;
336
331
    esac
337
 
    
 
332
 
338
333
    if [ $SSH -eq 1 ]; then
339
334
        for ssh_keytype in ecdsa-sha2-nistp256 ed25519 rsa; do
340
335
            set +e
351
346
            fi
352
347
        done
353
348
    fi
354
 
    
 
349
 
355
350
    # Import key into temporary key rings
356
351
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
357
352
        --homedir "$RINGDIR" --trust-model always --armor \
359
354
    gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
360
355
        --homedir "$RINGDIR" --trust-model always --armor \
361
356
        --import "$PUBKEYFILE"
362
 
    
 
357
 
363
358
    # Get fingerprint of key
364
359
    FINGERPRINT="`gpg --quiet --batch --no-tty --no-options \
365
360
        --enable-dsa2 --homedir "$RINGDIR" --trust-model always \
366
361
        --fingerprint --with-colons \
367
362
        | sed --quiet \
368
363
        --expression='/^fpr:/{s/^fpr:.*:\\([0-9A-Z]*\\):\$/\\1/p;q}'`"
369
 
    
 
364
 
370
365
    test -n "$FINGERPRINT"
371
 
    
372
 
    KEY_ID="$(certtool --key-id --hash=sha256 \
 
366
 
 
367
    if [ -r "$TLS_PUBKEYFILE" ]; then
 
368
       KEY_ID="$(certtool --key-id --hash=sha256 \
373
369
                       --infile="$TLS_PUBKEYFILE" 2>/dev/null || :)"
374
370
 
375
 
    if [ -z "$KEY_ID" ]; then
376
 
        KEY_ID=$(openssl pkey -pubin -in /tmp/tls-pubkey.pem \
377
 
                         -outform der \
378
 
                     | openssl sha256 \
379
 
                     | sed --expression='s/^.*[^[:xdigit:]]//')
 
371
       if [ -z "$KEY_ID" ]; then
 
372
           KEY_ID=$(openssl pkey -pubin -in "$TLS_PUBKEYFILE" \
 
373
                            -outform der \
 
374
                        | openssl sha256 \
 
375
                        | sed --expression='s/^.*[^[:xdigit:]]//')
 
376
       fi
 
377
       test -n "$KEY_ID"
380
378
    fi
381
 
    test -n "$KEY_ID"
382
 
    
 
379
 
383
380
    FILECOMMENT="Encrypted password for a Mandos client"
384
 
    
 
381
 
385
382
    while [ ! -s "$SECFILE" ]; do
386
383
        if [ -n "$PASSFILE" ]; then
387
 
            cat "$PASSFILE"
 
384
            cat -- "$PASSFILE"
388
385
        else
389
386
            tty --quiet && stty -echo
390
387
            echo -n "Enter passphrase: " >/dev/tty
400
397
                echo "Passphrase mismatch" >&2
401
398
                touch "$RINGDIR"/mismatch
402
399
            else
403
 
                echo -n "$first"
 
400
                printf "%s" "$first"
404
401
            fi
405
402
        fi | gpg --quiet --batch --no-tty --no-options --enable-dsa2 \
406
403
            --homedir "$RINGDIR" --trust-model always --armor \
415
412
            fi
416
413
        fi
417
414
    done
418
 
    
 
415
 
419
416
    cat <<-EOF
420
417
        [$KEYNAME]
421
418
        host = $KEYNAME
422
 
        key_id = $KEY_ID
 
419
        EOF
 
420
    if [ -n "$KEY_ID" ]; then
 
421
        echo "key_id = $KEY_ID"
 
422
    fi
 
423
    cat <<-EOF
423
424
        fingerprint = $FINGERPRINT
424
425
        secret =
425
426
        EOF
443
444
set +e
444
445
# Remove the password file, if any
445
446
if [ -n "$SECFILE" ]; then
446
 
    shred --remove "$SECFILE"
 
447
    shred --remove "$SECFILE" 2>/dev/null
447
448
fi
448
449
# Remove the key rings
449
450
shred --remove "$RINGDIR"/sec* 2>/dev/null