rasn1 0.14.0 → 0.16.0

data/lib/rasn1/types/base.rb

@@ -6,8 +6,8 @@ module RASN1
     #
     #   Subclasses SHOULD define:
     #   * an ID constant defining ASN.1 BER/DER identification number,
+    #   * a method {#der_to_value} converting DER into {#value}.
     #   * a private method {#value_to_der} converting its {#value} to DER,
-    #   * a private method {#der_to_value} converting DER into {#value}.
     #
     # ==Define an optional value
     # An optional value may be defined using +:optional+ key from {#initialize}:
@@ -178,14 +178,14 @@ module RASN1
       # @return [::Boolean,nil] return +nil+ if not tagged, return +true+
       #   if explicit, else +false+
       def explicit?
-        defined?(@tag) ? @tag == :explicit : nil
+        defined?(@tag) ? @tag == :explicit : nil # rubocop:disable Style/ReturnNilInPredicateMethodDefinition
       end
 
       # Say if a tagged type is implicit
       # @return [::Boolean,nil] return +nil+ if not tagged, return +true+
       #   if implicit, else +false+
       def implicit?
-        defined?(@tag) ? @tag == :implicit : nil
+        defined?(@tag) ? @tag == :implicit : nil # rubocop:disable Style/ReturnNilInPredicateMethodDefinition
       end
 
       # @abstract This method SHOULD be partly implemented by subclasses, which
@@ -225,7 +225,7 @@ module RASN1
       # @return [Integer] total number of parsed bytes
       # @raise [ASN1Error] error on parsing
       def parse!(der, ber: false)
-        total_length, data = do_parse(der, ber)
+        total_length, data = do_parse(der, ber: ber)
         return 0 if total_length.zero?
 
         if explicit?
@@ -300,6 +300,41 @@ module RASN1
         end
       end
 
+      # @private Parse tage and length from binary string. Return data length and binary data.
+      # @param [String] der
+      # @param [Boolean] ber
+      # @return [Array(::Integer, String)]
+      # @since 0.15.0 was private before
+      def do_parse(der, ber: false)
+        return [0, ''] unless check_id(der)
+
+        id_size = Types.decode_identifier_octets(der).last
+        total_length, data = get_data(der[id_size..], ber)
+        total_length += id_size
+        @no_value = false
+
+        [total_length, data]
+      end
+
+      # @private Delegate to #explicit type to generate sub-value
+      # @param [String] data
+      # @return [void]
+      # @since 0.15.0 was private before
+      def do_parse_explicit(data)
+        type = explicit_type
+        type.parse!(data)
+        @value = type.value
+      end
+
+      # Make value from DER/BER string
+      # @param [String] der
+      # @param [::Boolean] ber
+      # @return [void]
+      # @since 0.15.0 was private before
+      def der_to_value(der, ber: false) # rubocop:disable Lint/UnusedMethodArgument
+        @value = der
+      end
+
       private
 
       def trace_real
@@ -324,7 +359,7 @@ module RASN1
             lines << str
           end
           str[compute_trace_index(byte_count, 3), 2] = '%02x' % byte
-          str[compute_trace_index(byte_count, 1, 49)] = byte >= 32 && byte <= 126 ? byte.chr : '.'
+          str[compute_trace_index(byte_count, 1, 49)] = byte.between?(32, 126) ? byte.chr : '.'
           byte_count += 1
         end
         lines.map(&:rstrip).join << "\n"
@@ -349,7 +384,7 @@ module RASN1
       end
 
       def msg_type(no_id: false)
-        msg = name.nil? ? +'' : +"#{name} "
+        msg = name.nil? ? +'' : "#{name} "
         msg << "[ #{asn1_class_to_s}#{id} ] " unless no_id
         msg << if explicit?
                  +'EXPLICIT '
@@ -391,24 +426,6 @@ module RASN1
         end
       end
 
-      def do_parse(der, ber)
-        return [0, ''] unless check_id(der)
-
-        id_size = Types.decode_identifier_octets(der).last
-        total_length, data = get_data(der[id_size..-1], ber)
-        total_length += id_size
-        @no_value = false
-
-        [total_length, data]
-      end
-
-      def do_parse_explicit(data)
-        # Delegate to #explicit type to generate sub-value
-        type = explicit_type
-        type.parse!(data)
-        @value = type.value
-      end
-
       def value_to_der
         case @value
         when Base
@@ -418,10 +435,6 @@ module RASN1
         end
       end
 
