rasn1 0.6.8 → 0.9.0

data/lib/rasn1/types/sequence_of.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 SEQUENCE OF
     #
     # A SEQUENCE OF is an array of one ASN.1 type.
@@ -45,7 +46,8 @@ module RASN1
     #  seqof[0][:int].value    # => 12
     # @author Sylvain Daubert
     class SequenceOf < Constructed
-      TAG = Sequence::TAG
+      # SequenceOf id value
+      ID = Sequence::ID
 
       # @return [Class, Base]
       attr_reader :of_type
@@ -62,40 +64,27 @@ module RASN1
       def initialize(of_type, options={})
         super(options)
         @of_type = of_type
-        @value = []
+        @no_value = false
       end
 
       def initialize_copy(other)
         super
         @of_type = @of_type.dup
-        @value = @value.map { |v| v.dup }
+        @value = @value.map(&:dup)
+      end
+
+      # @return [Array]
+      def void_value
+        []
       end
 
       # Add an item to SEQUENCE OF
       # @param [Array,Hash, Model]
       def <<(obj)
-        if of_type_class < Primitive
-          raise ASN1Error, 'object to add should be an Array' unless obj.is_a?(Array)
-          @value += obj.map { |item| @of_type.new(item) }
-        elsif composed_of_type?
-          raise ASN1Error, 'object to add should be an Array' unless obj.is_a?(Array)
-          new_value = of_type_class.new
-          @of_type.value.each_with_index do |type, i|
-            type2 = type.dup
-            type2.value = obj[i]
-            new_value.value << type2
-          end
-          @value << new_value
-        elsif of_type_class < Model
-          case obj
-          when Hash
-            @value << @of_type.new(obj)
-          when of_type_class
-            @value << obj
-          else
-            raise ASN1Error, "object to add should be a #{of_type_class} or a Hash"
-          end
-        end
+        return push_array_of_primitive(obj) if of_type_class < Primitive
+        return push_composed_array(obj) if composed_of_type?
+
+        push_model(obj)
       end
 
       # Get element of index +idx+
@@ -112,17 +101,15 @@ module RASN1
       end
 
       def inspect(level=0)
-        str = ''
-        str << '  ' * level if level > 0
-        str << "#{@name} " unless @name.nil?
-        level = level.abs
-        str << "#{type}:\n"
-        level += 1
+        str = common_inspect(level)
+        str << "\n"
+        level = level.abs + 1
         @value.each do |item|
           case item
           when Base, Model
-            next if item.optional? and item.value.nil?
-            str << "#{item.inspect(level)}"
+            next if item.optional? && item.value.nil?
+
+            str << item.inspect(level)
             str << "\n" unless str.end_with?("\n")
           else
             str << '  ' * level + "#{item.inspect}\n"
@@ -138,24 +125,22 @@ module RASN1
       end
 
       def composed_of_type?
-        [Sequence, Set].include? of_type_class
+        !@of_type.is_a?(Class) && [Sequence, Set].include?(of_type_class)
       end
 
       def value_to_der
-        @value.map { |v| v.to_der }.join
+        @value.map(&:to_der).join
       end
 
-      def der_to_value(der, ber:false)
+      def der_to_value(der, ber: false) # rubocop:disable Lint/UnusedMethodArgument
         @value = []
         nb_bytes = 0
 
         while nb_bytes < der.length
-          type = if composed_of_type?
+          type = if composed_of_type? && !@of_type.is_a?(Class)
                    @of_type.dup
-                 elsif of_type_class < Model
-                   of_type_class.new
                  else
-                   of_type_class.new(:t)
+                   of_type_class.new
                  end
           nb_bytes += type.parse!(der[nb_bytes, der.length])
           @value << type
@@ -165,6 +150,35 @@ module RASN1
       def explicit_type
         self.class.new(self.of_type)
       end
+
+      def push_array_of_primitive(obj)
+        raise ASN1Error, 'object to add should be an Array' unless obj.is_a?(Array)
+
+        @value += obj.map { |item| of_type_class.new(value: item) }
+      end
+
+      def push_composed_array(obj)
+        raise ASN1Error, 'object to add should be an Array' unless obj.is_a?(Array)
+
+        new_value = of_type_class.new
+        @of_type.value.each_with_index do |type, i|
+          type2 = type.dup
+          type2.value = obj[i]
+          new_value.value << type2
+        end
+        @value << new_value
+      end
+
+      def push_model(obj)
+        case obj
+        when Hash
+          @value << of_type_class.new(obj)
+        when of_type_class
+          @value << obj
+        else
+          raise ASN1Error, "object to add should be a #{of_type_class} or a Hash"
+        end
+      end
     end
   end
 end

data/lib/rasn1/types/set.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 set
     #
     # A set is a collection of another ASN.1 types.
@@ -20,7 +21,8 @@ module RASN1
     #              ]
     # @author Sylvain Daubert
     class Set < Sequence
