rasn1 0.10.0 → 0.12.0

data/lib/rasn1/version.rb

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

data/lib/rasn1/wrapper.rb

@@ -0,0 +1,201 @@
+# 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 wraper, change an option
+  #   wrapper = RASN1::Wrapper.new(int, optional: true, 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
+
+    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
+
+    # 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
+
+    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]
+    def id
+      if implicit?
+        @implicit
+      elsif explicit?
+        @explicit
+      else
+        element.id
+      end
+    end
+
+    # @return [Symbol]
+    def asn1_class
+      return element.asn1_class unless @options.key?(:class)
+
+      @options[:class]
+    end
+
+    # @return [Boolean]
+    def constructed?
+      return element.constructed? unless @options.key?(:constructed)
+
+      @options[:constructed]
+    end
+
+    # @return [Boolean]
+    def primitive?
+      !constructed?
+    end
+
+    def inspect(level=0)
+      return super(level) unless explicit?
+
+      @explicit_wrapper.inspect(level) << ' ' << super(level)
+    end
+
+    private
+
+    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,36 +1,14 @@
 # frozen_string_literal: true
 
-require 'rasn1/version'
-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'
 
 # Rasn1 is a pure ruby library to parse, decode and encode ASN.1 data.
 # @author Sylvain Daubert
 module RASN1
-  # Base error class
-  class Error < StandardError; end
-
-  # ASN.1 encoding/decoding error
-  class ASN1Error < Error; end
-
-  # ASN.1 class error
-  class ClassError < Error
-    # @return [String]
-    def message
-      "Tag class should be a symbol among: #{Types::Base::CLASSES.keys.join(', ')}"
-    end
-  end
-
-  # Enumerated error
-  class EnumeratedError < Error; end
-
-  # CHOICE error: #chosen not set
-  class ChoiceError < RASN1::Error
-    def message
-      "CHOICE #{@name}: #chosen not set"
-    end
-  end
-
   # 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}.

metadata

@@ -1,57 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rasn1
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-11-12 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.
@@ -66,13 +38,16 @@ files:
 - LICENSE
 - README.md
 - lib/rasn1.rb
+- lib/rasn1/errors.rb
 - lib/rasn1/model.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
 - lib/rasn1/types/constructed.rb
 - lib/rasn1/types/enumerated.rb
 - lib/rasn1/types/generalized_time.rb
@@ -92,6 +67,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