2019-05-27 00:15:57 +02:00
#!/usr/bin/env bash
test_description = 'Message decryption with protected headers'
. $( dirname " $0 " ) /test-lib.sh || exit 1
##################################################
2020-04-28 20:57:22 +02:00
test_require_external_prereq gpgsm
2019-05-27 00:15:57 +02:00
add_gnupg_home
2020-04-28 20:57:22 +02:00
add_gpgsm_home
2019-05-27 00:15:57 +02:00
add_email_corpus protected-headers
test_begin_subtest "verify protected header is not visible without decryption"
output = $( notmuch show --format= json id:protected-header@crypto.notmuchmail.org)
test_json_nodes <<< " $output " \
'no_crypto_info:[0][0][0]["crypto"]={}' \
'subject:[0][0][0]["headers"]["Subject"]="Subject Unavailable"'
test_begin_subtest "verify protected header is visible with decryption"
output = $( notmuch show --decrypt= true --format= json id:protected-header@crypto.notmuchmail.org)
test_json_nodes <<< " $output " \
2019-05-28 00:14:16 +02:00
'crypto:[0][0][0]["crypto"]={"decrypted": {"status": "full", "header-mask": {"Subject": "Subject Unavailable"}}}' \
2019-05-27 00:15:57 +02:00
'subject:[0][0][0]["headers"]["Subject"]="This is a protected header"'
2019-05-27 00:16:00 +02:00
test_begin_subtest "when no external header is present, show masked subject as null"
output = $( notmuch show --decrypt= true --format= json id:subjectless-protected-header@crypto.notmuchmail.org)
test_json_nodes <<< " $output " \
'crypto:[0][0][0]["crypto"]={"decrypted": {"status": "full", "header-mask": {"Subject": null}}}' \
'subject:[0][0][0]["headers"]["Subject"]="This is a protected header"'
2019-05-27 00:15:57 +02:00
test_begin_subtest "misplaced protected headers should not be made visible during decryption"
output = $( notmuch show --decrypt= true --format= json id:misplaced-protected-header@crypto.notmuchmail.org)
test_json_nodes <<< " $output " \
'crypto:[0][0][0]["crypto"]={"decrypted": {"status": "full"}}' \
'subject:[0][0][0]["headers"]["Subject"]="Subject Unavailable"'
test_begin_subtest "verify double-wrapped phony protected header is not visible when inner decryption fails"
output = $( notmuch show --decrypt= true --format= json id:double-wrapped-with-phony-protected-header@crypto.notmuchmail.org)
test_json_nodes <<< " $output " \
'crypto:[0][0][0]["crypto"]={"decrypted": {"status": "full"}}' \
'subject:[0][0][0]["headers"]["Subject"]="Subject Unavailable"'
test_begin_subtest "cleartext phony protected headers should not be made visible when decryption fails"
output = $( notmuch show --decrypt= true --format= json id:phony-protected-header-bad-encryption@crypto.notmuchmail.org)
test_json_nodes <<< " $output " \
'no_crypto_info:[0][0][0]["crypto"]={}' \
'subject:[0][0][0]["headers"]["Subject"]="Subject Unavailable"'
test_begin_subtest "wrapped protected headers should not be made visible during decryption"
output = $( notmuch show --decrypt= true --format= json id:wrapped-protected-header@crypto.notmuchmail.org)
test_json_nodes <<< " $output " \
'crypto:[0][0][0]["crypto"]={"decrypted": {"status": "partial"}}' \
'subject:[0][0][0]["headers"]["Subject"]="[mailing-list] Subject Unavailable"'
test_begin_subtest "internal headers without protected-header attribute should be skipped"
output = $( notmuch show --decrypt= true --format= json id:no-protected-header-attribute@crypto.notmuchmail.org)
test_json_nodes <<< " $output " \
'crypto:[0][0][0]["crypto"]={"decrypted": {"status": "full"}}' \
'subject:[0][0][0]["headers"]["Subject"]="Subject Unavailable"'
test_begin_subtest "verify nested message/rfc822 protected header is visible"
output = $( notmuch show --decrypt= true --format= json id:nested-rfc822-message@crypto.notmuchmail.org)
test_json_nodes <<< " $output " \
2019-05-28 00:14:16 +02:00
'crypto:[0][0][0]["crypto"]={"decrypted": {"status": "full", "header-mask": {"Subject": "Subject Unavailable"}}}' \
2019-05-27 00:15:57 +02:00
'subject:[0][0][0]["headers"]["Subject"]="This is a message using draft-melnikov-smime-header-signing"'
2019-05-27 00:16:01 +02:00
test_begin_subtest "show cryptographic envelope on signed mail"
output = $( notmuch show --verify --format= json id:simple-signed-mail@crypto.notmuchmail.org)
test_json_nodes <<< " $output " \
'crypto:[0][0][0]["crypto"]={"signed": {"status": [{"created": 1525609971, "fingerprint": "' $FINGERPRINT '", "userid": "' " $SELF_USERID " '", "status": "good"}]}}'
test_begin_subtest "verify signed protected header"
output = $( notmuch show --verify --format= json id:signed-protected-header@crypto.notmuchmail.org)
test_json_nodes <<< " $output " \
'crypto:[0][0][0]["crypto"]={"signed": {"status": [{"created": 1525350527, "fingerprint": "' $FINGERPRINT '", "userid": "' " $SELF_USERID " '", "status": "good"}], "headers": ["Subject"]}}'
2019-05-27 00:16:02 +02:00
test_begin_subtest "protected subject does not leak by default in replies"
output = $( notmuch reply --decrypt= true --format= json id:protected-header@crypto.notmuchmail.org)
test_json_nodes <<< " $output " \
'crypto:["original"]["crypto"]={"decrypted": {"status": "full", "header-mask": {"Subject": "Subject Unavailable"}}}' \
'subject:["original"]["headers"]["Subject"]="This is a protected header"' \
'reply-subject:["reply-headers"]["Subject"]="Re: Subject Unavailable"'
2019-05-28 00:40:28 +02:00
test_begin_subtest "protected subject is not indexed by default"
output = $( notmuch search --output= messages 'subject:"This is a protected header"' )
test_expect_equal " $output " ''
test_begin_subtest "reindex message with protected header"
test_expect_success 'notmuch reindex --decrypt=true id:protected-header@crypto.notmuchmail.org'
test_begin_subtest "protected subject is indexed when cleartext is indexed"
output = $( notmuch search --output= messages 'subject:"This is a protected header"' )
test_expect_equal " $output " 'id:protected-header@crypto.notmuchmail.org'
test_begin_subtest "indexed protected subject is visible in search"
output = $( notmuch search --format= json 'id:protected-header@crypto.notmuchmail.org' )
test_json_nodes <<< " $output " \
'subject:[0]["subject"]="This is a protected header"'
2019-05-27 00:16:09 +02:00
test_begin_subtest "indexed protected subject is not visible in reply header"
output = $( notmuch reply --format= json 'id:protected-header@crypto.notmuchmail.org' )
test_json_nodes <<< " $output " \
'subject:["original"]["headers"]["Subject"]="This is a protected header"' \
'reply-subject:["reply-headers"]["Subject"]="Re: Subject Unavailable"'
2019-05-27 00:16:06 +02:00
test_begin_subtest "verify correct protected header when submessage exists"
output = $( notmuch show --decrypt= true --format= json id:encrypted-message-with-forwarded-attachment@crypto.notmuchmail.org)
test_json_nodes <<< " $output " \
'crypto:[0][0][0]["crypto"]={"decrypted": {"status": "full", "header-mask": {"Subject": "Subject Unavailable"}}}' \
'subject:[0][0][0]["headers"]["Subject"]="This is the cryptographic envelope subject"'
2019-05-27 00:16:04 +02:00
test_begin_subtest "verify protected header is both signed and encrypted"
output = $( notmuch show --decrypt= true --format= json id:encrypted-signed@crypto.notmuchmail.org)
test_json_nodes <<< " $output " \
' crypto:[ 0] [ 0] [ 0] [ "crypto" ] = {
"signed" :{ "status" : [ { "status" : "good" , "fingerprint" : " ' $FINGERPRINT ' " , "userid" : "'" $SELF_USERID "'" , "created" : 1525812676} ] ,
"encrypted" : true, "headers" : [ "Subject" ] } ,"decrypted" : { "status" : "full" , "header-mask" : { "Subject" : "Subject Unavailable" } } } ' \
'subject:[0][0][0]["headers"]["Subject"]="Rhinoceros dinner"'
test_begin_subtest "verify protected header is signed even when not masked"
output = $( notmuch show --decrypt= true --format= json id:encrypted-signed-not-masked@crypto.notmuchmail.org)
test_json_nodes <<< " $output " \
' crypto:[ 0] [ 0] [ 0] [ "crypto" ] = {
"signed" :{ "status" : [ { "status" : "good" , "fingerprint" : " ' $FINGERPRINT ' " , "userid" : "'" $SELF_USERID "'" , "created" : 1525812676} ] ,
"encrypted" : true, "headers" : [ "Subject" ] } ,"decrypted" : { "status" : "full" } } ' \
'subject:[0][0][0]["headers"]["Subject"]="Rhinoceros dinner"'
2019-05-27 00:16:05 +02:00
test_begin_subtest "reindex everything, ensure headers are as expected"
notmuch reindex --decrypt= true from:test_suite@notmuchmail.org
output = $( notmuch search --output= messages 'subject:"protected header" or subject:"Rhinoceros" or subject:"draft-melnikov-smime-header-signing" or subject:"valid"' | sort)
test_expect_equal " $output " ' id:encrypted-signed-not-masked@crypto.notmuchmail.org
id:encrypted-signed@crypto.notmuchmail.org
id:nested-rfc822-message@crypto.notmuchmail.org
id:protected-header@crypto.notmuchmail.org
id:subjectless-protected-header@crypto.notmuchmail.org'
test: avoid showing legacy-display parts
Enigmail generates a "legacy-display" part when it sends encrypted
mail with a protected Subject: header. This part is intended to
display the Subject for mail user agents that are capable of
decryption, but do not know how to deal with embedded protected
headers.
This part is the first child of a two-part multipart/mixed
cryptographic payload within a cryptographic envelope that includes
encryption (that is, it is not just a cleartext signed message). It
uses Content-Type: text/rfc822-headers.
That is:
A └┬╴multipart/encrypted
B ├─╴application/pgp-encrypted
C └┬╴application/octet-stream
* ╤ <decryption>
D └┬╴multipart/mixed; protected-headers=v1 (cryptographic payload)
E ├─╴text/rfc822-headers; protected-headers=v1 (legacy-display part)
F └─╴… (actual message body)
In discussions with jrollins, i've come to the conclusion that a
legacy-display part should be stripped entirely from "notmuch show"
and "notmuch reply" now that these tools can understand and interpret
protected headers.
You can tell when a message part is a protected header part this way:
* is the payload (D) multipart/mixed with exactly two children?
* is its first child (E) Content-Type: text/rfc822-headers?
* does the first child (E) have the property protected-headers=v1?
* do all the headers in the body of the first child (E) match
the protected headers in the payload part (D) itself?
If this is the case, and we already know how to deal with the
protected header, then there is no reason to try to render the
legacy-display part itself for the user.
Furthermore, when indexing, if we are indexing properly, we should
avoid indexing the text in E as part of the message body.
'notmuch reply' is an interesting case: the standard use of 'notmuch
reply' will end up omitting all mention of protected Subject:.
The right fix is for the replying MUA to be able to protect its
headers, and for it to set them appropriately based on headers found
in the original message.
If a replying MUA is unable to protect headers, but still wants the
user to be able to see the original header, a replying MUA that
notices that the original message's subject differs from the proposed
reply subject may choose to include the original's subject in the
quoted/attributed text. (this would be a stopgap measure; it's not
even clear that there is user demand for it)
This test suite change indicates what we want to happen for this case
(the tests are currently broken), and includes three additional TODO
suggestions of subtle cases for anyone who wants to flesh out the test
suite even further. (i believe all these cases should be already
fixed by the rest of this series, but haven't had time to write the
tests for the unusual cases)
Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-08-29 17:38:48 +02:00
test_begin_subtest "when rendering protected headers, avoid rendering legacy-display part"
output = $( notmuch show --format= json id:protected-with-legacy-display@crypto.notmuchmail.org)
test_json_nodes <<< " $output " \
'subject:[0][0][0]["headers"]["Subject"]="Interrupting Cow"' \
'no_legacy_display:[0][0][0]["body"][0]["content"][1]["content-type"]="text/plain"'
test_begin_subtest "when replying, avoid rendering legacy-display part"
output = $( notmuch reply --format= json id:protected-with-legacy-display@crypto.notmuchmail.org)
test_json_nodes <<< " $output " \
'no_legacy_display:["original"]["body"][0]["content"][1]["content-type"]="text/plain"'
test_begin_subtest "do not treat legacy-display part as body when indexing"
output = $( notmuch search --output= messages body:interrupting)
test_expect_equal " $output " ''
test_begin_subtest "identify message that had a legacy display part skipped during indexing"
output = $( notmuch search --output= messages property:index.repaired= skip-protected-headers-legacy-display)
test_expect_equal " $output " id:protected-with-legacy-display@crypto.notmuchmail.org
2020-04-28 20:57:22 +02:00
for variant in multipart-signed onepart-signed; do
test_begin_subtest " verify signed PKCS#7 subject ( $variant ) "
test_subtest_known_broken
output = $( notmuch show --verify --format= json " id:smime- ${ variant } @protected-headers.example " )
test_json_nodes <<< " $output " \
'signed_subject:[0][0][0]["crypto"]["signed"]["headers"]=["Subject"]' \
'sig_good:[0][0][0]["crypto"]["signed"]["status"][0]["status"]="good"' \
'sig_fpr:[0][0][0]["crypto"]["signed"]["status"][0]["fingerprint"]="702BA4B157F1E2B7D16B0C6A5FFC8A7DE2057DEB"' \
'sig_uid:[0][0][0]["crypto"]["signed"]["status"][0]["userid"]="CN=Alice Lovelace"' \
'not_encrypted:[0][0][0]["crypto"]!"decrypted"'
done
for variant in sign+enc sign+enc+legacy-disp; do
test_begin_subtest " confirm signed and encrypted PKCS#7 subject ( $variant ) "
test_subtest_known_broken
output = $( notmuch show --decrypt= true --format= json " id:smime- ${ variant } @protected-headers.example " )
test_json_nodes <<< " $output " \
'signed_subject:[0][0][0]["crypto"]["signed"]["headers"]=["Subject"]' \
'sig_good:[0][0][0]["crypto"]["signed"]["status"][0]["status"]="good"' \
'sig_fpr:[0][0][0]["crypto"]["signed"]["status"][0]["fingerprint"]="702BA4B157F1E2B7D16B0C6A5FFC8A7DE2057DEB"' \
'sig_uid:[0][0][0]["crypto"]["signed"]["status"][0]["userid"]="CN=Alice Lovelace"' \
'encrypted:[0][0][0]["crypto"]["decrypted"]={"status":"full","header-mask":{"Subject":"..."}}'
done
test_begin_subtest "confirm encryption-protected PKCS#7 subject (enc+legacy-disp)"
test_subtest_known_broken
output = $( notmuch show --decrypt= true --format= json "id:smime-enc+legacy-disp@protected-headers.example" )
test_json_nodes <<< " $output " \
'encrypted:[0][0][0]["crypto"]["decrypted"]={"status":"full","header-mask":{"Subject":"..."}}' \
'no_sig:[0][0][0]["crypto"]!"signed"'
test: avoid showing legacy-display parts
Enigmail generates a "legacy-display" part when it sends encrypted
mail with a protected Subject: header. This part is intended to
display the Subject for mail user agents that are capable of
decryption, but do not know how to deal with embedded protected
headers.
This part is the first child of a two-part multipart/mixed
cryptographic payload within a cryptographic envelope that includes
encryption (that is, it is not just a cleartext signed message). It
uses Content-Type: text/rfc822-headers.
That is:
A └┬╴multipart/encrypted
B ├─╴application/pgp-encrypted
C └┬╴application/octet-stream
* ╤ <decryption>
D └┬╴multipart/mixed; protected-headers=v1 (cryptographic payload)
E ├─╴text/rfc822-headers; protected-headers=v1 (legacy-display part)
F └─╴… (actual message body)
In discussions with jrollins, i've come to the conclusion that a
legacy-display part should be stripped entirely from "notmuch show"
and "notmuch reply" now that these tools can understand and interpret
protected headers.
You can tell when a message part is a protected header part this way:
* is the payload (D) multipart/mixed with exactly two children?
* is its first child (E) Content-Type: text/rfc822-headers?
* does the first child (E) have the property protected-headers=v1?
* do all the headers in the body of the first child (E) match
the protected headers in the payload part (D) itself?
If this is the case, and we already know how to deal with the
protected header, then there is no reason to try to render the
legacy-display part itself for the user.
Furthermore, when indexing, if we are indexing properly, we should
avoid indexing the text in E as part of the message body.
'notmuch reply' is an interesting case: the standard use of 'notmuch
reply' will end up omitting all mention of protected Subject:.
The right fix is for the replying MUA to be able to protect its
headers, and for it to set them appropriately based on headers found
in the original message.
If a replying MUA is unable to protect headers, but still wants the
user to be able to see the original header, a replying MUA that
notices that the original message's subject differs from the proposed
reply subject may choose to include the original's subject in the
quoted/attributed text. (this would be a stopgap measure; it's not
even clear that there is user demand for it)
This test suite change indicates what we want to happen for this case
(the tests are currently broken), and includes three additional TODO
suggestions of subtle cases for anyone who wants to flesh out the test
suite even further. (i believe all these cases should be already
fixed by the rest of this series, but haven't had time to write the
tests for the unusual cases)
Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
2019-08-29 17:38:48 +02:00
# TODO: test that a part that looks like a legacy-display in
# multipart/signed, but not encrypted, is indexed and not stripped.
# TODO: test that a legacy-display in a decrypted subpart (not in the
# cryptographic payload) is indexed and not stripped.
# TODO: test that a legacy-display inside multiple MIME layers that
# include an encryption layer (e.g. multipart/encrypted around
# multipart/signed) is stripped and not indexed.
2019-05-27 00:15:57 +02:00
test_done
