moxml 0.1.25 → 0.1.26

data/spec/moxml/signature/key_extractor_spec.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "moxml/signature"
+require "openssl"
+
+RSpec.describe Moxml::Signature::KeyExtractor do
+  let(:extractor) { described_class.new }
+
+  describe "RSAKeyValue" do
+    let(:rsa_key) { OpenSSL::PKey::RSA.generate(2048) }
+
+    it "reconstructs a public RSA key from Modulus and Exponent" do
+      require "base64"
+      n_b64 = Base64.strict_encode64(rsa_key.n.to_s(2))
+      e_b64 = Base64.strict_encode64(rsa_key.e.to_s(2))
+      key_value = Moxml::Signature::Model::KeyValue.new(
+        rsa_key_value: Moxml::Signature::Model::Key::RSAKeyValue.new(
+          modulus: n_b64,
+          exponent: e_b64,
+        ),
+      )
+      key_info = Moxml::Signature::Model::KeyInfo.new(key_value: key_value)
+      extracted = extractor.extract(key_info)
+      expect(extracted).to be_a(OpenSSL::PKey::RSA)
+      expect(extracted.n).to eq(rsa_key.n)
+      expect(extracted.e).to eq(rsa_key.e)
+    end
+  end
+
+  describe "X509Certificate" do
+    let(:rsa_key) { OpenSSL::PKey::RSA.generate(2048) }
+    let(:cert) do
+      # Generate a self-signed cert so we can round-trip the DER.
+      cert = OpenSSL::X509::Certificate.new
+      cert.version = 2
+      cert.serial = 1
+      cert.subject = OpenSSL::X509::Name.parse("/CN=test")
+      cert.issuer = cert.subject
+      cert.public_key = rsa_key
+      cert.not_before = Time.now
+      cert.not_after = Time.now + 3600
+      cert.sign(rsa_key, OpenSSL::Digest.new("SHA256"))
+      cert
+    end
+
+    it "extracts the public key from the certificate" do
+      require "base64"
+      key_info = Moxml::Signature::Model::KeyInfo.new(
+        x509_data: Moxml::Signature::Model::Key::X509Data.new(
+          # X509Certificate is stored as base64-encoded DER (spec §4.5.4).
+          certificates: [Base64.strict_encode64(cert.to_der)],
+        ),
+      )
+      extracted = extractor.extract(key_info)
+      expect(extracted).to be_a(OpenSSL::PKey::RSA)
+      expect(extracted.n).to eq(rsa_key.n)
+    end
+  end
+
+  describe "KeyName" do
+    it "looks up the key in the application-supplied map" do
+      key = OpenSSL::PKey::RSA.generate(2048)
+      extractor_with_map = described_class.new(key_map: { "my-key" => key })
+      key_info = Moxml::Signature::Model::KeyInfo.new(key_name: "my-key")
+      expect(extractor_with_map.extract(key_info)).to equal(key)
+    end
+
+    it "returns nil for an unknown key name" do
+      key_info = Moxml::Signature::Model::KeyInfo.new(key_name: "unknown")
+      expect(extractor.extract(key_info)).to be_nil
+    end
+  end
+
+  describe "ECKeyValue" do
+    it "reconstructs a P-256 public EC key" do
+      ec = OpenSSL::PKey::EC.generate("prime256v1")
+      # Spec §4.5.2.3: PublicKey contains the uncompressed-point form
+      # 0x04 || x || y, base64-encoded.
+      point_octets = ec.public_key.to_octet_string(:uncompressed)
+      ec_pub_b64 = Base64.strict_encode64(point_octets)
+
+      key_info = Moxml::Signature::Model::KeyInfo.new(
+        key_value: Moxml::Signature::Model::KeyValue.new(
+          ec_key_value: Moxml::Signature::Model::Key::ECKeyValue.new(
+            named_curve_uri: "urn:oid:1.2.840.10045.3.1.7",
+            public_key: ec_pub_b64,
+          ),
+        ),
+      )
+      extracted = extractor.extract(key_info)
+      expect(extracted).to be_a(OpenSSL::PKey::EC)
+      expect(extracted.public_key).to eq(ec.public_key)
+    end
+  end
+end

