rasn1 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d38c6038ef58e60eb51d02fc20416188918a736386c4273a713f1be2d2535a1
-  data.tar.gz: fd3b045acdd39707540c3909f24aa8a2e2ae6ed11e46339f90903b7ef96da0df
+  metadata.gz: cc6eb3e3649f88dae027153d6136d5e5969135c74a527d4abbc42a42e03e2e73
+  data.tar.gz: a674238e2461230d7076ffb29250b3a222c229b7af484b586da25642ba87863a
 SHA512:
-  metadata.gz: f21443bccf45e549a1999bedcef1858ff175ab9e65bdb09f048ad4723d4ac64be80338cbff491ddaf31654aabaa1ad567af4925edf24297e757a42c901684ff2
-  data.tar.gz: ad0a89d6a6d634b83fe89f45f64f327f5740f68be8dfe6ca143bcfcf028e387c9859ec665da82e5f0f8d3576133ef74cf63b24d511da19e2589a53909bcf95ce
+  metadata.gz: dba48f620835a6ce4c9b6764d1538a2f96a94f21a7c8aa39b587783ba08b5c745c918eb885276372b3ae215f904596dfb3b5eab818c1a7416131e898c9c220eb
+  data.tar.gz: e397c4b1b78320a3b69e24aa9bbf46d29b04653b03aed76f9c906e5e47a03b027957d2d8d6a8f60793f13255b2492f5eb43e9f05a73d3e8dd9bde676cbbcdfe9

data/lib/rasn1/errors.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+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
+
+  # Exception raised when a constraint is not verified on a constrained type.
+  # @version 0.11.0
+  # @author Sylvain Daubert
+  class ConstraintError < Error
+    # @param [Types::Base] object
+    def initialize(object)
+      @object = object
+      super()
+    end
+
+    # @return [String]
+    def message
+      "Constraint not verified on #{object.inspect}"
+    end
+  end
+end

data/lib/rasn1/model.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'types/constrained'
+
 module RASN1
   # @abstract
   # {Model} class is a base class to define ASN.1 models.
@@ -18,6 +20,8 @@ module RASN1
   #                       integer(:house, explicit: 1, default: 0)])
   #  end
   #
+  # In a model, each element must have a unique name.
+  #
   # === Parse a DER-encoded string
   #  record = Record.parse(der_string)
   #  record[:id]             # => RASN1::Types::Integer
@@ -53,16 +57,17 @@ module RASN1
   #
   # == Delegation
   # {Model} may delegate some methods to its root element. Thus, if root element
-  # is, for example, a {Types::Choice}, model may delegate +#chosen+ and +#chosen_value+.
+  # is, for example, a {TypeInts::Choice}, model may delegate +#chosen+ and +#chosen_value+.
   #
   # All methods defined by root may be delegated by model, unless model also defines
   # this method.
   # @author Sylvain Daubert
-  class Model # rubocop:disable Metrics/ClassLength
+  class Model
     # @private
     Elem = Struct.new(:name, :proc_or_class, :content)
 
-    class << self
+    # @private
+    module Accel
       # @return [Hash]
       attr_reader :options
 
@@ -100,120 +105,39 @@ module RASN1
         klass.class_eval { @root = root }
       end
 
-      # @method sequence(name, options)
-      #  @param [Symbol,String] name name of object in model
-      #  @param [Hash] options
-      #  @return [Elem]
-      #  @see Types::Sequence#initialize
-      # @method set(name, options)
-      #  @param [Symbol,String] name name of object in model
-      #  @param [Hash] options
-      #  @return [Elem]
-      #  @see Types::Set#initialize
-      # @method choice(name, options)
-      #  @param [Symbol,String] name name of object in model
-      #  @param [Hash] options
-      #  @return [Elem]
-      #  @see Types::Choice#initialize
-      %w[sequence set choice].each do |type|
-        class_eval "def #{type}(name, options={})\n" \
-                   "  options.merge!(name: name)\n" \
-                   "  proc = proc do |opts|\n" \
-                   "    Types::#{type.capitalize}.new(options.merge(opts))\n" \
-                   "  end\n" \
-                   "  @root = Elem.new(name, proc, options[:content])\n" \
-                   'end'
+      def define_type_accel_base(accel_name, klass)
+        singleton_class.class_eval(
+          "def #{accel_name}(name, options={})\n" \
+          "  options[:name] = name\n" \
+          "  proc = proc do |opts|\n" \
+          "    #{klass}.new(options.merge(opts))\n" \
+          "  end\n" \
+          "  @root = Elem.new(name, proc, options[:content])\n" \
+          'end'
+        )
       end
 
