rasn1 0.11.0 → 0.12.1

data/lib/rasn1/types/integer.rb

@@ -20,7 +20,7 @@ module RASN1
         initialize_enum(@options[:enum])
       end
 
-      # @param [Integer,String,Symbol,nil] v
+      # @param [Integer,String,Symbol,nil] val
       # @return [void]
       def value=(val)
         @no_value = false
@@ -128,17 +128,29 @@ module RASN1
         v
       end
 
+      def int_to_enum(int, check_enum: true)
+        raise EnumeratedError, "#{@name}: value #{int} not in enumeration" if check_enum && !@enum.value?(int)
+
+        @enum.key(int) || int
+      end
+
       def der_to_value(der, ber: false)
         @value = der_to_int_value(der, ber: ber)
         return if @enum.empty?
 
-        int_value = @value
-        @value = @enum.key(@value)
-        raise EnumeratedError, "#{@name}: value #{int_value} not in enumeration" unless value?
+        @value = int_to_enum(@value)
       end
 
       def explicit_type
-        self.class.new(name: @name, enum: @enum)
+        self.class.new(name: name, enum: enum)
+      end
+
+      def trace_data
+        return super if explicit?
+        return "    #{der_to_int_value(raw_data)} (0x#{raw_data.unpack1('H*')})" if @enum.empty?
+
+        v = int_to_enum(der_to_int_value(raw_data), check_enum: false)
+        "    #{v} (0x#{raw_data.unpack1('H*')})"
       end
     end
   end

data/lib/rasn1/types/null.rb

@@ -15,6 +15,12 @@ module RASN1
         str
       end
 
+      # @return [Boolean]
+      # Build only if not optional
+      def can_build?
+        !optional?
+      end
+
       private
 
       def value_to_der

data/lib/rasn1/types/numeric_string.rb

@@ -18,7 +18,7 @@ module RASN1
 
       def value_to_der
         check_characters
-        @value.to_s.force_encoding('BINARY')
+        @value.to_s.b
       end
 
       def der_to_value(der, ber: false)

data/lib/rasn1/types/octet_string.rb

@@ -15,6 +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}"

data/lib/rasn1/types/printable_string.rb

@@ -18,7 +18,7 @@ module RASN1
 
       def value_to_der
         check_characters
-        @value.to_s.force_encoding('BINARY')
+        @value.to_s.b
       end
 
       def der_to_value(der, ber: false)

data/lib/rasn1/types/sequence.rb

@@ -36,7 +36,8 @@ module RASN1
         @value ||= []
       end
 
-      def initialize_copy(other)
+      # Deep copy @value
+      def initialize_copy(*)
         super
         @value = case @value
                  when Array
@@ -88,8 +89,12 @@ module RASN1
         end
       end
 
+      def trace_data
+        ''
+      end
+
       def explicit_type
-        self.class.new(value: @value)
+        self.class.new(name: name, value: @value)
       end
     end
   end

data/lib/rasn1/types/sequence_of.rb

@@ -59,7 +59,6 @@ module RASN1
         Sequence.encoded_type
       end
 
-      # @param [Symbol, String] name name for this tag in grammar
       # @param [Class, Base] of_type base type for sequence of
       # @see Base#initialize
       def initialize(of_type, options={})
@@ -68,7 +67,8 @@ module RASN1
         @no_value = false
       end
 
-      def initialize_copy(other)
+      # Clone @#of_type and values
+      def initialize_copy(*)
         super
         @of_type = @of_type.dup
         @value = @value.map(&:dup)
@@ -105,6 +105,8 @@ module RASN1
         @value.length
       end
 
+      # @param [::Integer] level
+      # @return [String]
       def inspect(level=0)
         str = common_inspect(level)
         str << "\n"
@@ -153,7 +155,7 @@ module RASN1
       end
 
       def explicit_type
-        self.class.new(self.of_type)
+        self.class.new(self.of_type, name: name)
       end
 
       def push_primitive(obj)
@@ -188,6 +190,10 @@ module RASN1
           raise ASN1Error, "object to add should be a #{of_type_class} or a Hash"
         end
       end
+
+      def trace_data
+        ''
+      end
     end
   end
 end

data/lib/rasn1/types/utc_time.rb

@@ -35,20 +35,22 @@ module RASN1
 
       def der_to_value(der, ber: false) # rubocop:disable Lint/UnusedMethodArgument
         format = case der.size
-                 when 11
-                   '%Y%m%d%H%MZ'
-                 when 13
-                   '%Y%m%d%H%M%SZ'
-                 when 15
+                 when 11, 15
                    '%Y%m%d%H%M%z'
