rasn1 0.11.0 → 0.12.1

data/lib/rasn1/types/base.rb

@@ -69,6 +69,14 @@ module RASN1
       attr_reader :asn1_class
       # @return [Object,nil] default value, if defined
       attr_reader :default
+      # @return [Hash[Symbol, Object]]
+      attr_reader :options
+      # @return [String] raw parsed data
+      attr_reader :raw_data
+      # @return [String] raw parsed length
+      attr_reader :raw_length
+
+      private :raw_data, :raw_length
 
       # Get ASN.1 type
       # @return [String]
@@ -116,15 +124,19 @@ module RASN1
       # @option options [::String] :name name for this node
       def initialize(options={})
         @constructed = nil
-        set_options options
+        set_value(options.delete(:value))
+        self.options = options
         specific_initializer
+        @raw_data = ''.b
+        @raw_length = ''.b
       end
 
       # @abstract To help subclass initialize itself. Default implementation do nothing.
       def specific_initializer; end
 
-      # Used by +#dup+ and +#clone+. Deep copy @value and @default.
-      def initialize_copy(_other)
+      # Deep copy @value and @default.
+      def initialize_copy(*)
+        super
         @value = @value.dup
         @no_value = @no_value.dup
         @default = @default.dup
@@ -150,6 +162,7 @@ module RASN1
         ''
       end
 
+      # Say if this type is optional
       # @return [::Boolean]
       def optional?
         @optional
@@ -212,17 +225,11 @@ module RASN1
       # @return [Integer] total number of parsed bytes
       # @raise [ASN1Error] error on parsing
       def parse!(der, ber: false)
-        return 0 unless check_id(der)
+        total_length, data = do_parse(der, ber)
+        return 0 if total_length.zero?
 
-        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
         if explicit?
-          # Delegate to #explicit type to generate sub-value
-          type = explicit_type
-          type.parse!(data)
-          @value = type.value
+          do_parse_explicit(data)
         else
           der_to_value(data, ber: ber)
         end
@@ -253,11 +260,112 @@ module RASN1
         (other.class == self.class) && (other.to_der == self.to_der)
       end
 
+      # Set options to this object
+      # @param [Hash] options
+      # @return [void]
+      # @since 0.12
+      def options=(options)
+        set_class options[:class]
+        set_optional options[:optional]
+        set_default options[:default]
+        set_tag options
+        @name = options[:name]
+        @options = options
+      end
+
+      # Say if a value is set
+      # @return [Boolean]
+      # @since 0.12.0
+      def value?
+        !@no_value
+      end
+
+      # Say if DER can be built (not default value, not optional without value, has a value)
+      # @return [Boolean]
+      # @since 0.12.0
+      def can_build?
+        value? && (@default.nil? || (@value != @default))
+      end
+
+      # @private Tracer private API
+      # @return [String]
+      def trace
+        return trace_real if value?
+
+        msg = msg_type
+        if default.nil? # rubocop:disable Style/ConditionalAssignment
+          msg << ' NONE'
+        else
+          msg << " DEFAULT VALUE #{default}"
+        end
+      end
+
       private
 
+      def trace_real
+        encoded_id = unpack(encode_identifier_octets)
+        data_length = raw_data.length
+        encoded_length = unpack(raw_length)
+        msg = msg_type
+        msg << " (0x#{encoded_id}),"
+        msg << " len: #{data_length} (0x#{encoded_length})"
+        msg << trace_data
+      end
+
+      def trace_data(data=nil)
+        byte_count = 0
+        data ||= raw_data
+
+        lines = []
+        str = ''
+        data.each_byte do |byte|
+          if (byte_count % 16).zero?
+            str = trace_format_new_data_line(byte_count)
+            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 : '.'
+          byte_count += 1
+        end
+        lines.map(&:rstrip).join << "\n"
+      end
+
+      def trace_format_new_data_line(count)
+        head_line = RASN1.tracer.indent(RASN1.tracer.tracing_level + 1)
+        ("\n#{head_line}%04x " % count) << ' ' * 68
+      end
+
+      def compute_trace_index(byte_count, byte_count_mul=1, offset=0)
+        base_idx = 7 + RASN1.tracer.indent(RASN1.tracer.tracing_level + 1).length
+        base_idx + offset + (byte_count % 16) * byte_count_mul
+      end
+
+      def unpack(binstr)
+        binstr.unpack1('H*')
+      end
+
+      def asn1_class_to_s
+        asn1_class == :universal ? '' : asn1_class.to_s.upcase << ' '
+      end
+
+      def msg_type(no_id: false)
+        msg = name.nil? ? +'' : +"#{name} "
+        msg << "[ #{asn1_class_to_s}#{id} ] " unless no_id
+        msg << if explicit?
+                 +'EXPLICIT '
+               elsif implicit?
+                 +'IMPLICIT '
+               else
+                 +''
+               end
+        msg << type
+        msg << ' OPTIONAL' if optional?
+        msg
+      end
+
       def pc_bit
         if @constructed.nil?
