ruby-c2pa 0.2.0

data/lib/c2pa/actions.rb

@@ -0,0 +1,29 @@
+module C2PA
+  module Actions
+    CREATED         = "c2pa.created"
+    OPENED          = "c2pa.opened"
+    EDITED          = "c2pa.edited"
+    EDITED_METADATA = "c2pa.edited.metadata"
+    ADJUSTED_COLOR  = "c2pa.adjustedColor"
+    CHANGED_SPEED   = "c2pa.changedSpeed"
+    CONVERTED       = "c2pa.converted"
+    CROPPED         = "c2pa.cropped"
+    DELETED         = "c2pa.deleted"
+    DRAWING         = "c2pa.drawing"
+    DUBBED          = "c2pa.dubbed"
+    ENHANCED        = "c2pa.enhanced"
+    FILTERED        = "c2pa.filtered"
+    ORIENTATION     = "c2pa.orientation"
+    PLACED          = "c2pa.placed"
+    PUBLISHED       = "c2pa.published"
+    REDACTED        = "c2pa.redacted"
+    REMOVED         = "c2pa.removed"
+    REPACKAGED      = "c2pa.repackaged"
+    RESIZED         = "c2pa.resized"
+    TRANSLATED      = "c2pa.translated"
+    TRANSCODED      = "c2pa.transcoded"
+    TRIMMED         = "c2pa.trimmed"
+    UNKNOWN         = "c2pa.unknown"
+    WATERMARKED     = "c2pa.watermarked"
+  end
+end

data/lib/c2pa/error.rb

@@ -0,0 +1,6 @@
+module C2PA
+  class Error < StandardError; end
+  class SigningError < Error; end
+  class ReadError < Error; end
+  class InvalidManifestError < Error; end
+end

data/lib/c2pa/manifest.rb

@@ -0,0 +1,85 @@
+require "json"
+
+module C2PA
+  class Manifest
+    # @param title [String] human-readable title for this asset
+    def initialize(title:)
+      @title = title
+      @actions = []
+      @assertions = []
+      @ingredients = []
+    end
+
+    # Add a C2PA action to this manifest.
+    #
+    # @param action [String] one of the C2PA::Actions constants
+    # @param when_time           [String, nil] ISO 8601 timestamp of when the action occurred
+    # @param software_agent      [String, nil] name/version of the software that performed the action;
+    #                                          defaults to "ruby-c2pa/<version>"
+    # @param digital_source_type [String, nil] URI from the C2PA digitalSourceType vocabulary
+    # @param changed             [Array<String>, nil] list of regions or ingredients that changed
+    # @param parameters          [Hash, nil] action-specific additional parameters
+    # @return [self]
+    def add_action(action,
+                   when_time: nil,
+                   software_agent: nil,
+                   digital_source_type: nil,
+                   changed: nil,
+                   parameters: nil)
+      entry = { "action" => action }
+      entry["when"]              = when_time                              if when_time
+      entry["softwareAgent"]     = software_agent || "ruby-c2pa/#{VERSION}"
+      entry["digitalSourceType"] = digital_source_type                   if digital_source_type
+      entry["changed"]           = changed                               if changed
+      entry["parameters"]        = parameters                            if parameters
+      @actions << entry
+      self
+    end
+
+    # Add an arbitrary assertion to this manifest.
+    #
+    # @param label [String] the assertion label, e.g. "stds.schema-org.CreativeWork"
+    # @param data  [Hash]   the assertion data
+    # @return [self]
+    def add_assertion(label:, data:)
+      @assertions << { "label" => label, "data" => data }
+      self
+    end
+
+    # Add an ingredient (source asset) to this manifest.
+    #
+    # @param title       [String] human-readable title of the ingredient
+    # @param format      [String] MIME type of the ingredient, e.g. "image/jpeg"
+    # @param instance_id [String] unique identifier for the ingredient instance
+    # @param relationship [String] relationship to this asset; defaults to "parentOf"
+    # @return [self]
+    def add_ingredient(title:, format:, instance_id:, relationship: "parentOf")
+      @ingredients << {
+        "title"        => title,
+        "format"       => format,
+        "instance_id"  => instance_id,
+        "relationship" => relationship
+      }
+      self
+    end
+
+    # Serialize to the JSON structure expected by c2pa-rs.
+    #
+    # @return [String]
+    # @raise [C2PA::InvalidManifestError] if no actions have been added
+    def to_json
+      raise InvalidManifestError, "at least one action is required" if @actions.empty?
+
+      manifest = {
+        "title" => @title,
+        "assertions" => [
+          { "label" => "c2pa.actions.v2", "data" => { "actions" => @actions } },
+          *@assertions
+        ]
+      }
+      manifest["ingredients"] = @ingredients unless @ingredients.empty?
+
+      JSON.generate(manifest)
+    end
+  end
+end