data/spec/moxml/signature/model_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "moxml/signature"
+
+RSpec.describe Moxml::Signature::Model do
+  describe Moxml::Signature::Model::Signature do
+    it "stores its components" do
+      si = Moxml::Signature::Model::SignedInfo.new
+      sv = Moxml::Signature::Model::SignatureValue.new(value: "abc")
+      sig = described_class.new(id: "S1", signed_info: si, signature_value: sv)
+      expect(sig.id).to eq("S1")
+      expect(sig.signed_info).to equal(si)
+      expect(sig.signature_value).to equal(sv)
+      expect(sig.objects).to eq([])
+    end
+  end
+
+  describe Moxml::Signature::Model::Reference do
+    it "accepts uri, transforms, and digest method" do
+      t = Moxml::Signature::Model::Transforms.new(
+        transforms: [Moxml::Signature::Model::Transform.new(
+          algorithm: "http://www.w3.org/2000/09/xmldsig#enveloped-signature",
+        )],
+      )
+      dm = Moxml::Signature::Model::DigestMethod.new(
+        algorithm: "http://www.w3.org/2001/04/xmlenc#sha256",
+      )
+      ref = described_class.new(uri: "", transforms: t, digest_method: dm,
+                                digest_value: "abc=")
+      expect(ref.uri).to eq("")
+      expect(ref.transforms.transforms.size).to eq(1)
+      expect(ref.digest_method.algorithm).to eq(
+        "http://www.w3.org/2001/04/xmlenc#sha256",
+      )
+      expect(ref.digest_value).to eq("abc=")
+    end
+  end
+
+  describe Moxml::Signature::Model::Transforms do
+    it "is empty by default" do
+      expect(described_class.new).to be_empty
+    end
+
+    it "appends transforms with <<" do
+      transforms = described_class.new
+      t = Moxml::Signature::Model::Transform.new(
+        algorithm: "http://www.w3.org/2000/09/xmldsig#base64",
+      )
+      transforms << t
+      expect(transforms.size).to eq(1)
+    end
+  end
+end

