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
|
#!/usr/bin/env python
import itertools
import os
import re
import sys
import unittest
from base64 import b64decode, b64encode
from concurrent.futures import ThreadPoolExecutor
from dataclasses import replace
from datetime import datetime
from glob import glob
from xml.etree import ElementTree as stdlibElementTree
import cryptography.exceptions
from cryptography.hazmat.primitives.asymmetric import dsa, ec, rsa
from cryptography.x509 import load_der_x509_certificate, load_pem_x509_certificate
from lxml import etree
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
from signxml import ( # noqa:E402
CanonicalizationMethod,
DigestAlgorithm,
InvalidCertificate,
InvalidDigest,
InvalidInput,
InvalidSignature,
SignatureConfiguration,
SignatureConstructionMethod,
SignatureMethod,
SignatureReference,
VerifyResult,
XMLSignatureProcessor,
XMLSigner,
XMLVerifier,
methods,
namespaces,
)
from signxml.util import ds_tag # noqa:E402
from signxml.xades import ( # noqa:E402
XAdESDataObjectFormat,
XAdESSignatureConfiguration,
XAdESSignaturePolicy,
XAdESSigner,
XAdESVerifier,
XAdESVerifyResult,
)
class XMLSignerWithSHA1(XMLSigner):
def check_deprecated_methods(self):
pass
sha1_ok = SignatureConfiguration(signature_methods=list(SignatureMethod), digest_algorithms=list(DigestAlgorithm))
hmac_only = SignatureConfiguration(
signature_methods=[sm for sm in SignatureMethod if "HMAC" in sm.name], digest_algorithms=list(DigestAlgorithm)
)
xades_sha1_ok = XAdESSignatureConfiguration(
signature_methods=list(SignatureMethod), digest_algorithms=list(DigestAlgorithm)
)
def reset_tree(t, method):
if not isinstance(t, str):
for s in t.findall(".//ds:Signature", namespaces=namespaces):
if method == methods.enveloped and s.get("Id") == "placeholder":
continue
s.getparent().remove(s)
def get_verifier_for_year(year: int):
class _Verifier(XMLVerifier):
def get_cert_chain_verifier(self, ca_pem_file):
verifier = super().get_cert_chain_verifier(ca_pem_file)
verifier.verification_time = datetime(year, 1, 1)
return verifier
return _Verifier()
class URIResolver(etree.Resolver):
def resolve(self, url, id, context):
print(f"Resolving URL '{url}'")
return None
parser = etree.XMLParser(load_dtd=True)
parser.resolvers.add(URIResolver())
interop_dir = os.path.join(os.path.dirname(__file__), "interop")
class LoadExampleKeys:
def load_example_keys(self):
with open(os.path.join(os.path.dirname(__file__), "example.pem"), "rb") as fh:
crt = fh.read()
with open(os.path.join(os.path.dirname(__file__), "example.key"), "rb") as fh:
key = fh.read()
return crt, key
class TestVerifyXML(unittest.TestCase, LoadExampleKeys):
def test_example_multi(self):
cert, _ = self.load_example_keys()
with open(os.path.join(os.path.dirname(__file__), "example.pem")) as fh:
cert = fh.read()
example_file = os.path.join(os.path.dirname(__file__), "example-125.xml")
XMLVerifier().verify(
data=etree.parse(example_file),
x509_cert=cert,
expect_references=2,
)
class TestSignXML(unittest.TestCase, LoadExampleKeys):
def setUp(self):
self.example_xml_files = (
os.path.join(os.path.dirname(__file__), "example.xml"),
os.path.join(os.path.dirname(__file__), "example2.xml"),
)
self.keys = dict(
hmac=b"secret",
rsa=rsa.generate_private_key(public_exponent=65537, key_size=2048),
dsa=dsa.generate_private_key(key_size=1024),
ecdsa=ec.generate_private_key(curve=ec.SECP384R1()),
)
def test_basic_signxml_statements(self):
self.assertEqual(SignatureMethod.RSA_SHA256.value, "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256")
self.assertEqual(SignatureConstructionMethod.enveloped, methods.enveloped)
with self.assertRaisesRegex(InvalidInput, "Unknown signature construction method"):
XMLSignerWithSHA1(method=None)
with self.assertRaisesRegex(InvalidInput, "must be an XML element"):
XMLSigner(signature_algorithm="hmac-sha256").sign("x", key=b"abc")
digest_algs = list(DigestAlgorithm)
sig_algs = list(SignatureMethod)
c14n_algs = {
"http://www.w3.org/2001/10/xml-exc-c14n#",
"http://www.w3.org/2001/10/xml-exc-c14n#WithComments",
}
def test_case(case):
digest_alg, sig_alg, method, c14n_alg = case
data = [etree.parse(f).getroot() for f in self.example_xml_files]
# FIXME: data.extend(stdlibElementTree.parse(f).getroot() for f in (self.example_xml_files)
data.append(stdlibElementTree.parse(self.example_xml_files[0]).getroot())
data.append("x y \n z t\n я\n")
for d in data:
if isinstance(d, str) and method != methods.enveloping:
continue
print(digest_alg.name, sig_alg.name, c14n_alg, method, type(d))
reset_tree(d, method)
signer = XMLSignerWithSHA1(
method=method,
signature_algorithm=sig_alg,
digest_algorithm=digest_alg,
c14n_algorithm=c14n_alg,
)
sig_alg_type = "rsa" if "RSA_MGF1" in sig_alg.name else sig_alg.name.split("_")[0].lower()
signed = signer.sign(
d, key=self.keys[sig_alg_type], reference_uri="URI" if method == methods.detached else None
)
# print(etree.tostring(signed))
hmac_key = self.keys["hmac"] if sig_alg_type == "hmac" else None
expect_config = hmac_only if sig_alg_type == "hmac" else sha1_ok
verify_kwargs = dict(
require_x509=False, hmac_key=hmac_key, validate_schema=True, expect_config=expect_config
)
if method == methods.detached:
def resolver(uri):
if isinstance(d, stdlibElementTree.Element):
return etree.fromstring(stdlibElementTree.tostring(d))
else:
return d
verify_kwargs["uri_resolver"] = resolver
signed_data = etree.tostring(signed)
XMLVerifier().verify(signed_data, **verify_kwargs)
XMLVerifier().verify(signed_data, parser=parser, **verify_kwargs)
res = XMLVerifier().verify(signed_data, id_attribute="Id", **verify_kwargs)
self.assertIsInstance(res, VerifyResult)
for attr in "signed_data", "signed_xml", "signature_xml":
self.assertTrue(hasattr(res, attr))
if res.signed_xml is not None:
# Ensure the signature is not part of the signed data
self.assertIsNone(res.signed_xml.find(".//{http://www.w3.org/2000/09/xmldsig#}Signature"))
self.assertNotEqual(res.signed_xml.tag, "{http://www.w3.org/2000/09/xmldsig#}Signature")
# Ensure the signature was returned
self.assertEqual(res.signature_xml.tag, "{http://www.w3.org/2000/09/xmldsig#}Signature")
if method == methods.enveloping:
with self.assertRaisesRegex(InvalidInput, "Unable to resolve reference URI"):
XMLVerifier().verify(signed_data, id_attribute="X", **verify_kwargs)
with self.assertRaisesRegex(InvalidInput, "Expected a X.509 certificate based signature"):
XMLVerifier().verify(
signed_data,
hmac_key=hmac_key,
uri_resolver=verify_kwargs.get("uri_resolver"),
expect_config=expect_config,
)
if method != methods.detached:
with self.assertRaisesRegex(InvalidSignature, "Digest mismatch"):
mangled_sig = signed_data.replace(b"Austria", b"Mongolia").replace(b"x y", b"a b")
XMLVerifier().verify(mangled_sig, **verify_kwargs)
with self.assertRaises(cryptography.exceptions.InvalidSignature):
mangled_sig = signed_data.replace(b"<ds:DigestValue>", b"<ds:DigestValue>!")
XMLVerifier().verify(mangled_sig, **verify_kwargs)
with self.assertRaises(cryptography.exceptions.InvalidSignature):
sig_value = re.search(b"<ds:SignatureValue>(.+?)</ds:SignatureValue>", signed_data).group(1)
mangled_sig = re.sub(
b"<ds:SignatureValue>(.+?)</ds:SignatureValue>",
b"<ds:SignatureValue>" + b64encode(b64decode(sig_value)[::-1]) + b"</ds:SignatureValue>",
signed_data,
)
XMLVerifier().verify(mangled_sig, **verify_kwargs)
with self.assertRaises(etree.XMLSyntaxError):
XMLVerifier().verify("", hmac_key=hmac_key, require_x509=False)
if sig_alg_type == "hmac":
with self.assertRaisesRegex(InvalidSignature, "Signature mismatch"):
verify_kwargs["hmac_key"] = b"SECRET"
XMLVerifier().verify(signed_data, **verify_kwargs)
executor = ThreadPoolExecutor()
for _ in executor.map(test_case, itertools.product(digest_algs, sig_algs, methods, c14n_algs)):
pass
def test_x509_certs(self):
verifier = get_verifier_for_year(2015)
tree = etree.parse(self.example_xml_files[0])
ca_pem_file = os.path.join(os.path.dirname(__file__), "example-ca.pem").encode("utf-8")
crt, key = self.load_example_keys()
for method in methods.enveloped, methods.enveloping:
data = tree.getroot()
reset_tree(data, method)
signer = XMLSigner(method=method, signature_algorithm=SignatureMethod.RSA_SHA256)
signed = signer.sign(data, key=key, cert=crt)
signed_data = etree.tostring(signed)
verifier.verify(signed_data, x509_cert=crt)
verifier.verify(signed_data, x509_cert=load_pem_x509_certificate(crt))
verifier.verify(signed_data, x509_cert=crt, cert_subject_name="*.example.com")
with self.assertRaises(ValueError):
verifier.verify(signed_data, x509_cert=crt[::-1])
with self.assertRaises(InvalidSignature):
verifier.verify(signed_data, x509_cert=crt, cert_subject_name="test")
# FIXME: create new test case with reconfigured CA/EKU
with self.assertRaisesRegex(InvalidCertificate, "required EKU not found"):
verifier.verify(signed_data, ca_pem_file=ca_pem_file)
with self.assertRaisesRegex(InvalidCertificate, "required EKU not found"):
verifier.verify(signed_data)
# TODO: negative: verify with wrong cert, wrong CA
def test_xmldsig_interop_examples(self):
ca_pem_file = os.path.join(os.path.dirname(__file__), "interop", "cacert.pem").encode("utf-8")
verifier = get_verifier_for_year(2015)
for signature_file in glob(os.path.join(os.path.dirname(__file__), "interop", "*.xml")):
print("Verifying", signature_file)
with open(signature_file, "rb") as fh:
msg = "basicConstraints.cA must not be asserted in an EE certificate"
with self.assertRaisesRegex(InvalidCertificate, msg):
verifier.verify(fh.read(), ca_pem_file=ca_pem_file, expect_config=sha1_ok)
def test_xmldsig_interop_TR2012(self):
def get_x509_cert(**kwargs):
with open(os.path.join(interop_dir, "TR2012", "rsa-cert.der"), "rb") as fh:
return [load_der_x509_certificate(fh.read())]
signature_files = glob(os.path.join(interop_dir, "TR2012", "signature*.xml"))
for signature_file in signature_files:
print("Verifying", signature_file)
with open(signature_file, "rb") as fh:
try:
sig = fh.read()
XMLVerifier().verify(
sig,
require_x509=False,
hmac_key=b"testkey" if "hmac" in signature_file else None,
validate_schema=True,
cert_resolver=get_x509_cert if "x509digest" in signature_file else None,
expect_config=hmac_only if "hmac" in signature_file else sha1_ok,
)
sig.decode("utf-8")
except Exception as e:
if "keyinforeference" in signature_file:
print("Unsupported test case:", type(e), e)
elif "x509digest" in signature_file:
assert isinstance(e, InvalidCertificate)
else:
raise
def test_xmldsig_interop(self):
def resolver(uri):
if uri == "document.xml":
with open(os.path.join(interop_dir, "phaos-xmldsig-three", uri), "rb") as fh:
return fh.read()
elif uri == "http://www.ietf.org/rfc/rfc3161.txt":
with open(os.path.join(os.path.dirname(__file__), "rfc3161.txt"), "rb") as fh:
return fh.read()
return None
def get_x509_cert(signature_file):
if "windows_store_signature" in signature_file:
return open(os.path.join(interop_dir, "xml-crypto", "windows_store_certificate.pem")).read()
elif "pyXMLSecurity" in signature_file:
return open(os.path.join(interop_dir, "pyXMLSecurity", "test.pem")).read()
else:
return None
def get_ca_pem_file(signature_file):
if "signature-dsa" in signature_file:
ca_pem_file = os.path.join(interop_dir, "phaos-xmldsig-three", "certs", "dsa-ca-cert.pem")
elif "signature-rsa" in signature_file:
ca_pem_file = os.path.join(interop_dir, "phaos-xmldsig-three", "certs", "rsa-ca-cert.pem")
elif "aleksey-xmldsig-01-enveloped" in signature_file:
ca_pem_file = os.path.join(interop_dir, "aleksey-xmldsig-01-enveloped", "cacert.pem")
elif "aleksey" in signature_file:
ca_pem_file = os.path.join(interop_dir, "aleksey-xmldsig-01", "cacert.pem")
elif "wsfederation_metadata" in signature_file:
ca_pem_file = os.path.join(interop_dir, "xml-crypto", "wsfederation_metadata.pem")
elif "signature_with_inclusivenamespaces" in signature_file:
ca_pem_file = os.path.join(interop_dir, "xml-crypto", "signature_with_inclusivenamespaces.pem")
else:
return None
return ca_pem_file.encode("utf-8")
def cert_resolver(x509_issuer_name, x509_serial_number, x509_digest):
with open(os.path.join(interop_dir, "phaos-xmldsig-three", "certs", "rsa-cert.pem")) as fh:
return [fh.read()]
signature_files = glob(os.path.join(interop_dir, "*", "signature*.xml"))
signature_files += glob(os.path.join(interop_dir, "aleksey*", "*.xml"))
signature_files += glob(os.path.join(interop_dir, "xml-crypto", "*.xml"))
signature_files += glob(os.path.join(interop_dir, "pyXMLSecurity", "*.xml"))
for signature_file in signature_files:
print("Verifying", signature_file)
hmac_key = None
expect_config = sha1_ok
if "hmac" in signature_file:
hmac_key = b"test" if "phaos" in signature_file else b"secret"
expect_config = hmac_only
with open(signature_file, "rb") as fh:
try:
sig = fh.read()
verifier = get_verifier_for_year(2010 if "phaos" in signature_file else 2014)
verifier.excise_empty_xmlns_declarations = True
verifier.verify(
sig,
require_x509=False,
hmac_key=hmac_key,
validate_schema=True,
uri_resolver=resolver,
x509_cert=get_x509_cert(signature_file),
cert_resolver=cert_resolver if "issuer-serial" in signature_file else None,
ca_pem_file=get_ca_pem_file(signature_file),
expect_config=expect_config,
)
decoded_sig = sig.decode("utf-8")
if "HMACOutputLength" in decoded_sig or "bad" in signature_file or "expired" in signature_file:
raise BaseException("Expected an exception to occur")
except Exception as e:
unsupported_cases = (
"xpath-transform",
"xslt-transform",
"xpointer",
"x509-data-ski",
"x509-data-subject-name",
"x509data",
"signature-x509-ski",
"signature-x509-is",
)
bad_interop_cases = (
"signature-big",
"enveloping-dsa-x509chain",
"enveloping-sha512-hmac-sha512",
"enveloping-sha512-rsa-sha512",
"enveloping-rsa-x509chain",
"enveloping-sha1-rsa-sha1",
"enveloping-sha224-rsa-sha224",
"enveloping-sha256-rsa-sha256",
"enveloping-sha384-rsa-sha384",
)
if signature_file.endswith("expired-cert.xml") or signature_file.endswith(
"wsfederation_metadata.xml"
): # noqa
with self.assertRaisesRegex(InvalidCertificate, "cert is not valid at validation time"):
raise
elif signature_file.endswith("invalid_enveloped_transform.xml"):
self.assertIsInstance(e, InvalidSignature)
# with self.assertRaisesRegex(ValueError, "Can't remove the root signature node"):
# raise
elif "md5" in signature_file or "ripemd160" in signature_file:
self.assertIsInstance(e, InvalidInput)
# with self.assertRaisesRegex(InvalidInput, "Algorithm .+ is not recognized"):
# raise
elif "HMACOutputLength" in sig.decode("utf-8"):
self.assertIsInstance(e, (InvalidSignature, InvalidDigest))
elif signature_file.endswith("signature-rsa-enveloped-bad-digest-val.xml"):
# self.assertIsInstance(e, InvalidDigest)
self.assertIsInstance(e, InvalidCertificate)
elif signature_file.endswith("signature-rsa-detached-xslt-transform-bad-retrieval-method.xml"):
self.assertIsInstance(e, InvalidInput)
elif signature_file.endswith("signature-rsa-enveloped-bad-sig.xml"):
self.assertIsInstance(e, etree.DocumentInvalid)
elif signature_file.endswith("signature-x509-crt.xml"):
self.assertIsInstance(e, InvalidCertificate)
elif signature_file.endswith("signature-keyname.xml"):
self.assertIsInstance(e, InvalidInput)
elif signature_file.endswith("signature-x509-sn.xml"):
self.assertIsInstance(e, InvalidInput)
elif signature_file.endswith("signature-x509-crt-crl.xml"):
self.assertIsInstance(e, InvalidCertificate)
elif signature_file.endswith("signature-retrievalmethod-rawx509crt.xml"):
self.assertIsInstance(e, InvalidInput)
elif signature_file.endswith("merlin-xmldsig-twenty-three/signature.xml"):
self.assertIsInstance(e, InvalidInput)
elif any(x in signature_file for x in unsupported_cases):
print("Unsupported test case:", type(e), e)
elif any(x in signature_file for x in bad_interop_cases) or "Unable to resolve reference" in str(e):
print("Bad interop test case:", type(e), e)
elif "Certificate is missing required extension" in str(e):
print("IGNORED:", type(e), e)
elif "certificate must be an X509v3 certificate" in str(e):
print("IGNORED:", type(e), e)
elif "basicConstraints.cA must not be asserted in an EE certificate" in str(e):
print("IGNORED:", type(e), e)
elif "TR2012" not in signature_file:
raise
def test_changing_signature_namespace_prefix(self):
data = etree.parse(self.example_xml_files[0]).getroot()
signer = XMLSigner()
signer.namespaces = dict(digi_sign=namespaces["ds"])
signed = signer.sign(data, key=self.keys["rsa"])
signed_data = etree.tostring(signed)
expected_match = f'<digi_sign:Signature xmlns:digi_sign="{namespaces["ds"]}">'
self.assertTrue(re.search(expected_match.encode("ascii"), signed_data))
def test_changing_signature_namespace_prefix_to_default(self):
data = etree.parse(self.example_xml_files[0]).getroot()
signer = XMLSigner()
ns = dict()
ns[None] = namespaces["ds"]
signer.namespaces = ns
signed = signer.sign(data, key=self.keys["rsa"])
signed_data = etree.tostring(signed)
expected_match = f'<Signature xmlns="{namespaces["ds"]}">'
self.assertTrue(re.search(expected_match.encode("ascii"), signed_data))
def test_elementtree_compat(self):
data = stdlibElementTree.parse(self.example_xml_files[0]).getroot()
signer = XMLSigner()
signer.sign(data, key=self.keys["rsa"])
saml_test_vectors = [
"""<samlp:Response xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol"
xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion" ID="responseId">
<saml:Assertion xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema" ID="assertionId">
<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#" Id="placeholder" />
</saml:Assertion>
</samlp:Response>""",
"""<samlp:Response xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol"
xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion" Id="responseId">
<saml:Assertion xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema" Id="assertionId">
<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#" Id="placeholder" />
</saml:Assertion>
<saml:Assertion xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema" Id="assertion2">
</saml:Assertion>
</samlp:Response>""",
]
def test_reference_uris_and_custom_key_info(self):
crt, key = self.load_example_keys()
# Both ID and Id formats. XPath 1 doesn't have case insensitive attribute search
for d in self.saml_test_vectors:
data = etree.fromstring(d)
reference_uri = ["assertionId", "assertion2"] if "assertion2" in d else "assertionId"
signed_root = XMLSigner().sign(data, reference_uri=reference_uri, key=key, cert=crt)
res = XMLVerifier().verify(etree.tostring(signed_root), x509_cert=crt, expect_references=True)
signed_data_root = res.signed_xml
ref = signed_root.xpath(
"/samlp:Response/saml:Assertion/ds:Signature/ds:SignedInfo/ds:Reference",
namespaces={
"ds": "http://www.w3.org/2000/09/xmldsig#",
"saml": "urn:oasis:names:tc:SAML:2.0:assertion",
"samlp": "urn:oasis:names:tc:SAML:2.0:protocol",
},
)
self.assertEqual("assertionId", ref[0].attrib["URI"][1:])
self.assertEqual("{urn:oasis:names:tc:SAML:2.0:assertion}Assertion", signed_data_root.tag)
# Also test with detached signing
ref_xpath = "/ds:Signature/ds:SignedInfo/ds:Reference"
signer = XMLSigner(method=methods.detached)
s = signer.sign(data, reference_uri=reference_uri, key=key, cert=crt)
self.assertTrue(s.xpath(ref_xpath + "/ds:Transforms", namespaces=namespaces))
self.assertTrue(s.xpath(ref_xpath + "/ds:DigestMethod", namespaces=namespaces))
self.assertTrue(s.xpath(ref_xpath + "/ds:DigestValue", namespaces=namespaces))
self.assertTrue(s.xpath("/ds:Signature/ds:KeyInfo/ds:X509Data", namespaces=namespaces))
self.assertFalse(s.xpath("/ds:Signature/ds:KeyInfo/ds:KeyValue", namespaces=namespaces))
s2 = signer.sign(data, reference_uri=reference_uri, key=key, cert=crt, always_add_key_value=True)
self.assertTrue(s2.xpath("/ds:Signature/ds:KeyInfo/ds:X509Data", namespaces=namespaces))
self.assertTrue(s2.xpath("/ds:Signature/ds:KeyInfo/ds:KeyValue", namespaces=namespaces))
# Test setting custom key info
wsse_ns = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
with open(os.path.join(os.path.dirname(__file__), "wsse_keyinfo.xml")) as fh:
custom_key_info = etree.fromstring(fh.read())
s3 = signer.sign(data, reference_uri=reference_uri, key=key, cert=crt, key_info=custom_key_info)
self.assertTrue(
s3.xpath(
"/ds:Signature/ds:KeyInfo/wsse:SecurityTokenReference", namespaces=dict(namespaces, wsse=wsse_ns)
)
)
# Test setting both X509Data and KeyInfo
s4 = XMLSigner().sign(data, reference_uri=reference_uri, key=key, cert=crt, always_add_key_value=True)
try:
XMLVerifier().verify(s4, x509_cert=crt)
except InvalidSignature as e:
self.assertIn("Expected to find 1 references, but found 2", str(e))
expect_refs = etree.tostring(s4).decode().count("<ds:Reference")
XMLVerifier().verify(s4, x509_cert=crt, ignore_ambiguous_key_info=True, expect_references=expect_refs)
def test_inclusive_namespaces_signing(self):
# Test exclusive canonicalization with InclusiveNamespace PrefixList
data = etree.fromstring(self.saml_test_vectors[0])
reference_uri = "assertionId"
signer = XMLSigner(
c14n_algorithm=CanonicalizationMethod.EXCLUSIVE_XML_CANONICALIZATION_1_0,
signature_algorithm=SignatureMethod.HMAC_SHA256,
)
sign_args = dict(data=data, reference_uri=reference_uri, key=b"secret")
signed_with_insp = signer.sign(inclusive_ns_prefixes=["saml", "samlp", "ds"], **sign_args)
self.assertEqual(
signed_with_insp.find(".//ds:SignatureValue", namespaces=namespaces).text,
"V3HwLySk6TmkPFlqtOU3xCln1Cga7v30rFqy8ZmJITA=",
)
signed_without_insp = signer.sign(**sign_args)
self.assertEqual(
signed_without_insp.find(".//ds:SignatureValue", namespaces=namespaces).text,
"2Sk3E2SZwQCqX2STDkplw5JJp1ATAB5wsdRdQBAe/7o=",
)
# Test different c14n methods for signature and payload
ref = SignatureReference(
URI=reference_uri, c14n_method=CanonicalizationMethod.EXCLUSIVE_XML_CANONICALIZATION_1_0
)
sign_args = dict(data=data, reference_uri=[ref], key=b"secret")
signed = signer.sign(**sign_args)
self.assertEqual(
signed.find(".//ds:SignatureValue", namespaces=namespaces).text,
"2Sk3E2SZwQCqX2STDkplw5JJp1ATAB5wsdRdQBAe/7o=",
)
sign_args["reference_uri"][0] = replace(
sign_args["reference_uri"][0], c14n_method=CanonicalizationMethod.CANONICAL_XML_1_0
)
signed2 = signer.sign(**sign_args)
self.assertEqual(
signed2.find(".//ds:SignatureValue", namespaces=namespaces).text,
"8GPAVJstDxHyuoJqec8C0ssji4zfdXanu1YHGlWbfx0=",
)
# Test correct default c14n method for payload when c14n transform metadata is omitted
def _build_transforms_for_reference(transforms_node, reference):
etree.SubElement(
transforms_node, ds_tag("Transform"), Algorithm=SignatureConstructionMethod.enveloped.value
)
signer._build_transforms_for_reference = _build_transforms_for_reference
signed3 = signer.sign(**sign_args)
self.assertEqual(
signed3.find(".//ds:SignatureValue", namespaces=namespaces).text,
"/iezjApGBVMMUspj5WyZwIOEw30qLX3Gv576vwFMAbQ=",
)
XMLVerifier().verify(signed3, hmac_key=b"secret", require_x509=False)
def test_excision_of_untrusted_comments(self):
pass # TODO: test comments excision
def test_ws_security(self):
wsse_dir = os.path.join(interop_dir, "ws-security", "ws.js")
with open(os.path.join(wsse_dir, "examples", "server_public.pem"), "rb") as fh:
crt = fh.read()
data = etree.parse(os.path.join(wsse_dir, "test", "unit", "client", "files", "valid wss resp.xml"))
XMLVerifier().verify(data, x509_cert=crt, validate_schema=False, expect_references=2, expect_config=sha1_ok)
data = etree.parse(
os.path.join(wsse_dir, "test", "unit", "client", "files", "invalid wss resp - changed content.xml")
)
with self.assertRaisesRegex(InvalidDigest, "Digest mismatch for reference 0"):
XMLVerifier().verify(data, x509_cert=crt, validate_schema=False, expect_references=2, expect_config=sha1_ok)
def test_psha1(self):
from signxml.util import p_sha1
a, b, c, d = (
"grrlUUfhuNwlvQzQ4bV6TT3wA8ieZPltIf4+H7nIvCE=",
"YLABh3ZmZyiO5gvVLZe9J4JPd9w59KGeTFwE85XlzxE=",
"Wv3QzY84KfgwSkn1z3QV+LXEoo3nPraZPysJYtA3u4c=",
"g/uYZmYX7rOm/X7UV4usrvjIPCiWMWwNZJL0ejvz6Y4=",
)
self.assertEqual(p_sha1(a, b), c)
self.assertEqual(p_sha1(b, a), d)
def test_xml_attacks(self):
for filename in glob(os.path.join(os.path.dirname(__file__), "defusedxml-test-data", "*.xml")):
with open(filename, "rb") as fh:
with self.assertRaises((InvalidInput, etree.XMLSyntaxError)):
XMLVerifier().verify(fh.read())
def test_signature_properties_with_detached_method(self):
doc = etree.Element("Test", attrib={"Id": "mytest"})
sigprop = etree.Element("{http://somenamespace}MyCustomProperty")
sigprop.text = "Some Text"
cert, key = self.load_example_keys()
signature = XMLSigner(method=methods.detached).sign(
doc, cert=cert, key=key, reference_uri="#mytest", signature_properties=sigprop
)
fulldoc = b"<root>" + etree.tostring(signature) + etree.tostring(doc) + b"</root>"
XMLVerifier().verify(etree.fromstring(fulldoc), x509_cert=cert, expect_references=2)
def test_signature_properties_with_detached_method_re_enveloping(self):
doc = etree.Element("{http://somenamespace}Test", attrib={"Id": "mytest"})
sigprop = etree.Element("{http://somenamespace}MyCustomProperty")
sigprop.text = "Some Text"
cert, key = self.load_example_keys()
signer = XMLSigner(method=methods.detached, c14n_algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315")
signer.namespaces["ns0"] = "http://enveloping.namespace"
signature = signer.sign(doc, cert=cert, key=key, reference_uri="#mytest", signature_properties=sigprop)
fulldoc = (
b'<ns0:root xmlns:ns0="http://enveloping.namespace">'
+ etree.tostring(signature)
+ etree.tostring(doc)
+ b"</ns0:root>"
)
XMLVerifier().verify(etree.fromstring(fulldoc), x509_cert=cert, expect_references=2)
def test_payload_c14n(self):
doc = etree.fromstring('<abc xmlns="http://example.com"><foo xmlns="">bar</foo></abc>')
self.assertEqual(
XMLSignatureProcessor()._c14n(doc, algorithm=CanonicalizationMethod.CANONICAL_XML_1_1),
b'<abc xmlns="http://example.com"><foo xmlns="">bar</foo></abc>',
)
def test_xmlns_insulation_of_reference_c14n(self):
cert, key = self.load_example_keys()
doc = etree.fromstring(
'<rDE xmlns="http://example.com/ns1">'
'<DE Id="target"><dDVId>9</dDVId><gOpeDE><iTipEmi>1</iTipEmi></gOpeDE></DE>'
"</rDE>"
)
root = XMLSigner().sign(doc, cert=cert, key=key, reference_uri="#target")
XMLVerifier().verify(root, x509_cert=cert)
def test_verify_config(self):
data = etree.parse(self.example_xml_files[0]).getroot()
cert, key = self.load_example_keys()
signer = XMLSigner()
signed = signer.sign(data, cert=cert, key=key)
verifier = XMLVerifier()
verifier.verify(signed, x509_cert=cert)
config = SignatureConfiguration(location="./foo/bar/")
with self.assertRaisesRegex(InvalidInput, "Expected to find XML element Signature in data"):
verifier.verify(signed, x509_cert=cert, expect_config=config)
config = SignatureConfiguration(signature_methods=[])
with self.assertRaisesRegex(InvalidInput, "Signature method RSA_SHA256 forbidden by configuration"):
verifier.verify(signed, x509_cert=cert, expect_config=config)
config = SignatureConfiguration(digest_algorithms=[DigestAlgorithm.SHA3_512])
with self.assertRaisesRegex(InvalidInput, "Digest algorithm SHA256 forbidden by configuration"):
verifier.verify(signed, x509_cert=cert, expect_config=config)
config = SignatureConfiguration(digest_algorithms=[])
with self.assertRaisesRegex(InvalidInput, "Digest algorithm SHA256 forbidden by configuration"):
verifier.verify(signed, x509_cert=cert, expect_config=config)
def test_sha1_policy(self):
data = etree.parse(self.example_xml_files[0]).getroot()
cert, key = self.load_example_keys()
with self.assertRaisesRegex(InvalidInput, "SHA1-based algorithms are not supported"):
XMLSigner(signature_algorithm=SignatureMethod.RSA_SHA1)
signer = XMLSignerWithSHA1(signature_algorithm=SignatureMethod.RSA_SHA1, digest_algorithm=DigestAlgorithm.SHA1)
signed = signer.sign(data, cert=cert, key=key)
verifier = XMLVerifier()
with self.assertRaisesRegex(InvalidInput, "Signature method RSA_SHA1 forbidden by configuration"):
verifier.verify(signed, x509_cert=cert)
verifier.verify(signed, x509_cert=cert, expect_config=sha1_ok)
class TestXAdES(unittest.TestCase, LoadExampleKeys):
expect_references = {
"factura_ejemplo2_32v1.xml": 3,
"dss1770.xml": 3,
"xades-fake-counter-signature.xml": 3,
"Signature-X-SK_DIT-1.xml": 5,
"Signature-X-HR_FIN-1.xml": 5,
"TEST_S1a_C1a_InTL_VALID.xml": 3,
"Signature-X-CZ_SEF-4.xml": 4,
"Signature-X-FR_NOT-3.xml": 3,
"Signature-X-CZ_SEF-5.xml": 4,
"xades-counter-signature-injected.xml": 3,
"11068_signed.xml": 3,
"signature_property_signed.xml": 3,
"nonconformant-Signature-X-ES-100.xml": 3,
"nonconformant-Signature-X-ES-103.xml": 3,
"nonconformant-dss1770.xml": 3,
}
signature_policy = XAdESSignaturePolicy(
Identifier="urn:sbr:signature-policy:xml:2.0",
Description="Test description",
DigestMethod=DigestAlgorithm.SHA256,
DigestValue="sVHhN1eqNH/PZ1B6h//ehyC1OwRQOrz/tJ3ZYaRrBgA=",
)
claimed_roles = ["signer"]
data_object_format = XAdESDataObjectFormat(Description="Important Document", MimeType="text/xml")
def test_xades_roundtrip(self):
cert, key = self.load_example_keys()
with open(os.path.join(os.path.dirname(__file__), "example.xml"), "rb") as fh:
doc = etree.parse(fh)
signer = XAdESSigner(
signature_policy=self.signature_policy,
claimed_roles=self.claimed_roles,
data_object_format=self.data_object_format,
)
signed_doc = signer.sign(doc, key=key, cert=cert)
for ref in signed_doc.findall(".//{http://www.w3.org/2000/09/xmldsig#}Reference"):
if "SignedProperties" in ref.get("URI"):
self.assertEqual(ref.get("Type"), "http://uri.etsi.org/01903#SignedProperties")
verifier = XAdESVerifier()
verify_results = verifier.verify(
signed_doc, x509_cert=cert, expect_references=3, expect_signature_policy=self.signature_policy
)
self.assertIsInstance(verify_results[1], XAdESVerifyResult)
self.assertTrue(hasattr(verify_results[1], "signed_properties"))
def test_xades_interop_examples(self):
error_conditions = {
"altered": InvalidSignature,
"newlines": InvalidSignature,
"unsupported-signature-algorithm": InvalidInput,
"corrupted-cert": etree.DocumentInvalid, # FIXME - flaky validation
"cert-v2-wrong-digest": InvalidDigest,
"wrong-sign-cert-digest": InvalidDigest,
"nonconformant-X_BE_CONN_10": InvalidDigest,
"sigPolStore-noDigest": InvalidInput,
}
for sig_file in glob(os.path.join(os.path.dirname(__file__), "xades", "*.xml")):
print("Verifying", sig_file)
with open(sig_file, "rb") as fh:
doc = etree.parse(fh)
cert = doc.find(".//{http://www.w3.org/2000/09/xmldsig#}X509Certificate").text
kwargs = dict(
x509_cert=cert,
expect_references=self.expect_references.get(os.path.basename(sig_file), 2),
expect_config=xades_sha1_ok,
)
if "nonconformant" in sig_file:
kwargs.update(validate_schema=False)
if "sigPolStore" in sig_file:
kwargs.update(expect_signature_policy=self.signature_policy)
for condition, error in error_conditions.items():
if condition in sig_file:
with self.assertRaises(error):
XAdESVerifier().verify(doc, **kwargs)
break
else:
XAdESVerifier().verify(doc, **kwargs)
if __name__ == "__main__":
unittest.main()
|