uri-ni 0.1.5 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee2d458c5f63ebc9a63552bc94b0141052952a2729b4647a0d5d5b43859288a4
-  data.tar.gz: 21201a539b63b90db525760e20087b37c77167fd054b75bc38d1625dfd0fedd7
+  metadata.gz: c7f97e35f7fc6987d8051e1f09e23cc2cbc29b6e188496b5d1abd5d030a7ec32
+  data.tar.gz: 3a66e3863206978a52e1281318808f043de2b7e4409b09d8bdff37a589bfb3fd
 SHA512:
-  metadata.gz: 78679d956ad359ca94076ed41d148708c1fe4e8b79afe3cbaf144e3e874b20ae0d90d390414a58ab17b9152944b1ae3147e3e3478f9bc07e111a198ed7039ea5
-  data.tar.gz: 832ac38552ef80eccad02eb739da1471ad23c9c0aaa01b570ad2ffd829649ec93c02ee7b961d220e29ce06ad9858af322f829601e9a62da6a36d46bff8966eab
+  metadata.gz: eac81311c6e7e895c908b0d45db5a7b028ed1e9b2e1b65e35d264c5840837abc589a9c11ac315272bf751f1f326b753f1b5e2f1add14313ae66258eefeee7c88
+  data.tar.gz: 8456780c695e1ad060546e46bf8cc1fcccbee00c1d535e6a3845f19f2928fd1a13efb720e264f23091fcf24b82bae797365877ca3747d6701502f96df61c65ca

data/lib/uri/ni/version.rb

@@ -3,7 +3,7 @@ require 'uri/generic'
 
 module URI
   class NI < Generic
-    VERSION = "0.1.5"
+    VERSION = "0.2.1"
   end
 
   # might as well put this here

data/lib/uri/ni.rb

@@ -42,8 +42,24 @@ class URI::NI < URI::Generic
     "sha-256": Digest::SHA256,
     "sha-384": Digest::SHA384,
     "sha-512": Digest::SHA512,
+    # XXX not sure if i want to do this
+    "sha-256-32": Digest::SHA256,
+    "sha-256-64": Digest::SHA256,
+    "sha-256-96": Digest::SHA256,
+    "sha-256-120": Digest::SHA256,
+    "sha-256-128": Digest::SHA256,
   }
 
+  LENGTHS = DIGESTS.map do |k, v|
+    v = if m = /^sha-256-(\d+)$/.match(k)
+      m.captures.first.to_i / 8
+    else
+      v.new.digest_length
+    end
+
+    [k, v]
+  end.to_h
+
   # resolve first against digest length and then class
   DIGEST_REV = {
     64 => { Digest::SHA512 => :"sha-512", Digest::SHA2   => :"sha-512" },
@@ -95,11 +111,14 @@ class URI::NI < URI::Generic
     16  => [/^[0-9A-Fa-f]*$/, 'Data %s is not in hexadecimal'],
   }
 
-  def assert_repr data, radix
+  ASSERT_REPR = -> data, radix do
     re, error = ASSERT[radix]
-    raise ArgumentError, error % data unless re.match data
+    raise ArgumentError, error % data unless re.match? data
   end
 
+  define_method :assert_repr, &ASSERT_REPR
+  define_singleton_method :assert_repr, &ASSERT_REPR
+
   # from whatever to binary
   DECODE = {
     256 => -> x { x },
@@ -133,12 +152,15 @@ class URI::NI < URI::Generic
     16  => -> x { x.upcase },
   }
 
-  def transcode data, from: 256, to: 256, alt: false
+  TRANSCODE = -> data, from: 256, to: 256, alt: false do
     assert_repr data, from
     data = ENCODE[to].call(DECODE[from].call data) unless from == to
     alt ? ALT[to].call(data) : CANON[to].call(data)
   end
 
+  define_method :transcode, &TRANSCODE
+  define_singleton_method :transcode, &TRANSCODE
+
   protected
 
   # holy crap you can override these?
@@ -160,6 +182,53 @@ class URI::NI < URI::Generic
 
   public
 