-                 when 17
+                 when 13, 17
                    '%Y%m%d%H%M%S%z'
                  else
                    prefix = @name.nil? ? type : "tag #{@name}"
                    raise ASN1Error, "#{prefix}: unrecognized format: #{der}"
                  end
         century = (Time.now.year / 100).to_s
-        @value = DateTime.strptime(century + der, format).to_time
+        @value = Strptime.new(format).exec(century + der)
+      end
+
+      def trace_data
+        return super if explicit?
+
+        +'    ' << raw_data
       end
     end
   end

data/lib/rasn1/types/utf8_string.rb

@@ -17,12 +17,12 @@ module RASN1
       private
 
       def value_to_der
-        @value.to_s.force_encoding('UTF-8').force_encoding('BINARY')
+        @value.to_s.dup.force_encoding('UTF-8').b
       end
 
       def der_to_value(der, ber: false)
         super
-        @value = der.force_encoding('UTF-8')
+        @value = der.dup.force_encoding('UTF-8')
       end
     end
   end

data/lib/rasn1/types.rb

@@ -4,18 +4,25 @@ module RASN1
   # This modules is a namesapce for all ASN.1 type classes.
   # @author Sylvain Daubert
   module Types
+    @primitives = []
+    @constructed = []
+
     # Give all primitive types
     # @return [Array<Types::Primitive>]
     def self.primitives
-      @primitives ||= self.constants.map { |c| Types.const_get(c) }
-                          .select { |klass| klass < Primitive }
+      return @primitives unless @primitives.empty?
+
+      @primitives = self.constants.map { |c| Types.const_get(c) }
+                        .select { |klass| klass < Primitive }
     end
 
     # Give all constructed types
     # @return [Array<Types::Constructed>]
     def self.constructed
-      @constructed ||= self.constants.map { |c| Types.const_get(c) }
-                           .select { |klass| klass < Constructed }
+      return @constructed unless @constructed.empty?
+
+      @constructed = self.constants.map { |c| Types.const_get(c) }
+                         .select { |klass| klass < Constructed }
     end
 
     # @private
@@ -67,8 +74,8 @@ module RASN1
     def self.generate_id2type_cache
       constructed = self.constructed - [Types::SequenceOf, Types::SetOf]
       primitives = self.primitives - [Types::Enumerated]
-      ary = (primitives + constructed).select { |type| type.const_defined? :ID }
-                                      .map { |type| [type::ID, type] }
+      ary = (primitives + constructed).select { |type| type.const_defined?(:ID) }
+                                      .map { |type| [type.const_get(:ID), type] }
       @id2types = ary.to_h
       @id2types.default = Types::Base
       @id2types.freeze
@@ -77,9 +84,20 @@ module RASN1
     # Define a new ASN.1 type from a base one.
     # This new type may have a constraint defines on it.
     # @param [Symbol,String] name New type name. Must start with a capital letter.
-    # @param [Types::Base] from
+    # @param [Types::Base] from class from which inherits
+    # @param [Module] in_module module in which creates new type (default to {RASN1::Types})
     # @return [Class] newly created class
-    def self.define_type(name, from:, &block)
+    # @yieldparam [Object] value value to set to type, or infered at parsing
+    # @yieldreturn [Boolean]
+    # @since 0.11.0
+    # @since 0.12.0 in_module parameter
+    # @example
+    #   # Define a new UInt32 type
+    #   # UInt32 ::= INTEGER (0 .. 4294967295)
+    #   RASN1::Types.define_type('UInt32', from: RASN1::Types::Integer) do |value|
+    #     (value >= 0) && (value < 2**32)
+    #   end
+    def self.define_type(name, from:, in_module: self, &block)
       constraint = block.nil? ? nil : block.to_proc
 
       new_klass = Class.new(from) do
@@ -87,12 +105,13 @@ module RASN1
       end
       new_klass.constraint = constraint
 
-      self.const_set(name, new_klass)
-      Model.define_type_accel(name.downcase, new_klass)
+      in_module.const_set(name, new_klass)
+      accel_name = name.to_s.gsub(/([a-z])([A-Z])/, '\1_\2').downcase
+      Model.define_type_accel(accel_name, new_klass)
 
       # Empty type caches
-      @primitives = nil
-      @constructed = nil
+      @primitives = []
+      @constructed = []
 
       new_klass
     end
@@ -108,6 +127,7 @@ require_relative 'types/octet_string'
 require_relative 'types/null'
 require_relative 'types/object_id'
 require_relative 'types/enumerated'
+require_relative 'types/bmp_string'
 require_relative 'types/utf8_string'
 require_relative 'types/numeric_string'
 require_relative 'types/printable_string'