-      TAG = 0x11
+      # Set id value
+      ID = 0x11
     end
   end
 end

data/lib/rasn1/types/set_of.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 SET OF
     # @author Sylvain Daubert
     class SetOf < SequenceOf
-      TAG = Set::TAG
+      # SetOf id value
+      ID = Set::ID
 
       # A SET OF is encoded as a SET.
       # @return ['SET']
@@ -14,4 +16,3 @@ module RASN1
     end
   end
 end
-

data/lib/rasn1/types/utc_time.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'date'
 
 module RASN1
   module Types
-
     # ASN.1 UTCTime
     #
     # +{#value} of a +UtcTime+ should be a ruby Time.
@@ -17,7 +18,8 @@ module RASN1
     # not.
     # @author Sylvain Daubert
     class UtcTime < Primitive
-      TAG = 23
+      # UtcTime id value
+      ID = 23
 
       # Get ASN.1 type
       # @return [String]
@@ -26,12 +28,12 @@ module RASN1
       end
 
       private
-      
+
       def value_to_der
         @value.getutc.strftime('%y%m%d%H%M%SZ')
       end
-      
-      def der_to_value(der, ber: false)
+
+      def der_to_value(der, ber: false) # rubocop:disable Lint/UnusedMethodArgument
         format = case der.size
                  when 11
                    '%Y%m%d%H%MZ'

data/lib/rasn1/types/utf8_string.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 UTF8 String
     # @author Sylvain Daubert
     class Utf8String < OctetString
-      TAG = 12
+      # Utf8String id value
+      ID = 12
 
       # Get ASN.1 type
       # @return [String]
@@ -13,14 +15,14 @@ module RASN1
       end
 
       private
-      
+
       def value_to_der
         @value.to_s.force_encoding('UTF-8').force_encoding('BINARY')
       end
 
-      def der_to_value(der, ber:false)
+      def der_to_value(der, ber: false)
         super
-        @value.force_encoding('UTF-8')
+        @value = der.force_encoding('UTF-8')
       end
     end
   end

data/lib/rasn1/types/visible_string.rb

@@ -1,17 +1,18 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 Visible String
     # @author Sylvain Daubert
     class VisibleString < IA5String
-      TAG = 26
+      # VisibleString id value
+      ID = 26
 
       # Get ASN.1 type
       # @return [String]
       def self.type
         'VisibleString'
       end
-
     end
   end
 end

data/lib/rasn1/types.rb

@@ -1,48 +1,78 @@
+# frozen_string_literal: true
+
 module RASN1
   # This modules is a namesapce for all ASN.1 type classes.
   # @author Sylvain Daubert
   module Types
-
     # Give all primitive types
     # @return [Array<Types::Primitive>]
     def self.primitives
-      @primitives ||= self.constants.map { |c| Types.const_get(c) }.
-                           select { |klass| klass < Primitive }
+      @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 }
+      @constructed ||= self.constants.map { |c| Types.const_get(c) }
+                           .select { |klass| klass < Constructed }
+    end
+
+    # @private
+    # Decode a DER string to extract identifier octets.
+    # @param [String] der
+    # @return [Array] Return ASN.1 class as Symbol, contructed/primitive as Symbol,
+    #                 ID and size of identifier octets
+    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)
+      pc = (first_octet & Types::Constructed::ASN1_PC).positive? ? :constructed : :primitive
+      id = first_octet & Types::Base::MULTI_OCTETS_ID
+
+      size = if id == Types::Base::MULTI_OCTETS_ID
+               id = 0
+               der.bytes.each_with_index do |octet, i|
+                 next if i.zero?
+
+                 id = (id << 7) | (octet & 0x7f)
+                 break i + 1 if (octet & 0x80).zero?
+               end
+             else
+               1
+             end
+
+      [asn1_class, pc, id, size]
     end
 
-    # Give ASN.1 type from an integer. If +tag+ is unknown, return a {Types::Base}
+    # Give ASN.1 type from a DER string. If ID is unknown, return a {Types::Base}
     # object.
-    # @param [Integer] tag
+    # @param [String] der
     # @return [Types::Base]
     # @raise [ASN1Error] +tag+ is out of range
-    def self.tag2type(tag)
-      raise ASN1Error, "tag is out of range" if tag > 0xff
-
-      if !defined? @tag2types
-        constructed = self.constructed - [Types::SequenceOf, Types::SetOf]
-        primitives = self.primitives - [Types::Enumerated]
-        ary = [primitives, constructed].flatten.map do |type|
-          next unless type.const_defined? :TAG
-          [type::TAG, type]
-        end
-        @tag2types = Hash[ary]
-        @tag2types.default = Types::Base
-      end
+    def self.id2type(der)
+      # Define a cache for well-known ASN.1 types
+      self.generate_id2type_cache unless defined? @id2types
 
