ruby-c2pa 0.2.1 → 0.4.0

data/lib/c2pa.rb

@@ -2,10 +2,52 @@ require "json"
 require_relative "c2pa/version"
 require_relative "c2pa/error"
 require_relative "c2pa/actions"
+require_relative "c2pa/digital_source_types"
+require_relative "c2pa/config"
 require_relative "c2pa/manifest"
 require "c2pa/c2pa_native"
 
 module C2PA
+  # Validation states that mean a signed asset is good.
+  #
+  # "Trusted" is "Valid" plus a signing certificate that chains to a root in
+  # the active trust list. Accepting only "Valid" would reject exactly the
+  # production files that are most correct.
+  VALID_STATES = %w[Valid Trusted].freeze
+
+  # Configure how c2pa-rs validates.
+  #
+  # Settings are global and take effect for subsequent calls. Signing already
+  # in flight on another thread continues against the settings it started
+  # with, since the underlying context is replaced rather than mutated.
+  #
+  # @yieldparam config [C2PA::Config]
+  # @return [C2PA::Config] the configuration that was applied
+  # @raise [C2PA::InvalidSettingsError] if the settings are not usable
+  #
+  # @example Trusting a private CA
+  #   C2PA.configure do |config|
+  #     config.trust_anchors = "ca/root.pem"
+  #   end
+  #
+  # @example An offline environment
+  #   C2PA.configure do |config|
+  #     config.remote_manifest_fetch = false
+  #     config.ocsp_fetch = false
+  #   end
+  def self.configure
+    config = Config.new
+    yield config if block_given?
+
+    begin
+      Native.configure(config.to_json)
+    rescue RuntimeError => e
+      raise InvalidSettingsError, e.message
+    end
+
+    config
+  end
+
   # Sign a file with a C2PA manifest.
   #
   # @param file        [String]          path to the input file
@@ -14,7 +56,10 @@ module C2PA
   # @param key         [String]          path to a PEM-encoded private key
   # @param algorithm   [String]          signing algorithm (default: "es256")
   # @param manifest    [C2PA::Manifest]  the manifest to embed
+  # @param verify      [Boolean]         read the signed file back and confirm it
+  #                                      validates (default: true)
   # @return            [String]          the output path
+  # @raise [C2PA::SigningError] if signing fails, or if the signed file does not validate
   #
   # @example
   #   manifest = C2PA::Manifest.new(title: "Sunset over the bay")
@@ -27,7 +72,7 @@ module C2PA
   #     key:         "key.pem",
   #     manifest:    manifest
   #   )
-  def self.sign(file:, output:, certificate:, key:, algorithm: "es256", manifest:)
+  def self.sign(file:, output:, certificate:, key:, algorithm: "es256", manifest:, verify: true)
     manifest_json = manifest.to_json
 
     raise SigningError, "Source file not found: '#{file}'"             unless File.exist?(file)
@@ -35,9 +80,21 @@ module C2PA
     raise SigningError, "Key file not found: '#{key}'"                 unless File.exist?(key)
     raise SigningError, "Output file already exists: '#{output}'"      if File.exist?(output)
 
-    Native.sign_file(file, output, certificate, key, algorithm, manifest_json)
-  rescue RuntimeError => e
-    raise SigningError, e.message
+    begin
+      # to_json is the only thing genuinely required of a manifest, so an
+      # object that provides just that still signs — as a creation.
+      intent = manifest.respond_to?(:intent) ? manifest.intent&.to_s : nil
+      files = manifest.respond_to?(:ingredient_files) ? manifest.ingredient_files : []
+      ingredient_files = files.empty? ? nil : JSON.generate(files)
+      Native.sign_file(file, output, certificate, key, algorithm, manifest_json,
+                       intent, ingredient_files)
+    rescue RuntimeError => e
+      raise SigningError, e.message
+    end
+
+    verify_signed_output!(output) if verify
+
+    output
   end
 
   # Read the C2PA manifest embedded in a signed file.
@@ -62,4 +119,48 @@ module C2PA
   def self.sdk_version
     Native.sdk_version
   end
+
+  # Read a freshly signed file back and confirm it actually validates.
+  #
+  # Signing reports success for manifests that verifiers reject. c2pa-rs
+  # applies its rules when reading, not when writing, so without this the gem
+  # hands back a path to a file that fails everywhere else — which is what
+  # released versions did, for years, silently.
+  #
+  # The rejected file is deleted rather than left behind, so a failed sign
+  # cannot leave something shippable on disk.
+  #
+  # @param output [String] path to the signed file
+  # @raise [C2PA::SigningError] if the file does not validate
+  def self.verify_signed_output!(output)
+    result =
+      begin
+        read(file: output)
+      rescue ReadError => e
+        discard(output)
+        raise SigningError, "signed file failed verification: could not read it back: #{e.message}"
+      end
+
+    state = result["validation_state"]
+    return if VALID_STATES.include?(state)
+
+    failures = Array(result.dig("validation_results", "activeManifest", "failure"))
+               .map { |failure| "#{failure["code"]} (#{failure["explanation"]})" }
+    detail = failures.empty? ? "no failure detail reported" : failures.uniq.join(", ")
+
+    discard(output)
+    raise SigningError,
+          "signed file failed verification: validation_state=#{state.inspect}, #{detail}. " \
+          "The output file has been removed. Pass verify: false to keep it for inspection."
+  end
+  private_class_method :verify_signed_output!
+
+  # Remove a file this library created and is about to reject.
+  def self.discard(path)
+    File.delete(path) if File.exist?(path)
+  rescue SystemCallError
+    # Leaving the file behind is better than masking the original failure.
+    nil
+  end
+  private_class_method :discard
 end