-      def der_to_value(der, ber: false) # rubocop:disable Lint/UnusedMethodArgument
-        @value = der
-      end
-
       def set_class(asn1_class) # rubocop:disable Naming/AccessorMethodName
         case asn1_class
         when nil
@@ -533,7 +546,11 @@ module RASN1
         end
       end
 
-      def check_id(der)
+      # Check ID from +der+ is the one expected
+      # @return [Boolean] +true+ is ID is expected, +false+ if it is not but +self+ is {#optional?}
+      #   or has a {#default} value.
+      # @raise [ASN1Error] ID was not expected, is not optional and has no default value
+      def check_id(der) # rubocop:disable Naming/PredicateMethod
         expected_id = encode_identifier_octets
         real_id = der[0, expected_id.size]
         return true if real_id == expected_id
@@ -595,13 +612,13 @@ module RASN1
       end
 
       def raise_id_error(der)
-        msg = name.nil? ? +'' : +"#{name}: "
+        msg = name.nil? ? +'' : "#{name}: "
         msg << "Expected #{self2name} but get #{der2name(der)}"
         raise ASN1Error, msg
       end
 
       def self2name
-        name = +"#{asn1_class.to_s.upcase} #{constructed? ? 'CONSTRUCTED' : 'PRIMITIVE'}"
+        name = "#{asn1_class.to_s.upcase} #{constructed? ? 'CONSTRUCTED' : 'PRIMITIVE'}"
         if implicit? || explicit?
           name << ' 0x%X (0x%s)' % [id, bin2hex(encode_identifier_octets)]
         else
@@ -613,7 +630,7 @@ module RASN1
         return 'no ID' if der.nil? || der.empty?
 
         asn1_class, pc, id, id_size = Types.decode_identifier_octets(der)
-        name = +"#{asn1_class.to_s.upcase} #{pc.to_s.upcase}"
+        name = "#{asn1_class.to_s.upcase} #{pc.to_s.upcase}"
         type =  find_type(id)
         name << " #{type.nil? ? '0x%X (0x%s)' % [id, bin2hex(der[0...id_size])] : type.encoded_type}"
       end

data/lib/rasn1/types/bit_string.rb

@@ -48,6 +48,18 @@ module RASN1
         super || (!@default.nil? && (@bit_length != @default_bit_length))
       end
 
+      # Make value from DER/BER string. Also set {#bit_length}.
+      # @param [String] der
+      # @param [::Boolean] ber
+      # @return [void]
+      # @see Types::Base#der_to_value
+      def der_to_value(der, ber: false) # rubocop:disable Lint/UnusedMethodArgument
+        unused = der.unpack1('C').to_i
+        value = der[1..].to_s
+        @bit_length = value.length * 8 - unused
+        @value = value
+      end
+
       private
 
       # @author Sylvain Daubert
@@ -80,13 +92,6 @@ module RASN1
         value[0, max_len].to_s
       end
 
-      def der_to_value(der, ber: false) # rubocop:disable Lint/UnusedMethodArgument
-        unused = der.unpack1('C').to_i
-        value = der[1..-1].to_s
-        @bit_length = value.length * 8 - unused
-        @value = value
-      end
-
       def explicit_type
         self.class.new(name: name, value: @value, bit_length: @bit_length)
       end

data/lib/rasn1/types/bmp_string.rb

@@ -8,23 +8,15 @@ module RASN1
     class BmpString < OctetString
       # BmpString id value
       ID = 30
+      # UniversalString encoding
+      # @since 0.15.0
+      ENCODING = Encoding::UTF_16BE
 
       # Get ASN.1 type
       # @return [String]
       def self.type
         'BmpString'
       end
-
-      private
-
-      def value_to_der
-        @value.to_s.dup.encode('UTF-16BE').b
-      end
-
-      def der_to_value(der, ber: false)
-        super
-        @value = der.to_s.dup.force_encoding('UTF-16BE')
-      end
     end
   end
 end

data/lib/rasn1/types/boolean.rb

@@ -8,22 +8,23 @@ module RASN1
       # Boolean id value
       ID = 0x01
 
-      # @private
+      # DER true value
       DER_TRUE = 0xff
-      # @private
+      # DER false value
       DER_FALSE = 0
 
       # @return [false]
-      def void_value
+      def void_value # rubocop:disable Naming/PredicateMethod
         false
       end
 
