rasn1 0.10.0 → 0.12.0

data/lib/rasn1/types/base.rb

@@ -69,6 +69,8 @@ module RASN1
       attr_reader :asn1_class
       # @return [Object,nil] default value, if defined
       attr_reader :default
+      # @return [Hash[Symbol, Object]]
+      attr_reader :options
 
       # Get ASN.1 type
       # @return [String]
@@ -95,6 +97,13 @@ module RASN1
         obj
       end
 
+      # Say if a type is constrained.
+      # Always return +false+ for predefined types
+      # @return [Booleran]
+      def self.constrained?
+        false
+      end
+
       # @param [Hash] options
       # @option options [Symbol] :class ASN.1 class. Default value is +:universal+.
       #  If +:explicit+ or +:implicit:+ is defined, default value is +:context+.
@@ -109,9 +118,14 @@ module RASN1
       # @option options [::String] :name name for this node
       def initialize(options={})
         @constructed = nil
-        set_options options
+        set_value(options.delete(:value))
+        self.options = options
+        specific_initializer
       end
 
+      # @abstract To help subclass initialize itself. Default implementation do nothing.
+      def specific_initializer; end
+
       # Used by +#dup+ and +#clone+. Deep copy @value and @default.
       def initialize_copy(_other)
         @value = @value.dup
@@ -242,11 +256,38 @@ module RASN1
         (other.class == self.class) && (other.to_der == self.to_der)
       end
 
+      # Set options to this object
+      # @param [Hash] options
+      # @return [void]
+      # @since 0.12
+      def options=(options)
+        set_class options[:class]
+        set_optional options[:optional]
+        set_default options[:default]
+        set_tag options
+        @name = options[:name]
+        @options = options
+      end
+
+      # Say if a value is set
+      # @return [Boolean]
+      # @since 0.12.0
+      def value?
+        !@no_value
+      end
+
+      # Say if DER can be built (not default value, not optional without value, has a value)
+      # @return [Boolean]
+      # @since 0.12.0
+      def can_build?
+        value? && (@default.nil? || (@value != @default))
+      end
+
       private
 
       def pc_bit
         if @constructed.nil?
-          self.class::ASN1_PC
+          self.class.const_get(:ASN1_PC)
         elsif @constructed # true
           Constructed::ASN1_PC
         else # false
@@ -285,16 +326,6 @@ module RASN1
         @value = der
       end
 
-      def set_options(options) # rubocop:disable Naming/AccessorMethodName
-        set_class options[:class]
-        set_optional options[:optional]
-        set_default options[:default]
-        set_tag options
-        set_value options[:value]
-        @name = options[:name]
-        @options = options
-      end
-
       def set_class(asn1_class) # rubocop:disable Naming/AccessorMethodName
         case asn1_class
         when nil
@@ -319,17 +350,15 @@ module RASN1
       # handle undocumented option +:tag_value+, used internally by
       # {RASN1.parse} to parse non-universal class tags.
       def set_tag(options) # rubocop:disable Naming/AccessorMethodName
+        @constructed = options[:constructed]
         if options[:explicit]
           @tag = :explicit
           @id_value = options[:explicit]
-          @constructed = options[:constructed]
         elsif options[:implicit]
           @tag = :implicit
           @id_value = options[:implicit]
-          @constructed = options[:constructed]
         elsif options[:tag_value]
           @id_value = options[:tag_value]
-          @constructed = options[:constructed]
         end
 
         @asn1_class = :context if defined?(@tag) && (@asn1_class == :universal)
@@ -346,15 +375,6 @@ module RASN1
         value
       end
 
-      def value?
-        !@no_value
-      end
-
-      def can_build?
-        (@default.nil? || (value? && (@value != @default))) &&
-          (!optional? || value?)
-      end
-
       def build
         if can_build?
           if explicit?
@@ -371,9 +391,9 @@ module RASN1
       end
 
       def id_value
-        return @id_value if defined? @id_value
+        return @id_value if defined?(@id_value) && !@id_value.nil?
 