data/spec/moxml/signature/round_trip_spec.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "moxml/signature"
+require "openssl"
+
+# End-to-end signing + verification, including tamper detection and
+# wrong-key rejection. Uses real model instances and real OpenSSL keys
+# per the project's "no doubles" rule.
+RSpec.describe "Moxml XML Signature end-to-end round trip" do
+  let(:ctx) { Moxml.new(:nokogiri) }
+  let(:private_key) { OpenSSL::PKey::RSA.generate(2048) }
+  let(:document_xml) { "<doc><greeting>Hello, World!</greeting></doc>" }
+
+  let(:common_options) do
+    {
+      context: ctx,
+      signature_method: "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256",
+      canonicalization_method: "http://www.w3.org/2001/10/xml-exc-c14n#",
+      digest_method: "http://www.w3.org/2001/04/xmlenc#sha256",
+      reference_uri: "",
+      transforms: ["http://www.w3.org/2000/09/xmldsig#enveloped-signature"],
+    }
+  end
+
+  def sign_and_attach(xml, key, **opts)
+    doc = ctx.parse(xml)
+    signature = Moxml::Signature.sign(document: doc, key: key, **common_options.merge(opts))
+    serialized = Moxml::Signature::Serializer.new(context: ctx).serialize(signature)
+    doc.root.add_child(serialized.root)
+    doc
+  end
+
+  describe "RSA-SHA256 round trip" do
+    it "verifies a freshly-signed document" do
+      doc = sign_and_attach(document_xml, private_key)
+      result = Moxml::Signature.verify(context: ctx, document: doc, key: private_key)
+      expect(result.valid?).to be true
+      expect(result.signature_count).to eq(1)
+    end
+
+    it "verifies with the public key alone" do
+      doc = sign_and_attach(document_xml, private_key)
+      pub = OpenSSL::PKey::RSA.new(private_key.public_to_pem)
+      result = Moxml::Signature.verify(context: ctx, document: doc, key: pub)
+      expect(result.valid?).to be true
+    end
+
+    it "detects payload tampering" do
+      doc = sign_and_attach(document_xml, private_key)
+      greeting = doc.at_xpath("//greeting")
+      greeting.text = "Goodbye, World!"
+      result = Moxml::Signature.verify(context: ctx, document: doc, key: private_key)
+      expect(result.valid?).to be false
+      # SignatureValue still matches (SignedInfo unchanged) but reference
+      # digest mismatches.
+      expect(result.results.first.signature_valid?).to be true
+      expect(result.results.first.references.first.valid?).to be false
+    end
+
+    it "detects SignedInfo tampering" do
+      doc = sign_and_attach(document_xml, private_key)
+      dv = doc.at_xpath("//ds:DigestValue",
+                        "ds" => "http://www.w3.org/2000/09/xmldsig#")
+      dv.text = Base64.strict_encode64("x" * 32)
+      result = Moxml::Signature.verify(context: ctx, document: doc, key: private_key)
+      expect(result.valid?).to be false
+    end
+
+    it "rejects an unrelated verification key" do
+      doc = sign_and_attach(document_xml, private_key)
+      other = OpenSSL::PKey::RSA.generate(2048)
+      result = Moxml::Signature.verify(context: ctx, document: doc, key: other)
+      expect(result.valid?).to be false
+      expect(result.results.first.signature_valid?).to be false
+    end
+  end
+
+  describe "HMAC-SHA256 round trip" do
+    let(:hmac_options) do
+      common_options.merge(
+        signature_method: "http://www.w3.org/2001/04/xmldsig-more#hmac-sha256",
+      )
+    end
+
+    it "verifies with the shared secret" do
+      doc = sign_and_attach(document_xml, "shared-secret", **hmac_options)
+      result = Moxml::Signature.verify(context: ctx, document: doc, key: "shared-secret")
+      expect(result.valid?).to be true
+    end
+
+    it "rejects the wrong secret" do
+      doc = sign_and_attach(document_xml, "shared-secret", **hmac_options)
+      result = Moxml::Signature.verify(context: ctx, document: doc, key: "wrong-secret")
+      expect(result.valid?).to be false
+    end
+  end
+
+  describe "fixture key" do
+    let(:pem_path) do
+      File.expand_path("../../fixtures/xmldsig/keys/rsa_private.pem", __dir__)
+    end
+    let(:fixture_key) { OpenSSL::PKey::RSA.new(File.read(pem_path)) }
+
+    it "loads and round-trips" do
+      skip "fixture key not present" unless File.exist?(pem_path)
+
+      doc = sign_and_attach(document_xml, fixture_key)
+      result = Moxml::Signature.verify(context: ctx, document: doc, key: fixture_key)
+      expect(result.valid?).to be true
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moxml
 version: !ruby/object:Gem::Version
-  version: 0.1.25
+  version: 0.1.26
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-06-26 00:00:00.000000000 Z
+date: 2026-07-22 00:00:00.000000000 Z
 dependencies: []
 description: |
   Moxml is a unified XML manipulation library that provides a common API
@@ -82,6 +82,13 @@ files:
 - docs/_tutorials/namespace-handling.adoc
 - docs/_tutorials/xpath-queries.adoc
 - docs/index.adoc
+- docs/signature/algorithms.md
+- docs/signature/architecture.md
+- docs/signature/c14n.md
+- docs/signature/examples.md
+- docs/signature/flows.md
+- docs/signature/quick-reference.md
+- docs/signature/security.md
 - examples/README.md
 - examples/api_client/README.md
 - examples/api_client/api_client.rb
@@ -96,6 +103,9 @@ files:
 - examples/sax_parsing/example.xml
 - examples/sax_parsing/large_file.rb
 - examples/sax_parsing/simple_parser.rb
+- examples/signature/auto_key_extraction.rb
+- examples/signature/enveloped_rsa.rb
+- examples/signature/hmac.rb
 - examples/web_scraper/README.md
 - examples/web_scraper/example_page.html
 - examples/web_scraper/web_scraper.rb