-      private
-
-      def value_to_der
-        [@value ? DER_TRUE : DER_FALSE].pack('C')
-      end
-
+      # Make boolean value from DER/BER string.
+      # @param [String] der
+      # @param [::Boolean] ber
+      # @return [void]
+      # @see Types::Base#der_to_value
+      # @raise [ASN1Error] +der+ is not 1-byte long
+      # @raise [ASN1Error] +der+ is not {DER_TRUE} nor {DER_FALSE} and +ber+ is +false+
       def der_to_value(der, ber: false)
         raise ASN1Error, "tag #{@name}: BOOLEAN should have a length of 1" unless der.size == 1
 
@@ -40,6 +41,12 @@ module RASN1
         end
       end
 
+      private
+
+      def value_to_der
+        [@value ? DER_TRUE : DER_FALSE].pack('C')
+      end
+
       def trace_data
         return super if explicit?
 

data/lib/rasn1/types/choice.rb

@@ -57,6 +57,8 @@ module RASN1
           @value[@chosen].value
         when Model
           @value[@chosen]
+        when Wrapper
+          @value[@chosen].element
         end
       end
 
@@ -75,10 +77,25 @@ module RASN1
       # @return [Integer] total number of parsed bytes
       # @raise [ASN1Error] error on parsing
       def parse!(der, ber: false)
+        len, data = do_parse(der, ber: ber)
+        return 0 if len.zero?
+
+        element = @value[@chosen]
+        if element.explicit?
+          element.do_parse_explicit(data)
+        else
+          element.der_to_value(data, ber: ber)
+        end
+        len
+      end
+
+      # @private
+      # @see Types::Base#do_parse
+      # @since 0.15.0 Specific +#do_parse+ to handle recursivity
+      def do_parse(der, ber: false)
         @value.each_with_index do |element, i|
           @chosen = i
-          nb_bytes = element.parse!(der, ber: ber)
-          return nb_bytes
+          return element.do_parse(der, ber: ber)
         rescue ASN1Error
           @chosen = nil
           next
@@ -88,7 +105,23 @@ module RASN1
         @value = void_value
         raise ASN1Error, "CHOICE #{@name}: no type matching #{der.inspect}" unless optional?
 
-        0
+        [0, ''.b]
+      end
+
+      # Make choice value from DER/BER string.
+      # @param [String] der
+      # @param [::Boolean] ber
+      # @return [void]
+      # @since 0.15.0 Specific +#der_to_value+ to handle recursivity
+      def der_to_value(der, ber: false)
+        @value.each_with_index do |element, i|
+          @chosen = i
+          element.parse!(der, ber: ber)
+          break
+        rescue ASN1Error
+          @chosen = nil
+          next
+        end
       end
 
       # @param [::Integer] level
@@ -108,6 +141,13 @@ module RASN1
         msg_type(no_id: true)
       end
 
+      # Return empty array
+      # @return [Array()]
+      # @since 0.15.0
+      def void_value
+        []
+      end
+
       private
 
       def check_chosen

data/lib/rasn1/types/constrained.rb

@@ -37,8 +37,11 @@ module RASN1
         super
       end
 
-      private
-
+      # Make value from +der+ string and check constraints
+      # @param [String] der
+      # @param [::Boolean] ber
+      # @return [void]
+      # @raise [ConstraintError] constraint is not verified
       def der_to_value(der, ber: false)
         super
         self.class.check_constraint(@value)

data/lib/rasn1/types/generalized_time.rb

@@ -44,18 +44,10 @@ module RASN1
         Time.now
       end
 
-      private
-
-      def value_to_der
-        utc_value = @value.getutc
-        if utc_value.nsec.positive?
-          der = utc_value.strftime('%Y%m%d%H%M%S.%9NZ')
-          der.sub(/0+Z/, 'Z')
-        else
-          utc_value.strftime('%Y%m%d%H%M%SZ')
-        end
-      end
-
+      # Make time value from +der+ string
+      # @param [String] der
+      # @param [::Boolean] ber
+      # @return [void]
       def der_to_value(der, ber: false) # rubocop:disable Lint/UnusedMethodArgument
         date_hour, fraction = der.split('.')
         date_hour = date_hour.to_s
@@ -70,19 +62,20 @@ module RASN1
         end
       end
 
+      private
+
+      def value_to_der
+        utc_value = @value.getutc
+        if utc_value.nsec.positive?
+          der = utc_value.strftime('%Y%m%d%H%M%S.%9NZ')
+          der.sub(/0+Z/, 'Z')
+        else
+          utc_value.strftime('%Y%m%d%H%M%SZ')
+        end
+      end
+
       def value_when_fraction_empty(date_hour)