-        self.class::ID
+        self.class.const_get(:ID)
       end
 
       def encode_identifier_octets
@@ -455,7 +475,7 @@ module RASN1
       def raise_on_indefinite_length(ber)
         if primitive?
           raise ASN1Error, "malformed #{type}: indefinite length " \
-            'forbidden for primitive types'
+                           'forbidden for primitive types'
         elsif ber
           raise NotImplementedError, 'indefinite length not supported'
         else

data/lib/rasn1/types/bit_string.rb

@@ -42,14 +42,14 @@ module RASN1
         str << " #{value.inspect} (bit length: #{bit_length})"
       end
 
-      private
-
       def can_build?
-        !(!@default.nil? && (!value? || (@value == @default) &&
-                              (@bit_length == @default_bit_length))) &&
-          !(optional? && !value?)
+        super || (!@default.nil? && (@bit_length != @default_bit_length))
       end
 
+      private
+
+      # @author Sylvain Daubert
+      # @author adfoster-r7
       def value_to_der
         raise ASN1Error, "#{@name}: bit length is not set" if bit_length.nil?
 
@@ -70,9 +70,8 @@ module RASN1
       end
 
       def generate_value_with_correct_length
-        value = @value || ''
-        value << "\x00" while value.length * 8 < @bit_length.to_i
-        value.force_encoding('BINARY')
+        value = (@value || '').dup.force_encoding('BINARY')
+        value << "\x00".b while value.length * 8 < @bit_length.to_i
         return value unless value.length * 8 > @bit_length.to_i
 
         max_len = @bit_length.to_i / 8 + ((@bit_length.to_i % 8).positive? ? 1 : 0)
@@ -85,6 +84,10 @@ module RASN1
         @bit_length = value.length * 8 - unused
         @value = value
       end
+
+      def explicit_type
+        self.class.new(value: @value, bit_length: @bit_length)
+      end
     end
   end
 end

data/lib/rasn1/types/bmp_string.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RASN1
+  module Types
+    # ASN.1 BmpString
+    # @since 0.12.0
+    # @author adfoster-r7
+    class BmpString < OctetString
+      # BmpString id value
+      ID = 30
+
+      # Get ASN.1 type
+      # @return [String]
+      def self.type
+        'BmpString'
+      end
+
+      private
+
+      def value_to_der
+        @value.to_s.dup.encode('UTF-16BE').b
+      end
+
+      def der_to_value(der, ber: false)
+        super
+        @value = der.to_s.dup.force_encoding('UTF-16BE')
+      end
+    end
+  end
+end

data/lib/rasn1/types/choice.rb

@@ -77,15 +77,13 @@ module RASN1
       def parse!(der, ber: false)
         parsed = false
         @value.each_with_index do |element, i|
-          begin
-            @chosen = i
-            nb_bytes = element.parse!(der, ber: ber)
-            parsed = true
-            return nb_bytes
-          rescue ASN1Error
-            @chosen = nil
-            next
-          end
+          @chosen = i
+          nb_bytes = element.parse!(der, ber: ber)
+          parsed = true
+          return nb_bytes
+        rescue ASN1Error
+          @chosen = nil
+          next
         end
         raise ASN1Error, "CHOICE #{@name}: no type matching #{der.inspect}" unless parsed
       end
@@ -102,7 +100,7 @@ module RASN1
       private
 
       def check_chosen
-        raise ChoiceError if !defined?(@chosen) || @chosen.nil?
+        raise ChoiceError.new(self) if !defined?(@chosen) || @chosen.nil?
       end
     end
   end

