uri-idna 0.1.0 → 0.2.0

data/lib/uri/idna/validation/label.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative "../intranges"
+require_relative "../data/idna"
+
+module URI
+  module IDNA
+    module Validation
+      module Label
+        class << self
+          # 4.1. Input to IDNA Registration
+          # https://datatracker.ietf.org/doc/html/rfc5891#section-4.1
+          def check_nfc(label)
+            return if label.unicode_normalized?(:nfc)
+
+            raise Error, "Label must be in Unicode Normalization Form NFC"
+          end
+
+          # 4.2.3.1. Hyphen Restrictions
+          # https://datatracker.ietf.org/doc/html/rfc5891#section-4.2.3.1
+          def check_hyphen34(label)
+            return if label[2..3] != "--"
+
+            raise Error, "Label must not contain a U+002D HYPHEN-MINUS character in both the third and fourth positions"
+          end
+
+          # 4.2.3.1. Hyphen Restrictions
+          # https://datatracker.ietf.org/doc/html/rfc5891#section-4.2.3.1
+          def check_hyphen_sides(label)
+            return unless label[0] == "-" || label[-1] == "-"
+
+            raise Error, "Label must neither begin nor end with a U+002D HYPHEN-MINUS character"
+          end
+
+          def check_ace_prefix(label)
+            return unless label.start_with?(ACE_PREFIX)
+
+            raise Error, "Label must not begin with `xn--`"
+          end
+
+          # 4.2.3.2. Leading Combining Marks
+          # https://datatracker.ietf.org/doc/html/rfc5891#section-4.2.3.2
+          def check_leading_combining(label)
+            return unless Intranges.contain?(label[0].ord, INITIAL_COMBINERS)
+
+            raise Error, "Label begins with an illegal combining character"
+          end
+
+          def check_dot(label)
+            raise Error, "Label must not contain a U+002E ( . ) FULL STOP" if label.include?(".")
+          end
+
+          # DNS label size limit
+          # See Processing step 4.2
+          # https://www.unicode.org/reports/tr46/#ToASCII
+          def check_length(label)
+            raise Error, "Label too long" unless label.length < 64
+          end
+
+          # DNS name size limit
+          # See Processing step 4.1
+          # https://www.unicode.org/reports/tr46/#ToASCII
+          def check_domain_length(domain_name)
+            raise Error, "Domain too long" unless domain_name.length < (domain_name[-1] == "." ? 255 : 254)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/uri/idna/version.rb

@@ -2,6 +2,6 @@
 
 module URI
   module IDNA
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/uri/idna/whatwg/processing.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module URI
+  module IDNA
+    # https://url.spec.whatwg.org/#idna
+    module WHATWG
+      class ToASCII < UTS46::ToASCII
+        def initialize(domain_name, be_strict: true)
+          super(
+            domain_name,
+            use_std3_ascii_rules: be_strict,
+            check_hyphens: false,
+            check_bidi: true,
+            check_joiners: true,
+            transitional_processing: false,
+            verify_dns_length: be_strict,
+          )
+        end
+      end
+
+      class ToUnicode < UTS46::ToUnicode
+        def initialize(domain_name, be_strict: true)
+          super(
+            domain_name,
+            use_std3_ascii_rules: be_strict,
+            check_hyphens: false,
+            check_bidi: true,
+            check_joiners: true,
+            transitional_processing: false,
+          )
+        end
+      end
+    end
+  end
+end

data/lib/uri/idna.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
 require_relative "idna/version"
-require_relative "idna/process"
+require_relative "idna/punycode"
+require_relative "idna/base_processing"
+require_relative "idna/idna2008/processing"
+require_relative "idna/uts46/processing"
+require_relative "idna/whatwg/processing"
 
 module URI
   module IDNA
-    ALABEL_PREFIX = "xn--"
+    ACE_PREFIX = "xn--"
 
     class Error < StandardError; end
 
@@ -22,38 +26,40 @@ module URI
     class PunycodeError < Error; end
 
     class << self
-      UTS46_PARAMS = {
-        check_dot: true,
-        idna_validity: false,
-        uts46: true,
-        uts46_std3: true,
-        uts46_transitional: false,
-        contexto: false,
-      }.freeze
-
-      LOOKUP_PARAMS = {
-        hyphen_sides: false,
-        leading_combining: false,
-      }.freeze
-
-      def lookup(s, **params)
-        Process.new(**LOOKUP_PARAMS.merge(params)).lookup(s)
+      # IDNA2008 Lookup protocol defined in RFC 5891
+      # https://datatracker.ietf.org/doc/html/rfc5891#section-5
+      def lookup(domain_name, **options)
+        IDNA2008::Lookup.new(domain_name, **options).call
       end
 