data/ruby-c2pa.gemspec

@@ -8,10 +8,35 @@ Gem::Specification.new do |spec|
   spec.summary          = "Ruby bindings for the c2pa content authenticity library"
   spec.description      = "Embed and verify C2PA content provenance and authenticity credentials in images, video, and audio files. Ruby bindings for the official Rust c2pa-rs library."
   spec.license          = "MIT"
-  spec.homepage         = "https://github.com/carlosrodriguez/ruby-c2pa"
-  spec.metadata["source_code_uri"] = spec.homepage
+  spec.homepage         = "https://github.com/eddorre/ruby-c2pa"
 
-  spec.files         = Dir["lib/**/*.rb", "ext/**/*.{rs,toml,rb}", "Rakefile", "*.gemspec", "LICENSE", "README.md"]
+  spec.metadata["source_code_uri"]   = spec.homepage
+  spec.metadata["bug_tracker_uri"]   = "#{spec.homepage}/issues"
+  spec.metadata["changelog_uri"]     = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "#{spec.homepage}/blob/main/README.md"
+
+  # Listed explicitly rather than globbed. "ext/**/*.rs" swept in whatever
+  # happened to be under ext/c2pa_native/target, so the package contents
+  # depended on what had been compiled on the machine that ran `gem build` —
+  # 1.3 MB of dependency build-script output shipped in 0.2.1.
+  #
+  # Cargo.lock is included deliberately. The extension is compiled at install
+  # time, so without it every installer resolves the dependency tree afresh.
+  # That is how 0.2.1 shipped against a broken atree and aborted the Ruby
+  # process on TIFF input.
+  spec.files = [
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md",
+    "CONTRIBUTING.md",
+    "Rakefile",
+    "ruby-c2pa.gemspec",
+    "ext/c2pa_native/Cargo.toml",
+    "ext/c2pa_native/Cargo.lock",
+    "ext/c2pa_native/extconf.rb",
+    *Dir["ext/c2pa_native/src/**/*.rs"],
+    *Dir["lib/**/*.rb"]
+  ].sort
   spec.require_paths = ["lib"]
   spec.extensions    = ["ext/c2pa_native/extconf.rb"]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-c2pa
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Carlos Rodriguez
@@ -74,32 +74,31 @@ extensions:
 - ext/c2pa_native/extconf.rb
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- CONTRIBUTING.md
 - LICENSE
 - README.md
 - Rakefile
+- ext/c2pa_native/Cargo.lock
 - ext/c2pa_native/Cargo.toml
 - ext/c2pa_native/extconf.rb
 - ext/c2pa_native/src/lib.rs
-- ext/c2pa_native/target/release/build/oid-registry-c350c75504c969dc/out/oid_db.rs
-- ext/c2pa_native/target/release/build/pix-f303ab89d734032b/out/gamma_lut.rs
-- ext/c2pa_native/target/release/build/serde-2e9abb4d9d73cae4/out/private.rs
-- ext/c2pa_native/target/release/build/serde-f471616b462b0caf/out/private.rs
-- ext/c2pa_native/target/release/build/serde_core-2b94e9134dc44065/out/private.rs
-- ext/c2pa_native/target/release/build/serde_core-3dc945fa0ab21dd5/out/private.rs
-- ext/c2pa_native/target/release/build/thiserror-a1f4c63469c326b9/out/private.rs
-- ext/c2pa_native/target/release/build/typenum-4eb7d34b9fb695ef/out/tests.rs
-- ext/c2pa_native/target/release/build/typenum-b8de96984639a942/out/tests.rs
 - lib/c2pa.rb
 - lib/c2pa/actions.rb
+- lib/c2pa/config.rb
+- lib/c2pa/digital_source_types.rb
 - lib/c2pa/error.rb
 - lib/c2pa/manifest.rb
 - lib/c2pa/version.rb
 - ruby-c2pa.gemspec
-homepage: https://github.com/carlosrodriguez/ruby-c2pa
+homepage: https://github.com/eddorre/ruby-c2pa
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/carlosrodriguez/ruby-c2pa
+  source_code_uri: https://github.com/eddorre/ruby-c2pa
+  bug_tracker_uri: https://github.com/eddorre/ruby-c2pa/issues
+  changelog_uri: https://github.com/eddorre/ruby-c2pa/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/eddorre/ruby-c2pa/blob/main/README.md
 rdoc_options: []
 require_paths:
 - lib