-      # @method sequence_of(name, type, options)
-      #  @param [Symbol,String] name name of object in model
-      #  @param [Model, Types::Base] type type for SEQUENCE OF
-      #  @param [Hash] options
-      #  @return [Elem]
-      #  @see Types::SequenceOf#initialize
-      # @method set_of(name, type, options)
-      #  @param [Symbol,String] name name of object in model
-      #  @param [Model, Types::Base] type type for SET OF
-      #  @param [Hash] options
-      #  @return [Elem]
-      #  @see Types::SetOf#initialize
-      %w[sequence set].each do |type|
-        klass_name = "Types::#{type.capitalize}Of"
-        class_eval "def #{type}_of(name, type, options={})\n" \
-                   "  options.merge!(name: name)\n" \
-                   "  proc = proc do |opts|\n" \
-                   "    #{klass_name}.new(type, options.merge(opts))\n" \
-                   "  end\n" \
-                   "  @root = Elem.new(name, proc, nil)\n" \
-                   'end'
+      def define_type_accel_of(accel_name, klass)
+        singleton_class.class_eval(
+          "def #{accel_name}_of(name, type, options={})\n" \
+          "  options[:name] = name\n" \
+          "  proc = proc do |opts|\n" \
+          "    #{klass}.new(type, options.merge(opts))\n" \
+          "  end\n" \
+          "  @root = Elem.new(name, proc, nil)\n" \
+          'end'
+        )
       end
 
-      # @method boolean(name, options)
-      #  @param [Symbol,String] name name of object in model
-      #  @param [Hash] options
-      #  @return [Elem]
-      #  @see Types::Boolean#initialize
-      # @method integer(name, options)
-      #  @param [Symbol,String] name name of object in model
-      #  @param [Hash] options
-      #  @return [Elem]
-      #  @see Types::Integer#initialize
-      # @method bit_string(name, options)
-      #  @param [Symbol,String] name name of object in model
-      #  @param [Hash] options
-      #  @return [Elem]
-      #  @see Types::BitString#initialize
-      # @method octet_string(name, options)
-      #  @param [Symbol,String] name name of object in model
-      #  @param [Hash] options
-      #  @return [Elem]
-      #  @see Types::OctetString#initialize
-      # @method null(name, options)
-      #  @param [Symbol,String] name name of object in model
-      #  @param [Hash] options
-      #  @return [Elem]
-      #  @see Types::Null#initialize
-      # @method enumerated(name, options)
-      #  @param [Symbol,String] name name of object in model
-      #  @param [Hash] options
-      #  @return [Elem]
-      #  @see Types::Enumerated#initialize
-      # @method utf8_string(name, options)
-      #  @param [Symbol,String] name name of object in model
-      #  @param [Hash] options
-      #  @return [Elem]
-      #  @see Types::Utf8String#initialize
-      # @method numeric_string(name, options)
-      #  @param [Symbol,String] name name of object in model
-      #  @param [Hash] options
-      #  @return [Elem]
-      #  @see Types::NumericString#initialize
-      # @method printable_string(name, options)
-      #  @param [Symbol,String] name name of object in model
-      #  @param [Hash] options
-      #  @return [Elem]
-      #  @see Types::PrintableString#initialize
-      # @method visible_string(name, options)
-      #  @param [Symbol,String] name name of object in model
-      #  @param [Hash] options
-      #  @return [Elem]
-      #  @see Types::VisibleString#initialize
-      # @method ia5_string(name, options)
-      #  @param [Symbol,String] name name of object in model
-      #  @param [Hash] options
-      #  @return [Elem]
-      #  @see Types::IA5String#initialize
-      Types.primitives.each do |prim|
-        next if prim == Types::ObjectId
-
-        method_name = prim.type.gsub(/([a-z0-9])([A-Z])/, '\1_\2').downcase.gsub(/\s+/, '_')
-        class_eval "def #{method_name}(name, options={})\n" \
-                   "  options.merge!(name: name)\n" \
-                   "  proc = proc do |opts|\n" \
-                   "    #{prim}.new(options.merge(opts))\n" \
-                   "  end\n" \
-                   "  @root = Elem.new(name, proc, nil)\n" \
-                   'end'
+      # Define an accelarator to access a type in a model definition
+      # @param [String] accel_name
+      # @param [Class] klass
+      def define_type_accel(accel_name, klass)
+        if klass < Types::SequenceOf
+          define_type_accel_of(accel_name, klass)
+        else
+          define_type_accel_base(accel_name, klass)
+        end
       end
 
       # @param [Symbol,String] name name of object in model
@@ -258,6 +182,105 @@ module RASN1
       end
     end
 