-          self.class::ASN1_PC
+          self.class.const_get(:ASN1_PC)
         elsif @constructed # true
           Constructed::ASN1_PC
         else # false
@@ -269,7 +377,7 @@ module RASN1
         lvl = level >= 0 ? level : 0
         str = '  ' * lvl
         str << "#{@name} " unless @name.nil?
-        str << asn1_class.to_s.upcase << ' ' unless asn1_class == :universal
+        str << asn1_class_to_s
         str << "[#{id}] EXPLICIT " if explicit?
         str << "[#{id}] IMPLICIT " if implicit?
         str << "#{type}:"
@@ -283,6 +391,24 @@ 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
@@ -296,16 +422,6 @@ module RASN1
         @value = der
       end
 
-      def set_options(options) # rubocop:disable Naming/AccessorMethodName
-        set_class options[:class]
-        set_optional options[:optional]
-        set_default options[:default]
-        set_tag options
-        set_value options[:value]
-        @name = options[:name]
-        @options = options
-      end
-
       def set_class(asn1_class) # rubocop:disable Naming/AccessorMethodName
         case asn1_class
         when nil
@@ -330,17 +446,15 @@ module RASN1
       # handle undocumented option +:tag_value+, used internally by
       # {RASN1.parse} to parse non-universal class tags.
       def set_tag(options) # rubocop:disable Naming/AccessorMethodName
+        @constructed = options[:constructed]
         if options[:explicit]
           @tag = :explicit
           @id_value = options[:explicit]
-          @constructed = options[:constructed]
         elsif options[:implicit]
           @tag = :implicit
           @id_value = options[:implicit]
-          @constructed = options[:constructed]
         elsif options[:tag_value]
           @id_value = options[:tag_value]
-          @constructed = options[:constructed]
         end
 
         @asn1_class = :context if defined?(@tag) && (@asn1_class == :universal)
@@ -357,15 +471,6 @@ module RASN1
         value
       end
 
-      def value?
-        !@no_value
-      end
-
-      def can_build?
-        (@default.nil? || (value? && (@value != @default))) &&
-          (!optional? || value?)
-      end
-
       def build
         if can_build?
           if explicit?
@@ -382,9 +487,9 @@ module RASN1
       end
 
       def id_value
-        return @id_value if defined? @id_value
+        return @id_value if defined?(@id_value) && !@id_value.nil?
 
-        self.class::ID
+        self.class.const_get(:ID)
       end
 
       def encode_identifier_octets
@@ -445,6 +550,21 @@ module RASN1
       end
 
       def get_data(der, ber)
+        return [0, ''] if der.nil? || der.empty?
+
+        length, length_length = get_length(der, ber)
+
+        data = der[1 + length_length, length]
+        @raw_length = der[0, length_length + 1]
+        @raw_data = data
+
+        total_length = 1 + length
+        total_length += length_length if length_length.positive?
+
+        [total_length, data]
+      end
+
+      def get_length(der, ber)
         length = der.unpack1('C').to_i
         length_length = 0
 
@@ -455,12 +575,8 @@ module RASN1
           length = der[1, length_length].unpack('C*')
                                         .reduce(0) { |len, b| (len << 8) | b }
         end
-        data = der[1 + length_length, length]
-
-        total_length = 1 + length
-        total_length += length_length if length_length.positive?
 
-        [total_length, data]
+        [length, length_length]
       end
 
       def raise_on_indefinite_length(ber)
@@ -475,7 +591,7 @@ module RASN1
       end
 
       def explicit_type
-        self.class.new
+        self.class.new(name: name)
       end
 
       def raise_id_error(der)
@@ -484,10 +600,6 @@ module RASN1
         raise ASN1Error, msg
       end
 
-      def class_from_numeric_id(id)
-        CLASSES.key(id & CLASS_MASK)
-      end
-
       def self2name
         name = +"#{asn1_class.to_s.upcase} #{constructed? ? 'CONSTRUCTED' : 'PRIMITIVE'}"
         if implicit? || explicit?

data/lib/rasn1/types/bit_string.rb

@@ -8,7 +8,6 @@ module RASN1
       # BitString id value
       ID = 3
 
-      # @param [Integer] bit_length
       # @return [Integer]
       attr_writer :bit_length
 
@@ -42,14 +41,17 @@ module RASN1
         str << " #{value.inspect} (bit length: #{bit_length})"
       end
 
-      private
-
+      # Same as {Base#can_build?} but also check bit_length
+      # @see Base#can_build?
+      # @return [Boolean]
       def can_build?
