rasn2 0.16.0 → 1.0.1

data/lib/{rasn1 → rasn2}/types/base.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module RASN1
+module RASN2
   module Types
     # @abstract This is base class for all ASN.1 types.
     #
@@ -34,17 +34,21 @@ module RASN1
     #  -- private tag
     #  PType ::= [PRIVATE 2] EXPLICIT INTEGER
     # These types may be defined as:
-    #  ctype = RASN1::Types::Integer.new(explicit: 0)                      # with explicit, default #asn1_class is :context
-    #  atype = RASN1::Types::Integer.new(explicit: 1, class: :application)
-    #  ptype = RASN1::Types::Integer.new(explicit: 2, class: :private)
+    #  ctype = RASN2::Types::Integer.new(explicit: 0)                      # with explicit, default #asn1_class is :context
+    #  atype = RASN2::Types::Integer.new(explicit: 1, class: :application)
+    #  ptype = RASN2::Types::Integer.new(explicit: 2, class: :private)
     # Sometimes, an EXPLICIT type should be CONSTRUCTED. To do that, use +:constructed+
     # option:
-    #  ptype = RASN1::Types::Integer.new(explicit: 2, class: :private, constructed: true)
+    #  ptype = RASN2::Types::Integer.new(explicit: 2, class: :private, constructed: true)
     #
     # Implicit tagged values may also be defined:
-    #  ctype_implicit = RASN1::Types::Integer.new(implicit: 0)
+    #  ctype_implicit = RASN2::Types::Integer.new(implicit: 0)
     # @author Sylvain Daubert
     class Base # rubocop:disable Metrics/ClassLength
+      ID = nil
+
+      attr_accessor :model
+
       # Allowed ASN.1 classes
       CLASSES = {
         universal: 0x00,
@@ -54,10 +58,10 @@ module RASN1
       }.freeze
 
       def colorize(msg)
-        tracer ? tracer.colorize(msg) : Rainbow.new.wrap(msg)
+        tracer ? tracer.colorize(msg) : self.colorizer.wrap(msg)
       end
 
-      include RASN1::Helpers::Colorize
+      include RASN2::Helpers::Colorize
 
       # Binary mask to get class
       # @private
@@ -85,7 +89,7 @@ module RASN1
       private :raw_data, :raw_length
 
       def tracer
-        ::RASN1.tracer
+        ::RASN2.tracer
       end
 
       # Get ASN.1 type
@@ -199,6 +203,10 @@ module RASN1
         defined?(@tag) ? @tag == :implicit : nil # rubocop:disable Style/ReturnNilInPredicateMethodDefinition
       end
 
+      def private?
+        self.instance_of?(Types::Tag)
+      end
+
       # @abstract This method SHOULD be partly implemented by subclasses, which
       #   SHOULD respond to +#value_to_der+.
       # @return [String] DER-formated string
@@ -254,14 +262,43 @@ module RASN1
         value_to_der.size
       end
 
+      def attributes
+        attributes = []
+        attributes << 'OPTIONAL' if optional?
+        attributes << 'CONSTRUCTED' if constructed? && !(self.class < Constructed)
+        attributes << 'EXPLICIT' if explicit?
+        attributes << 'IMPLICIT' if implicit?
+        attributes
+      end
+
       # @param [Integer] level
       # @return [String]
-      def inspect(level=0, color: true)
-        str = common_inspect(level)
-        str << ' ' << inspect_value
-        str << ' OPTIONAL' if optional?
-        str << " DEFAULT #{@default}" unless @default.nil?
-        str
+      def inspect(level=0, color: false)
+        parts = []
+        new_level = level.abs + 1
+
+        begin_colorizer(color)
+        parts << common_inspect(level, color: color)
+
+        if constructed?
+          if @value.is_a?(Array)
+            @value.each do |value|
+              parts << "\n"
+              parts << value.inspect(new_level, color: color).to_s
+            end
+          else
+            parts << "\n"
+            if @value.is_a?(Base)
+              parts << @value.inspect(new_level, color: color).to_s
+            else
+              @value.inspect.to_s
+            end
+          end
+        else
+          parts << inspect_value unless inspect_value.empty?
+        end
+        end_colorizer
+        parts.reject(&:empty?).join(' ')
       end
 
       # Objects are equal if they have same class AND same DER
