hanko_xml 0.1.0 → 0.2.0

data/sig/hanko_xml/xades.rbs

@@ -1,6 +1,7 @@
 module HankoXml
   module Xades
     NS: String
+    NS141: String
     LEGACY_NAMESPACES: Array[String]
     NAMESPACES: Array[String]
     SIGNED_PROPERTIES_TYPE: String
@@ -23,11 +24,19 @@ module HankoXml
       def initialize: (?mime_type: String?, ?description: String?, ?encoding: String?) -> void
     end
 
+    # Takes a DER TimeStampReq, returns the TSA's DER TimeStampResp (#162).
+    interface _Timestamper
+      def call: (String request_der) -> String
+    end
+
     class Signer < HankoXml::Signer
       attr_reader signing_time: Time?
       attr_reader signature_policy: (SignaturePolicy | :implied)?
       attr_reader claimed_roles: Array[String]
       attr_reader data_object_format: DataObjectFormat?
+      attr_reader timestamper: _Timestamper?
+      attr_reader timestamp_canonicalization_method: Symbol
+      attr_reader validation_data: ValidationData?
 
       def initialize: (
         ?certificate: (Key | OpenSSL::X509::Certificate | String | _ToPath)?,
@@ -37,10 +46,52 @@ module HankoXml
         ?data_object_format: (DataObjectFormat | Hash[Symbol, untyped])?,
         ?signature_id: String?,
         ?template: Symbol,
+        ?timestamper: _Timestamper?,
+        ?timestamp_digest_method: Symbol?,
+        ?timestamp_canonicalization_method: Symbol,
+        ?validation_data: (ValidationData | Hash[Symbol, untyped])?,
         **untyped
       ) ?{ (self) -> void } -> void
 
       def signed_properties_id: () -> String
+      def signature_timestamp_id: () -> String
+      def timestamp_digest_method: () -> Symbol
+    end
+
+    # XAdES-LT validation material (#167). Embedded, never trusted.
+    class ValidationData
+      attr_reader certificates: Array[OpenSSL::X509::Certificate]
+      attr_reader crls: Array[OpenSSL::X509::CRL]
+      attr_reader ocsp_responses: Array[OpenSSL::OCSP::Response]
+
+      def initialize: (
+        ?certificates: Array[OpenSSL::X509::Certificate | String | Key],
+        ?crls: Array[OpenSSL::X509::CRL | String],
+        ?ocsp_responses: Array[OpenSSL::OCSP::Response | String]
+      ) -> void
+      def self.coerce: ((ValidationData | Hash[Symbol, untyped])? value) -> ValidationData?
+    end
+
+    # Adds a SignatureTimeStamp and XAdES-LT validation data to an existing signature (#167).
+    class Augmenter
+      attr_reader timestamper: _Timestamper?
+      attr_reader timestamp_digest_method: Symbol
+      attr_reader timestamp_canonicalization_method: Symbol
+      attr_reader validation_data: ValidationData?
+      attr_reader archive_timestamp: bool
+      attr_reader archive_canonicalization_method: Symbol
+      attr_reader policy: Policy
+
+      def initialize: (
+        ?timestamper: _Timestamper?,
+        ?timestamp_digest_method: Symbol,
+        ?timestamp_canonicalization_method: Symbol,
+        ?validation_data: (ValidationData | Hash[Symbol, untyped])?,
+        ?archive_timestamp: bool,
+        ?archive_canonicalization_method: Symbol,
+        ?policy: Policy
+      ) -> void
+      def augment: (untyped source, ?signature: Integer?) -> SignedDocument
     end
   end
 end
@@ -57,12 +108,51 @@ module HankoXml
       attr_reader data_object_formats: Array[Hash[Symbol, String?]]
     end
 
+    class SignatureTimeStamp
+      attr_reader id: String?
+      attr_reader time: Time
+      attr_reader serial_number: Integer
+      attr_reader tsa_certificate: OpenSSL::X509::Certificate?
+      attr_reader digest_method: String
+      attr_reader policy_id: String?
+    end
+
+    # The revocation evidence a chain certificate passed with (#168).
+    class RevocationStatus
+      attr_reader certificate: OpenSSL::X509::Certificate
+      attr_reader source: :ocsp | :crl
+      attr_reader issued_at: Time
+      attr_reader status: :good | :revoked_later
+    end
+
+    # A passed XAdES-LT validation (#168).
+    class LongTermValidation
+      attr_reader time: Time
+      attr_reader certificate_chain: Array[OpenSSL::X509::Certificate]
+      attr_reader revocation: Array[RevocationStatus]
+    end
+
     class Verification < HankoXml::Verification
       attr_reader signed_properties: SignedProperties?
+      attr_reader signature_timestamps: Array[SignatureTimeStamp]?
+      attr_reader long_term_validation: LongTermValidation?
+      attr_reader archive_timestamps: Array[SignatureTimeStamp]?
+      def timestamp_time: () -> Time?
     end
 
     class Verifier < HankoXml::Verifier
-      def initialize: (?signature_policy: (SignaturePolicy | Hash[Symbol, untyped] | :implied)?, **untyped) -> void
+      TIMESTAMP_MODES: Array[Symbol]
+      LONG_TERM_MODES: Array[Symbol]
+
+      def initialize: (
+        ?signature_policy: (SignaturePolicy | Hash[Symbol, untyped] | :implied)?,
+        ?timestamps: :verify | :require | :ignore,
+        ?tsa_store: OpenSSL::X509::Store?,
+        ?tsa_certificates: Array[OpenSSL::X509::Certificate | String | Key]?,
+        ?long_term: (:verify | :require | :ignore)?,
+        ?revocation_grace: Numeric,
+        **untyped
+      ) -> void
       def verify: (untyped xml) -> Verification
       def verify_all: (untyped xml) -> Array[Verification]
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanko_xml
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Danimar Ribeiro
@@ -56,6 +56,11 @@ files:
 - lib/hanko_xml/verifier.rb
 - lib/hanko_xml/version.rb
 - lib/hanko_xml/xades.rb
+- lib/hanko_xml/xades/augmenter.rb
+- lib/hanko_xml/xades/locator.rb
+- lib/hanko_xml/xades/long_term.rb
+- lib/hanko_xml/xades/timestamp.rb
+- lib/hanko_xml/xades/validation_data.rb
 - lib/hanko_xml/xades/verifier.rb
 - lib/hanko_xml/xml.rb
 - lib/hanko_xml/xmldsig-core-schema.xsd