rasn1 0.6.8 → 0.7.0

data/lib/rasn1/types/base.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # @abstract This is base class for all ASN.1 types.
     #
     #   Subclasses SHOULD define:
@@ -46,11 +47,25 @@ module RASN1
     class Base
       # Allowed ASN.1 tag classes
       CLASSES = {
-                 universal:   0x00,
-                 application: 0x40,
-                 context:     0x80,
-                 private:     0xc0
-                }
+        universal:   0x00,
+        application: 0x40,
+        context:     0x80,
+        private:     0xc0
+      }.freeze
+
+      # @private Types that cannot be dupped (Ruby <= 2.3)
+      UNDUPPABLE_TYPES = [[NilClass, nil], [TrueClass, true], [FalseClass, false], [Integer, 0]].map do |klass, obj|
+        begin
+          obj.dup
+          nil
+        rescue => TypeError
+          klass
+        end
+      end.compact.freeze
+
+      # Binary mask to get class
+      # @private
+      CLASS_MASK = 0xc0
 
       # Maximum ASN.1 tag number
       MAX_TAG = 0x1e
@@ -71,6 +86,7 @@ module RASN1
       # @return [String]
       def self.type
         return @type if defined? @type
+
         @type = self.to_s.gsub(/.*::/, '').gsub(/([a-z0-9])([A-Z])/, '\1 \2').upcase
       end
 
@@ -91,7 +107,6 @@ module RASN1
         obj
       end
 
-
       # @overload initialize(options={})
       #   @param [Hash] options
       #   @option options [Symbol] :class ASN.1 tag class. Default value is +:universal+.
@@ -128,20 +143,10 @@ module RASN1
         end
       end
 
-      # Used by +#dup+ and +#clone+. Deep copy @value.
-      def initialize_copy(other)
-        @value = case
-                 when NilClass, TrueClass, FalseClass, Integer
-                   @value
-                 else
-                   @value.dup
-                 end
-        @default = case
-                 when NilClass, TrueClass, FalseClass, Integer
-                   @default
-                 else
-                   @default.dup
-                 end
+      # Used by +#dup+ and +#clone+. Deep copy @value and @default.
+      def initialize_copy(_other)
+        @value = @value.dup unless UNDUPPABLE_TYPES.include?(@value.class)
+        @default = @default.dup unless UNDUPPABLE_TYPES.include?(@default.class)
       end
 
       # Get value or default value
@@ -192,7 +197,7 @@ module RASN1
 
       # @return [::Boolean] +true+ if this is a constructed type
       def constructed?
-        !!((self.class < Constructed) ||  @constructed)
+        (self.class < Constructed) || !!@constructed
       end
 
       # Get ASN.1 type
@@ -206,9 +211,9 @@ module RASN1
       def tag
         pc = if @constructed.nil?
                self.class::ASN1_PC
-             elsif @constructed   # true
+             elsif @constructed # true
                Constructed::ASN1_PC
-             else    # false
+             else # false
                0
              end
         tag_value | CLASSES[@asn1_class] | pc
@@ -247,11 +252,9 @@ module RASN1
       # @param [Integer] level
       # @return [String]
       def inspect(level=0)
-        str = ''
-        str << '  ' * level if level > 0
-        str << "#{@name} " unless @name.nil?
-        str << "#{type}: #{value.inspect}"
-        str << " OPTIONAL" if optional?
+        str = common_inspect(level)
+        str << " #{value.inspect}"
+        str << ' OPTIONAL' if optional?
         str << " DEFAULT #{@default}" unless @default.nil?
         str
       end
@@ -265,6 +268,13 @@ module RASN1
 
       private
 
+      def common_inspect(level)
+        lvl = level >= 0 ? level : 0
+        str = '  ' * lvl
+        str << "#{@name} " unless @name.nil?
+        str << "#{type}:"
+      end
+
       def value_to_der
         case @value
         when Base