@@ -303,12 +340,14 @@ module RASN1
       def trace
         return trace_real if value?
 
-        msg = msg_type
-        if default.nil? # rubocop:disable Style/ConditionalAssignment
-          msg << " #{colorize_nil}"
-        else
-          msg << " #{colorize_attribute('DEFAULT VALUE')} #{colorize_default(value)}"
-        end
+        parts = [msg_type]
+        parts << if default.nil?
+                   colorize_nil
+                 else
+                   colorize_default(value)
+                 end
+
+        parts.reject(&:empty?).join(' ')
       end
 
       # @private Parse tage and length from binary string. Return data length and binary data.
@@ -346,42 +385,28 @@ module RASN1
         @value = der
       end
 
-      private
-
       def trace_real
-        encoded_id = unpack(encode_identifier_octets)
+        raw_id = encode_identifier_octets
+        encoded_id = raw_id.unpack1('w*')
         data_length = raw_data.length
-        encoded_length = unpack(raw_length)
-        msg = "#{msg_type} #{parens_hex(encoded_id)}, #{length_specifier(data_length, encoded_length)}"
+        encoded_length = raw_length.unpack1('w*')
+        parts = [msg_type(raw_id.unpack1('H*').to_i(16), encoded_id)]
+        msg = parts.reject(&:empty?).join(' ')
+        msg << ", #{length_specifier(data_length, 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.between?(32, 126) ? byte.chr : '.'
-          byte_count += 1
+        format_string = data.size > 65_535 ? '%08X' : '%04X'
+        lines = data.bytes.each_slice(16).map.with_index do |chunk, index|
+          offset = format_string % (index * 16)
+          hex = chunk.map { |b| '%02x' % b }.join(' ')
+          hex_padded = hex.ljust(47) # 16*2 hex digits + 15 spaces
+          ascii = chunk.map { |b| (32..126).cover?(b) ? b.chr : '.' }.join
+          "  #{offset}  #{hex_padded}  |#{ascii}|"
         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
+        "\n#{lines.join("\n")}"
       end
 
       def unpack(binstr)
@@ -389,22 +414,16 @@ module RASN1
       end
 
       def asn1_class_to_s
-        asn1_class == :universal ? '' : asn1_class.to_s.upcase << ' '
+        asn1_class.to_s.upcase
       end
 
-      def msg_type(no_id: false)
-        msg = name.nil? ? +'' : "#{colorize_name(name)} "
-        msg << "#{colorize_id(id, asn1_class_to_s)} " unless no_id
-        msg << if explicit?
-                 + "#{colorize_attribute('EXPLICIT')} "
-               elsif implicit?
-                 +  "#{colorize_attribute('IMPLICIT')} "
-               else
-                 +''
-               end
-        msg << colorize_class(type)
-        msg << " #{colorize_attribute('OPTIONAL')}" if optional?
-        msg
+      def msg_type(raw_id=nil, _encoded_id=nil, no_id: false)
+        parts = []
+        parts << colorize_name(name) unless name.nil?
+        real_id = no_id ? nil : raw_id || id
+        parts << colorize_id(id, asn1_class_to_s) if real_id
+        parts << colorize_class(type, real_id, *self.attributes)
+        parts.reject(&:empty?).join(' ')
       end
 
       def pc_bit
@@ -417,22 +436,32 @@ module RASN1
         end
       end
 