-        !(!@default.nil? && (!value? || (@value == @default) &&
-                              (@bit_length == @default_bit_length))) &&
-          !(optional? && !value?)
+        super || (!@default.nil? && (@bit_length != @default_bit_length))
       end
 
+      private
+
+      # @author Sylvain Daubert
+      # @author adfoster-r7
       def value_to_der
         raise ASN1Error, "#{@name}: bit length is not set" if bit_length.nil?
 
@@ -70,9 +72,8 @@ module RASN1
       end
 
       def generate_value_with_correct_length
-        value = @value || ''
-        value << "\x00" while value.length * 8 < @bit_length.to_i
-        value.force_encoding('BINARY')
+        value = (@value || '').dup.force_encoding('BINARY')
+        value << "\x00".b while value.length * 8 < @bit_length.to_i
         return value unless value.length * 8 > @bit_length.to_i
 
         max_len = @bit_length.to_i / 8 + ((@bit_length.to_i % 8).positive? ? 1 : 0)
@@ -85,6 +86,10 @@ module RASN1
         @bit_length = value.length * 8 - unused
         @value = value
       end
+
+      def explicit_type
+        self.class.new(name: name, value: @value, bit_length: @bit_length)
+      end
     end
   end
 end

data/lib/rasn1/types/bmp_string.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RASN1
+  module Types
+    # ASN.1 BmpString
+    # @since 0.12.0
+    # @author adfoster-r7
+    class BmpString < OctetString
+      # BmpString id value
+      ID = 30
+
+      # 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

@@ -39,6 +39,12 @@ module RASN1
           @value = true
         end
       end
+
+      def trace_data
+        return super if explicit?
+
+        "    #{raw_data == "\x00".b ? 'FALSE' : 'TRUE'} (0x#{raw_data.unpack1('H*')})"
+      end
     end
   end
 end

data/lib/rasn1/types/choice.rb

@@ -88,6 +88,8 @@ module RASN1
         raise ASN1Error, "CHOICE #{@name}: no type matching #{der.inspect}" unless parsed
       end
 
+      # @param [::Integer] level
+      # @return [String]
       def inspect(level=0)
         str = common_inspect(level)
         str << if defined? @chosen
@@ -97,10 +99,16 @@ module RASN1
                end
       end
 
+      # @private Tracer private API
+      # @return [String]
+      def trace
+        msg_type(no_id: true)
+      end
+
       private
 
       def check_chosen
-        raise ChoiceError if !defined?(@chosen) || @chosen.nil?
+        raise ChoiceError.new(self) if !defined?(@chosen) || @chosen.nil?
       end
     end
   end

data/lib/rasn1/types/constrained.rb

@@ -2,11 +2,12 @@
 
 module RASN1
   module Types
-    # Mixin to had constraints on a RASN1 type.
-    # Should not be used directly but through {Model.define_type}.
+    # Mixin to add constraints on a RASN1 type.
+    # Should not be used directly but through {Types.define_type}.
     # @version 0.11.0
     # @author Sylvain Daubert
     module Constrained
+      # Define class/module methods for {Constrained} module
       module ClassMethods
         # Setter for constraint
         # @param [Proc,nil] constraint
@@ -31,8 +32,10 @@ module RASN1
       end
 
       class << self
+        # @return [Proc] proc to check constraints
         attr_reader :constraint
 
+        # Extend +base+ with {ClassMethods}
         def included(base)
           base.extend ClassMethods
         end
@@ -46,6 +49,8 @@ module RASN1
         super
       end
 
+      private
+
       def der_to_value(der, ber: false)
         super
         self.class.check_constraint(@value)

data/lib/rasn1/types/constructed.rb

@@ -10,6 +10,22 @@ module RASN1
       # Constructed value
       ASN1_PC = 0x20
 
+      # @return [Boolean]
+      # @since 0.12.0
+      # @see Base#can_build?
+      def can_build? # rubocop:disable Metrics/CyclomaticComplexity
+        return super unless @value.is_a?(Array) && optional?
+        return false unless super
+
+        @value.any? do |el|
+          el.can_build? && (
+            el.primitive? ||
+              (el.value.respond_to?(:empty?) ? !el.value.empty? : !el.value.nil?))
+        end
+      end
+
+      # @param [::Integer] level (default: 0)
+      # @return [String]
       def inspect(level=0)
         case @value
         when Array
@@ -18,7 +34,7 @@ module RASN1
           level = level.abs + 1
           @value.each do |item|
             case item
-            when Base, Model
+            when Base, Model, Wrapper
               str << "#{item.inspect(level)}\n"
             else
               str << '  ' * level

data/lib/rasn1/types/generalized_time.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'strptime'
+
 module RASN1
   module Types
     # ASN.1 GeneralizedTime
