rasn1 0.6.8 → 0.9.0

data/lib/rasn1/types/bit_string.rb

@@ -1,91 +1,89 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 Bit String
     # @author Sylvain Daubert
     class BitString < Primitive
-      TAG = 0x03
+      # BitString id value
+      ID = 3
 
       # @param [Integer] bit_length
       # @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
-        opts = value_or_options.is_a?(Hash) ? value_or_options : options
         if @default
-          if opts[:bit_length].nil?
-            raise ASN1Error, "TAG #@name: default bit length is not defined"
-          end
-          @default_bit_length = opts[:bit_length]
+          raise ASN1Error, "#{@name}: default bit length is not defined" if @options[:bit_length].nil?
+
+          @default_bit_length = @options[:bit_length]
         end
-        @bit_length = opts[:bit_length]
+        @bit_length = @options[:bit_length]
       end
 
       # Get bit length
       def bit_length
-        if @value.nil?
-          @default_bit_length
-        else
+        if value?
           @bit_length
+        else
+          @default_bit_length
         end
       end
 
       # @param [Integer] level
       # @return [String]
       def inspect(level=0)
-        str = ''
-        str << '  ' * level if level > 0
-        str << "#{name} " unless @name.nil?
-        str << "#{type}: #{value.inspect} (bit length: #{bit_length})"
+        str = common_inspect(level)
+        str << " #{value.inspect} (bit length: #{bit_length})"
       end
 
       private
 
-      def build_tag?
-        !(!@default.nil? and (@value.nil? or @value == @default and
-                              @bit_length == @default_bit_length)) and
-          !(optional? and @value.nil?)
+      def can_build?
+        !(!@default.nil? && (!value? || (@value == @default) &&
+                              (@bit_length == @default_bit_length))) &&
+          !(optional? && !value?)
       end
 
       def value_to_der
-        raise ASN1Error, "TAG #@name: bit length is not set" if bit_length.nil?
+        raise ASN1Error, "#{@name}: bit length is not set" if bit_length.nil?
 