-      def common_inspect(level)
-        lvl = [level, 0].max
-        str = '  ' * lvl
-        str << "#{@name} " unless @name.nil?
-        str << asn1_class_to_s
-        str << "[#{id}] EXPLICIT " if explicit?
-        str << "[#{id}] IMPLICIT " if implicit?
-        str << "#{type}:"
+      def universal?
+        @asn1_class == :universal
+      end
+
+      def common_inspect(level=0, color: false)
+        begin_colorizer(color)
+        parts = []
+        parts << "(#{model})" if model
+        parts << colorize_name(name) if name
+        parts << colorize_id(id, asn1_class_to_s) if id && !universal?
+        class_name = colorize_class(type, nil, *self.attributes)
+        class_name += ':' if constructed?
+        parts << class_name
+        end_colorizer
+        "#{"  " * level}" + parts.reject(&:empty?).join(' ').to_s
       end
 
       def inspect_value
-        if value?
-          value.inspect
-        else
-          '(NO VALUE)'
-        end
+        str = if value?
+                colorize_value(value.inspect)
+              else
+                colorize_nil('(NO VALUE)')
+              end
+
+        str += colorize_default(@default) if @default
+        str
       end
 
       def value_to_der
@@ -466,7 +495,7 @@ module RASN1
       end
 
       # handle undocumented option +:tag_value+, used internally by
-      # {RASN1.parse} to parse non-universal class tags.
+      # {RASN2.parse} to parse non-universal class tags.
       def set_tag(options) # rubocop:disable Naming/AccessorMethodName
         @constructed = options[:constructed]
         if options[:explicit]
@@ -586,6 +615,8 @@ module RASN1
         elsif !@default.nil?
           @value = @default
         else
+          return true if self.instance_of?(Tag)
+
           raise_id_error(der)
         end
         false
@@ -638,18 +669,24 @@ module RASN1
 
       def raise_id_error(der)
         msg = name.nil? ? +'' : "#{name}: "
-        msg << "Expected #{self2name} but get #{der2name(der)}"
+        msg << "Expected #{self2name} but got #{der2name(der)}"
 
         raise ASN1Error, msg
       end
 
       def self2name
-        name = "#{colorize_class(asn1_class.to_s.upcase)} #{colorize_attribute(constructed? ? 'CONSTRUCTED' : 'PRIMITIVE')}"
+        parts = [asn1_class.to_s.upcase]
+        parts << (constructed? ? 'CONSTRUCTED' : 'PRIMITIVE').to_s
         if implicit? || explicit?
-          name << ' 0x%X (0x%s)' % [id, bin2hex(encode_identifier_octets)]
+          parts << '0x%X (0x%s)' % [id, bin2hex(encode_identifier_octets)]
         else
-          name << ' ' << colorize_class(self.class.type)
+          parts << self.class.type.to_s
         end
+        parts.reject(&:empty?).join(' ')
+      end
+
+      def indent(input, by=2)
+        input.split("\n").map { |line| ("  " * by) + line }.join("\n")
       end
 
       def der2name(der)
@@ -658,11 +695,12 @@ module RASN1
         asn1_class, pc, id, id_size = Types.decode_identifier_octets(der)
         name = "#{asn1_class.to_s.upcase} #{pc.to_s.upcase}"
         type =  find_type(id)
-        name << " #{type.nil? ? "#{colorize(bin2hex(der[0...id_size])).magenta}" : colorize(type.encoded_type).green}"
+        name << " #{type.nil? ? bin2hex(der[0...id_size]).to_s : type.encoded_type}"
       end
 
       def find_type(id)
         Types.constants.map { |c| Types.const_get(c) }
+             .grep(Class)
              .select { |klass| klass < Primitive || klass < Constructed }
              .find { |klass| id == klass::ID }
       end

data/lib/{rasn1 → rasn2}/types/bit_string.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module RASN1
+module RASN2
   module Types
     # ASN.1 Bit String
     # @author Sylvain Daubert
@@ -34,11 +34,8 @@ module RASN1
         end
       end
 
-      # @param [Integer] level
-      # @return [String]
-      def inspect(level=0)
-        str = common_inspect(level)
-        str << " #{value.inspect} (bit length: #{bit_length})"
+      def inspect_value
+        "(bit length: #{bit_length}): #{value.inspect}"
       end
 
       # Same as {Base#can_build?} but also check bit_length