@@ -24,25 +26,33 @@ module RASN1
       # GeneralizedTime id value
       ID = 24
 
+      # @private
+      HOUR_TO_SEC = 3600
+      # @private
+      MINUTE_TO_SEC = 60
+      # @private
+      SECOND_TO_SEC = 1
+
       # Get ASN.1 type
       # @return [String]
       def self.type
         'GeneralizedTime'
       end
 
-      # @return [DateTime]
+      # @return [Time]
       def void_value
-        DateTime.now
+        Time.now
       end
 
       private
 
       def value_to_der
-        if @value.nsec.positive?
-          der = @value.getutc.strftime('%Y%m%d%H%M%S.%9NZ')
+        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
-          @value.getutc.strftime('%Y%m%d%H%M%SZ')
+          utc_value.strftime('%Y%m%d%H%M%SZ')
         end
       end
 
@@ -61,18 +71,13 @@ module RASN1
       end
 
       def value_when_fraction_empty(date_hour)
-        utc_offset_forced = false
-
         if (date_hour[-1] != 'Z') && (date_hour !~ /[+-]\d+$/)
           # If not UTC, have to add offset with UTC to force
-          # DateTime#strptime to generate a local time. But this difference
-          # may be errored because of DST.
+          # Strptime to generate a local time.
           date_hour << Time.now.strftime('%z')
-          utc_offset_forced = true
         end
 
         value_from(date_hour)
-        fix_dst if utc_offset_forced
       end
 
       def value_when_fraction_ends_with_z(date_hour, fraction)
@@ -90,62 +95,50 @@ module RASN1
           date_hour << match[2]
         else
           # fraction only contains fraction.
-          # Have to add offset with UTC to force DateTime#strptime to
-          # generate a local time. But this difference may be errored
-          # because of DST.
+          # Have to add offset with UTC to force Strptime to
+          # generate a local time.
           date_hour << Time.now.strftime('%z')
-          utc_offset_forced = true
         end
 
         frac_base = value_from(date_hour)
-        fix_dst if utc_offset_forced
         fix_value(fraction, frac_base)
       end
 
       def value_from(date_hour)
         format, frac_base = strformat(date_hour)
-        @value = DateTime.strptime(date_hour, format).to_time
+        @value = Strptime.new(format).exec(date_hour)
         frac_base
       end
 
-      # Check DST. There may be a shift of one hour...
-      def fix_dst
-        compare_time = Time.new(*@value.to_a[0..5].reverse)
-        @value = compare_time if compare_time.utc_offset != @value.utc_offset
-      end
-
       def fix_value(fraction, frac_base)
-        @value += ".#{fraction}".to_r * frac_base unless fraction.nil?
+        frac = ".#{fraction}".to_r * frac_base
+        @value = (@value + frac) unless fraction.nil?
       end
 
-      def strformat(date_hour) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+      def strformat(date_hour)
         case date_hour.size
         when 11
-          frac_base = 60 * 60
-          format = '%Y%m%d%HZ'
-        when 13
-          frac_base = 60
-          format = '%Y%m%d%H%MZ'
+          ['%Y%m%d%H%z', HOUR_TO_SEC]
+        when 13, 17
+          ['%Y%m%d%H%M%z', MINUTE_TO_SEC]
         when 15
           if date_hour[-1] == 'Z'
-            frac_base = 1
-            format = '%Y%m%d%H%M%SZ'
+            ['%Y%m%d%H%M%S%z', SECOND_TO_SEC]
           else
-            frac_base = 60 * 60
-            format = '%Y%m%d%H%z'
+            ['%Y%m%d%H%z', HOUR_TO_SEC]
           end
-        when 17
-          frac_base = 60
-          format = '%Y%m%d%H%M%z'
         when 19
-          frac_base = 1
-          format = '%Y%m%d%H%M%S%z'
+          ['%Y%m%d%H%M%S%z', SECOND_TO_SEC]
         else
           prefix = @name.nil? ? type : "tag #{@name}"
-          raise ASN1Error, "#{prefix}: unrecognized format: #{der}"
+          raise ASN1Error, "#{prefix}: unrecognized format: #{date_hour}"
         end
+      end
+
+      def trace_data
+        return super if explicit?
 
-        [format, frac_base]
+        +'    ' << raw_data
       end
     end
   end

data/lib/rasn1/types/ia5string.rb

@@ -17,12 +17,12 @@ module RASN1
       private
 
       def value_to_der
-        @value.to_s.force_encoding('US-ASCII').force_encoding('BINARY')
+        @value.to_s.dup.force_encoding('US-ASCII').b
       end
 
       def der_to_value(der, ber: false)
         super
-        @value.to_s.force_encoding('US-ASCII')
+        @value.to_s.dup.force_encoding('US-ASCII')
       end
     end
   end