-      def register(alabel: nil, ulabel: nil, **params)
-        Process.new(**params).register(alabel: alabel, ulabel: ulabel)
+      # IDNA2008 Registration protocol defined in RFC 5891
+      # https://datatracker.ietf.org/doc/html/rfc5891#section-4
+      def register(alabel: nil, ulabel: nil, **options)
+        IDNA2008::Registration.new(alabel: alabel, ulabel: ulabel, **options).call
       end
 
       # UTS46 ToUnicode process
       # https://unicode.org/reports/tr46/#ToUnicode
-      def to_unicode(s, **params)
-        Process.new(**UTS46_PARAMS.merge(params)).decode(s)
+      def to_unicode(domain_name, **options)
+        UTS46::ToUnicode.new(domain_name, **options).call
       end
 
       # UTS46 ToASCII process
       # https://unicode.org/reports/tr46/#ToASCII
-      def to_ascii(s, **params)
-        Process.new(**UTS46_PARAMS.merge(params)).encode(s)
+      def to_ascii(domain_name, **options)
+        UTS46::ToASCII.new(domain_name, **options).call
+      end
+
+      # WHATWG URL Standard domain to ASCII algorithm
+      # https://url.spec.whatwg.org/#idna
+      def whatwg_to_unicode(domain_name, **options)
+        WHATWG::ToUnicode.new(domain_name, **options).call
+      end
+
+      # WHATWG URL Standard domain to Unicode algorithm
+      # https://url.spec.whatwg.org/#idna
+      def whatwg_to_ascii(domain_name, **options)
+        WHATWG::ToASCII.new(domain_name, **options).call
       end
     end
   end

data/lib/uri-idna.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "uri/idna"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uri-idna
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Svyatoslav Kryukov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-05 00:00:00.000000000 Z
+date: 2023-11-14 00:00:00.000000000 Z
 dependencies: []
 description: Internationalized Domain Names in Applications (IDNA)
 email:
@@ -20,16 +20,23 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- lib/uri-idna.rb
 - lib/uri/idna.rb
+- lib/uri/idna/base_processing.rb
 - lib/uri/idna/data/idna.rb
 - lib/uri/idna/data/uts46.rb
+- lib/uri/idna/idna2008/options.rb
+- lib/uri/idna/idna2008/processing.rb
 - lib/uri/idna/intranges.rb
-- lib/uri/idna/process.rb
 - lib/uri/idna/punycode.rb
-- lib/uri/idna/uts46.rb
-- lib/uri/idna/validation.rb
+- lib/uri/idna/uts46/mapping.rb
+- lib/uri/idna/uts46/options.rb
+- lib/uri/idna/uts46/processing.rb
 - lib/uri/idna/validation/bidi.rb
+- lib/uri/idna/validation/codepoint.rb
+- lib/uri/idna/validation/label.rb
 - lib/uri/idna/version.rb
+- lib/uri/idna/whatwg/processing.rb
 homepage: https://github.com/skryukov/uri-idna
 licenses:
 - MIT

data/lib/uri/idna/process.rb

