1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469
|
# This file is dual licensed under the terms of the Apache License, Version
# 2.0, and the BSD License. See the LICENSE file in the root of this repository
# for complete details.
import email.parser
import os
import typing
from email.message import EmailMessage
import pytest
from cryptography import exceptions, x509
from cryptography.exceptions import _Reasons
from cryptography.hazmat.bindings._rust import test_support
from cryptography.hazmat.primitives import hashes, serialization
from cryptography.hazmat.primitives.asymmetric import ed25519, padding, rsa
from cryptography.hazmat.primitives.serialization import pkcs7
from tests.x509.test_x509 import _generate_ca_and_leaf
from ...hazmat.primitives.fixtures_rsa import (
RSA_KEY_2048_ALT,
)
from ...hazmat.primitives.test_rsa import rsa_key_2048
from ...utils import load_vectors_from_file, raises_unsupported_algorithm
# Make ruff happy since we're importing fixtures that pytest patches in as
# func args
__all__ = ["rsa_key_2048"]
@pytest.mark.supported(
only_if=lambda backend: backend.pkcs7_supported(),
skip_message="Requires OpenSSL with PKCS7 support",
)
class TestPKCS7Loading:
def test_load_invalid_der_pkcs7(self, backend):
with pytest.raises(ValueError):
pkcs7.load_der_pkcs7_certificates(b"nonsense")
def test_load_invalid_pem_pkcs7(self, backend):
with pytest.raises(ValueError):
pkcs7.load_pem_pkcs7_certificates(b"nonsense")
def test_not_bytes_der(self, backend):
with pytest.raises(TypeError):
pkcs7.load_der_pkcs7_certificates(38) # type: ignore[arg-type]
def test_not_bytes_pem(self, backend):
with pytest.raises(TypeError):
pkcs7.load_pem_pkcs7_certificates(38) # type: ignore[arg-type]
def test_load_pkcs7_pem(self, backend):
certs = load_vectors_from_file(
os.path.join("pkcs7", "isrg.pem"),
lambda pemfile: pkcs7.load_pem_pkcs7_certificates(pemfile.read()),
mode="rb",
)
assert len(certs) == 1
assert certs[0].subject.get_attributes_for_oid(
x509.oid.NameOID.COMMON_NAME
) == [x509.NameAttribute(x509.oid.NameOID.COMMON_NAME, "ISRG Root X1")]
@pytest.mark.parametrize(
"filepath",
[
os.path.join("pkcs7", "amazon-roots.der"),
os.path.join("pkcs7", "amazon-roots.p7b"),
],
)
def test_load_pkcs7_der(self, filepath, backend):
certs = load_vectors_from_file(
filepath,
lambda derfile: pkcs7.load_der_pkcs7_certificates(derfile.read()),
mode="rb",
)
assert len(certs) == 2
assert certs[0].subject.get_attributes_for_oid(
x509.oid.NameOID.COMMON_NAME
) == [
x509.NameAttribute(
x509.oid.NameOID.COMMON_NAME, "Amazon Root CA 3"
)
]
assert certs[1].subject.get_attributes_for_oid(
x509.oid.NameOID.COMMON_NAME
) == [
x509.NameAttribute(
x509.oid.NameOID.COMMON_NAME, "Amazon Root CA 2"
)
]
def test_load_pkcs7_unsupported_type(self, backend):
with raises_unsupported_algorithm(_Reasons.UNSUPPORTED_SERIALIZATION):
load_vectors_from_file(
os.path.join("pkcs7", "enveloped.pem"),
lambda pemfile: pkcs7.load_pem_pkcs7_certificates(
pemfile.read()
),
mode="rb",
)
def test_load_pkcs7_empty_certificates(self):
der = b"\x30\x0b\x06\x09\x2a\x86\x48\x86\xf7\x0d\x01\x07\x02"
with pytest.raises(ValueError):
pkcs7.load_der_pkcs7_certificates(der)
def _load_cert_key():
key = load_vectors_from_file(
os.path.join("x509", "custom", "ca", "ca_key.pem"),
lambda pemfile: serialization.load_pem_private_key(
pemfile.read(), None, unsafe_skip_rsa_key_validation=True
),
mode="rb",
)
cert = load_vectors_from_file(
os.path.join("x509", "custom", "ca", "ca.pem"),
loader=lambda pemfile: x509.load_pem_x509_certificate(pemfile.read()),
mode="rb",
)
return cert, key
@pytest.mark.supported(
only_if=lambda backend: backend.pkcs7_supported(),
skip_message="Requires OpenSSL with PKCS7 support",
)
class TestPKCS7SignatureBuilder:
def test_invalid_data(self, backend):
builder = pkcs7.PKCS7SignatureBuilder()
with pytest.raises(TypeError):
builder.set_data("not bytes") # type: ignore[arg-type]
def test_set_data_twice(self, backend):
builder = pkcs7.PKCS7SignatureBuilder().set_data(b"test")
with pytest.raises(ValueError):
builder.set_data(b"test")
def test_sign_no_signer(self, backend):
builder = pkcs7.PKCS7SignatureBuilder().set_data(b"test")
with pytest.raises(ValueError):
builder.sign(serialization.Encoding.SMIME, [])
def test_sign_no_data(self, backend):
cert, key = _load_cert_key()
builder = pkcs7.PKCS7SignatureBuilder().add_signer(
cert, key, hashes.SHA256()
)
with pytest.raises(ValueError):
builder.sign(serialization.Encoding.SMIME, [])
def test_unsupported_hash_alg(self, backend):
cert, key = _load_cert_key()
with pytest.raises(TypeError):
pkcs7.PKCS7SignatureBuilder().add_signer(
cert,
key,
hashes.SHA512_256(), # type: ignore[arg-type]
)
def test_not_a_cert(self, backend):
_, key = _load_cert_key()
with pytest.raises(TypeError):
pkcs7.PKCS7SignatureBuilder().add_signer(
b"notacert", # type: ignore[arg-type]
key,
hashes.SHA256(),
)
@pytest.mark.supported(
only_if=lambda backend: backend.ed25519_supported(),
skip_message="Does not support ed25519.",
)
def test_unsupported_key_type(self, backend):
cert, _ = _load_cert_key()
key = ed25519.Ed25519PrivateKey.generate()
with pytest.raises(TypeError):
pkcs7.PKCS7SignatureBuilder().add_signer(
cert,
key, # type: ignore[arg-type]
hashes.SHA256(),
)
def test_sign_invalid_options(self, backend):
cert, key = _load_cert_key()
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(b"test")
.add_signer(cert, key, hashes.SHA256())
)
with pytest.raises(ValueError):
builder.sign(
serialization.Encoding.SMIME,
[b"invalid"], # type: ignore[list-item]
)
def test_sign_invalid_encoding(self, backend):
cert, key = _load_cert_key()
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(b"test")
.add_signer(cert, key, hashes.SHA256())
)
with pytest.raises(ValueError):
builder.sign(serialization.Encoding.Raw, [])
def test_sign_invalid_options_text_no_detached(self, backend):
cert, key = _load_cert_key()
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(b"test")
.add_signer(cert, key, hashes.SHA256())
)
options = [pkcs7.PKCS7Options.Text]
with pytest.raises(ValueError):
builder.sign(serialization.Encoding.SMIME, options)
def test_sign_invalid_options_text_der_encoding(self, backend):
cert, key = _load_cert_key()
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(b"test")
.add_signer(cert, key, hashes.SHA256())
)
options = [
pkcs7.PKCS7Options.Text,
pkcs7.PKCS7Options.DetachedSignature,
]
with pytest.raises(ValueError):
builder.sign(serialization.Encoding.DER, options)
def test_sign_invalid_options_no_attrs_and_no_caps(self, backend):
cert, key = _load_cert_key()
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(b"test")
.add_signer(cert, key, hashes.SHA256())
)
options = [
pkcs7.PKCS7Options.NoAttributes,
pkcs7.PKCS7Options.NoCapabilities,
]
with pytest.raises(ValueError):
builder.sign(serialization.Encoding.SMIME, options)
def test_smime_sign_detached(self, backend):
data = b"hello world"
cert, key = _load_cert_key()
options = [pkcs7.PKCS7Options.DetachedSignature]
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(cert, key, hashes.SHA256())
)
sig = builder.sign(serialization.Encoding.SMIME, options)
sig_binary = builder.sign(serialization.Encoding.DER, options)
assert b"text/plain" not in sig
# We don't have a generic ASN.1 parser available to us so we instead
# will assert on specific byte sequences being present based on the
# parameters chosen above.
assert b"sha-256" in sig
# Detached signature means that the signed data is *not* embedded into
# the PKCS7 structure itself, but is present in the SMIME serialization
# as a separate section before the PKCS7 data. So we should expect to
# have data in sig but not in sig_binary
assert data in sig
# Parse the message to get the signed data, which is the
# first payload in the message
message = email.parser.BytesParser().parsebytes(sig)
payload = message.get_payload()
assert isinstance(payload, list)
assert isinstance(payload[0], email.message.Message)
signed_data = payload[0].get_payload()
assert isinstance(signed_data, str)
test_support.pkcs7_verify(
serialization.Encoding.SMIME,
sig,
signed_data.encode(),
[cert],
options,
)
assert data not in sig_binary
test_support.pkcs7_verify(
serialization.Encoding.DER,
sig_binary,
data,
[cert],
options,
)
def test_sign_byteslike(self, backend):
data = bytearray(b"hello world")
cert, key = _load_cert_key()
options = [pkcs7.PKCS7Options.DetachedSignature]
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(cert, key, hashes.SHA256())
)
sig = builder.sign(serialization.Encoding.SMIME, options)
assert bytes(data) in sig
test_support.pkcs7_verify(
serialization.Encoding.SMIME,
sig,
data,
[cert],
options,
)
data = bytearray(b"")
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(cert, key, hashes.SHA256())
)
sig = builder.sign(serialization.Encoding.SMIME, options)
test_support.pkcs7_verify(
serialization.Encoding.SMIME,
sig,
data,
[cert],
options,
)
def test_sign_pem(self, backend):
data = b"hello world"
cert, key = _load_cert_key()
options: typing.List[pkcs7.PKCS7Options] = []
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(cert, key, hashes.SHA256())
)
sig = builder.sign(serialization.Encoding.PEM, options)
test_support.pkcs7_verify(
serialization.Encoding.PEM,
sig,
None,
[cert],
options,
)
@pytest.mark.parametrize(
("hash_alg", "expected_value"),
[
(hashes.SHA256(), b"\x06\t`\x86H\x01e\x03\x04\x02\x01"),
(hashes.SHA384(), b"\x06\t`\x86H\x01e\x03\x04\x02\x02"),
(hashes.SHA512(), b"\x06\t`\x86H\x01e\x03\x04\x02\x03"),
],
)
def test_sign_alternate_digests_der(
self, hash_alg, expected_value, backend
):
data = b"hello world"
cert, key = _load_cert_key()
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(cert, key, hash_alg)
)
options: typing.List[pkcs7.PKCS7Options] = []
sig = builder.sign(serialization.Encoding.DER, options)
assert expected_value in sig
test_support.pkcs7_verify(
serialization.Encoding.DER, sig, None, [cert], options
)
@pytest.mark.parametrize(
("hash_alg", "expected_value"),
[
(hashes.SHA256(), b"sha-256"),
(hashes.SHA384(), b"sha-384"),
(hashes.SHA512(), b"sha-512"),
],
)
def test_sign_alternate_digests_detached(
self, hash_alg, expected_value, backend
):
data = b"hello world"
cert, key = _load_cert_key()
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(cert, key, hash_alg)
)
options = [pkcs7.PKCS7Options.DetachedSignature]
sig = builder.sign(serialization.Encoding.SMIME, options)
# When in detached signature mode the hash algorithm is stored as a
# byte string like "sha-384".
assert expected_value in sig
def test_sign_attached(self, backend):
data = b"hello world"
cert, key = _load_cert_key()
options: typing.List[pkcs7.PKCS7Options] = []
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(cert, key, hashes.SHA256())
)
sig_binary = builder.sign(serialization.Encoding.DER, options)
# When not passing detached signature the signed data is embedded into
# the PKCS7 structure itself
assert data in sig_binary
test_support.pkcs7_verify(
serialization.Encoding.DER,
sig_binary,
None,
[cert],
options,
)
def test_sign_binary(self, backend):
data = b"hello\nworld"
cert, key = _load_cert_key()
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(cert, key, hashes.SHA256())
)
options: typing.List[pkcs7.PKCS7Options] = []
sig_no_binary = builder.sign(serialization.Encoding.DER, options)
sig_binary = builder.sign(
serialization.Encoding.DER, [pkcs7.PKCS7Options.Binary]
)
# Binary prevents translation of LF to CR+LF (SMIME canonical form)
# so data should not be present in sig_no_binary, but should be present
# in sig_binary
assert data not in sig_no_binary
test_support.pkcs7_verify(
serialization.Encoding.DER,
sig_no_binary,
None,
[cert],
options,
)
assert data in sig_binary
test_support.pkcs7_verify(
serialization.Encoding.DER,
sig_binary,
None,
[cert],
options,
)
def test_sign_smime_canonicalization(self, backend):
data = b"hello\nworld"
cert, key = _load_cert_key()
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(cert, key, hashes.SHA256())
)
options: typing.List[pkcs7.PKCS7Options] = []
sig_binary = builder.sign(serialization.Encoding.DER, options)
# LF gets converted to CR+LF (SMIME canonical form)
# so data should not be present in the sig
assert data not in sig_binary
assert b"hello\r\nworld" in sig_binary
test_support.pkcs7_verify(
serialization.Encoding.DER,
sig_binary,
None,
[cert],
options,
)
def test_sign_text(self, backend):
data = b"hello world"
cert, key = _load_cert_key()
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(cert, key, hashes.SHA256())
)
options = [
pkcs7.PKCS7Options.Text,
pkcs7.PKCS7Options.DetachedSignature,
]
sig_pem = builder.sign(serialization.Encoding.SMIME, options)
# The text option adds text/plain headers to the S/MIME message
# These headers are only relevant in SMIME mode, not binary, which is
# just the PKCS7 structure itself.
assert sig_pem.count(b"text/plain") == 1
assert b"Content-Type: text/plain\r\n\r\nhello world\r\n" in sig_pem
# Parse the message to get the signed data, which is the
# first payload in the message
message = email.parser.BytesParser().parsebytes(sig_pem)
payload = message.get_payload()
assert isinstance(payload, list)
assert isinstance(payload[0], email.message.Message)
signed_data = payload[0].as_bytes(
policy=message.policy.clone(linesep="\r\n")
)
test_support.pkcs7_verify(
serialization.Encoding.SMIME,
sig_pem,
signed_data,
[cert],
options,
)
def test_smime_capabilities(self, backend):
data = b"hello world"
cert, key = _load_cert_key()
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(cert, key, hashes.SHA256())
)
sig_binary = builder.sign(serialization.Encoding.DER, [])
# 1.2.840.113549.1.9.15 (SMIMECapabilities) as an ASN.1 DER encoded OID
assert b"\x06\t*\x86H\x86\xf7\r\x01\t\x0f" in sig_binary
# 2.16.840.1.101.3.4.1.42 (aes256-CBC-PAD) as an ASN.1 DER encoded OID
aes256_cbc_pad_oid = b"\x06\x09\x60\x86\x48\x01\x65\x03\x04\x01\x2a"
# 2.16.840.1.101.3.4.1.22 (aes192-CBC-PAD) as an ASN.1 DER encoded OID
aes192_cbc_pad_oid = b"\x06\x09\x60\x86\x48\x01\x65\x03\x04\x01\x16"
# 2.16.840.1.101.3.4.1.2 (aes128-CBC-PAD) as an ASN.1 DER encoded OID
aes128_cbc_pad_oid = b"\x06\x09\x60\x86\x48\x01\x65\x03\x04\x01\x02"
# Each algorithm in SMIMECapabilities should be inside its own
# SEQUENCE.
# This is encoded as SEQUENCE_IDENTIFIER + LENGTH + ALGORITHM_OID.
# This tests that each algorithm is indeed encoded inside its own
# sequence. See RFC 2633, Appendix A for more details.
sequence_identifier = b"\x30"
for oid in [
aes256_cbc_pad_oid,
aes192_cbc_pad_oid,
aes128_cbc_pad_oid,
]:
len_oid = len(oid).to_bytes(length=1, byteorder="big")
assert sequence_identifier + len_oid + oid in sig_binary
test_support.pkcs7_verify(
serialization.Encoding.DER,
sig_binary,
None,
[cert],
[],
)
def test_sign_no_capabilities(self, backend):
data = b"hello world"
cert, key = _load_cert_key()
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(cert, key, hashes.SHA256())
)
options = [pkcs7.PKCS7Options.NoCapabilities]
sig_binary = builder.sign(serialization.Encoding.DER, options)
# NoCapabilities removes the SMIMECapabilities attribute from the
# PKCS7 structure. This is an ASN.1 sequence with the
# OID 1.2.840.113549.1.9.15. It does NOT remove all authenticated
# attributes, so we verify that by looking for the signingTime OID.
# 1.2.840.113549.1.9.15 SMIMECapabilities as an ASN.1 DER encoded OID
assert b"\x06\t*\x86H\x86\xf7\r\x01\t\x0f" not in sig_binary
# 1.2.840.113549.1.9.5 signingTime as an ASN.1 DER encoded OID
assert b"\x06\t*\x86H\x86\xf7\r\x01\t\x05" in sig_binary
test_support.pkcs7_verify(
serialization.Encoding.DER,
sig_binary,
None,
[cert],
options,
)
def test_sign_no_attributes(self, backend):
data = b"hello world"
cert, key = _load_cert_key()
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(cert, key, hashes.SHA256())
)
options = [pkcs7.PKCS7Options.NoAttributes]
sig_binary = builder.sign(serialization.Encoding.DER, options)
# NoAttributes removes all authenticated attributes, so we shouldn't
# find SMIMECapabilities or signingTime.
# 1.2.840.113549.1.9.15 SMIMECapabilities as an ASN.1 DER encoded OID
assert b"\x06\t*\x86H\x86\xf7\r\x01\t\x0f" not in sig_binary
# 1.2.840.113549.1.9.5 signingTime as an ASN.1 DER encoded OID
assert b"\x06\t*\x86H\x86\xf7\r\x01\t\x05" not in sig_binary
test_support.pkcs7_verify(
serialization.Encoding.DER,
sig_binary,
None,
[cert],
options,
)
def test_sign_no_certs(self, backend):
data = b"hello world"
cert, key = _load_cert_key()
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(cert, key, hashes.SHA256())
)
options: typing.List[pkcs7.PKCS7Options] = []
sig = builder.sign(serialization.Encoding.DER, options)
assert sig.count(cert.public_bytes(serialization.Encoding.DER)) == 1
options = [pkcs7.PKCS7Options.NoCerts]
sig_no = builder.sign(serialization.Encoding.DER, options)
assert sig_no.count(cert.public_bytes(serialization.Encoding.DER)) == 0
@pytest.mark.parametrize(
"pad",
[
padding.PKCS1v15(),
None,
padding.PSS(
mgf=padding.MGF1(hashes.SHA512()),
salt_length=padding.PSS.DIGEST_LENGTH,
),
],
)
def test_rsa_pkcs_padding_options(self, pad, backend):
data = b"hello world"
rsa_key = load_vectors_from_file(
os.path.join("x509", "custom", "ca", "rsa_key.pem"),
lambda pemfile: serialization.load_pem_private_key(
pemfile.read(), None, unsafe_skip_rsa_key_validation=True
),
mode="rb",
)
assert isinstance(rsa_key, rsa.RSAPrivateKey)
rsa_cert = load_vectors_from_file(
os.path.join("x509", "custom", "ca", "rsa_ca.pem"),
loader=lambda pemfile: x509.load_pem_x509_certificate(
pemfile.read()
),
mode="rb",
)
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(rsa_cert, rsa_key, hashes.SHA512(), rsa_padding=pad)
)
options: typing.List[pkcs7.PKCS7Options] = []
sig = builder.sign(serialization.Encoding.DER, options)
# This should be a pkcs1 sha512 signature
if isinstance(pad, padding.PSS):
# PKCS7_verify can't verify a PSS sig and we don't bind CMS so
# we instead just check that a few things are present in the
# output.
# There should be four SHA512 OIDs in this structure
assert sig.count(b"\x06\t`\x86H\x01e\x03\x04\x02\x03") == 4
# There should be one MGF1 OID in this structure
assert (
sig.count(b"\x06\x09\x2a\x86\x48\x86\xf7\x0d\x01\x01\x08") == 1
)
else:
# This should be a pkcs1 RSA signature, which uses the
# `rsaEncryption` OID (1.2.840.113549.1.1.1) no matter which
# digest algorithm is used.
# See RFC 3370 section 3.2 for more details.
# This OID appears twice, once in the certificate itself and
# another in the SignerInfo data structure in the
# `digest_encryption_algorithm` field.
assert (
sig.count(b"\x06\x09\x2a\x86\x48\x86\xf7\x0d\x01\x01\x01") == 2
)
test_support.pkcs7_verify(
serialization.Encoding.DER,
sig,
None,
[rsa_cert],
options,
)
def test_not_rsa_key_with_padding(self, backend):
cert, key = _load_cert_key()
with pytest.raises(TypeError):
pkcs7.PKCS7SignatureBuilder().add_signer(
cert, key, hashes.SHA512(), rsa_padding=padding.PKCS1v15()
)
def test_rsa_invalid_padding(self, backend):
rsa_key = load_vectors_from_file(
os.path.join("x509", "custom", "ca", "rsa_key.pem"),
lambda pemfile: serialization.load_pem_private_key(
pemfile.read(), None, unsafe_skip_rsa_key_validation=True
),
mode="rb",
)
assert isinstance(rsa_key, rsa.RSAPrivateKey)
rsa_cert = load_vectors_from_file(
os.path.join("x509", "custom", "ca", "rsa_ca.pem"),
loader=lambda pemfile: x509.load_pem_x509_certificate(
pemfile.read()
),
mode="rb",
)
with pytest.raises(TypeError):
pkcs7.PKCS7SignatureBuilder().add_signer(
rsa_cert,
rsa_key,
hashes.SHA512(),
rsa_padding=object(), # type: ignore[arg-type]
)
def test_multiple_signers(self, backend):
data = b"hello world"
cert, key = _load_cert_key()
rsa_key = load_vectors_from_file(
os.path.join("x509", "custom", "ca", "rsa_key.pem"),
lambda pemfile: serialization.load_pem_private_key(
pemfile.read(), None, unsafe_skip_rsa_key_validation=True
),
mode="rb",
)
assert isinstance(rsa_key, rsa.RSAPrivateKey)
rsa_cert = load_vectors_from_file(
os.path.join("x509", "custom", "ca", "rsa_ca.pem"),
loader=lambda pemfile: x509.load_pem_x509_certificate(
pemfile.read()
),
mode="rb",
)
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(cert, key, hashes.SHA512())
.add_signer(rsa_cert, rsa_key, hashes.SHA512())
)
options: typing.List[pkcs7.PKCS7Options] = []
sig = builder.sign(serialization.Encoding.DER, options)
# There should be three SHA512 OIDs in this structure
assert sig.count(b"\x06\t`\x86H\x01e\x03\x04\x02\x03") == 3
test_support.pkcs7_verify(
serialization.Encoding.DER,
sig,
None,
[cert, rsa_cert],
options,
)
def test_multiple_signers_different_hash_algs(self, backend):
data = b"hello world"
cert, key = _load_cert_key()
rsa_key = load_vectors_from_file(
os.path.join("x509", "custom", "ca", "rsa_key.pem"),
lambda pemfile: serialization.load_pem_private_key(
pemfile.read(), None, unsafe_skip_rsa_key_validation=True
),
mode="rb",
)
rsa_cert = load_vectors_from_file(
os.path.join("x509", "custom", "ca", "rsa_ca.pem"),
loader=lambda pemfile: x509.load_pem_x509_certificate(
pemfile.read()
),
mode="rb",
)
assert isinstance(rsa_key, rsa.RSAPrivateKey)
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(cert, key, hashes.SHA384())
.add_signer(rsa_cert, rsa_key, hashes.SHA512())
)
options: typing.List[pkcs7.PKCS7Options] = []
sig = builder.sign(serialization.Encoding.DER, options)
# There should be two SHA384 and two SHA512 OIDs in this structure
assert sig.count(b"\x06\t`\x86H\x01e\x03\x04\x02\x02") == 2
assert sig.count(b"\x06\t`\x86H\x01e\x03\x04\x02\x03") == 2
test_support.pkcs7_verify(
serialization.Encoding.DER,
sig,
None,
[cert, rsa_cert],
options,
)
def test_add_additional_cert_not_a_cert(self, backend):
with pytest.raises(TypeError):
pkcs7.PKCS7SignatureBuilder().add_certificate(
b"notacert" # type: ignore[arg-type]
)
def test_add_additional_cert(self, backend):
data = b"hello world"
cert, key = _load_cert_key()
rsa_cert = load_vectors_from_file(
os.path.join("x509", "custom", "ca", "rsa_ca.pem"),
loader=lambda pemfile: x509.load_pem_x509_certificate(
pemfile.read()
),
mode="rb",
)
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(cert, key, hashes.SHA384())
.add_certificate(rsa_cert)
)
options: typing.List[pkcs7.PKCS7Options] = []
sig = builder.sign(serialization.Encoding.DER, options)
assert (
sig.count(rsa_cert.public_bytes(serialization.Encoding.DER)) == 1
)
def test_add_multiple_additional_certs(self, backend):
data = b"hello world"
cert, key = _load_cert_key()
rsa_cert = load_vectors_from_file(
os.path.join("x509", "custom", "ca", "rsa_ca.pem"),
loader=lambda pemfile: x509.load_pem_x509_certificate(
pemfile.read()
),
mode="rb",
)
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(cert, key, hashes.SHA384())
.add_certificate(rsa_cert)
.add_certificate(rsa_cert)
)
options: typing.List[pkcs7.PKCS7Options] = []
sig = builder.sign(serialization.Encoding.DER, options)
assert (
sig.count(rsa_cert.public_bytes(serialization.Encoding.DER)) == 2
)
def _load_rsa_cert_key():
key = load_vectors_from_file(
os.path.join("x509", "custom", "ca", "rsa_key.pem"),
lambda pemfile: serialization.load_pem_private_key(
pemfile.read(), None, unsafe_skip_rsa_key_validation=True
),
mode="rb",
)
cert = load_vectors_from_file(
os.path.join("x509", "custom", "ca", "rsa_ca.pem"),
loader=lambda pemfile: x509.load_pem_x509_certificate(pemfile.read()),
mode="rb",
)
return cert, key
@pytest.mark.supported(
only_if=lambda backend: backend.pkcs7_supported()
and backend.rsa_encryption_supported(padding.PKCS1v15()),
skip_message="Requires OpenSSL with PKCS7 support and PKCS1 v1.5 padding "
"support",
)
class TestPKCS7EnvelopeBuilder:
def test_invalid_data(self, backend):
builder = pkcs7.PKCS7EnvelopeBuilder()
with pytest.raises(TypeError):
builder.set_data("not bytes") # type: ignore[arg-type]
def test_set_data_twice(self, backend):
builder = pkcs7.PKCS7EnvelopeBuilder().set_data(b"test")
with pytest.raises(ValueError):
builder.set_data(b"test")
def test_encrypt_no_recipient(self, backend):
builder = pkcs7.PKCS7EnvelopeBuilder().set_data(b"test")
with pytest.raises(ValueError):
builder.encrypt(serialization.Encoding.SMIME, [])
def test_encrypt_no_data(self, backend):
cert, _ = _load_rsa_cert_key()
builder = pkcs7.PKCS7EnvelopeBuilder().add_recipient(cert)
with pytest.raises(ValueError):
builder.encrypt(serialization.Encoding.SMIME, [])
def test_unsupported_encryption(self, backend):
cert_non_rsa, _ = _load_cert_key()
with pytest.raises(TypeError):
pkcs7.PKCS7EnvelopeBuilder().add_recipient(cert_non_rsa)
def test_not_a_cert(self, backend):
with pytest.raises(TypeError):
pkcs7.PKCS7EnvelopeBuilder().add_recipient(
b"notacert", # type: ignore[arg-type]
)
def test_encrypt_invalid_options(self, backend):
cert, _ = _load_rsa_cert_key()
builder = (
pkcs7.PKCS7EnvelopeBuilder().set_data(b"test").add_recipient(cert)
)
with pytest.raises(ValueError):
builder.encrypt(
serialization.Encoding.SMIME,
[b"invalid"], # type: ignore[list-item]
)
def test_encrypt_invalid_encoding(self, backend):
cert, _ = _load_rsa_cert_key()
builder = (
pkcs7.PKCS7EnvelopeBuilder().set_data(b"test").add_recipient(cert)
)
with pytest.raises(ValueError):
builder.encrypt(serialization.Encoding.Raw, [])
@pytest.mark.parametrize(
"invalid_options",
[
[pkcs7.PKCS7Options.NoAttributes],
[pkcs7.PKCS7Options.NoCapabilities],
[pkcs7.PKCS7Options.NoCerts],
[pkcs7.PKCS7Options.DetachedSignature],
[pkcs7.PKCS7Options.Binary, pkcs7.PKCS7Options.Text],
],
)
def test_encrypt_invalid_encryption_options(
self, backend, invalid_options
):
cert, _ = _load_rsa_cert_key()
builder = (
pkcs7.PKCS7EnvelopeBuilder().set_data(b"test").add_recipient(cert)
)
with pytest.raises(ValueError):
builder.encrypt(serialization.Encoding.DER, invalid_options)
@pytest.mark.parametrize(
"options",
[
[pkcs7.PKCS7Options.Text],
[pkcs7.PKCS7Options.Binary],
],
)
def test_smime_encrypt_smime_encoding(self, backend, options):
data = b"hello world\n"
cert, private_key = _load_rsa_cert_key()
builder = (
pkcs7.PKCS7EnvelopeBuilder().set_data(data).add_recipient(cert)
)
enveloped = builder.encrypt(serialization.Encoding.SMIME, options)
assert b"MIME-Version: 1.0\n" in enveloped
assert b"Content-Transfer-Encoding: base64\n" in enveloped
message = email.parser.BytesParser().parsebytes(enveloped)
assert message.get_content_disposition() == "attachment"
assert message.get_filename() == "smime.p7m"
assert message.get_content_type() == "application/pkcs7-mime"
assert message.get_param("smime-type") == "enveloped-data"
assert message.get_param("name") == "smime.p7m"
payload = message.get_payload(decode=True)
assert isinstance(payload, bytes)
# We want to know if we've serialized something that has the parameters
# we expect, so we match on specific byte strings of OIDs & DER values.
# OID 2.16.840.1.101.3.4.1.2 (aes128-CBC)
assert b"\x06\x09\x60\x86\x48\x01\x65\x03\x04\x01\x02" in payload
# OID 1.2.840.113549.1.1.1 (rsaEncryption (PKCS #1))
assert b"\x06\x09\x2a\x86\x48\x86\xf7\x0d\x01\x01\x01" in payload
# cryptography CA (the recipient's Common Name)
assert (
b"\x0c\x0f\x63\x72\x79\x70\x74\x6f\x67\x72\x61\x70\x68\x79"
b"\x20\x43\x41"
) in payload
decrypted_bytes = pkcs7.pkcs7_decrypt_smime(
enveloped,
cert,
private_key,
[o for o in options if o != pkcs7.PKCS7Options.Binary],
)
# New lines are canonicalized to '\r\n' when not using Binary
expected_data = (
data
if pkcs7.PKCS7Options.Binary in options
else data.replace(b"\n", b"\r\n")
)
assert decrypted_bytes == expected_data
@pytest.mark.parametrize(
"options",
[
[pkcs7.PKCS7Options.Text],
[pkcs7.PKCS7Options.Binary],
],
)
def test_smime_encrypt_der_encoding(self, backend, options):
data = b"hello world\n"
cert, private_key = _load_rsa_cert_key()
builder = (
pkcs7.PKCS7EnvelopeBuilder().set_data(data).add_recipient(cert)
)
enveloped = builder.encrypt(serialization.Encoding.DER, options)
# We want to know if we've serialized something that has the parameters
# we expect, so we match on specific byte strings of OIDs & DER values.
# OID 2.16.840.1.101.3.4.1.2 (aes128-CBC)
assert b"\x06\x09\x60\x86\x48\x01\x65\x03\x04\x01\x02" in enveloped
# OID 1.2.840.113549.1.1.1 (rsaEncryption (PKCS #1))
assert b"\x06\x09\x2a\x86\x48\x86\xf7\x0d\x01\x01\x01" in enveloped
# cryptography CA (the recipient's Common Name)
assert (
b"\x0c\x0f\x63\x72\x79\x70\x74\x6f\x67\x72\x61\x70\x68\x79"
b"\x20\x43\x41"
) in enveloped
decrypted_bytes = pkcs7.pkcs7_decrypt_der(
enveloped,
cert,
private_key,
[o for o in options if o != pkcs7.PKCS7Options.Binary],
)
# New lines are canonicalized to '\r\n' when not using Binary
expected_data = (
data
if pkcs7.PKCS7Options.Binary in options
else data.replace(b"\n", b"\r\n")
)
assert decrypted_bytes == expected_data
@pytest.mark.parametrize(
"options",
[
[pkcs7.PKCS7Options.Text],
[pkcs7.PKCS7Options.Binary],
],
)
def test_smime_encrypt_pem_encoding(self, backend, options):
data = b"hello world\n"
cert, private_key = _load_rsa_cert_key()
builder = (
pkcs7.PKCS7EnvelopeBuilder().set_data(data).add_recipient(cert)
)
enveloped = builder.encrypt(serialization.Encoding.PEM, options)
decrypted_bytes = pkcs7.pkcs7_decrypt_pem(
enveloped,
cert,
private_key,
[o for o in options if o != pkcs7.PKCS7Options.Binary],
)
# New lines are canonicalized to '\r\n' when not using Binary
expected_data = (
data
if pkcs7.PKCS7Options.Binary in options
else data.replace(b"\n", b"\r\n")
)
assert decrypted_bytes == expected_data
def test_smime_encrypt_multiple_recipients(self, backend):
data = b"hello world\n"
cert, _ = _load_rsa_cert_key()
builder = (
pkcs7.PKCS7EnvelopeBuilder()
.set_data(data)
.add_recipient(cert)
.add_recipient(cert)
)
enveloped = builder.encrypt(serialization.Encoding.DER, [])
# cryptography CA (the recipient's Common Name)
common_name_bytes = (
b"\x0c\x0f\x63\x72\x79\x70\x74\x6f\x67\x72\x61"
b"\x70\x68\x79\x20\x43\x41"
)
assert enveloped.count(common_name_bytes) == 2
@pytest.mark.supported(
only_if=lambda backend: backend.pkcs7_supported()
and backend.rsa_encryption_supported(padding.PKCS1v15()),
skip_message="Requires OpenSSL with PKCS7 support and PKCS1 v1.5 padding "
"support",
)
class TestPKCS7Decrypt:
@pytest.fixture(name="data")
def fixture_data(self, backend) -> bytes:
return b"Hello world!\n"
@pytest.fixture(name="certificate")
def fixture_certificate(self, backend) -> x509.Certificate:
certificate, _ = _load_rsa_cert_key()
return certificate
@pytest.fixture(name="private_key")
def fixture_private_key(self, backend) -> rsa.RSAPrivateKey:
_, private_key = _load_rsa_cert_key()
return private_key
def test_unsupported_certificate_encryption(self, backend, private_key):
cert_non_rsa, _ = _load_cert_key()
with pytest.raises(TypeError):
pkcs7.pkcs7_decrypt_der(b"", cert_non_rsa, private_key, [])
def test_not_a_cert(self, backend, private_key):
with pytest.raises(TypeError):
pkcs7.pkcs7_decrypt_der(b"", b"wrong_type", private_key, []) # type: ignore[arg-type]
def test_not_a_pkey(self, backend, certificate):
with pytest.raises(TypeError):
pkcs7.pkcs7_decrypt_der(b"", certificate, b"wrong_type", []) # type: ignore[arg-type]
@pytest.mark.parametrize(
"invalid_options",
[
[b"invalid"],
[pkcs7.PKCS7Options.NoAttributes],
[pkcs7.PKCS7Options.Binary],
],
)
def test_pkcs7_decrypt_invalid_options(
self, backend, invalid_options, data, certificate, private_key
):
with pytest.raises(ValueError):
pkcs7.pkcs7_decrypt_der(
data, certificate, private_key, invalid_options
)
@pytest.mark.parametrize("options", [[], [pkcs7.PKCS7Options.Text]])
def test_pkcs7_decrypt_der(
self, backend, data, certificate, private_key, options
):
# Encryption
builder = (
pkcs7.PKCS7EnvelopeBuilder()
.set_data(data)
.add_recipient(certificate)
)
enveloped = builder.encrypt(serialization.Encoding.DER, options)
# Test decryption: new lines are canonicalized to '\r\n' when
# encryption has no Binary option
decrypted = pkcs7.pkcs7_decrypt_der(
enveloped, certificate, private_key, options
)
assert decrypted == data.replace(b"\n", b"\r\n")
@pytest.mark.parametrize(
"header",
[
"content-type: text/plain",
"CONTENT-TYPE: text/plain",
"MIME-Version: 1.0\r\nContent-Type: text/plain; charset='UTF-8'"
"\r\nContent-Transfer-Encoding: 7bit\r\nFrom: sender@example.com"
"\r\nTo: recipient@example.com\r\nSubject: Test Email",
],
)
def test_pkcs7_decrypt_der_text_handmade_header(
self, backend, certificate, private_key, header
):
# Encryption of data with a custom header
base_data = "Hello world!\r\n"
data = f"{header}\r\n\r\n{base_data}".encode()
builder = (
pkcs7.PKCS7EnvelopeBuilder()
.set_data(data)
.add_recipient(certificate)
)
enveloped = builder.encrypt(
serialization.Encoding.DER, [pkcs7.PKCS7Options.Binary]
)
# Test decryption with text option
decrypted = pkcs7.pkcs7_decrypt_der(
enveloped, certificate, private_key, [pkcs7.PKCS7Options.Text]
)
assert decrypted == base_data.encode()
@pytest.mark.parametrize("options", [[], [pkcs7.PKCS7Options.Text]])
def test_pkcs7_decrypt_pem(
self, backend, data, certificate, private_key, options
):
# Encryption
builder = (
pkcs7.PKCS7EnvelopeBuilder()
.set_data(data)
.add_recipient(certificate)
)
enveloped = builder.encrypt(serialization.Encoding.PEM, options)
# Test decryption: new lines are canonicalized to '\r\n' when
# encryption has no Binary option
decrypted = pkcs7.pkcs7_decrypt_pem(
enveloped, certificate, private_key, options
)
assert decrypted == data.replace(b"\n", b"\r\n")
def test_pkcs7_decrypt_pem_with_wrong_tag(
self, backend, data, certificate, private_key
):
with pytest.raises(ValueError):
pkcs7.pkcs7_decrypt_pem(
certificate.public_bytes(serialization.Encoding.PEM),
certificate,
private_key,
[],
)
@pytest.mark.parametrize("options", [[], [pkcs7.PKCS7Options.Text]])
def test_pkcs7_decrypt_smime(
self, backend, data, certificate, private_key, options
):
# Encryption
builder = (
pkcs7.PKCS7EnvelopeBuilder()
.set_data(data)
.add_recipient(certificate)
)
enveloped = builder.encrypt(serialization.Encoding.SMIME, options)
# Test decryption
decrypted = pkcs7.pkcs7_decrypt_smime(
enveloped, certificate, private_key, options
)
assert decrypted == data.replace(b"\n", b"\r\n")
def test_pkcs7_decrypt_no_encrypted_content(
self, backend, data, certificate, private_key
):
enveloped = load_vectors_from_file(
os.path.join("pkcs7", "enveloped-no-content.der"),
loader=lambda pemfile: pemfile.read(),
mode="rb",
)
# Test decryption with text option
with pytest.raises(ValueError):
pkcs7.pkcs7_decrypt_der(enveloped, certificate, private_key, [])
def test_pkcs7_decrypt_text_no_header(
self, backend, data, certificate, private_key
):
# Encryption of data without a header (no "Text" option)
builder = (
pkcs7.PKCS7EnvelopeBuilder()
.set_data(data)
.add_recipient(certificate)
)
enveloped = builder.encrypt(serialization.Encoding.DER, [])
# Test decryption with text option
with pytest.raises(ValueError):
pkcs7.pkcs7_decrypt_der(
enveloped, certificate, private_key, [pkcs7.PKCS7Options.Text]
)
def test_pkcs7_decrypt_text_html_content_type(
self, backend, certificate, private_key
):
# Encryption of data with a text/html content type header
data = b"Content-Type: text/html\r\n\r\nHello world!<br>"
builder = (
pkcs7.PKCS7EnvelopeBuilder()
.set_data(data)
.add_recipient(certificate)
)
enveloped = builder.encrypt(
serialization.Encoding.DER, [pkcs7.PKCS7Options.Binary]
)
# Test decryption with text option
with pytest.raises(ValueError):
pkcs7.pkcs7_decrypt_der(
enveloped, certificate, private_key, [pkcs7.PKCS7Options.Text]
)
def test_smime_decrypt_no_recipient_match(
self, backend, data, certificate, rsa_key_2048: rsa.RSAPrivateKey
):
# Encrypt some data with one RSA chain
builder = (
pkcs7.PKCS7EnvelopeBuilder()
.set_data(data)
.add_recipient(certificate)
)
enveloped = builder.encrypt(serialization.Encoding.DER, [])
# Prepare another RSA chain
another_private_key = RSA_KEY_2048_ALT.private_key(
unsafe_skip_rsa_key_validation=True
)
_, another_cert = _generate_ca_and_leaf(
rsa_key_2048, another_private_key
)
# Test decryption with another RSA chain
with pytest.raises(ValueError):
pkcs7.pkcs7_decrypt_der(
enveloped, another_cert, another_private_key, []
)
def test_smime_decrypt_unsupported_key_encryption_algorithm(
self, backend, data, certificate, private_key
):
enveloped = load_vectors_from_file(
os.path.join("pkcs7", "enveloped-rsa-oaep.pem"),
loader=lambda pemfile: pemfile.read(),
mode="rb",
)
with pytest.raises(exceptions.UnsupportedAlgorithm):
pkcs7.pkcs7_decrypt_pem(enveloped, certificate, private_key, [])
def test_smime_decrypt_unsupported_content_encryption_algorithm(
self, backend, data, certificate, private_key
):
enveloped = load_vectors_from_file(
os.path.join("pkcs7", "enveloped-aes-256-cbc.pem"),
loader=lambda pemfile: pemfile.read(),
mode="rb",
)
with pytest.raises(exceptions.UnsupportedAlgorithm):
pkcs7.pkcs7_decrypt_pem(enveloped, certificate, private_key, [])
def test_smime_decrypt_not_enveloped(
self, backend, data, certificate, private_key
):
# Create a signed email
cert, key = _load_cert_key()
options = [pkcs7.PKCS7Options.DetachedSignature]
builder = (
pkcs7.PKCS7SignatureBuilder()
.set_data(data)
.add_signer(cert, key, hashes.SHA256())
)
signed = builder.sign(serialization.Encoding.DER, options)
# Test decryption failure with signed email
with pytest.raises(ValueError):
pkcs7.pkcs7_decrypt_der(signed, certificate, private_key, [])
def test_smime_decrypt_smime_not_encrypted(
self, backend, certificate, private_key
):
# Create a plain email
email_message = EmailMessage()
email_message.set_content("Hello world!")
# Test decryption failure with plain email
with pytest.raises(ValueError):
pkcs7.pkcs7_decrypt_smime(
email_message.as_bytes(), certificate, private_key, []
)
@pytest.mark.supported(
only_if=lambda backend: backend.pkcs7_supported(),
skip_message="Requires OpenSSL with PKCS7 support",
)
class TestPKCS7SerializeCerts:
@pytest.mark.parametrize(
("encoding", "loader"),
[
(serialization.Encoding.PEM, pkcs7.load_pem_pkcs7_certificates),
(serialization.Encoding.DER, pkcs7.load_der_pkcs7_certificates),
],
)
def test_roundtrip(self, encoding, loader, backend):
certs = load_vectors_from_file(
os.path.join("pkcs7", "amazon-roots.der"),
lambda derfile: pkcs7.load_der_pkcs7_certificates(derfile.read()),
mode="rb",
)
p7 = pkcs7.serialize_certificates(certs, encoding)
certs2 = loader(p7)
assert certs == certs2
def test_ordering(self, backend):
certs = load_vectors_from_file(
os.path.join("pkcs7", "amazon-roots.der"),
lambda derfile: pkcs7.load_der_pkcs7_certificates(derfile.read()),
mode="rb",
)
p7 = pkcs7.serialize_certificates(
list(reversed(certs)), serialization.Encoding.DER
)
certs2 = pkcs7.load_der_pkcs7_certificates(p7)
assert certs == certs2
def test_pem_matches_vector(self, backend):
p7_pem = load_vectors_from_file(
os.path.join("pkcs7", "isrg.pem"),
lambda p: p.read(),
mode="rb",
)
certs = pkcs7.load_pem_pkcs7_certificates(p7_pem)
p7 = pkcs7.serialize_certificates(certs, serialization.Encoding.PEM)
assert p7 == p7_pem
def test_der_matches_vector(self, backend):
p7_der = load_vectors_from_file(
os.path.join("pkcs7", "amazon-roots.der"),
lambda p: p.read(),
mode="rb",
)
certs = pkcs7.load_der_pkcs7_certificates(p7_der)
p7 = pkcs7.serialize_certificates(certs, serialization.Encoding.DER)
assert p7 == p7_der
def test_invalid_types(self):
certs = load_vectors_from_file(
os.path.join("pkcs7", "amazon-roots.der"),
lambda derfile: pkcs7.load_der_pkcs7_certificates(derfile.read()),
mode="rb",
)
with pytest.raises(TypeError):
pkcs7.serialize_certificates(
object(), # type: ignore[arg-type]
serialization.Encoding.PEM,
)
with pytest.raises(TypeError):
pkcs7.serialize_certificates([], serialization.Encoding.PEM)
with pytest.raises(TypeError):
pkcs7.serialize_certificates(
certs,
"not an encoding", # type: ignore[arg-type]
)
@pytest.mark.supported(
only_if=lambda backend: not backend.pkcs7_supported(),
skip_message="Requires OpenSSL without PKCS7 support (BoringSSL)",
)
class TestPKCS7Unsupported:
def test_pkcs7_functions_unsupported(self):
with raises_unsupported_algorithm(_Reasons.UNSUPPORTED_SERIALIZATION):
pkcs7.load_der_pkcs7_certificates(b"nonsense")
with raises_unsupported_algorithm(_Reasons.UNSUPPORTED_SERIALIZATION):
pkcs7.load_pem_pkcs7_certificates(b"nonsense")
@pytest.mark.supported(
only_if=lambda backend: backend.pkcs7_supported()
and not backend.rsa_encryption_supported(padding.PKCS1v15()),
skip_message="Requires OpenSSL with no PKCS1 v1.5 padding support",
)
class TestPKCS7EnvelopeBuilderUnsupported:
def test_envelope_builder_unsupported(self, backend):
with raises_unsupported_algorithm(_Reasons.UNSUPPORTED_PADDING):
pkcs7.PKCS7EnvelopeBuilder()
@pytest.mark.supported(
only_if=lambda backend: backend.pkcs7_supported()
and not backend.rsa_encryption_supported(padding.PKCS1v15()),
skip_message="Requires OpenSSL with no PKCS1 v1.5 padding support",
)
class TestPKCS7DecryptUnsupported:
def test_pkcs7_decrypt_unsupported(self, backend):
cert, key = _load_rsa_cert_key()
with raises_unsupported_algorithm(_Reasons.UNSUPPORTED_PADDING):
pkcs7.pkcs7_decrypt_der(b"", cert, key, [])
|