rasn1 0.8.0 → 0.9.0

data/lib/rasn1/types/base.rb

@@ -44,7 +44,7 @@ module RASN1
     # Implicit tagged values may also be defined:
     #  ctype_implicit = RASN1::Types::Integer.new(implicit: 0)
     # @author Sylvain Daubert
-    class Base
+    class Base # rubocop:disable Metrics/ClassLength
       # Allowed ASN.1 classes
       CLASSES = {
         universal: 0x00,
@@ -69,8 +69,6 @@ module RASN1
       attr_reader :asn1_class
       # @return [Object,nil] default value, if defined
       attr_reader :default
-      # @return [Object]
-      attr_writer :value
 
       # Get ASN.1 type
       # @return [String]
@@ -97,57 +95,50 @@ module RASN1
         obj
       end
 
-      # @overload initialize(options={})
-      #   @param [Hash] options
-      #   @option options [Symbol] :class ASN.1 class. Default value is +:universal+.
-      #    If +:explicit+ or +:implicit:+ is defined, default value is +:context+.
-      #   @option options [::Boolean] :optional define this tag as optional. Default
-      #     is +false+
-      #   @option options [Object] :default default value (ASN.1 DEFAULT)
-      #   @option options [Object] :value value to set
-      #   @option options [::Integer] :implicit define an IMPLICIT tagged type
-      #   @option options [::Integer] :explicit define an EXPLICIT tagged type
-      #   @option options [::Boolean] :constructed if +true+, set type as constructed.
-      #    May only be used when +:explicit+ is defined, else it is discarded.
-      #   @option options [::String] :name name for this node
-      # @overload initialize(value, options={})
-      #   @param [Object] value value to set for this ASN.1 object
-      #   @param [Hash] options
-      #   @option options [Symbol] :class ASN.1 class. Default value is +:universal+.
-      #    If +:explicit+ or +:implicit:+ is defined, default value is +:context+.
-      #   @option options [::Boolean] :optional define this value as optional. Default
-      #     is +false+
-      #   @option options [Object] :default default value (ASN.1 DEFAULT)
-      #   @option options [::Integer] :implicit define an IMPLICIT tagged type
-      #   @option options [::Integer] :explicit define an EXPLICIT tagged type
-      #   @option options [::Boolean] :constructed if +true+, set type as constructed.
-      #    May only be used when +:explicit+ is defined, else it is discarded.
-      #   @option options [::String] :name name for this node
-      def initialize(value_or_options={}, options={})
+      # @param [Hash] options
+      # @option options [Symbol] :class ASN.1 class. Default value is +:universal+.
+      #  If +:explicit+ or +:implicit:+ is defined, default value is +:context+.
+      # @option options [::Boolean] :optional define this tag as optional. Default
+      #   is +false+
+      # @option options [Object] :default default value (ASN.1 DEFAULT)
+      # @option options [Object] :value value to set
+      # @option options [::Integer] :implicit define an IMPLICIT tagged type
+      # @option options [::Integer] :explicit define an EXPLICIT tagged type
+      # @option options [::Boolean] :constructed if +true+, set type as constructed.
+      #  May only be used when +:explicit+ is defined, else it is discarded.
+      # @option options [::String] :name name for this node
+      def initialize(options={})
         @constructed = nil
-        if value_or_options.is_a? Hash
-          set_options value_or_options
-        else
-          set_options options
-          @value = value_or_options
-        end
+        set_options options
       end
 
       # Used by +#dup+ and +#clone+. Deep copy @value and @default.
       def initialize_copy(_other)
         @value = @value.dup
+        @no_value = @no_value.dup
         @default = @default.dup
       end
 
       # Get value or default value
       def value
-        if @value.nil?
-          @default
-        else
+        if value?
           @value
+        else
+          @default
         end
       end
 
+      # Set value. If +val+ is +nil+, unset value
+      # @param [Object,nil] val
+      def value=(val)
+        set_value(val)
+      end
+
+      # @abstract Define 'void' value (i.e. 'value' when no value was set)
+      def void_value
+        ''
+      end
+
       # @return [::Boolean]
       def optional?
         @optional
@@ -163,14 +154,14 @@ module RASN1
       # @return [::Boolean,nil] return +nil+ if not tagged, return +true+
       #   if explicit, else +false+
       def explicit?
-        !defined?(@tag) ? nil : @tag == :explicit
+        defined?(@tag) ? @tag == :explicit : nil
       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) ? nil : @tag == :implicit
