rasn1 0.13.1 → 0.15.0

data/lib/rasn1/types/printable_string.rb

@@ -7,6 +7,8 @@ module RASN1
     class PrintableString < OctetString
       # PrintableString id value
       ID = 19
+      # Invalid characters in PrintableString
+      INVALID_CHARS = %r{([^a-zA-Z0-9 '=()+,\-./:?])}
 
       # Get ASN.1 type
       # @return [String]
@@ -14,6 +16,16 @@ module RASN1
         'PrintableString'
       end
 
+      # Make string value from +der+ string
+      # @param [String] der
+      # @param [::Boolean] ber
+      # @return [void]
+      # @raise [ASN1Error] invalid characters detected
+      def der_to_value(der, ber: false)
+        super
+        check_characters
+      end
+
       private
 
       def value_to_der
@@ -21,13 +33,8 @@ module RASN1
         @value.to_s.b
       end
 
-      def der_to_value(der, ber: false)
-        super
-        check_characters
-      end
-
       def check_characters
-        m = @value.to_s.match(%r{([^a-zA-Z0-9 '=()+,\-./:?])})
+        m = @value.to_s.match(INVALID_CHARS)
         raise ASN1Error, "PRINTABLE STRING #{@name}: invalid character: '#{m[1]}'" if m
       end
     end

data/lib/rasn1/types/sequence.rb

@@ -66,22 +66,15 @@ module RASN1
         end
       end
 
-      private
-
-      def value_to_der
-        case @value
-        when Array
-          @value.map(&:to_der).join
-        else
-          @value.to_s
-        end
-      end
-
+      # Make sequence value from +der+ string
+      # @param [String] der
+      # @param [::Boolean] ber
+      # @return [void]
       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])
+            nb_bytes += element.parse!(der[nb_bytes..])
           end
         else
           @value = der
@@ -89,6 +82,17 @@ module RASN1
         end
       end
 
+      private
+
+      def value_to_der
+        case @value
+        when Array
+          @value.map(&:to_der).join
+        else
+          @value.to_s
+        end
+      end
+
       def trace_data
         ''
       end

data/lib/rasn1/types/sequence_of.rb

@@ -125,6 +125,21 @@ module RASN1
         str
       end
 
+      # Make sequence of value from +der+ string
+      # @param [String] der
+      # @param [::Boolean] ber
+      # @return [void]
+      def der_to_value(der, ber: false) # rubocop:disable Lint/UnusedMethodArgument
+        @value = []
+        nb_bytes = 0
+
+        while nb_bytes < der.length
+          type = of_type_class.new
+          nb_bytes += type.parse!(der[nb_bytes, der.length])
+          @value << type
+        end
+      end
+
       private
 
       def of_type_class
@@ -139,17 +154,6 @@ module RASN1
         @value.map(&:to_der).join
       end
 
-      def der_to_value(der, ber: false) # rubocop:disable Lint/UnusedMethodArgument
-        @value = []
-        nb_bytes = 0
-
-        while nb_bytes < der.length
-          type = of_type_class.new
-          nb_bytes += type.parse!(der[nb_bytes, der.length])
-          @value << type
-        end
-      end
-
       def explicit_type
         self.class.new(self.of_type, name: name)
       end

data/lib/rasn1/types/universal_string.rb

@@ -8,23 +8,15 @@ module RASN1
     class UniversalString < OctetString
       # UniversalString id value
       ID = 28
+      # UniversalString encoding
+      # @since 0.15.0
+      ENCODING = Encoding::UTF_32BE
 
       # Get ASN.1 type
       # @return [String]
       def self.type
         'UniversalString'
       end
-
-      private
-
-      def value_to_der
-        @value.to_s.dup.encode('UTF-32BE').b
-      end
-
-      def der_to_value(der, ber: false)
-        super
-        @value = der.to_s.dup.force_encoding('UTF-32BE')
-      end
     end
   end
 end

data/lib/rasn1/types/utc_time.rb

@@ -27,12 +27,11 @@ module RASN1
         'UTCTime'
       end
 
-      private
-
-      def value_to_der
-        @value.getutc.strftime('%y%m%d%H%M%SZ')
-      end
-
+      # Make time value from +der+ string
+      # @param [String] der
+      # @param [::Boolean] ber
+      # @return [void]
+      # @raise [ASN1Error] unrecognized  time format
       def der_to_value(der, ber: false) # rubocop:disable Lint/UnusedMethodArgument
         format = case der.size
                  when 11, 15
@@ -44,7 +43,18 @@ module RASN1
                    raise ASN1Error, "#{prefix}: unrecognized format: #{der}"
                  end
         century = (Time.now.year / 100).to_s
-        @value = Strptime.new(format).exec(century + der)
+        begin
+          @value = Strptime.new(format).exec(century + der)
+        rescue ArgumentError
+          prefix = @name.nil? ? type : "tag #{@name}"
+          raise ASN1Error, "#{prefix}: unrecognized format: #{der}"
+        end
+      end
+
+      private
+
+      def value_to_der
+        @value.getutc.strftime('%y%m%d%H%M%SZ')
       end
 
       def trace_data

data/lib/rasn1/types/utf8_string.rb

@@ -7,23 +7,15 @@ module RASN1
     class Utf8String < OctetString
       # Utf8String id value
       ID = 12
+      # Utf8String encoding
+      # @since 0.15.0
+      ENCODING = Encoding::UTF_8
 
       # Get ASN.1 type
       # @return [String]
       def self.type
         'UTF8String'
       end
-
-      private
-
-      def value_to_der
-        @value.to_s.dup.force_encoding('UTF-8').b
-      end
-
-      def der_to_value(der, ber: false)
-        super
-        @value = der.dup.force_encoding('UTF-8')
-      end
     end
   end
 end

data/lib/rasn1/types/visible_string.rb

@@ -2,14 +2,26 @@
 
 module RASN1
   module Types
+    # Create VisibleString as a Constrained subclass of IA5String
+    Types.define_type(:VisibleString, from: IA5String) do |value|
+      value.nil? || value.chars.all? { |c| c.ord >= 32 && c.ord <= 126 }
+    end
+
     # ASN.1 Visible String
-    # @author Sylvain Daubert
-    class VisibleString < IA5String
+    #
+    # VisibleString may only contain ASCII characters from range 32 to 126.
+    # @author LemonTree55
+    # @since 0.3.0
+    # @since 0.15.0 VisibleString is defined as a constrained {IA5String}. It will now raise if value contains a non-visible character.
+    class VisibleString
       # VisibleString id value
+      # @since 0.3.0
       ID = 26
 
       # Get ASN.1 type
       # @return [String]
+      # @author Sylvain Daubert
+      # @since 0.3.0
       def self.type
         'VisibleString'
       end

data/lib/rasn1/types.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'types/constrained'
+
 module RASN1
   # This modules is a namesapce for all ASN.1 type classes.
   # @author Sylvain Daubert
@@ -33,17 +35,17 @@ module RASN1
     def self.decode_identifier_octets(der)
       first_octet = der.unpack1('C').to_i
       asn1_class = Types::Base::CLASSES.key(first_octet & Types::Base::CLASS_MASK) || :universal
-      pc = (first_octet & Types::Constructed::ASN1_PC).positive? ? :constructed : :primitive
+      pc = first_octet.anybits?(Types::Constructed::ASN1_PC) ? :constructed : :primitive
       id = first_octet & Types::Base::MULTI_OCTETS_ID
 
       size = if id == Types::Base::MULTI_OCTETS_ID
                id = 0
                count = 1
-               der[1..-1].to_s.bytes.each do |octet|
+               der[1..].to_s.bytes.each do |octet|
                  count += 1
 
                  id = (id << 7) | (octet & 0x7f)
-                 break if (octet & 0x80).zero?
+                 break if octet.nobits?(0x80)
                end
                count
              else
@@ -85,7 +87,7 @@ 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 [Symbol,String] name new type name. Must start with a capital letter.
     # @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
@@ -135,7 +137,6 @@ require_relative 'types/utf8_string'
 require_relative 'types/numeric_string'
 require_relative 'types/printable_string'
 require_relative 'types/ia5string'
-require_relative 'types/visible_string'
 require_relative 'types/constructed'
 require_relative 'types/sequence'
 require_relative 'types/sequence_of'

data/lib/rasn1/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module RASN1
-  VERSION = '0.13.1'
+  # RASN1 version number
+  VERSION = '0.15.0'
 end

data/lib/rasn1/wrapper.rb

@@ -6,12 +6,13 @@ 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:
+  # This class may be used to wrap another RASN1 object by 4 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)
+  # * explicitly wrap an object (i.e wrap the object in another explicit ASN.1 tag),
+  # * wrap a choice model to reuse it in its own definition.
   #
-  # @example
+  # @example Wrapping object
   #   # object to wrap
   #   int = RASN1::Types::Integer.new(implicit: 1)    # its tag is 0x81
   #   # simple wrapper, change an option
@@ -20,7 +21,18 @@ module RASN1
   #   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
+  # @example Wrapping a choice to make it recursive
+  #  class RecursiveChoice < RASN1::Model
+  #    choice :choice,
+  #           content: [
+  #             integer(:value, implicit: 1),
+  #             wrapper(model(:recursive, RecursiveChoice), implicit:2)
+  #           ]
+  #  end
   # @since 0.12.0
+  # @since 0.15.0 Wrappers are lazy. They allocate their inner element only when needed (i.e. when calling {#to_der}, {#parse!} or {#element})
+  # @author Sylvain Daubert
+  # @author LemonTree55
   class Wrapper < SimpleDelegator
     # @private Private class used to build/parse explicit wrappers
     class ExplicitWrapper < Types::Base
@@ -54,15 +66,16 @@ module RASN1
     # @param [Types::Base,Model] element element to wrap
     # @param [Hash] options
     def initialize(element, options={})
+      @lazy = true
       opts = explicit_implicit(options)
 
       if explicit?
         generate_explicit_wrapper(opts)
-        element.options = element.options.merge(generate_explicit_wrapper_options(opts))
+        @element_options_to_merge = generate_explicit_wrapper_options(opts)
         @options = opts
       else
-        opts[:value] = element.value
-        element.options = element.options.merge(opts)
+        opts[:value] = element.value if element.respond_to?(:value)
+        @element_options_to_merge = opts
         @options = {}
       end
       raise RASN1::Error, 'Cannot be implicit and explicit' if explicit? && implicit?
@@ -84,7 +97,10 @@ module RASN1
 
     # Convert wrapper and its element to a DER string
     # @return [String]
+    # @since 0.12.0
+    # @since 0.15.0 Allocate element (lazy wrapper)
     def to_der
+      lazy_generation
       if implicit?
         el = generate_implicit_element
         el.to_der
@@ -101,7 +117,10 @@ module RASN1
     # @param [Boolean] ber if +true+, accept BER encoding
     # @return [Integer] total number of parsed bytes
     # @raise [ASN1Error] error on parsing
+    # @since 0.12.0
+    # @since 0.15.0 Allocate element (lazy wrapper)
     def parse!(der, ber: false)
+      lazy_generation
       if implicit?
         el = generate_implicit_element
         parsed = el.parse!(der, ber: ber)
@@ -116,11 +135,25 @@ module RASN1
       end
     end
 
+    # @private
+    # @see Types::Base#do_parse
+    def do_parse(der, ber: false)
+      if implicit?
+        generate_implicit_element(Types::Base.new(constructed: element.constructed?)).do_parse(der, ber: ber)
+      elsif explicit?
+        @explicit_wrapper.do_parse(der, ber: ber)
+      else
+        element.do_parse(der, ber: ber)
+      end
+    end
+
     # @return [Boolean]
     # @see Types::Base#value?
     def value?
       if explicit?
         @explicit_wrapper.value?
+      elsif __getobj__.is_a?(Class)
+        false
       else
         __getobj__.value?
       end
@@ -128,8 +161,10 @@ module RASN1
 
     # Return Wrapped element
     # @return [Types::Base,Model]
+    # @since 0.12.0
+    # @since 0.15.0 Allocate element (lazy wrapper)
     def element
-      __getobj__
+      lazy_generation
     end
 
     # @return [::Integer]
@@ -140,14 +175,14 @@ module RASN1
       elsif explicit?
         @explicit
       else
-        element.id
+        lazy_generation(register: false).id
       end
     end
 
     # @return [Symbol]
     # @see Types::Base#asn1_class
     def asn1_class
-      return element.asn1_class unless @options.key?(:class)
+      return lazy_generation(register: false).asn1_class unless @options.key?(:class)
 
       @options[:class]
     end
@@ -155,7 +190,7 @@ module RASN1
     # @return [Boolean]
     # @see Types::Base#constructed
     def constructed?
-      return element.constructed? unless @options.key?(:constructed)
+      return lazy_generation(register: false).constructed? unless @options.key?(:constructed)
 
       @options[:constructed]
     end
@@ -169,9 +204,9 @@ module RASN1
     # @param [::Integer] level
     # @return [String]
     def inspect(level=0)
-      return super(level) unless explicit?
+      return super() unless explicit?
 
-      @explicit_wrapper.inspect(level) << ' ' << super(level)
+      @explicit_wrapper.inspect(level) << ' ' << super()
     end
 
     private
@@ -196,14 +231,33 @@ module RASN1
       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
+    def generate_implicit_element(from=nil)
+      el = (from || element).dup
+      el.options = if element.explicit?
+                     el.options.merge(explicit: @implicit)
+                   else
+                     el.options.merge(implicit: @implicit)
+                   end
       el
     end
+
+    def lazy_generation(register: true)
+      return __getobj__ unless @lazy
+
+      real_element = __getobj__
+      case real_element
+      when Types::Base, Model
+        real_element.options = real_element.options.merge(@element_options_to_merge)
+        @lazy = false
+        real_element
+      else
+        el = real_element.new(@element_options_to_merge)
+        if register
+          @lazy = false
+          __setobj__(el)
+        end
+        el
+      end
+    end
   end
 end

data/lib/rasn1.rb

@@ -7,6 +7,9 @@ require_relative 'rasn1/model'
 require_relative 'rasn1/wrapper'
 require_relative 'rasn1/tracer'
 
+# Constrained types
+require_relative 'rasn1/types/visible_string'
+
 # Rasn1 is a pure ruby library to parse, decode and encode ASN.1 data.
 # @author Sylvain Daubert
 module RASN1
@@ -33,7 +36,7 @@ module RASN1
       RASN1.tracer.tracing_level += 1 unless RASN1.tracer.nil?
       until subder.empty?
         ary << self.parse(subder)
-        subder = subder[ary.last.to_der.size..-1]
+        subder = subder[ary.last.to_der.size..]
       end
       RASN1.tracer.tracing_level -= 1 unless RASN1.tracer.nil?
       type.value = ary

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rasn1
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.15.0
 platform: ruby
 authors:
 - LemonTree55
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-13 00:00:00.000000000 Z
+date: 2025-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: strptime
@@ -92,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="