rasn1 0.6.8 → 0.9.0

data/lib/rasn1/types/integer.rb

@@ -1,132 +1,140 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 Integer
     # @author Sylvain Daubert
     class Integer < Primitive
       # @return [Hash,nil]
       attr_reader :enum
 
-      TAG = 0x02
-
-      # @overload initialize(options={})
-      #   @option options [Hash] :enum enumeration hash. Keys are names, and values
-      #     are integers.
-      #   @raise [EnumeratedError] +:default+ value is unknown when +:enum+ key is present
-      # @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] +:default+ value is unknown when +:enum+ key is present
+      # Integer id value
+      ID = 2
+
+      # @option options [Hash] :enum enumeration hash. Keys are names, and values
+      #   are integers.
+      # @raise [EnumeratedError] +:default+ value is unknown when +:enum+ key is present
       # @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
-        @enum = opts[:enum]
-
-        return if @enum.nil?
-
-        # To ensure @value has the correct type
-        self.value = @value
-
-        case @default
-        when String,Symbol
-          unless @enum.has_key? @default
-            raise EnumeratedError, "TAG #@name: unknwon enumerated default value #@default"
-          end
-        when ::Integer
-          if @enum.has_value? @default
-            @default = @enum.key(@default)
-          else
-            raise EnumeratedError, "TAG #@name: default value #@default not in enumeration"
-          end
-        when nil
-        else
-          raise TypeError, "TAG #@name: #{@default.class} not handled as default value"
-        end
+        initialize_enum(@options[:enum])
       end
 
       # @param [Integer,String,Symbol,nil] v
-      # @return [String,Symbol,nil]
-      def value=(v)
-        case v
-        when String,Symbol
-          raise EnumeratedError, 'TAG #@name has no :enum' if @enum.nil?
-
-          unless @enum.has_key? v
-            raise EnumeratedError, "TAG #@name: unknwon enumerated value #{v}"
-          end
-          @value = v
+      # @return [void]
+      def value=(val)
+        @no_value = false
+        case val
+        when String, Symbol
+          value_from_string_or_symbol(val)
         when ::Integer
-          if @enum.nil?
-            @value = v
-          elsif @enum.has_value? v
-            @value = @enum.key(v)
-          else
-            raise EnumeratedError, "TAG #@name: #{v} not in enumeration"
-          end
+          value_from_integer(val)
         when nil
-          @value = nil
+          @no_value = true
+          @value = void_value
         else
-          raise EnumeratedError, "TAG #@name: not in enumeration"
+          raise EnumeratedError, "#{@name}: not in enumeration"
         end
       end
 
+      # @return [Integer]
+      def void_value
+        0
+      end
+
       # Integer value
       # @return [Integer]
       def to_i
-        if @enum.nil?
-          @value || @default || 0
+        if @enum.empty?
+          value? ? @value : @default || 0
         else
-          @enum[@value || @default] || 0
+          @enum[value? ? @value : @default] || 0
         end
       end
 
       private
 
-      def int_value_to_der(value=nil)
-        v = value || @value
-        size = v.bit_length / 8 + (v.bit_length % 8 > 0 ? 1 : 0)
-        size = 1 if size == 0
-        comp_value = if v > 0
-                       # If MSB is 1, increment size to set initial octet
-                       # to 0 to amrk it as a positive integer
-                       size += 1 if v >> (size * 8 - 1) == 1
-                       v
-                     else
-                       ~(v.abs) + 1
-                     end
-        ary = []
-        size.times { ary << (comp_value & 0xff); comp_value >>= 8 }
+      def initialize_enum(enum)
+        @enum = enum || {}
+        return if @enum.empty?
+
+        # To ensure @value has the correct type
+        self.value = @value if value?
+
+        check_enum_default
+      end
+
+      def check_enum_default
+        case @default
+        when String, Symbol
+          raise EnumeratedError, "#{@name}: unknwon enumerated default value #@{default}" unless @enum.key?(@default)
+        when ::Integer
+          raise EnumeratedError, "#{@name}: default value #@{default} not in enumeration" unless @enum.value?(@default)
+
+          @default = @enum.key(@default)
+        when nil
+        else
+          raise TypeError, "#{@name}: #{@default.class} not handled as default value"
+        end
+      end
+
+      def value_from_string_or_symbol(val)
+        raise EnumeratedError, "#{@name} has no :enum" if @enum.empty?
+        raise EnumeratedError, "#{@name}: unknwon enumerated value #{val}" unless @enum.key? val
+
+        @value = val
+      end
+
+      def value_from_integer(val)
+        if @enum.empty?
+          @value = val
+        elsif @enum.value? val
+          @value = @enum.key(val)
+        else
+          raise EnumeratedError, "#{@name}: #{val} not in enumeration"
+        end
+      end
+
+      def int_value_to_der(value)
+        size = compute_size(value)
+        comp_value = value >= 0 ? value : (~(-value) + 1) & ((1 << (size * 8)) - 1)
+        ary = comp_value.digits(256)
+        # v is > 0 and its MSBit is 1. Add a 0 byte to mark it as positive
+        ary << 0 if value.positive? && (value >> (size * 8 - 1) == 1)
         ary.reverse.pack('C*')
       end
 