+        defined?(@tag) ? @tag == :implicit : nil
       end
 
       # @abstract This method SHOULD be partly implemented by subclasses, which
@@ -215,10 +206,10 @@ module RASN1
         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.value = @value
           type.parse!(data)
           @value = type.value
         else
@@ -238,7 +229,7 @@ module RASN1
       # @return [String]
       def inspect(level=0)
         str = common_inspect(level)
-        str << " #{value.inspect}"
+        str << ' ' << inspect_value
         str << ' OPTIONAL' if optional?
         str << " DEFAULT #{@default}" unless @default.nil?
         str
@@ -267,9 +258,20 @@ 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 << "[#{id}] EXPLICIT " if explicit?
+        str << "[#{id}] IMPLICIT " if implicit?
         str << "#{type}:"
       end
 
+      def inspect_value
+        if value?
+          value.inspect
+        else
+          '(NO VALUE)'
+        end
+      end
+
       def value_to_der
         case @value
         when Base
@@ -279,21 +281,21 @@ module RASN1
         end
       end
 
-      def der_to_value(der, ber: false)
+      def der_to_value(der, ber: false) # rubocop:disable Lint/UnusedMethodArgument
         @value = der
       end
 
-      def set_options(options)
+      def set_options(options) # rubocop:disable Naming/AccessorMethodName
         set_class options[:class]
         set_optional options[:optional]
         set_default options[:default]
         set_tag options
-        @value = options[:value]
+        set_value options[:value]
         @name = options[:name]
         @options = options
       end
 
-      def set_class(asn1_class)
+      def set_class(asn1_class) # rubocop:disable Naming/AccessorMethodName
         case asn1_class
         when nil
           @asn1_class = :universal
@@ -306,17 +308,17 @@ module RASN1
         end
       end
 
-      def set_optional(optional)
+      def set_optional(optional) # rubocop:disable Naming/AccessorMethodName
         @optional = !!optional
       end
 
-      def set_default(default)
+      def set_default(default) # rubocop:disable Naming/AccessorMethodName
         @default = default
       end
 
       # handle undocumented option +:tag_value+, used internally by
       # {RASN1.parse} to parse non-universal class tags.
-      def set_tag(options)
+      def set_tag(options) # rubocop:disable Naming/AccessorMethodName
         if options[:explicit]
           @tag = :explicit
           @id_value = options[:explicit]
@@ -333,9 +335,24 @@ module RASN1
         @asn1_class = :context if defined?(@tag) && (@asn1_class == :universal)
       end
 
+      def set_value(value) # rubocop:disable Naming/AccessorMethodName
+        if value.nil?
+          @no_value = true
+          @value = void_value
+        else
+          @no_value = false
+          @value = value
+        end
+        value
+      end
+
+      def value?
+        !@no_value
+      end
+
       def can_build?
-        !(!@default.nil? && (@value.nil? || (@value == @default))) &&
-          !(optional? && @value.nil?)
+        (@default.nil? || (value? && (@value != @default))) &&
+          (!optional? || value?)
       end
 
       def build
@@ -403,41 +420,31 @@ module RASN1
       def check_id(der)
         expected_id = encode_identifier_octets
         real_id = der[0, expected_id.size]