data/lib/{rasn1 → rasn2}/types/bmp_string.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module RASN1
+module RASN2
   module Types
     # ASN.1 BmpString
     # @since 0.12.0

data/lib/{rasn1 → rasn2}/types/boolean.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module RASN1
+module RASN2
   module Types
     # ASN.1 Boolean
     # @author Sylvain Daubert
@@ -50,7 +50,7 @@ module RASN1
       def trace_data
         return super if explicit?
 
-        '    ' + colorize_bool(raw_data != "\x00".b, raw_data.unpack1('H*'))
+        "    #{colorize_bool(raw_data != "\x00".b, raw_data)}"
       end
     end
   end

data/lib/{rasn1 → rasn2}/types/choice.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module RASN1
+module RASN2
   module Types
     # A ASN.1 CHOICE is a choice between different types.
     #
@@ -25,7 +25,7 @@ module RASN1
     #
     # == Parse a CHOICE
     # Parsing a CHOICE set {#chosen} and set value to chosen type. If parsed string does
-    # not contain a type from CHOICE, a {RASN1::ASN1Error} is raised.
+    # not contain a type from CHOICE, a {RASN2::ASN1Error} is raised.
     #   str = "\x04\x03abc"
     #   choice.parse! str
     #   choice.chosen        # => 2
@@ -126,12 +126,12 @@ module RASN1
 
       # @param [::Integer] level
       # @return [String]
-      def inspect(level=0)
+      def inspect(level=0, color: true)
         str = common_inspect(level)
         str << if defined?(@chosen) && value?
-                 "\n#{@value[@chosen].inspect(level + 1)}"
+                 @value[@chosen].inspect(level + 1)
                else
-                 ' not chosen!'
+                 'not chosen!'
                end
       end
 

data/lib/{rasn1 → rasn2}/types/constrained.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-module RASN1
+module RASN2
   module Types
-    # Mixin to add constraints on a RASN1 type.
+    # Mixin to add constraints on a RASN2 type.
     # Should not be used directly but through {Types.define_type}.
     # @version 0.11.0
     # @author Sylvain Daubert

data/lib/{rasn1 → rasn2}/types/constructed.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module RASN1
+module RASN2
   module Types
     # @abstract This class SHOULD be used as base class for all ASN.1 primitive
     #  types.