data/lib/rasn1/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RASN1
-  VERSION = '0.11.0'
+  VERSION = '0.12.1'
 end

data/lib/rasn1/wrapper.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+require 'delegate'
+
+module RASN1
+  # This class is used to wrap a {Types::Base} or {Model} instance to force its options.
+  #
+  # == Usage
+  # This class may be used to wrap another RASN1 object by 3 ways:
+  # * wrap an object to modify its options,
+  # * implicitly wrap an object (i.e. change its tag),
+  # * explicitly wrap an object (i.e wrap the object in another explicit ASN.1 tag)
+  #
+  # @example
+  #   # object to wrap
+  #   int = RASN1::Types::Integer.new(implicit: 1)    # its tag is 0x81
+  #   # simple wrapper, change an option
+  #   wrapper = RASN1::Wrapper.new(int, default: 1)
+  #   # implicit wrapper
+  #   wrapper = RASN1::Wrapper.new(int, implicit: 3)  # wrapped int tag is now 0x83
+  #   # explicit wrapper
+  #   wrapper = RASN1::Wrapper.new(int, explicit: 4)  # int tag is always 0x81, but it is wrapped in a 0x84 tag
+  # @since 0.12.0
+  class Wrapper < SimpleDelegator
+    # @private Private class used to build/parse explicit wrappers
+    class ExplicitWrapper < Types::Base
+      ID = 0 # not used
+      ASN1_PC = 0 # not constructed
+
+      def self.type
+        ''
+      end
+
+      # @return [Boolean]
+      # @see Types::Base#can_build?
+      def can_build?
+        ok = super
+        return ok unless optional?
+
+        ok && @value.can_build?
+      end
+
+      private
+
+      def value_to_der
+        @value.is_a?(String) ? @value : @value.to_der
+      end
+
+      def inspect_value
+        ''
+      end
+    end
+
+    # @param [Types::Base,Model] element element to wrap
+    # @param [Hash] options
+    def initialize(element, options={})
+      opts = explicit_implicit(options)
+
+      if explicit?
+        generate_explicit_wrapper(opts)
+        element.options = element.options.merge(generate_explicit_wrapper_options(opts))
+        @options = opts
+      else
+        opts[:value] = element.value
+        element.options = element.options.merge(opts)
+        @options = {}
+      end
+      raise RASN1::Error, 'Cannot be implicit and explicit' if explicit? && implicit?
+
+      super(element)
+    end
+
+    # Say if wrapper is an explicit one (i.e. add tag and length to its element)
+    # @return [Boolean]
+    def explicit?
+      !!@explicit
+    end
+
+    # Say if wrapper is an implicit one (i.e. change tag of its element)
+    # @return [Boolean]
+    def implicit?
+      !!@implicit
+    end
+
+    # Convert wrapper and its element to a DER string
+    # @return [String]
+    def to_der
+      if implicit?
+        el = generate_implicit_element
+        el.to_der
+      elsif explicit?
+        @explicit_wrapper.value = element
+        @explicit_wrapper.to_der
+      else
+        element.to_der
+      end
+    end
+
+    # Parse a DER string. This method updates object.
+    # @param [String] der DER string
+    # @param [Boolean] ber if +true+, accept BER encoding
+    # @return [Integer] total number of parsed bytes
+    # @raise [ASN1Error] error on parsing
+    def parse!(der, ber: false)
+      if implicit?
+        el = generate_implicit_element
+        parsed = el.parse!(der, ber: ber)
+        element.value = el.value
+        parsed
+      elsif explicit?
+        parsed = @explicit_wrapper.parse!(der, ber: ber)
+        element.parse!(@explicit_wrapper.value, ber: ber) if parsed.positive?
+        parsed
+      else
+        element.parse!(der, ber: ber)
+      end
+    end
+
+    # @return [Boolean]
+    # @see Types::Base#value?
+    def value?
+      if explicit?
+        @explicit_wrapper.value?
+      else
+        __getobj__.value?
+      end
+    end
+
+    # Return Wrapped element
+    # @return [Types::Base,Model]
+    def element
+      __getobj__
+    end
+
+    # @return [::Integer]
+    # @see Types::Base#id
+    def id
+      if implicit?
+        @implicit
+      elsif explicit?
+        @explicit
+      else
+        element.id
+      end
+    end
+
+    # @return [Symbol]
+    # @see Types::Base#asn1_class
+    def asn1_class
+      return element.asn1_class unless @options.key?(:class)
+
+      @options[:class]
+    end
+
+    # @return [Boolean]
+    # @see Types::Base#constructed
+    def constructed?
+      return element.constructed? unless @options.key?(:constructed)
+
+      @options[:constructed]
+    end
+
+    # @return [Boolean]
+    # @see Types::Base#primitive
+    def primitive?
+      !constructed?
+    end
+
+    # @param [::Integer] level
+    # @return [String]
+    def inspect(level=0)
+      return super(level) unless explicit?
+
+      @explicit_wrapper.inspect(level) << ' ' << super(level)
+    end
+
+    private
+
+    def explicit_implicit(options)
+      opts = options.dup
+      @explicit = opts.delete(:explicit)
+      @implicit = opts.delete(:implicit)
+      opts
+    end
+
+    def generate_explicit_wrapper(options)
+      # ExplicitWrapper is a hand-made explicit tag, but we have to use its implicit option
+      # to force its tag value.
+      @explicit_wrapper = ExplicitWrapper.new(options.merge(implicit: @explicit))
+    end
+
+    def generate_explicit_wrapper_options(options)
+      new_opts = {}
+      new_opts[:default] = options[:default] if options.key?(:default)
+      new_opts[:optional] = options[:optional] if options.key?(:optional)
+      new_opts
+    end
+
+    def generate_implicit_element
+      el = element.dup
+      if el.explicit?
+        el.options = el.options.merge(explicit: @implicit)
+      elsif el.implicit?
+        el.options = el.options.merge(implicit: @implicit)
+      end
+      el
+    end
+  end
+end