-        if real_id != expected_id
-          if optional?
-            @value = nil
-          elsif !@default.nil?
-            @value = @default
-          else
-            raise_id_error(der)
-          end
-          false
+        return true if real_id == expected_id
+
+        if optional?
+          @no_value = true
+          @value = void_value
+        elsif !@default.nil?
+          @value = @default
         else
-          true
+          raise_id_error(der)
         end
+        false
       end
 
       def get_data(der, ber)
-        length = der[0, 1].unpack1('C')
+        length = der.unpack1('C').to_i
         length_length = 0
 
         if length == INDEFINITE_LENGTH
-          if primitive?
-            raise ASN1Error, "malformed #{type}: indefinite length " \
-              'forbidden for primitive types'
-          elsif ber
-            raise NotImplementedError, 'indefinite length not supported'
-          else
-            raise ASN1Error, 'indefinite length forbidden in DER encoding'
-          end
-        elsif length < INDEFINITE_LENGTH
-          data = der[1, length]
-        else
+          raise_on_indefinite_length(ber)
+        elsif length > INDEFINITE_LENGTH
           length_length = length & 0x7f
           length = der[1, length_length].unpack('C*')
                                         .reduce(0) { |len, b| (len << 8) | b }
-          data = der[1 + length_length, length]
         end
+        data = der[1 + length_length, length]
 
         total_length = 1 + length
         total_length += length_length if length_length.positive?
@@ -445,6 +452,17 @@ module RASN1
         [total_length, data]
       end
 
+      def raise_on_indefinite_length(ber)
+        if primitive?
+          raise ASN1Error, "malformed #{type}: indefinite length " \
+            'forbidden for primitive types'
+        elsif ber
+          raise NotImplementedError, 'indefinite length not supported'
+        else
+          raise ASN1Error, 'indefinite length forbidden in DER encoding'
+        end
+      end
+
       def explicit_type
         self.class.new
       end
@@ -473,12 +491,16 @@ module RASN1
 
         asn1_class, pc, id, id_size = Types.decode_identifier_octets(der)
         name = +"#{asn1_class.to_s.upcase} #{pc.to_s.upcase}"
-        type =  Types.constants.map { |c| Types.const_get(c) }
-                     .select { |klass| klass < Primitive || klass < Constructed }
-                     .find { |klass| klass::ID == id }
+        type =  find_type(id)
         name << " #{type.nil? ? '0x%X (0x%s)' % [id, bin2hex(der[0...id_size])] : type.encoded_type}"
       end
 
+      def find_type(id)
+        Types.constants.map { |c| Types.const_get(c) }
+             .select { |klass| klass < Primitive || klass < Constructed }
+             .find { |klass| klass::ID == id }
+      end
+
       def bin2hex(str)
         str.unpack1('H*')
       end

data/lib/rasn1/types/bit_string.rb

@@ -12,17 +12,11 @@ module RASN1
       # @return [Integer]
       attr_writer :bit_length
 
-      # @overload initialize(options={})
-      #   @param [Hash] options
-      #   @option options [Object] :bit_length default bit_length value. Should be
-      #     present if +:default+ is set
-      # @overload initialize(value, options={})
-      #   @param [Object] value value to set for this ASN.1 object
-      #   @param [Hash] options
-      #   @option options [Object] :bit_length default bit_length value. Should be
-      #     present if +:default+ is set
+      # @param [Hash] options
+      # @option options [Object] :bit_length default bit_length value. Should be
+      #   present if +:default+ is set
       # @see Base#initialize common options to all ASN.1 types
-      def initialize(value_or_options={}, options={})
+      def initialize(options={})
         super
         if @default
           raise ASN1Error, "#{@name}: default bit length is not defined" if @options[:bit_length].nil?
@@ -34,10 +28,10 @@ module RASN1
 
       # Get bit length
       def bit_length
-        if @value.nil?
-          @default_bit_length
-        else
+        if value?
           @bit_length
+        else
+          @default_bit_length
         end
       end
 
@@ -51,37 +45,45 @@ module RASN1
       private
 
       def can_build?