@@ -1,139 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "punycode"
-require_relative "validation"
-
-require_relative "uts46"
-
-module URI
-  module IDNA
-    class Process
-      UNICODE_DOTS_REGEX = /[\u002e\u3002\uff0e\uff61]/.freeze
-
-      def initialize(**options)
-        @options = options
-      end
-
-      def register(alabel: nil, ulabel: nil)
-        raise ArgumentError, "Provide alabel or ulabel" if alabel.nil? && ulabel.nil?
-
-        return encode(ulabel) if alabel.nil?
-
-        raise ArgumentError, "String expected" unless alabel.is_a?(String)
-        raise Error, "Invalid alabel #{alabel}" unless alabel.start_with?(ALABEL_PREFIX)
-
-        process_labels(alabel) do |l|
-          to_alabel(l, roundtrip: true, ulabel: ulabel)
-        end
-      end
-
-      def lookup(s)
-        raise ArgumentError, "String expected" unless s.is_a?(String)
-
-        s = process_labels(s) do |l|
-          to_alabel(l, roundtrip: true)
-        end
-        validate_domain_length(s) if options.fetch(:dns_length, true)
-        s
-      end
-
-      def encode(s)
-        raise ArgumentError, "String expected" unless s.is_a?(String)
-
-        s = process_labels(s) { |l| to_alabel(l) }
-        validate_domain_length(s) if options.fetch(:dns_length, true)
-        s
-      end
-
-      def decode(s)
-        raise ArgumentError, "String expected" unless s.is_a?(String)
-
-        process_labels(s) { |l| to_ulabel(l) }
-      end
-
-      private
-
-      attr_reader :labels, :options
-
-      def splitter
-        @splitter ||= options.fetch(:uts46, false) ? "." : UNICODE_DOTS_REGEX
-      end
-
-      def process_labels(s)
-        s = UTS46.map_string(s, **options.slice(:uts46_std3, :uts46_transitional)) if options.fetch(:uts46, false)
-        @labels ||= s.split(splitter, -1)
-        trailing_dot = labels[-1] && labels[-1].empty? ? labels.pop : false
-
-        raise Error, "Empty domain" if labels.empty? || labels == [""]
-
-        result = []
-        labels.each do |label|
-          str = yield(label)
-          raise Error, "Empty label" if str.empty?
-
-          result << str
-        end
-
-        result << "" if trailing_dot
-        result.join(".")
-      end
-
-      def to_alabel(label, roundtrip: false, ulabel: nil)
-        orig_label = label
-        # validate label is a valid U-label
-        label = to_ulabel(label)
-        if ulabel && ulabel != label
-          raise Error, "Provided ulabel does not match conversion of alabel, #{ulabel.inspect} != #{label.inspect}"
-        end
-
-        label = encode_punycode_label(label) unless label.ascii_only?
-        validate_label_length(label)
-
-        if roundtrip && orig_label.ascii_only? && orig_label != label
-          raise Error, "Roundtrip encoding failed, #{orig_label.inspect} != #{label.inspect}"
-        end
-
-        label
-      end
-
-      # https://datatracker.ietf.org/doc/html/rfc5891#section-5.3
-      def to_ulabel(label)
-        decoded = false
-        label, decoded = decode_punycode_label(label) if label.ascii_only?
-        validation.call(label, decoded: decoded)
-        label
-      end
-
-      def encode_punycode_label(label)
-        ALABEL_PREFIX + Punycode.encode(label)
-      end
-
-      def decode_punycode_label(label)
-        label = label.downcase
-        return [label, false] unless label.start_with?(ALABEL_PREFIX)
-
-        code = label[ALABEL_PREFIX.length..]
-        raise Error, "Malformed A-label, no Punycode eligible content found" if code.empty?
-        raise Error, "A-label must not end with a hyphen" if code[-1] == "-"
-
-        [URI::IDNA::Punycode.decode(code), true]
-      end
-
-      def validate_label_length(label)
-        raise Error, "Label too long" unless label.length < 64
-      end
-
-      def validate_domain_length(s)
-        raise Error, "Domain too long" unless s.length < (s[-1] == "." ? 255 : 254)
-      end
-
-      def validation
-        @validation ||= Validation.new(options.merge(bidi: check_bidi?))
-      end
-
-      def check_bidi?
-        options.fetch(:bidi, true) && Validation::Bidi.check?(labels)
-      end
-    end
-  end
-end

data/lib/uri/idna/uts46.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "data/uts46"
-
-module URI
-  module IDNA
-    module UTS46
-      class << self
-        # https://unicode.org/reports/tr46/#ProcessingStepMap
-        def map_string(domain, uts46_std3: true, uts46_transitional: false)
-          output = ""
-          domain.each_char do |char|
-            code_point = char.ord
-            _, status, replacement = uts46_status(code_point)
-            case status
-            when "I"
-              next
-            when "V"
-              output += char
-            when "M"
-              output += replacement
-            when "D"
-              output += uts46_transitional ? replacement : char
-            when "3"
-              if uts46_std3
-                raise InvalidCodepointError,
-                      "Codepoint #{code_point} not allowed in #{domain} via STD3 rules"
-              end
-
-              output += replacement || char
-            else
-              raise InvalidCodepointError, "Codepoint #{code_point} not allowed in #{domain}"
-            end
-          end
-          output.unicode_normalize(:nfc)
-        end
-
-        def valid?(char, uts46_transitional: false)
-          _, status, = uts46_status(char.ord)
-          return true if status == "V"
-          return true if uts46_transitional && status == "D"
-
-          false
-        end
-
-        private
-
-        def uts46_status(code_point)
-          index =
-            if code_point < 256
-              code_point
-            else
-              (UTS46_DATA.bsearch_index { |x| x[0] > code_point } || UTS46_DATA.length) - 1
-            end
-          UTS46_DATA[index] || []
-        end
-      end
-    end
-  end
-end