data/lib/rasn1/types/constrained.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RASN1
+  module Types
+    # Mixin to had constraints on a RASN1 type.
+    # Should not be used directly but through {Types.define_type}.
+    # @version 0.11.0
+    # @author Sylvain Daubert
+    module Constrained
+      module ClassMethods
+        # Setter for constraint
+        # @param [Proc,nil] constraint
+        # @return [Proc,nil]
+        def constraint=(constraint)
+          @constraint = constraint
+        end
+
+        # Check if a constraint is really defined
+        # @return [Boolean]
+        def constrained?
+          @constraint.is_a?(Proc)
+        end
+
+        # Check constraint, if defined
+        # @param [Object] value the value of the type to check
+        # @raise [ConstraintError] constraint is not verified
+        def check_constraint(value)
+          return unless constrained?
+          raise ConstraintError.new(self) unless @constraint.call(value)
+        end
+      end
+
+      class << self
+        attr_reader :constraint
+
+        def included(base)
+          base.extend ClassMethods
+        end
+      end
+
+      # Redefined +#value=+ to check constraint before assigning +val+
+      # @see Types::Base#value=
+      # @raise [ConstraintError] constraint is not verified
+      def value=(val)
+        self.class.check_constraint(val)
+        super
+      end
+
+      def der_to_value(der, ber: false)
+        super
+        self.class.check_constraint(@value)
+      end
+    end
+  end
+end

data/lib/rasn1/types/constructed.rb

@@ -10,6 +10,22 @@ module RASN1
       # Constructed value
       ASN1_PC = 0x20
 