+    extend Accel
+
+    # @method sequence(name, options)
+    #  @param [Symbol,String] name name of object in model
+    #  @param [Hash] options
+    #  @return [Elem]
+    #  @see Types::Sequence#initialize
+    # @method set(name, options)
+    #  @param [Symbol,String] name name of object in model
+    #  @param [Hash] options
+    #  @return [Elem]
+    #  @see Types::Set#initialize
+    # @method choice(name, options)
+    #  @param [Symbol,String] name name of object in model
+    #  @param [Hash] options
+    #  @return [Elem]
+    #  @see Types::Choice#initialize
+    %w[sequence set choice].each do |type|
+      self.define_type_accel_base(type, Types.const_get(type.capitalize))
+    end
+
+    # @method sequence_of(name, type, options)
+    #  @param [Symbol,String] name name of object in model
+    #  @param [Model, Types::Base] type type for SEQUENCE OF
+    #  @param [Hash] options
+    #  @return [Elem]
+    #  @see Types::SequenceOf#initialize
+    # @method set_of(name, type, options)
+    #  @param [Symbol,String] name name of object in model
+    #  @param [Model, Types::Base] type type for SET OF
+    #  @param [Hash] options
+    #  @return [Elem]
+    #  @see Types::SetOf#initialize
+    %w[sequence set].each do |type|
+      define_type_accel_of(type, Types.const_get("#{type.capitalize}Of"))
+    end
+
+    # @method boolean(name, options)
+    #  @param [Symbol,String] name name of object in model
+    #  @param [Hash] options
+    #  @return [Elem]
+    #  @see Types::Boolean#initialize
+    # @method integer(name, options)
+    #  @param [Symbol,String] name name of object in model
+    #  @param [Hash] options
+    #  @return [Elem]
+    #  @see Types::Integer#initialize
+    # @method bit_string(name, options)
+    #  @param [Symbol,String] name name of object in model
+    #  @param [Hash] options
+    #  @return [Elem]
+    #  @see Types::BitString#initialize
+    # @method octet_string(name, options)
+    #  @param [Symbol,String] name name of object in model
+    #  @param [Hash] options
+    #  @return [Elem]
+    #  @see Types::OctetString#initialize
+    # @method null(name, options)
+    #  @param [Symbol,String] name name of object in model
+    #  @param [Hash] options
+    #  @return [Elem]
+    #  @see Types::Null#initialize
+    # @method enumerated(name, options)
+    #  @param [Symbol,String] name name of object in model
+    #  @param [Hash] options
+    #  @return [Elem]
+    #  @see Types::Enumerated#initialize
+    # @method utf8_string(name, options)
+    #  @param [Symbol,String] name name of object in model
+    #  @param [Hash] options
+    #  @return [Elem]
+    #  @see Types::Utf8String#initialize
+    # @method numeric_string(name, options)
+    #  @param [Symbol,String] name name of object in model
+    #  @param [Hash] options
+    #  @return [Elem]
+    #  @see Types::NumericString#initialize
+    # @method printable_string(name, options)
+    #  @param [Symbol,String] name name of object in model
+    #  @param [Hash] options
+    #  @return [Elem]
+    #  @see Types::PrintableString#initialize
+    # @method visible_string(name, options)
+    #  @param [Symbol,String] name name of object in model
+    #  @param [Hash] options
+    #  @return [Elem]
+    #  @see Types::VisibleString#initialize
+    # @method ia5_string(name, options)
+    #  @param [Symbol,String] name name of object in model
+    #  @param [Hash] options
+    #  @return [Elem]
+    #  @see Types::IA5String#initialize
+    Types.primitives.each do |prim|
+      next if prim == Types::ObjectId
+
+      method_name = prim.type.gsub(/([a-z0-9])([A-Z])/, '\1_\2').downcase.gsub(/\s+/, '_')
+      self.define_type_accel_base(method_name, prim)
+    end
+
     # Create a new instance of a {Model}
     # @param [Hash] args
     def initialize(args={})
@@ -425,7 +448,7 @@ module RASN1
       when Proc
         proc_or_class.call(options)
       when Class
-        proc_or_class.new
+        proc_or_class.new(options)
       end
     end
 

data/lib/rasn1/types/base.rb

@@ -95,6 +95,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+.
@@ -110,8 +117,12 @@ module RASN1
       def initialize(options={})
         @constructed = nil
         set_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
@@ -455,7 +466,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/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

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 {Model.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.rb

@@ -73,6 +73,29 @@ module RASN1
       @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
+    # @return [Class] newly created class
+    def self.define_type(name, from:, &block)
+      constraint = block.nil? ? nil : block.to_proc
+
+      new_klass = Class.new(from) do
+        include Constrained
+      end
+      new_klass.constraint = constraint
+
+      self.const_set(name, new_klass)
+      Model.define_type_accel(name.downcase, new_klass)
+
+      # Empty type caches
+      @primitives = nil
+      @constructed = nil
+
+      new_klass
+    end
   end
 end
 

data/lib/rasn1/version.rb

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

data/lib/rasn1.rb

@@ -1,36 +1,13 @@
 # frozen_string_literal: true
 
 require 'rasn1/version'
+require 'rasn1/errors'
 require 'rasn1/types'
 require 'rasn1/model'
 
 # 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rasn1
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,6 +66,7 @@ files:
 - LICENSE
 - README.md
 - lib/rasn1.rb
+- lib/rasn1/errors.rb
 - lib/rasn1/model.rb
 - lib/rasn1/types.rb
 - lib/rasn1/types/any.rb
@@ -73,6 +74,7 @@ files:
 - lib/rasn1/types/bit_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