data/lib/rasn1.rb

@@ -1,13 +1,18 @@
 # frozen_string_literal: true
 
-require 'rasn1/version'
-require 'rasn1/errors'
-require 'rasn1/types'
-require 'rasn1/model'
+require_relative 'rasn1/version'
+require_relative 'rasn1/errors'
+require_relative 'rasn1/types'
+require_relative 'rasn1/model'
+require_relative 'rasn1/wrapper'
+require_relative 'rasn1/tracer'
 
 # Rasn1 is a pure ruby library to parse, decode and encode ASN.1 data.
 # @author Sylvain Daubert
 module RASN1
+  # @private
+  CONTAINER_CLASSES = [Types::Sequence, Types::Set].freeze
+
   # Parse a DER/BER string without checking a model
   # @note If you want to check ASN.1 grammary, you should define a {Model}
   #       and use {Model#parse}.
@@ -18,24 +23,21 @@ module RASN1
   # @param [String] der binary string to parse
   # @param [Boolean] ber if +true+, decode a BER string, else a DER one
   # @return [Types::Base]
-  def self.parse(der, ber: false)
-    root = nil
-    until der.empty?
-      type = Types.id2type(der)
-      type.parse!(der, ber: ber)
-      root ||= type
+  def self.parse(der, ber: false) # rubocop:disable Metrics:AbcSize
+    type = Types.id2type(der)
+    type.parse!(der, ber: ber)
 
-      if [Types::Sequence, Types::Set].include? type.class
-        subder = type.value
-        ary = []
-        until subder.empty?
-          ary << self.parse(subder)
-          subder = subder[ary.last.to_der.size..-1]
-        end
-        type.value = ary
+    if CONTAINER_CLASSES.include?(type.class)
+      subder = type.value
+      ary = []
+      RASN1.tracer.tracing_level += 1 unless RASN1.tracer.nil?
+      until subder.empty?
+        ary << self.parse(subder)
+        subder = subder[ary.last.to_der.size..-1]
       end
-      der = der[type.to_der.size..-1]
+      RASN1.tracer.tracing_level -= 1 unless RASN1.tracer.nil?
+      type.value = ary
     end
-    root
+    type
   end
 end

metadata

@@ -1,57 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rasn1
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-13 00:00:00.000000000 Z
+date: 2022-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: strptime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
-  type: :development
+        version: 0.2.5
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.2.5
 description: |
   RASN1 is a pure ruby ASN.1 library. It may encode and decode DER and BER
   encodings.
@@ -68,10 +40,12 @@ files:
 - lib/rasn1.rb
 - lib/rasn1/errors.rb
 - lib/rasn1/model.rb
+- lib/rasn1/tracer.rb
 - lib/rasn1/types.rb
 - lib/rasn1/types/any.rb
 - lib/rasn1/types/base.rb
 - lib/rasn1/types/bit_string.rb
+- lib/rasn1/types/bmp_string.rb
 - lib/rasn1/types/boolean.rb
 - lib/rasn1/types/choice.rb
 - lib/rasn1/types/constrained.rb
@@ -94,6 +68,7 @@ files:
 - lib/rasn1/types/utf8_string.rb
 - lib/rasn1/types/visible_string.rb
 - lib/rasn1/version.rb
+- lib/rasn1/wrapper.rb
 homepage: https://github.com/sdaubert/rasn1
 licenses:
 - MIT