@@ -274,7 +284,7 @@ module RASN1
         end
       end
 
-      def der_to_value(der, ber:false)
+      def der_to_value(der, ber: false)
         @value = der
       end
 
@@ -292,11 +302,9 @@ module RASN1
         when nil
           @asn1_class = :universal
         when Symbol
-          if CLASSES.keys.include? asn1_class
-            @asn1_class = asn1_class
-          else
-            raise ClassError
-          end
+          raise ClassError unless CLASSES.keys.include? asn1_class
+
+          @asn1_class = asn1_class
         else
           raise ClassError
         end
@@ -330,8 +338,8 @@ module RASN1
       end
 
       def build_tag?
-        !(!@default.nil? and (@value.nil? or @value == @default)) and
-          !(optional? and @value.nil?)
+        !(!@default.nil? && (@value.nil? || (@value == @default))) &&
+          !(optional? && @value.nil?)
       end
 
       def build_tag
@@ -356,22 +364,19 @@ module RASN1
       end
 
       def encode_tag
-        if tag_value <= MAX_TAG
-          [tag].pack('C')
-        else
-          raise ASN1Error, 'multi-byte tag value are not supported'
-        end
+        raise ASN1Error, 'multi-byte tag value are not supported' unless tag_value <= MAX_TAG
+
+        [tag].pack('C')
       end
 
       def encode_size(size)
         if size >= INDEFINITE_LENGTH
           bytes = []
           while size > 255
-            bytes << (size & 0xff)
+            bytes.unshift(size & 0xff)
             size >>= 8
           end
-          bytes << size
-          bytes.reverse!
+          bytes.unshift(size)
           bytes.unshift(INDEFINITE_LENGTH | bytes.size)
           bytes.pack('C*')
         else
@@ -402,27 +407,25 @@ module RASN1
         if length == INDEFINITE_LENGTH
           if primitive?
             raise ASN1Error, "malformed #{type} TAG: indefinite length " \
-              "forbidden for primitive types"
+              'forbidden for primitive types'
+          elsif ber
+            raise NotImplementedError, 'TAG: indefinite length not ' \
+              'supported yet'
           else
-            if ber
-              raise NotImplementedError, "TAG: indefinite length not " \
-                "supported yet"
-            else
-              raise ASN1Error, "TAG: indefinite length forbidden in DER " \
-                "encoding"
-            end
+            raise ASN1Error, 'TAG: indefinite length forbidden in DER ' \
+              'encoding'
           end
         elsif length < INDEFINITE_LENGTH
           data = der[2, length]
         else
           length_length = length & 0x7f
-          length = der[2, length_length].unpack('C*').
-            reduce(0) { |len, b| (len << 8) | b }
+          length = der[2, length_length].unpack('C*')
+                                        .reduce(0) { |len, b| (len << 8) | b }
           data = der[2 + length_length, length]
         end
 
         total_length = 2 + length
-        total_length += length_length if length_length > 0
+        total_length += length_length if length_length.positive?
 
         [total_length, data]
       end
@@ -432,14 +435,18 @@ module RASN1
       end
 
       def raise_tag_error(tag)
-        msg = name.nil? ? '' : "#{name}: "
+        msg = name.nil? ? +'' : +"#{name}: "
         msg << "Expected #{self2name} but get #{tag2name(tag)}"
         raise ASN1Error, msg
       end
 
+      def class_from_numeric_tag(tag)
+        CLASSES.key(tag & CLASS_MASK)
+      end
+
       def self2name
-        name = CLASSES.key(tag & 0xc0).to_s.upcase
-        name << " #{tag & Constructed::ASN1_PC > 0 ? 'CONSTRUCTED' : 'PRIMITIVE'}"
+        name = class_from_numeric_tag(tag).to_s.upcase
+        name << " #{(tag & Constructed::ASN1_PC).positive? ? 'CONSTRUCTED' : 'PRIMITIVE'}"
         if implicit? || explicit?
           name << ' 0x%02X (0x%02X)' % [tag & 0x1f, tag]
         else