-        # Ruby 3.0: special handle for timezone
-        #   From 3.1: "Z" and "-0100" are supported
-        #   Below 3.1: should be "-01:00" or "+00:00"
-        tz = if date_hour[-1] == 'Z'
-               date_hour.slice!(-1, 1)
-               '+00:00' # Ruby 3.0: to remove after end-of support of ruby 3.0
-             elsif date_hour.match?(/[+-]\d+$/)
-               # Ruby 3.0
-               # date_hour.slice!(-5, 5)
-               zone = date_hour.slice!(-5, 5).to_s
-               "#{zone[0, 3]}:#{zone[3, 2]}"
-             end
+        tz = compute_tz(date_hour)
         year = date_hour.slice!(0, 4).to_i
         month = date_hour.slice!(0, 2).to_i
         day = date_hour.slice!(0, 2).to_i
@@ -92,6 +85,21 @@ module RASN1
         @value = Time.new(year, month, day, hour, minute, second, tz)
       end
 
+      # Ruby 3.0: special handle for timezone
+      #   From 3.1: "Z" and "-0100" are supported
+      #   Below 3.1: should be "-01:00" or "+00:00"
+      def compute_tz(date_hour)
+        if date_hour.end_with?('Z')
+          date_hour.slice!(-1, 1)
+          '+00:00' # Ruby 3.0: to remove after end-of support of ruby 3.0
+        elsif date_hour.match?(/[+-]\d+$/)
+          # Ruby 3.0
+          # date_hour.slice!(-5, 5)
+          zone = date_hour.slice!(-5, 5).to_s
+          "#{zone[0, 3]}:#{zone[3, 2]}"
+        end
+      end
+
       def value_when_fraction_ends_with_z(date_hour, fraction)
         fraction = fraction[0...-1]
         date_hour << 'Z'

data/lib/rasn1/types/ia5string.rb

@@ -7,23 +7,15 @@ module RASN1
     class IA5String < OctetString
       # IA5String id value
       ID = 22
+      # UniversalString encoding
+      # @since 0.15.0
+      ENCODING = Encoding::US_ASCII
 
       # Get ASN.1 type
       # @return [String]
       def self.type
         'IA5String'
       end
-
-      private
-
-      def value_to_der
-        @value.to_s.dup.force_encoding('US-ASCII').b
-      end
-
-      def der_to_value(der, ber: false)
-        super
-        @value.to_s.dup.force_encoding('US-ASCII')
-      end
     end
   end
 end

data/lib/rasn1/types/integer.rb

@@ -54,6 +54,19 @@ module RASN1
         end
       end
 
+      # Make integer value from +der+ string.
+      # @param [String] der
+      # @param [::Boolean] ber
+      # @return [void]
+      def der_to_value(der, ber: false)
+        int_value = der_to_int_value(der, ber: ber)
+        @value = if @enum.empty?
+                   int_value
+                 else
+                   int_to_enum(int_value)
+                 end
+      end
+
       private
 
       def initialize_enum(enum)
@@ -136,15 +149,6 @@ module RASN1
         @enum.key(int) || int
       end
 
-      def der_to_value(der, ber: false)
-        int_value = der_to_int_value(der, ber: ber)
-        @value = if @enum.empty?
-                   int_value
-                 else
-                   int_to_enum(int_value)
-                 end
-      end
-
       def explicit_type
         self.class.new(name: name, enum: enum)
       end

data/lib/rasn1/types/null.rb

@@ -21,18 +21,23 @@ module RASN1
         !optional?
       end
 
-      private
-
-      def value_to_der
-        ''
-      end
-
+      # Check +der+ string
+      # @param [String] der
+      # @param [::Boolean] ber
+      # @return [void]
+      # @raise [ASN1Error] +der+ is not empty
       def der_to_value(der, ber: false) # rubocop:disable Lint/UnusedMethodArgument
         raise ASN1Error, 'NULL should not have content!' if der.length.positive?
 
         @no_value = true
         @value = void_value
       end
+
+      private
+
+      def value_to_der
+        ''
+      end
     end
   end
 end

data/lib/rasn1/types/numeric_string.rb

@@ -7,6 +7,8 @@ module RASN1
     class NumericString < OctetString
       # NumericString id value
       ID = 18
+      # Invalid characters in NumericString
+      INVALID_CHARS = /([^0-9 ])/
 
       # Get ASN.1 type
       # @return [String]