+      def compute_size(value)
+        size = value.bit_length / 8 + ((value.bit_length % 8).positive? ? 1 : 0)
+        size = 1 if size.zero?
+        size
+      end
+
       def value_to_der
         case @value
         when String, Symbol
-          int_value_to_der @enum[@value]
+          int_value_to_der(@enum[@value])
         when ::Integer
-          int_value_to_der
+          int_value_to_der(@value)
         else
-          raise TypeError, "TAG #@name: #{@value.class} not handled"
+          raise TypeError, "#{@name}: #{@value.class} not handled"
         end
       end
 
-      def der_to_int_value(der, ber: false)
+      def der_to_int_value(der, ber: false) # rubocop:disable Lint/UnusedMethodArgument
         ary = der.unpack('C*')
         v = ary.reduce(0) { |len, b| (len << 8) | b }
-        if ary[0] & 0x80 == 0x80
-          v = -((~v & ((1 << v.bit_length) - 1)) + 1)
-        end
+        v = -((~v & ((1 << v.bit_length) - 1)) + 1) if ary[0] & 0x80 == 0x80
         v
       end
 
       def der_to_value(der, ber: false)
         @value = der_to_int_value(der, ber: ber)
-        return if @enum.nil?
+        return if @enum.empty?
 
+        int_value = @value
         @value = @enum.key(@value)
-        raise EnumeratedError, "TAG #@name: value #{v} not in enumeration" if @value.nil?
+        raise EnumeratedError, "#{@name}: value #{int_value} not in enumeration" unless value?
       end
 
       def explicit_type

data/lib/rasn1/types/null.rb

@@ -1,18 +1,17 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 Null
     # @author Sylvain Daubert
     class Null < Primitive
-      TAG = 0x05
+      # Null id value
+      ID = 0x05
 
       # @return [String]
       def inspect(level=0)
-        str = ''
-        str << '  ' * level if level > 0
-        str << "#{@name} " unless @name.nil?
-        str << "#{type}"
-        str << " OPTIONAL" if optional?
+        str = common_inspect(level)[0..-2] # remove terminal ':'
+        str << ' OPTIONAL' if optional?
         str
       end
 
@@ -22,9 +21,11 @@ module RASN1
         ''
       end
 
-      def der_to_value(der, ber: false)
-        raise ASN1Error, "NULL TAG should not have content!" if der.length > 0
-        @value = nil
+      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
     end
   end

data/lib/rasn1/types/numeric_string.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 Numeric String
     # @author Sylvain Daubert
     class NumericString < OctetString
-      TAG = 18
+      # NumericString id value
+      ID = 18
 
       # Get ASN.1 type
       # @return [String]
@@ -13,21 +15,19 @@ module RASN1
       end
 
       private
-      
+
       def value_to_der
         check_characters
         @value.to_s.force_encoding('BINARY')
       end
 
-      def der_to_value(der, ber:false)
+      def der_to_value(der, ber: false)
         super
         check_characters
       end
 
       def check_characters
-        if @value.to_s =~ /([^0-9 ])/
-          raise ASN1Error, "NUMERIC STRING #@name: invalid character: '#{$1}'"
-        end
+        raise ASN1Error, "NUMERIC STRING #{@name}: invalid character: '#{$1}'" if @value.to_s =~ /([^0-9 ])/
       end
     end
   end

data/lib/rasn1/types/object_id.rb

@@ -1,77 +1,47 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 Object ID
     # @author Sylvain Daubert
     class ObjectId < Primitive
-      TAG = 6
+      # ObjectId id value
+      ID = 6
 
       private
 
       def value_to_der
-        ids = @value.split('.').map! { |str| str.to_i }
+        ids = @value.to_s.split('.').map!(&:to_i)
 
-        if ids[0] > 2
-          raise ASN1Error, 'OBJECT ID #@name: first subidentifier should be less than 3'
-        end
-        if ids[0] < 2 and ids[1] > 39
-          raise ASN1Error, 'OBJECT ID #@name: second subidentifier should be less than 40'
-        end
+        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]
         ids.map! do |v|
           next v if v < 128
 
-          ary = []
-          while v > 0
-            ary.unshift (v & 0x7f) | 0x80
-            v >>= 7
-          end
-          ary[-1] &= 0x7f
-          ary
+          unsigned_to_chained_octets(v)
         end
         ids.flatten.pack('C*')
       end
 
-      def der_to_value(der, ber: false)
+      def der_to_value(der, ber: false) # rubocop:disable Lint/UnusedMethodArgument
         bytes = der.unpack('C*')