@@ -23,29 +23,6 @@ module RASN1
               (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
-          str = common_inspect(level)
-          str << "\n"
-          level = level.abs + 1
-          @value.each do |item|
-            case item
-            when Base, Model, Wrapper
-              str << "#{item.inspect(level)}\n"
-            else
-              str << '  ' * level
-              str << "#{item.inspect}\n"
-            end
-          end
-          str
-        else
-          super
-        end
-      end
     end
   end
 end

data/lib/{rasn1 → rasn2}/types/enumerated.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-module RASN1
+module RASN2
   module Types
     # ASN.1 Enumerated
     #
     # An enumerated type permits to assign names to integer values. It may be defined
     # different ways:
-    #  enum = RASN1::Types::Enumerated.new(enum: { 'a' => 0, 'b' => 1, 'c' => 2 })
-    #  enum = RASN1::Types::Enumerated.new(enum: { a: 0, b: 1, c: 2 })
+    #  enum = RASN2::Types::Enumerated.new(enum: { 'a' => 0, 'b' => 1, 'c' => 2 })
+    #  enum = RASN2::Types::Enumerated.new(enum: { a: 0, b: 1, c: 2 })
     # Its value should be setting as an Integer or a String/symbol:
     #  enum.value = :b
     #  enum.value = 1   # equivalent to :b

data/lib/{rasn1 → rasn2}/types/generalized_time.rb

@@ -2,7 +2,7 @@
 
 require 'strptime'
 
-module RASN1
+module RASN2
   module Types
     # ASN.1 GeneralizedTime
     #

data/lib/{rasn1 → rasn2}/types/ia5_string.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module RASN1
+module RASN2
   module Types
     # ASN.1 IA5 String
     # @author Sylvain Daubert
@@ -16,6 +16,10 @@ module RASN1
       def self.type
         'IA5String'
       end
+
+      def inspect_value
+        colorize_value(@value.inspect)
+      end
     end
   end
 end

data/lib/{rasn1 → rasn2}/types/integer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module RASN1
+module RASN2
   module Types
     # ASN.1 Integer
     # @author Sylvain Daubert
@@ -155,8 +155,9 @@ module RASN1
 
       def trace_data
         return super if explicit?
+
         i = der_to_int_value(raw_data)
-        return "    #{int_with_hex(i, raw_data.unpack1('H*'))}" if @enum.empty?
+        return "    #{int_with_hex(i, raw_data.unpack1('w*'))}" if @enum.empty?
 
         v = int_to_enum(i, check_enum: false)
         "    #{colorize_enum(v, raw_data)}"

data/lib/{rasn1 → rasn2}/types/null.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module RASN1
+module RASN2
   module Types
     # ASN.1 Null
     # @author Sylvain Daubert
@@ -9,10 +9,11 @@ module RASN1
       ID = 0x05
 
       # @return [String]
-      def inspect(level=0)
-        str = common_inspect(level)[0..-2] # remove terminal ':'
-        str << ' OPTIONAL' if optional?
-        str
+      def inspect(level=0, color: true)
+        begin_colorizer(color)
+        result = common_inspect(level)
+        end_colorizer
+        result
       end
 
       # @return [Boolean]

data/lib/{rasn1 → rasn2}/types/numeric_string.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module RASN1
+module RASN2
   module Types
     # ASN.1 Numeric String
     # @author Sylvain Daubert

data/lib/{rasn1 → rasn2}/types/object_id.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module RASN1
+module RASN2
   module Types
     # ASN.1 Object ID
     # @author Sylvain Daubert

data/lib/{rasn1 → rasn2}/types/octet_string.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module RASN1
+module RASN2
   module Types
     # ASN.1 Octet String
     #
@@ -15,11 +15,8 @@ module RASN1
       # OctetString id value
       ID = 4
 
-      # @param [::Integer] level
-      # @return [String]
-      def inspect(level=0)
-        str = common_inspect(level)
-        str << " #{value.inspect}"
+      def inspect_value
+        value.inspect
       end
 
       # Make string value from +der+ string. Force encoding to UTF-8

data/lib/{rasn1 → rasn2}/types/primitive.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module RASN1
+module RASN2
   module Types
     # @abstract This class SHOULD be used as base class for all ASN.1 primitive
     #  types.

data/lib/{rasn1 → rasn2}/types/printable_string.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module RASN1
+module RASN2
   module Types
     # ASN.1 Printable String
     # @author Sylvain Daubert

data/lib/{rasn1 → rasn2}/types/sequence.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module RASN1
+module RASN2
   module Types
     # ASN.1 sequence
     #
@@ -13,15 +13,15 @@ module RASN1
     #    house [1] IMPLICIT INTEGER DEFAULT 0
     #  }
     # do:
-    #  seq = RASN1::Types::Sequence.new
+    #  seq = RASN2::Types::Sequence.new
     #  seq.value = [
-    #               RASN1::Types::Integer.new
-    #               RASN1::Types::Integer.new(explicit: 0, optional: true),
-    #               RASN1::Types::Integer.new(implicit: 1, default: 0)
+    #               RASN2::Types::Integer.new
+    #               RASN2::Types::Integer.new(explicit: 0, optional: true),
+    #               RASN2::Types::Integer.new(implicit: 1, default: 0)
     #              ]
     #
     # A sequence may also be used without value to not parse sequence content:
-    #  seq = RASN1::Types::Sequence.new(:seq)
+    #  seq = RASN2::Types::Sequence.new(:seq)
     #  seq.parse!(der_string)
     #  seq.value    # => String
     # @author Sylvain Daubert