@@ -14,6 +16,16 @@ module RASN1
         'NumericString'
       end
 
+      # Make string value from +der+ string
+      # @param [String] der
+      # @param [::Boolean] ber
+      # @return [void]
+      # @raise [ASN1Error] invalid characters detected
+      def der_to_value(der, ber: false)
+        super
+        check_characters
+      end
+
       private
 
       def value_to_der
@@ -21,13 +33,8 @@ module RASN1
         @value.to_s.b
       end
 
-      def der_to_value(der, ber: false)
-        super
-        check_characters
-      end
-
       def check_characters
-        raise ASN1Error, "NUMERIC STRING #{@name}: invalid character: '#{$1}'" if @value.to_s =~ /([^0-9 ])/
+        raise ASN1Error, "NUMERIC STRING #{@name}: invalid character: '#{$1}'" if @value.to_s =~ INVALID_CHARS
       end
     end
   end

data/lib/rasn1/types/object_id.rb

@@ -4,30 +4,15 @@ module RASN1
   module Types
     # ASN.1 Object ID
     # @author Sylvain Daubert
+    # @author LemonTree55
     class ObjectId < Primitive
       # ObjectId id value
       ID = 6
 
-      private
-
-      def value_to_der
-        ids = @value.to_s.split('.').map(&:to_i)
-
-        raise ASN1Error, "OBJECT ID #{@name}: first subidentifier should be less than 3" if ids[0] > 2
-        raise ASN1Error, "OBJECT ID #{@name}: second subidentifier should be less than 40" if (ids[0] < 2) && (ids[1] > 39)
-
-        ids[0, 2] = ids[0] * 40 + ids[1]
-        octets = []
-        ids.each do |v|
-          if v < 128
-            octets << v
-          else
-            octets.concat(unsigned_to_chained_octets(v))
-        end
-        end
-        octets.pack('C*')
-      end
-
+      # Make object id value from +der+ string
+      # @param [String] der
+      # @param [::Boolean] ber
+      # @return [void]
       def der_to_value(der, ber: false) # rubocop:disable Lint/UnusedMethodArgument
         bytes = der.unpack('C*')
 
@@ -35,7 +20,7 @@ module RASN1
         current_id = 0
         bytes.each do |byte|
           current_id = (current_id << 7) | (byte & 0x7f)
-          if (byte & 0x80).zero?
+          if byte.nobits?(0x80)
             ids << current_id
             current_id = 0
           end
@@ -47,6 +32,33 @@ module RASN1
 
         @value = ids.join('.')
       end
+
+      private
+
+      # @raise [ASN1Error]
+      def value_to_der
+        ids = @value.to_s.split('.').map(&:to_i)
+
+        check_first_ids(ids)
+
+        ids[0, 2] = ids[0] * 40 + ids[1]
+        octets = []
+        ids.each do |v|
+          if v < 128
+            octets << v
+          else
+            octets.concat(unsigned_to_chained_octets(v))
+          end
+        end
+        octets.pack('C*')
+      end
+
+      # @param [Array[::Integer]] ids
+      # @raise [ASN1Error]
+      def check_first_ids(ids)
+        raise ASN1Error, "OBJECT ID #{@name}: first subidentifier should be less than 3" if ids[0] > 2
+        raise ASN1Error, "OBJECT ID #{@name}: second subidentifier should be less than 40" if (ids[0] < 2) && (ids[1] > 39)
+      end
     end
   end
 end

data/lib/rasn1/types/octet_string.rb

@@ -21,6 +21,32 @@ module RASN1
         str = common_inspect(level)
         str << " #{value.inspect}"
       end
+
+      # Make string value from +der+ string. Force encoding to UTF-8
+      # @param [String] der
+      # @param [::Boolean] ber
+      # @return [void]
+      # @since 0.15.0 Handle ENCODING constant, if defined by subclass
+      def der_to_value(der, ber: false)
+        klass = self.class
+        if klass.const_defined?(:ENCODING)
+          @value = der.to_s.dup.force_encoding(klass.const_get(:ENCODING))
+        else
+          super
+        end
+      end
+
+      private
+
+      # @since 0.15.0 Handle ENCODING constant, if defined by subclass
+      def value_to_der
+        klass = self.class
+        if klass.const_defined?(:ENCODING)
+          @value.to_s.encode(klass.const_get(:ENCODING)).b
+        else
+          super
+        end
+      end
     end
   end
 end