-        ids = if bytes[0] < 80
-                remove = 1
-                [ bytes[0] / 40, bytes[0] % 40]
-              elsif bytes[0] < 128
-                remove = 1
-                [2, bytes[0] - 80]
-              else
-                remove = 1
-                second_id = bytes[0] & 0x7f
-                bytes[1..-1].each do |byte|
-                  remove += 1
-                  second_id <<= 7
-                  if byte < 128
-                    second_id |= byte
-                    break
-                  else
-                    second_id |= byte & 0x7f
-                  end
-                end
-                [2, second_id - 80]
-              end
 
-        id = 0
-        bytes.shift(remove)
+        ids = []
+        current_id = 0
         bytes.each do |byte|
-          if byte < 128
-            if id == 0
-              ids << byte
-            else
-              ids << ((id << 7) | byte)
-              id = 0
-            end
-          else
-            id = (id << 7) | (byte & 0x7f)
+          current_id = (current_id << 7) | (byte & 0x7f)
+          if (byte & 0x80).zero?
+            ids << current_id
+            current_id = 0
           end
         end
 
+        first_id = [2, ids.first / 40].min
+        second_id = ids.first - first_id * 40
+        ids[0..0] = [first_id, second_id]
+
         @value = ids.join('.')
       end
     end

data/lib/rasn1/types/octet_string.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 Octet String
     #
     # An OCTET STRINT may contain another primtive object:
@@ -11,13 +12,12 @@ module RASN1
     #  os.to_der   # => DER string with INTEGER in OCTET STRING
     # @author Sylvain Daubert
     class OctetString < Primitive
-      TAG = 0x04
+      # OctetString id value
+      ID = 4
 
       def inspect(level=0)
-        str = ''
-        str << '  ' * level if level > 0
-        str << "#{@name} " unless @name.nil?
-        str << "#{type}: #{value.inspect}"
+        str = common_inspect(level)
+        str << " #{value.inspect}"
       end
     end
   end

data/lib/rasn1/types/primitive.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.
     # @author Sylvain Daubert

data/lib/rasn1/types/printable_string.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 Printable String
     # @author Sylvain Daubert
     class PrintableString < OctetString
-      TAG = 19
+      # PrintableString id value
+      ID = 19
 
       # Get ASN.1 type
       # @return [String]
@@ -13,21 +15,20 @@ module RASN1
       end
 
       private
-      
+
       def value_to_der
         check_characters
         @value.to_s.force_encoding('BINARY')
       end
 
-      def der_to_value(der, ber:false)
+      def der_to_value(der, ber: false)
         super
         check_characters
       end
 
       def check_characters
-        if @value.to_s =~ /([^a-zA-Z0-9 '=\(\)\+,\-\.\/:\?])/
-          raise ASN1Error, "PRINTABLE STRING #@name: invalid character: '#{$1}'"
-        end
+        m = @value.to_s.match(%r{([^a-zA-Z0-9 '=()+,\-./:?])})
+        raise ASN1Error, "PRINTABLE STRING #{@name}: invalid character: '#{m[1]}'" if m
       end
     end
   end

data/lib/rasn1/types/sequence.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 sequence
     #
     # A sequence is a collection of another ASN.1 types.
@@ -25,17 +26,43 @@ module RASN1
     #  seq.value    # => String
     # @author Sylvain Daubert
     class Sequence < Constructed
-      TAG = 0x10
+      # Sequence id value
+      ID = 0x10
 
       # @see Base#initialize
-      def initialize(value_or_options={}, options={})
+      def initialize(options={})
         super
+        @no_value = false
         @value ||= []
       end
 
       def initialize_copy(other)
         super
-        @value = @value.map { |v| v.dup }
+        @value = case @value
+                 when Array
+                   @value.map(&:dup)
+                 else
+                   @value.dup
+                 end
+      end
+
+      # @return [Array]
+      def void_value
+        []
+      end
+
+      # Get element at index +idx+, or element of name +name+
+      # @param [Integer, String, Symbol] idx_or_name
+      # @return [Object,nil]
+      def [](idx_or_name)
+        return unless @value.is_a?(Array)
+
+        case idx_or_name
+        when Integer
+          @value[idx_or_name.to_i]
+        when String, Symbol
+          @value.find { |elt| elt.name == idx_or_name }
+        end
       end
 
       private
@@ -43,14 +70,14 @@ module RASN1
       def value_to_der
         case @value
         when Array
-          @value.map { |element| element.to_der }.join
+          @value.map(&:to_der).join
         else
           @value.to_s
         end
       end
 
-      def der_to_value(der, ber:false)
-        if @value.is_a?(Array) and !@value.empty?
+      def der_to_value(der, ber: false) # rubocop:disable Lint/UnusedMethodArgument
+        if @value.is_a?(Array) && !@value.empty?
           nb_bytes = 0
           @value.each do |element|
             nb_bytes += element.parse!(der[nb_bytes..-1])
@@ -58,7 +85,11 @@ module RASN1
         else
           @value = der
           der.length
-        end 
+        end
+      end
+
+      def explicit_type
+        self.class.new(value: @value)
       end
     end
   end