data/lib/uri/idna/validation.rb

@@ -1,199 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "intranges"
-require_relative "data/idna"
-require_relative "validation/bidi"
-
-module URI
-  module IDNA
-    # U-label domain validation for IDNA and UTS46.
-    class Validation
-      # @param [Hash] params
-      # @option params [Boolean] :nfc Normalize to NFC (true by default)
-      # @option params [Boolean] :hyphen34 Hyphen restrictions (true by default)
-      # @option params [Boolean] :hyphen_sides Hyphen restrictions (true for the register protocol and UTS46)
-      # @option params [Boolean] :leading_combining Leading combining marks (true for the register protocol and UTS46)
-      # @option params [Boolean] :contextj Contextual rules CONTEXTJ (true by default)
-      # @option params [Boolean] :contexto Contextual rules CONTEXTO (true for IDNA2008 protocols)
-      # @option params [Boolean] :bidi Bidi rules (true by default)
-      # @option params [Boolean] :idna_validity IDNA2008 validity (true for IDNA2008 protocols)
-      # @option params [Boolean] :uts46 UTS46 validity (true for UTS46)
-      # @option params [Boolean] :uts46_transitional UTS46 transitional validity (false by default)
-      # @option params [Boolean] :check_dot Check for dots (true for UTS46)
-      #
-      def initialize(params)
-        @nfc = params.fetch(:nfc, true)
-        @hyphen34 = params.fetch(:hyphen34, true)
-        @hyphen_sides = params.fetch(:hyphen_sides, true)
-
-        # Contextual rules
-        @leading_combining = params.fetch(:leading_combining, true)
-        @contextj = params.fetch(:contextj, true)
-        @contexto = params.fetch(:contexto, true)
-        @bidi = params.fetch(:bidi, true)
-        # IDNA2008 specific
-        @idna_validity = params.fetch(:idna_validity, true)
-
-        # UTS46 specific
-        @uts46 = params.fetch(:uts46, false)
-        @uts46_transitional = params.fetch(:uts46_transitional, false)
-        @check_dot = params.fetch(:check_dot, false)
-      end
-
-      def call(label, decoded: false)
-        raise Error, "Empty label" if label.empty?
-
-        check_nfc(label) if @nfc
-        check_hyphen34(label) if @hyphen34
-        check_hyphen_sides(label) if @hyphen_sides
-        check_leading_combining(label) if @leading_combining
-        check_dot(label) if @check_dot
-        label.each_char.with_index do |cp, pos|
-          next if codepoint?(cp, "PVALID")
-
-          if @contextj && codepoint?(cp, "CONTEXTJ")
-            next if valid_contextj?(label, pos)
-
-            raise InvalidCodepointContextError, cp_error_message(cp, label, pos)
-          end
-
-          if @contexto && codepoint?(cp, "CONTEXTO")
-            next if valid_contexto?(label, pos)
-
-            raise InvalidCodepointContextError, cp_error_message(cp, label, pos)
-          end
-
-          # 4.2.2. Rejection of Characters That Are Not Permitted
-          # https://datatracker.ietf.org/doc/html/rfc5891#section-4.2.2
-          raise InvalidCodepointError, cp_error_message(cp, label, pos) if @idna_validity
-
-          if @uts46 && !UTS46.valid?(cp, uts46_transitional: @uts46_transitional && !decoded)
-            raise InvalidCodepointError, cp_error_message(cp, label, pos)
-          end
-        end
-        Bidi.call(label) if @bidi
-      end
-
-      private
-
-      # 4.1. Input to IDNA Registration
-      # https://datatracker.ietf.org/doc/html/rfc5891#section-4.1
-      def check_nfc(label)
-        return true if label.unicode_normalized?(:nfc)
-
-        raise Error, "Label must be in Normalization Form C"
-      end
-
-      # 4.2.3.1. Hyphen Restrictions
-      # https://datatracker.ietf.org/doc/html/rfc5891#section-4.2.3.1
-      def check_hyphen34(label)
-        return unless label[2..3] == "--"
-
-        raise Error, "Label has disallowed hyphens in 3rd and 4th position"
-      end
-
-      # 4.2.3.1. Hyphen Restrictions
-      # https://datatracker.ietf.org/doc/html/rfc5891#section-4.2.3.1
-      def check_hyphen_sides(label)
-        return unless label[0] == "-" || label[-1] == "-"
-
-        raise Error, "Label must not start or end with a hyphen"
-      end
-
-      # 4.2.3.2. Leading Combining Marks
-      # https://datatracker.ietf.org/doc/html/rfc5891#section-4.2.3.2
-      def check_leading_combining(label)
-        return unless Intranges.contain?(label[0].ord, INITIAL_COMBINERS)
-
-        raise Error, "Label begins with an illegal combining character"
-      end
-
-      def check_dot(label)
-        raise Error, "Label must not contain dots" if label.include?(".")
-      end
-
-      def valid_contexto?(label, pos)
-        cp_value = label[pos].ord
-        case cp_value
-          # https://datatracker.ietf.org/doc/html/rfc5892#appendix-A.3
-        when 0x00b7
-          pos > 0 && pos < label.length - 1 ? (label[pos - 1].ord == 0x006c && label[pos + 1].ord == 0x006c) : false
-          # https://datatracker.ietf.org/doc/html/rfc5892#appendix-A.4
-        when 0x0375
-          pos < label.length - 1 ? script?(label[pos + 1], "Greek") : false
-          # https://datatracker.ietf.org/doc/html/rfc5892#appendix-A.5
-          # https://datatracker.ietf.org/doc/html/rfc5892#appendix-A.6
-        when 0x05f3, 0x05f4
-          pos > 0 ? script?(label[pos - 1], "Hebrew") : false
-          # https://datatracker.ietf.org/doc/html/rfc5892#appendix-A.7
-        when 0x30fb
-          label.each_char do |cp|
-            next if cp.ord == 0x30fb
-            return true if script?(cp, "Hiragana") || script?(cp, "Katakana") || script?(cp, "Han")
-          end
-          false
-          # https://datatracker.ietf.org/doc/html/rfc5892#appendix-A.8
-        when 0x0660..0x0669
-          label.each_char do |cp|
-            return false if cp.ord >= 0x06f0 && cp.ord <= 0x06f9
-          end
-          true
-          # https://datatracker.ietf.org/doc/html/rfc5892#appendix-A.9
-        when 0x06f0..0x06f9
-          label.each_char do |cp|
-            return false if cp.ord >= 0x0660 && cp.ord <= 0x0669
-          end
-          true
-        else
-          false
-        end
-      end
-
-      def valid_contextj?(label, pos)
-        case label[pos].ord
-          # https://datatracker.ietf.org/doc/html/rfc5892#appendix-A.1
-        when 0x200c
-          return true if pos > 0 && virama_combining_class?(label[pos - 1])
-
-          ok = false
-          (pos - 1).downto(0) do |i|
-            joining_type = JOINING_TYPES[label[i].ord]
-            next if joining_type == 0x54
-
-            if [0x4c, 0x44].include?(joining_type)
-              ok = true
-              break
-            end
-          end
-          return false unless ok
-
-          (pos + 1).upto(label.length - 1) do |i|
-            joining_type = JOINING_TYPES[label[i].ord]
-            next if joining_type == 0x54
-            return true if [0x52, 0x44].include?(joining_type)
-          end
-          # https://datatracker.ietf.org/doc/html/rfc5892#appendix-A.2
-        when 0x200d
-          return virama_combining_class?(label[pos - 1]) if pos > 0
-        end
-        false
-      end
-
-      def codepoint?(cp, class_name)
-        Intranges.contain?(cp.ord, CODEPOINT_CLASSES[class_name])
-      end
-
-      def script?(cp, script)
-        Intranges.contain?(cp.ord, SCRIPTS[script])
-      end
-
-      def virama_combining_class?(cp)
-        Intranges.contain?(cp.ord, VIRAMA_COMBINING_CLASSES)
-      end
-
-      def cp_error_message(cp, label, pos)
-        format("Codepoint U+%04X at position %d of %p not allowed", cp.ord, pos + 1, label)
-      end
-    end
-  end
-end