+      # @return [Boolean]
+      # @since 0.12.0
+      # @see Base#can_build?
+      def can_build? # rubocop:disable Metrics/CyclomaticComplexity
+        return super unless @value.is_a?(Array) && optional?
+        return false unless super
+
+        @value.any? do |el|
+          el.can_build? && (
+            el.primitive? ||
+              (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
@@ -18,7 +34,7 @@ module RASN1
           level = level.abs + 1
           @value.each do |item|
             case item
-            when Base, Model
+            when Base, Model, Wrapper
               str << "#{item.inspect(level)}\n"
             else
               str << '  ' * level

data/lib/rasn1/types/generalized_time.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'strptime'
+
 module RASN1
   module Types
     # ASN.1 GeneralizedTime
@@ -24,25 +26,33 @@ module RASN1
       # GeneralizedTime id value
       ID = 24
 
+      # @private
+      HOUR_TO_SEC = 3600
+      # @private
+      MINUTE_TO_SEC = 60
+      # @private
+      SECOND_TO_SEC = 1
+
       # Get ASN.1 type
       # @return [String]
       def self.type
         'GeneralizedTime'
       end
 
-      # @return [DateTime]
+      # @return [Time]
       def void_value
-        DateTime.now
+        Time.now
       end
 
       private
 
       def value_to_der
-        if @value.nsec.positive?
-          der = @value.getutc.strftime('%Y%m%d%H%M%S.%9NZ')
+        utc_value = @value.getutc
+        if utc_value.nsec.positive?
+          der = utc_value.strftime('%Y%m%d%H%M%S.%9NZ')
           der.sub(/0+Z/, 'Z')
         else
-          @value.getutc.strftime('%Y%m%d%H%M%SZ')
+          utc_value.strftime('%Y%m%d%H%M%SZ')
         end
       end
 
@@ -61,18 +71,13 @@ module RASN1
       end
 
       def value_when_fraction_empty(date_hour)
-        utc_offset_forced = false
-
         if (date_hour[-1] != 'Z') && (date_hour !~ /[+-]\d+$/)
           # If not UTC, have to add offset with UTC to force
-          # DateTime#strptime to generate a local time. But this difference
-          # may be errored because of DST.
+          # Strptime to generate a local time.
           date_hour << Time.now.strftime('%z')
-          utc_offset_forced = true
         end
 
         value_from(date_hour)
-        fix_dst if utc_offset_forced
       end
 
       def value_when_fraction_ends_with_z(date_hour, fraction)
@@ -90,62 +95,44 @@ module RASN1
           date_hour << match[2]
         else
           # fraction only contains fraction.
-          # Have to add offset with UTC to force DateTime#strptime to
-          # generate a local time. But this difference may be errored
-          # because of DST.
+          # Have to add offset with UTC to force Strptime to
+          # generate a local time.
           date_hour << Time.now.strftime('%z')
-          utc_offset_forced = true
         end
 
         frac_base = value_from(date_hour)
-        fix_dst if utc_offset_forced
         fix_value(fraction, frac_base)
       end
 
       def value_from(date_hour)
         format, frac_base = strformat(date_hour)
-        @value = DateTime.strptime(date_hour, format).to_time
+        @value = Strptime.new(format).exec(date_hour)
         frac_base
       end
 
-      # Check DST. There may be a shift of one hour...
-      def fix_dst
-        compare_time = Time.new(*@value.to_a[0..5].reverse)
-        @value = compare_time if compare_time.utc_offset != @value.utc_offset
-      end
-
       def fix_value(fraction, frac_base)
-        @value += ".#{fraction}".to_r * frac_base unless fraction.nil?
+        frac = ".#{fraction}".to_r * frac_base
+        @value = (@value + frac) unless fraction.nil?
       end
 
-      def strformat(date_hour) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+      def strformat(date_hour)
         case date_hour.size
         when 11
-          frac_base = 60 * 60
-          format = '%Y%m%d%HZ'
-        when 13
-          frac_base = 60
-          format = '%Y%m%d%H%MZ'
+          ['%Y%m%d%H%z', HOUR_TO_SEC]
+        when 13, 17
+          ['%Y%m%d%H%M%z', MINUTE_TO_SEC]
         when 15
           if date_hour[-1] == 'Z'
-            frac_base = 1
-            format = '%Y%m%d%H%M%SZ'
+            ['%Y%m%d%H%M%S%z', SECOND_TO_SEC]
           else
-            frac_base = 60 * 60
-            format = '%Y%m%d%H%z'
+            ['%Y%m%d%H%z', HOUR_TO_SEC]
           end
-        when 17
-          frac_base = 60
-          format = '%Y%m%d%H%M%z'
         when 19
-          frac_base = 1
-          format = '%Y%m%d%H%M%S%z'
+          ['%Y%m%d%H%M%S%z', SECOND_TO_SEC]
         else
           prefix = @name.nil? ? type : "tag #{@name}"
-          raise ASN1Error, "#{prefix}: unrecognized format: #{der}"
+          raise ASN1Error, "#{prefix}: unrecognized format: #{date_hour}"
         end
-
-        [format, frac_base]
       end
     end
   end

data/lib/rasn1/types/ia5string.rb

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

data/lib/rasn1/types/integer.rb

@@ -133,8 +133,9 @@ module RASN1
         return if @enum.empty?
 
         int_value = @value
+        raise EnumeratedError, "#{@name}: value #{int_value} not in enumeration" unless @enum.value?(@value)
+
         @value = @enum.key(@value)
-        raise EnumeratedError, "#{@name}: value #{int_value} not in enumeration" unless value?
       end
 
       def explicit_type

data/lib/rasn1/types/null.rb

@@ -15,6 +15,10 @@ module RASN1
         str
       end
 
+      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/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_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={})
@@ -105,6 +104,7 @@ module RASN1
         @value.length
       end
 
+      # @return [String]
       def inspect(level=0)
         str = common_inspect(level)
         str << "\n"

data/lib/rasn1/types/utc_time.rb

@@ -35,20 +35,16 @@ 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
     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,12 +74,39 @@ 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
     end
+
+    # 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 class from which inherits
+    # @param [Module] in_module module in which creates new type (default to {RASN1::Types})
+    # @return [Class] newly created class
+    # @since 0.11.0
+    # @since 0.12.0 in_module parameter
+    def self.define_type(name, from:, in_module: self, &block)
+      constraint = block.nil? ? nil : block.to_proc
+
+      new_klass = Class.new(from) do
+        include Constrained
+      end
+      new_klass.constraint = constraint
+
+      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 = []
+      @constructed = []
+
+      new_klass
+    end
   end
 end
 
@@ -85,6 +119,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'