@@ -139,6 +149,27 @@ files:
 - lib/moxml/adapter/rexml.rb
 - lib/moxml/attribute.rb
 - lib/moxml/builder.rb
+- lib/moxml/c14n.rb
+- lib/moxml/c14n/attribute_handler.rb
+- lib/moxml/c14n/character_encoder.rb
+- lib/moxml/c14n/data_model.rb
+- lib/moxml/c14n/exclusive.rb
+- lib/moxml/c14n/inclusive_10.rb
+- lib/moxml/c14n/inclusive_11.rb
+- lib/moxml/c14n/namespace_context.rb
+- lib/moxml/c14n/namespace_handler.rb
+- lib/moxml/c14n/node.rb
+- lib/moxml/c14n/nodes.rb
+- lib/moxml/c14n/nodes/attribute_node.rb
+- lib/moxml/c14n/nodes/comment_node.rb
+- lib/moxml/c14n/nodes/element_node.rb
+- lib/moxml/c14n/nodes/namespace_node.rb
+- lib/moxml/c14n/nodes/processing_instruction_node.rb
+- lib/moxml/c14n/nodes/root_node.rb
+- lib/moxml/c14n/nodes/text_node.rb
+- lib/moxml/c14n/processor.rb
+- lib/moxml/c14n/writer.rb
+- lib/moxml/c14n/xml_base_handler.rb
 - lib/moxml/cdata.rb
 - lib/moxml/comment.rb
 - lib/moxml/config.rb
@@ -164,6 +195,55 @@ files:
 - lib/moxml/sax/element_handler.rb
 - lib/moxml/sax/handler.rb
 - lib/moxml/sax/namespace_splitter.rb
+- lib/moxml/signature.rb
+- lib/moxml/signature/algorithms.rb
+- lib/moxml/signature/algorithms/base64_transform.rb
+- lib/moxml/signature/algorithms/canonicalization_base.rb
+- lib/moxml/signature/algorithms/digest_base.rb
+- lib/moxml/signature/algorithms/dsa_sha.rb
+- lib/moxml/signature/algorithms/ecdsa_sha.rb
+- lib/moxml/signature/algorithms/enveloped_signature_transform.rb
+- lib/moxml/signature/algorithms/exc_c14n_10.rb
+- lib/moxml/signature/algorithms/hmac_sha.rb
+- lib/moxml/signature/algorithms/inclusive_c14n_10.rb
+- lib/moxml/signature/algorithms/inclusive_c14n_11.rb
+- lib/moxml/signature/algorithms/rsa_pkcs1_sha.rb
+- lib/moxml/signature/algorithms/sha1.rb
+- lib/moxml/signature/algorithms/sha224.rb
+- lib/moxml/signature/algorithms/sha256.rb
+- lib/moxml/signature/algorithms/sha384.rb
+- lib/moxml/signature/algorithms/sha512.rb
+- lib/moxml/signature/algorithms/signature_method_base.rb
+- lib/moxml/signature/algorithms/transform_base.rb
+- lib/moxml/signature/errors.rb
+- lib/moxml/signature/key_extractor.rb
+- lib/moxml/signature/model.rb
+- lib/moxml/signature/model/algorithm_method.rb
+- lib/moxml/signature/model/digest_method.rb
+- lib/moxml/signature/model/key/dsa_key_value.rb
+- lib/moxml/signature/model/key/ec_key_value.rb
+- lib/moxml/signature/model/key/rsa_key_value.rb
+- lib/moxml/signature/model/key/x509_data.rb
+- lib/moxml/signature/model/key/x509_digest.rb
+- lib/moxml/signature/model/key/x509_issuer_serial.rb
+- lib/moxml/signature/model/key_info.rb
+- lib/moxml/signature/model/key_value.rb
+- lib/moxml/signature/model/object_element.rb
+- lib/moxml/signature/model/reference.rb
+- lib/moxml/signature/model/signature.rb
+- lib/moxml/signature/model/signature_value.rb
+- lib/moxml/signature/model/signed_info.rb
+- lib/moxml/signature/model/transform.rb
+- lib/moxml/signature/model/transforms.rb
+- lib/moxml/signature/parser.rb
+- lib/moxml/signature/reference_resolver.rb
+- lib/moxml/signature/reference_result.rb
+- lib/moxml/signature/serializer.rb
+- lib/moxml/signature/signer.rb
+- lib/moxml/signature/single_verification_result.rb
+- lib/moxml/signature/transform_pipeline.rb
+- lib/moxml/signature/verification_result.rb
+- lib/moxml/signature/verifier.rb
 - lib/moxml/text.rb
 - lib/moxml/version.rb
 - lib/moxml/xml_utils.rb