-      klass = @tag2types[tag & 0xdf] # Remove CONSTRUCTED bit
-      is_constructed = (tag & 0x20) == 0x20
-      asn1class = Types::Base::CLASSES.key(tag & 0xc0)
+      asn1class, pc, id, = self.decode_identifier_octets(der)
+      # cache_id: check versus class and 5 LSB bits
+      cache_id = der.unpack1('C') & 0xdf
+      klass = cache_id < Types::Base::MULTI_OCTETS_ID ? @id2types[id] : Types::Base
+      is_constructed = (pc == :constructed)
       options = { class: asn1class, constructed: is_constructed }
-      options[:tag_value] = (tag & 0x1f) if klass == Types::Base
+      options[:tag_value] = id if klass == Types::Base
       klass.new(options)
     end
+
+    # @private Generate cache for {.id2type}
+    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] }
+      @id2types = ary.to_h
+      @id2types.default = Types::Base
+      @id2types.freeze
+    end
   end
 end
 

data/lib/rasn1/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RASN1
-  VERSION = '0.6.8'
+  VERSION = '0.9.0'
 end

data/lib/rasn1.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rasn1/version'
 require 'rasn1/types'
 require 'rasn1/model'
@@ -5,7 +7,6 @@ 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
 
@@ -26,10 +27,10 @@ module RASN1
   # CHOICE error: #chosen not set
   class ChoiceError < RASN1::Error
     def message
-      "CHOICE #@name: #chosen not set"
+      "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}.
@@ -42,15 +43,15 @@ module RASN1
   # @return [Types::Base]
   def self.parse(der, ber: false)
     root = nil
-    while der.size > 0
-      type = Types.tag2type(der[0].ord)
+    until der.empty?
+      type = Types.id2type(der)
       type.parse!(der, ber: ber)
-      root = type if root.nil?
+      root ||= type
 
       if [Types::Sequence, Types::Set].include? type.class
         subder = type.value
         ary = []
-        while subder.size > 0
+        until subder.empty?
           ary << self.parse(subder)
           subder = subder[ary.last.to_der.size..-1]
         end

metadata

@@ -1,57 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rasn1
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.9.0
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-11 00:00:00.000000000 Z
+date: 2021-12-27 00:00:00.000000000 Z
 dependencies:
-- !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'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -67,36 +39,32 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
-description: |2
-
-    RASN1 is a pure ruby ASN.1 library. It may encode and decode DER and BER
-    encodings.
+        version: '0.9'
+description: |
+  RASN1 is a pure ruby ASN.1 library. It may encode and decode DER and BER
+  encodings.
 email:
 - sylvain.daubert@laposte.net
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- LICENSE
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - lib/rasn1.rb
 - lib/rasn1/model.rb
 - lib/rasn1/types.rb
@@ -124,28 +92,36 @@ files:
 - lib/rasn1/types/utf8_string.rb
 - lib/rasn1/types/visible_string.rb
 - lib/rasn1/version.rb
-- rasn1.gemspec
 homepage: https://github.com/sdaubert/rasn1
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/sdaubert/rasn1
+  source_code_uri: https://github.com/sdaubert/rasn1
+  bug_tracker_uri: https://github.com/sdaubert/rasn1/issues
+  documentation_uri: https://www.rubydoc.info/gems/rasn1
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- "--title"
+- RASN1 - A pure ruby ASN.1 library
+- "--main"
+- README.md
+- "--inline-source"
+- "--quiet"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Ruby ASN.1 library

data/.gitignore

@@ -1,11 +0,0 @@
-*~
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/vendor/

data/.rubocop.yml

@@ -1,28 +0,0 @@
-Layout/SpaceAroundEqualsInParameterDefault:
-  EnforcedStyle: no_space
-Lint/EmptyWhen:
-  Enabled: false
-Lint/Void:
-  Enabled: false
-Metrics:
-  Enabled: false
-Style/AsciiComments:
-  Enabled: false
-Style/Encoding:
-  Enabled: false
-Style/EvalWithLocation:
-  Enabled: false
-Style/FormatString:
-  EnforcedStyle: percent
-Style/FormatStringToken:
-  EnforcedStyle: unannotated
-Style/PerlBackrefs:
-  Enabled: false
-Style/RedundantSelf:
-  Enabled: false
-Style/StructInheritance:
-  Enabled: false
-Style/TrailingCommaInArrayLiteral:
-  Enabled: false
-Style/TrailingCommaInHashLiteral:
-  Enabled: false

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-install:
-  - bundle install --path vendor/bundle --jobs=3 --retry=3
-script:
-  - bundle exec rake

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in rasn1.gemspec
-gemspec

data/Rakefile

@@ -1,12 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'yard'
-
-RSpec::Core::RakeTask.new
-YARD::Rake::YardocTask.new do |t|
-  t.files = ['lib/**/*.rb', '-', 'README.md', 'LICENSE']
-  t.options = %w(--no-private)
-end
-
-task :default => :spec
-