-        !(!@default.nil? && (@value.nil? || (@value == @default) &&
+        !(!@default.nil? && (!value? || (@value == @default) &&
                               (@bit_length == @default_bit_length))) &&
-          !(optional? && @value.nil?)
+          !(optional? && !value?)
       end
 
       def value_to_der
         raise ASN1Error, "#{@name}: bit length is not set" if bit_length.nil?
 
-        @value << "\x00" while @value.length * 8 < @bit_length
-        @value.force_encoding('BINARY')
-
-        if @value.length * 8 > @bit_length
-          max_len = @bit_length / 8 + ((@bit_length % 8).positive? ? 1 : 0)
-          @value = @value[0, max_len]
-        end
+        value = generate_value_with_correct_length
 
-        unused = @value.length * 8 - @bit_length
-        der = [unused, @value].pack('CA*')
+        unused = value.length * 8 - @bit_length.to_i
+        der = [unused, value].pack('CA*')
 
         if unused.positive?
-          last_byte = @value[-1].unpack1('C')
+          last_byte = value[-1].to_s.unpack1('C').to_i
           last_byte &= (0xff >> unused) << unused
           der[-1] = [last_byte].pack('C')
         end
 
+        @value = value
+
         der
       end
 
-      def der_to_value(der, ber: false)
-        unused, @value = der.unpack('CA*')
-        @bit_length = @value.length * 8 - unused
+      def generate_value_with_correct_length
+        value = @value || ''
+        value << "\x00" while value.length * 8 < @bit_length.to_i
+        value.force_encoding('BINARY')
+        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)
+        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
     end
   end

data/lib/rasn1/types/boolean.rb

@@ -13,6 +13,11 @@ module RASN1
       # @private
       DER_FALSE = 0
 
+      # @return [false]
+      def void_value
+        false
+      end
+
       private
 
       def value_to_der

data/lib/rasn1/types/choice.rb

@@ -41,7 +41,7 @@ module RASN1
       # @param [Object] value
       # @return [Object] value
       # @raise [ChoiceError] {#chosen} not set
-      def set_chosen_value(value)
+      def set_chosen_value(value) # rubocop:disable Naming/AccessorMethodName
         check_chosen
         @value[@chosen].value = value
       end
@@ -92,10 +92,10 @@ module RASN1
 
       def inspect(level=0)
         str = common_inspect(level)
-        str << if !defined? @chosen
-                 ' not chosen!'
-               else
+        str << if defined? @chosen
                  "\n#{@value[@chosen].inspect(level + 1)}"
+               else
+                 ' not chosen!'
                end
       end
 

data/lib/rasn1/types/constructed.rb

@@ -19,8 +19,6 @@ module RASN1
           @value.each do |item|
             case item
             when Base, Model
-              next if item.optional? && item.value.nil?
-
               str << "#{item.inspect(level)}\n"
             else
               str << '  ' * level

data/lib/rasn1/types/enumerated.rb

@@ -25,21 +25,14 @@ module RASN1
       # Enumerated id value
       ID = 0x0a
 
-      # @overload initialize(options={})
-      #   @option options [Hash] :enum enumeration hash. Keys are names, and values
-      #     are integers. This key is mandatory.
-      #   @raise [EnumeratedError] +:enum+ key is not present
-      #   @raise [EnumeratedError] +:default+ value is unknown
-      # @overload initialize(value, options={})
-      #   @param [Object] value value to set for this ASN.1 object
-      #   @option options [Hash] :enum enumeration hash. Keys are names, and values
-      #     are integers. This key is mandatory.
-      #   @raise [EnumeratedError] +:enum+ key is not present
-      #   @raise [EnumeratedError] +:default+ value is unknown
+      # @option options [Hash] :enum enumeration hash. Keys are names, and values
+      #   are integers. This key is mandatory.
+      # @raise [EnumeratedError] +:enum+ key is not present
+      # @raise [EnumeratedError] +:default+ value is unknown
       # @see Base#initialize common options to all ASN.1 types
-      def initialize(value_or_options={}, options={})
+      def initialize(options={})
         super
-        raise EnumeratedError, 'no enumeration given' if @enum.nil?
+        raise EnumeratedError, 'no enumeration given' if @enum.empty?
       end
 
       # @return [Hash]

data/lib/rasn1/types/generalized_time.rb

@@ -30,6 +30,11 @@ module RASN1
         'GeneralizedTime'
       end
 
+      # @return [DateTime]
+      def void_value
+        DateTime.now
+      end
+
       private
 
       def value_to_der
@@ -41,69 +46,107 @@ module RASN1
         end
       end
 
-      def der_to_value(der, ber: false)
+      def der_to_value(der, ber: false) # rubocop:disable Lint/UnusedMethodArgument
         date_hour, fraction = der.split('.')
-        utc_offset_forced = false
-        if fraction.nil?
-          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.
-            date_hour << Time.now.strftime('%z')
-            utc_offset_forced = true
-          end
+        date_hour = date_hour.to_s
+        fraction = fraction.to_s
+
+        if fraction.empty?
+          value_when_fraction_empty(date_hour)
         elsif fraction[-1] == 'Z'
-          fraction = fraction[0...-1]
-          date_hour << 'Z'
+          value_when_fraction_ends_with_z(date_hour, fraction)
         else
-          match = fraction.match(/(\d+)([+-]\d+)/)
-          if match
-            # fraction contains fraction and timezone info. Split them
-            fraction = match[1]
-            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.
-            date_hour << Time.now.strftime('%z')
-            utc_offset_forced = true
-          end
+          value_on_others_cases(date_hour, fraction)
         end
-        format = case date_hour.size
-                 when 11
-                   frac_base = 60 * 60
-                   '%Y%m%d%HZ'
-                 when 13
-                   frac_base = 60
-                   '%Y%m%d%H%MZ'
-                 when 15
-                   if date_hour[-1] == 'Z'
-                     frac_base = 1
-                     '%Y%m%d%H%M%SZ'
-                   else
-                     frac_base = 60 * 60
-                     '%Y%m%d%H%z'
-                   end
-                 when 17
-                   frac_base = 60
-                   '%Y%m%d%H%M%z'
-                 when 19
-                   frac_base = 1
-                   '%Y%m%d%H%M%S%z'
-                 else
-                   prefix = @name.nil? ? type : "tag #{@name}"
-                   raise ASN1Error, "#{prefix}: unrecognized format: #{der}"
-                 end
-        @value = DateTime.strptime(date_hour, format).to_time
-        # local time format.
-        # Check DST. There may be a shift of one hour...
-        if utc_offset_forced
-          compare_time = Time.new(*@value.to_a[0..5].reverse)
-          @value = compare_time if compare_time.utc_offset != @value.utc_offset
+      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.
+          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)
+        fraction = fraction[0...-1]
+        date_hour << 'Z'
+        frac_base = value_from(date_hour)
+        fix_value(fraction, frac_base)
+      end
+
+      def value_on_others_cases(date_hour, fraction)
+        match = fraction.match(/(\d+)([+-]\d+)/)
+        if match
+          # fraction contains fraction and timezone info. Split them
+          fraction = match[1]
+          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.
+          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
+        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?
       end
+
+      def strformat(date_hour) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+        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'
+        when 15
+          if date_hour[-1] == 'Z'
+            frac_base = 1
+            format = '%Y%m%d%H%M%SZ'
+          else
+            frac_base = 60 * 60
+            format = '%Y%m%d%H%z'
+          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'
+        else
+          prefix = @name.nil? ? type : "tag #{@name}"
+          raise ASN1Error, "#{prefix}: unrecognized format: #{der}"
+        end
+
+        [format, frac_base]
+      end
     end
   end
 end