+  # Transform a digest for a known algorithm into a {URI::NI}. Takes a
+  # binary, Base64, Base32, or hexadecimal string.
+  #
+  # @param algorithm [Symbol,#to_sym] a supported algorithm
+  # @param digest [String, #to_s, Digest::Instance] the digest (or context)
+  #
+  # @raise [ArgumentError] if the algorithm is unsupported
+  # @raise [ArgumentError] if the input string is not the right length
+  #  for the algorithm
+  # @raise [ArgumentError] if the input string is incorrectly encoded
+  #
+  # @return [URI::NI] the transformed identifier
+  #
+  def self.ingest algorithm = nil, digest
+    return compute(digest) if digest.is_a? Digest::Instance
+    return digest if digest.is_a? URI::NI # noop
+
+    # make sure we're indeed dealing with a string
+    digest = digest.to_s
+
+    # just parse if it's already a ni: URI string
+    return URI(digest) if /^ni:/i.match? digest
+
+    # get the expected length of the digest for the algorithm
+    len = LENGTHS[algorithm.to_s.downcase.to_sym] or raise ArgumentError,
+      "unsupported algorithm #{algorithm}"
+
+    # the length of the string is used to determine the expected encoding
+    radix = case digest.length
+            when len then 256
+            when -> x { x >= (len * 8 / 6.0).ceil && x < (len * 8 / 5.0).ceil }
+              # note that a length longer than base64 but shorter than base32
+              # can be assumed to be base64 with padding
+              64
+            when (len * 8 / 5.0).ceil then 32
+            when len * 2 then 16
+            else
+              raise ArgumentError, "invalid string length: #{digest.length}"
+            end
+
+    # then we lint it to see if it's correct
+    digest = transcode digest, from: radix, to: 64
+
+    # then we transcode
+    URI("ni:///#{algorithm};#{digest}")
+  end
+
   # Compute an RFC6920 URI from a data source.
   #
   # @param data [#to_s, IO, Digest, nil]
@@ -171,8 +240,8 @@ class URI::NI < URI::Generic
   # @yieldparam ctx [Digest::Instance] The digest instance to the block
   # @yieldparam buf [String, nil] The current read buffer (if +data+ is set)
   # @yieldreturn [nil] The result of the block is ignored
-  # 
-  # @return [URI::NI] 
+  #
+  # @return [URI::NI]
   def self.compute data = nil, algorithm: :"sha-256", blocksize: 65536,
       authority: nil, query: nil, &block
 
@@ -192,7 +261,7 @@ class URI::NI < URI::Generic
       ctx = DIGESTS[algorithm]
     ctx.new
   end
-  
+
   # (Re)-compute a digest using existing information from an instance.
   # @see .compute
   def compute data = nil, algorithm: nil, blocksize: 65536,
@@ -206,7 +275,8 @@ class URI::NI < URI::Generic
     # special case for when the data is a digest
     ctx = nil
     if data.is_a? Digest::Instance
-      algorithm ||= algo_for data, algorithm
+      # note the self; this would have been a bug lol
+      self.algorithm = algorithm ||= algo_for data, algorithm
       ctx  = data
       data = nil # unset data
     else
@@ -241,17 +311,26 @@ class URI::NI < URI::Generic
       block.call ctx, nil
     end
 
-    self.set_path("/#{algorithm};" +
-      ctx.base64digest.tr('+/', '-_').tr('=', ''))
+    set_digest ctx.digest
+
     self
   end
 
+  # Returns true if the digest length matches the algorithm.
+  #
+  # @return [false, true]
+  #
+  def valid?
+    LENGTHS[algorithm] and LENGTHS[algorithm] == digest.length
+  end
+
   # Display the available algorithms.
   #
   # @return [Array] containing the symbols representing the available
   #  digest algorithms.
-  def self.algorithms
-    DIGESTS.keys.sort
+  def self.algorithms truncated: false
+    out = DIGESTS.keys.sort
+    truncated ? out : out.reject { |a| /^sha-256-/.match? a }
   end
 
   # Obtain the algorithm of the digest. May be nil.
@@ -329,7 +408,10 @@ class URI::NI < URI::Generic
     when Digest::Instance
       compute value
     when String
-      value = transcode value, from: radix, to: 64
+      value = transcode value, from: radix
+      value = value[0, LENGTHS[a.to_sym]] # deal with truncation
+      value = transcode value, to: 64
+
       self.path = a ? "/#{a};#{value}" : "/;#{value}"
     when nil
       self.path = a ? "/#{a}" : ?/
@@ -475,16 +557,17 @@ class URI::NI < URI::Generic
     to_www https: false, authority: authority
   end
 
-  # Returns the set of supported algorithms.
-  # @return [Array] the algorithms
-  def self.algorithms
-    DIGESTS.keys
-  end
 
   # Returns true if the algorithm is supported.
   # @param algorithm [Symbol,String] the algorithm identifier to test
   # @return [true, false] whether it is supported
   def self.valid_algo? algorithm
-    DIGESTS.has_key? algorithm.to_s.downcase.to_sym
+    algorithm = algorithm.to_s.downcase.to_sym
+
+    # special case for truncated sha-256
+    return true if /^(sha-256)-(32|64|96|120|128)$/.match? algorithm
+
+    # etc
+    DIGESTS.has_key? algorithm
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: uri-ni
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.1
 platform: ruby
 authors:
 - Dorian Taylor
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,7 +64,6 @@ licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://github.com/doriantaylor/rb-uri-ni
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -80,8 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.15
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: URI handler for RFC6920 ni:/// URIs
 test_files: []