-        while @value.length * 8 < @bit_length
-          @value << "\x00"
-        end
-        @value.force_encoding('BINARY')
-
-        if @value.length * 8 > @bit_length
-          max_len = @bit_length / 8 + (@bit_length % 8 > 0 ? 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 > 0
-          last_byte = @value[-1].unpack('C').first
+        if unused.positive?
+          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

@@ -1,34 +1,42 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 Boolean
     # @author Sylvain Daubert
     class Boolean < Primitive
-      TAG = 0x01
+      # Boolean id value
+      ID = 0x01
+
+      # @private
+      DER_TRUE = 0xff
+      # @private
+      DER_FALSE = 0
+
+      # @return [false]
+      def void_value
+        false
+      end
 
       private
 
       def value_to_der
-        [@value ? 0xff : 0x00].pack('C')
+        [@value ? DER_TRUE : DER_FALSE].pack('C')
       end
 
       def der_to_value(der, ber: false)
-        unless der.size == 1
-          raise ASN1Error, "tag #@name: BOOLEAN should have a length of 1"
-        end
+        raise ASN1Error, "tag #{@name}: BOOLEAN should have a length of 1" unless der.size == 1
 
-        bool = der.unpack('C').first
+        bool = der.unpack1('C')
         case bool
-        when 0
+        when DER_FALSE
           @value = false
-        when 0xff
+        when DER_TRUE
           @value = true
         else
-          if ber
-            @value = true
-          else
-            raise ASN1Error, "tag #@name: bad value 0x%02x for BOOLEAN" % bool
-          end
+          raise ASN1Error, "tag #{@name}: bad value 0x%02x for BOOLEAN" % bool unless ber
+
+          @value = true
         end
       end
     end

data/lib/rasn1/types/choice.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # A ASN.1 CHOICE is a choice between different types.
     #
     # == Create a CHOICE
@@ -31,7 +32,6 @@ module RASN1
     #   choice.chosen_value  # => "abc"
     # @author Sylvain Daubert
     class Choice < Base
-
       # Chosen type
       # @return [Integer] index of type in choice value
       attr_accessor :chosen
@@ -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
@@ -79,7 +79,7 @@ module RASN1
         @value.each_with_index do |element, i|
           begin
             @chosen = i
-            nb_bytes = element.parse!(der)
+            nb_bytes = element.parse!(der, ber: ber)
             parsed = true
             return nb_bytes
           rescue ASN1Error
@@ -87,19 +87,16 @@ module RASN1
             next
           end
         end
-        raise ASN1Error, "CHOICE #@name: no type matching #{der.inspect}" unless parsed
+        raise ASN1Error, "CHOICE #{@name}: no type matching #{der.inspect}" unless parsed
       end
 
       def inspect(level=0)
-        str = ''
-        str << '  ' * level if level > 0
-        str << "#{name} " if name
-        str << "#{type}:"
-        if !defined? @chosen
-          str << ' not chosen!'
-        else
-          str << "\n#{@value[@chosen].inspect(level+1)}"
-        end
+        str = common_inspect(level)
+        str << if defined? @chosen
+                 "\n#{@value[@chosen].inspect(level + 1)}"
+               else
+                 ' not chosen!'
+               end
       end
 
       private
@@ -110,5 +107,3 @@ module RASN1
     end
   end
 end
-
-

data/lib/rasn1/types/constructed.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # @abstract This class SHOULD be used as base class for all ASN.1 primitive
     #  types.
     # Base class for all ASN.1 constructed types
@@ -12,19 +13,16 @@ module RASN1
       def inspect(level=0)
         case @value
         when Array
-          str = ''
-          str << '  ' * level if level > 0
-          str << "#{@name} " unless @name.nil?
-          level = level.abs
-          str << "#{type}:\n"
-          level += 1
+          str = common_inspect(level)
+          str << "\n"
+          level = level.abs + 1
           @value.each do |item|
             case item
             when Base, Model
-              next if item.optional? and item.value.nil?
               str << "#{item.inspect(level)}\n"
             else
-              str <<  '  ' * level + item.inspect + "\n"
+              str << '  ' * level
+              str << "#{item.inspect}\n"
             end
           end
           str

data/lib/rasn1/types/enumerated.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 Enumerated
     #
     # An enumerated type permits to assign names to integer values. It may be defined
@@ -21,23 +22,17 @@ module RASN1
       # @!attribute enum
       # @return [Hash]
 
-      TAG = 0x0a
+      # 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

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 GeneralizedTime
     #
     # +{#value} of a {GeneralizedTime} should be a ruby Time.
@@ -20,7 +21,8 @@ module RASN1
     # second are supported.
     # @author Sylvain Daubert
     class GeneralizedTime < Primitive
-      TAG = 24
+      # GeneralizedTime id value
+      ID = 24
 
       # Get ASN.1 type
       # @return [String]
@@ -28,83 +30,122 @@ module RASN1
         'GeneralizedTime'
       end
 
+      # @return [DateTime]
+      def void_value
+        DateTime.now
+      end
+
       private
-      
+
       def value_to_der
-        if @value.nsec > 0
+        if @value.nsec.positive?
           der = @value.getutc.strftime('%Y%m%d%H%M%S.%9NZ')
           der.sub(/0+Z/, 'Z')
         else
           @value.getutc.strftime('%Y%m%d%H%M%SZ')
         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('.')
+        date_hour = date_hour.to_s
+        fraction = fraction.to_s
+
+        if fraction.empty?
+          value_when_fraction_empty(date_hour)
+        elsif fraction[-1] == 'Z'
+          value_when_fraction_ends_with_z(date_hour, fraction)
+        else
+          value_on_others_cases(date_hour, fraction)
+        end
+      end
+
+      def value_when_fraction_empty(date_hour)
         utc_offset_forced = false
-        if fraction.nil?
-          if date_hour[-1] != 'Z' and 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
+
+        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
-          if fraction[-1] == 'Z'
-            fraction = fraction[0...-1]
-            date_hour << 'Z'
-          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
-          end
+          # 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
-        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
+
+        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
-        # 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)
-          if compare_time.utc_offset != @value.utc_offset
-            @value = compare_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
-        @value += ".#{fraction}".to_r * frac_base unless fraction.nil?
+
+        [format, frac_base]
       end
     end
   end

data/lib/rasn1/types/ia5string.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 IA5 String
     # @author Sylvain Daubert
     class IA5String < OctetString
-      TAG = 22
+      # IA5String id value
+      ID = 22
 
       # Get ASN.1 type
       # @return [String]
@@ -13,15 +15,15 @@ module RASN1
       end
 
       private
-      
+
       def value_to_der
         @value.to_s.force_encoding('US-ASCII').force_encoding('BINARY')
       end
 
-      def der_to_value(der, ber:false)
+      def der_to_value(der, ber: false)
         super
-        @value.force_encoding('US-ASCII')
+        @value.to_s.force_encoding('US-ASCII')
       end
-     end
+    end
   end
 end