data/lib/c2pa/version.rb

@@ -0,0 +1,3 @@
+module C2PA
+  VERSION = "0.2.0"
+end

data/lib/c2pa.rb

@@ -0,0 +1,58 @@
+require "json"
+require_relative "c2pa/version"
+require_relative "c2pa/error"
+require_relative "c2pa/actions"
+require_relative "c2pa/manifest"
+require "c2pa/c2pa_native"
+
+module C2PA
+  # Sign a file with a C2PA manifest.
+  #
+  # @param file        [String]          path to the input file
+  # @param output      [String]          path for the signed output file (must not already exist)
+  # @param certificate [String]          path to a PEM-encoded X.509 certificate (chain)
+  # @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
+  # @return            [String]          the output path
+  #
+  # @example
+  #   manifest = C2PA::Manifest.new(title: "Sunset over the bay")
+  #   manifest.add_action(C2PA::Actions::CREATED)
+  #
+  #   C2PA.sign(
+  #     file:        "photo.jpg",
+  #     output:      "photo_signed.jpg",
+  #     certificate: "cert.pem",
+  #     key:         "key.pem",
+  #     manifest:    manifest
+  #   )
+  def self.sign(file:, output:, certificate:, key:, algorithm: "es256", manifest:)
+    Native.sign_file(file, output, certificate, key, algorithm, manifest.to_json)
+  rescue RuntimeError => e
+    raise SigningError, e.message
+  end
+
+  # Read the C2PA manifest embedded in a signed file.
+  #
+  # @param file [String] path to the signed file
+  # @return     [Hash]   parsed manifest JSON
+  # @raise      [C2PA::ReadError] if the file has no valid manifest
+  #
+  # @example
+  #   manifest = C2PA.read(file: "photo_signed.jpg")
+  #   active = manifest["manifests"][manifest["active_manifest"]]
+  #   puts active["title"]
+  def self.read(file:)
+    JSON.parse(Native.read_file(file))
+  rescue RuntimeError => e
+    raise ReadError, e.message
+  end
+
+  # Return the version of the underlying c2pa-rs SDK.
+  #
+  # @return [String]
+  def self.sdk_version
+    Native.sdk_version
+  end
+end

data/ruby-c2pa.gemspec

@@ -0,0 +1,25 @@
+require_relative "lib/c2pa/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby-c2pa"
+  spec.version       = C2PA::VERSION
+  spec.authors       = [`git config user.name`.strip]
+  spec.email         = [`git config user.email`.strip]
+  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.files         = Dir["lib/**/*.rb", "ext/**/*.{rs,toml,rb}", "Rakefile", "*.gemspec", "LICENSE", "README.md"]
+  spec.require_paths = ["lib"]
+  spec.extensions    = ["ext/c2pa_native/extconf.rb"]
+
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.add_dependency "rb_sys", "~> 0.9"
+
+  spec.add_development_dependency "rake-compiler", "~> 1.2"
+  spec.add_development_dependency "minitest",      "~> 5.0"
+  spec.add_development_dependency "rake",          "~> 13.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: ruby-c2pa
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Carlos Rodriguez
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rb_sys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+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.
+email:
+- carlos@eddorre.com
+executables: []
+extensions:
+- ext/c2pa_native/extconf.rb
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- 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/error.rb
+- lib/c2pa/manifest.rb
+- lib/c2pa/version.rb
+- ruby-c2pa.gemspec
+homepage: https://github.com/carlosrodriguez/ruby-c2pa
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/carlosrodriguez/ruby-c2pa
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Ruby bindings for the c2pa content authenticity library
+test_files: []