@@ -182,6 +262,8 @@ files:
 - lib/moxml/xpath/ruby/node.rb
 - moxml.gemspec
 - old-specs/moxml/adapter/customized_libxml/.gitkeep
+- reference-docs/w3c-xmldsig-bestpractices.md
+- reference-docs/w3c-xmldsig-core.md
 - scripts/format_xml.rb
 - scripts/pretty_format_xml.rb
 - sig/moxml.rbs
@@ -279,6 +361,13 @@ files:
 - spec/fixtures/w3c/namespaces/1.0/LICENSE.md
 - spec/fixtures/w3c/namespaces/1.0/README.adoc
 - spec/fixtures/w3c/namespaces/1.0/rmt-ns10.xml
+- spec/fixtures/xmldsig/keys/rsa_private.pem
+- spec/fixtures/xmldsig/keys/rsa_public.pem
+- spec/fixtures/xmldsig/keys/rsa_ref.pem
+- spec/fixtures/xmldsig/keys/rsa_ref.pub
+- spec/fixtures/xmldsig/sign2-doc.xml
+- spec/fixtures/xmldsig/sign2-result.xml
+- spec/fixtures/xmldsig/sign3-result.xml
 - spec/integration/README.md
 - spec/integration/all_adapters_spec.rb
 - spec/integration/headed_ox_integration_spec.rb
@@ -326,6 +415,12 @@ files:
 - spec/moxml/allocation_guard_spec.rb
 - spec/moxml/attribute_spec.rb
 - spec/moxml/builder_spec.rb
+- spec/moxml/c14n/api_spec.rb
+- spec/moxml/c14n/c14n_spec.rb
+- spec/moxml/c14n/comments_pis_spec.rb
+- spec/moxml/c14n/inclusive10_spec.rb
+- spec/moxml/c14n/namespace_edge_cases_spec.rb
+- spec/moxml/c14n/xml_attributes_spec.rb
 - spec/moxml/cdata_spec.rb
 - spec/moxml/comment_spec.rb
 - spec/moxml/config_spec.rb
@@ -361,6 +456,20 @@ files:
 - spec/moxml/processing_instruction_spec.rb
 - spec/moxml/sax/namespace_splitter_spec.rb
 - spec/moxml/sax_spec.rb
+- spec/moxml/signature/algorithms/base64_transform_spec.rb
+- spec/moxml/signature/algorithms/digest_base_spec.rb
+- spec/moxml/signature/algorithms/dsa_sha_spec.rb
+- spec/moxml/signature/algorithms/ecdsa_sha_spec.rb
+- spec/moxml/signature/algorithms/enveloped_signature_transform_spec.rb
+- spec/moxml/signature/algorithms/hmac_sha_spec.rb
+- spec/moxml/signature/algorithms/rsa_pkcs1_sha_spec.rb
+- spec/moxml/signature/algorithms_spec.rb
+- spec/moxml/signature/cross_verify_spec.rb
+- spec/moxml/signature/edge_cases_spec.rb
+- spec/moxml/signature/fixtures_spec.rb
+- spec/moxml/signature/key_extractor_spec.rb
+- spec/moxml/signature/model_spec.rb
+- spec/moxml/signature/round_trip_spec.rb
 - spec/moxml/text_spec.rb
 - spec/moxml/version_spec.rb
 - spec/moxml/xml_utils/.gitkeep