@@ -448,15 +455,15 @@ module RASN1
       end
 
       def tag2name(tag)
-        return 'no tag' if tag.nil? or tag.empty?
+        return 'no tag' if tag.nil? || tag.empty?
 
         itag = tag.unpack('C').first
-        name = CLASSES.key(itag & 0xc0).to_s.upcase
-        name << " #{itag & Constructed::ASN1_PC > 0 ? 'CONSTRUCTED' : 'PRIMITIVE'}"
-        type =  Types.constants.map { |c| Types.const_get(c) }.
-                  select { |klass| klass < Primitive || klass < Constructed }.
-                  find { |klass| klass::TAG == itag & 0x1f }
-        name << " #{type.nil? ? "0x%02X (0x%02X)" % [itag & 0x1f, itag] : type.encode_type }"
+        name = class_from_numeric_tag(itag).to_s.upcase
+        name << " #{(itag & Constructed::ASN1_PC).positive? ? 'CONSTRUCTED' : 'PRIMITIVE'}"
+        type =  Types.constants.map { |c| Types.const_get(c) }
+                     .select { |klass| klass < Primitive || klass < Constructed }
+                     .find { |klass| klass::TAG == itag & 0x1f }
+        name << " #{type.nil? ? '0x%02X (0x%02X)' % [itag & 0x1f, itag] : type.encode_type}"
       end
     end
   end

data/lib/rasn1/types/bit_string.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 Bit String
     # @author Sylvain Daubert
     class BitString < Primitive
+      # BitString tag value
       TAG = 0x03
 
       # @param [Integer] bit_length
@@ -25,7 +27,7 @@ module RASN1
         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"
+            raise ASN1Error, "TAG #{@name}: default bit length is not defined"
           end
           @default_bit_length = opts[:bit_length]
         end
@@ -44,37 +46,33 @@ module RASN1
       # @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?)
+        !(!@default.nil? && (@value.nil? || (@value == @default) &&
+                              (@bit_length == @default_bit_length))) &&
+          !(optional? && @value.nil?)
       end
 
       def value_to_der
-        raise ASN1Error, "TAG #@name: bit length is not set" if bit_length.nil?
+        raise ASN1Error, "TAG #{@name}: bit length is not set" if bit_length.nil?
 
-        while @value.length * 8 < @bit_length
-          @value << "\x00"
-        end
+        @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 > 0 ? 1 : 0)
+          max_len = @bit_length / 8 + ((@bit_length % 8).positive? ? 1 : 0)
           @value = @value[0, max_len]
         end
 
         unused = @value.length * 8 - @bit_length
         der = [unused, @value].pack('CA*')
 
-        if unused > 0
+        if unused.positive?
           last_byte = @value[-1].unpack('C').first
           last_byte &= (0xff >> unused) << unused
           der[-1] = [last_byte].pack('C')
@@ -83,7 +81,7 @@ module RASN1
         der
       end
 
-      def der_to_value(der, ber:false)
+      def der_to_value(der, ber: false)
         unused, @value = der.unpack('CA*')
         @bit_length = @value.length * 8 - unused
       end

data/lib/rasn1/types/boolean.rb

@@ -1,34 +1,37 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 Boolean
     # @author Sylvain Daubert
     class Boolean < Primitive
+      # Boolean tag value
       TAG = 0x01
 
+      # @private
+      DER_TRUE = 0xff
+      # @private
+      DER_FALSE = 0
+
       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
         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
@@ -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
+                 ' not chosen!'
+               else
+                 "\n#{@value[@chosen].inspect(level + 1)}"
+               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,17 @@ 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?
+              next if item.optional? && item.value.nil?
+
               str << "#{item.inspect(level)}\n"
             else
-              str <<  '  ' * level + item.inspect + "\n"
+              str << '  ' * level + item.inspect + "\n"
             end
           end
           str