rasn1 0.6.8 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1889a0ada74e2d9255ce6af799caa441fd2d2cacfaf0097b5afd1730ed9a9fd9
-  data.tar.gz: e0453969129814385bd272c362373b12ae0e38201145280c360ac3696dd95cb1
+  metadata.gz: 7fc411854088bf4835982774db3a4037c1760c9cb2088653fb2dc92d82d7788c
+  data.tar.gz: e81586c34344dfa3c3c26868e6689ebf841c964eff6c80dd0705288617818143
 SHA512:
-  metadata.gz: 4dc47229a202f0bfa7d56a129cd5e1807009b9147da6e844d5a47589fbf0e8eab9bebbb51f81866a0222eb4a6dbf953d381f266ec332e697b6caf1b894fa6c18
-  data.tar.gz: 4fc5127882d478d111452dff0cac6e226d270f47b4798b6a365f735c0bb1402ec417640b48be9839f7336fcf6d526f2a771d90bdc6ed64b0cefc3258d9e22bff
+  metadata.gz: aecf47fe0ebb5d79546cf63c514359d4477fbd0c3a543aaebe1619f45cd4f8604beeff8ca614a59444a68ddc6aa8901ead9160b3cb7026ead301ea2d6935ed27
+  data.tar.gz: edea58f24e5931deb04a5f038d8c9f0b2945bb4c90892acfa264b29c9f530b0e6534b25a41173a57fd002f7da7bfa52f1820d172dfe91ddaf4257a73df5ab9d1

data/.rubocop.yml

@@ -6,6 +6,8 @@ Lint/Void:
   Enabled: false
 Metrics:
   Enabled: false
+Naming/AccessorMethodName:
+  Enabled: false
 Style/AsciiComments:
   Enabled: false
 Style/Encoding:
@@ -20,6 +22,8 @@ Style/PerlBackrefs:
   Enabled: false
 Style/RedundantSelf:
   Enabled: false
+Style/RegexpLiteral:
+  EnforcedStyle: slashes
 Style/StructInheritance:
   Enabled: false
 Style/TrailingCommaInArrayLiteral:

data/.travis.yml

@@ -3,7 +3,8 @@ rvm:
   - 2.3
   - 2.4
   - 2.5
+  - 2.6
 install:
-  - bundle install --path vendor/bundle --jobs=3 --retry=3
-script:
-  - bundle exec rake
+  - gem install bundler --version "~> 1.17.3"
+  - bundle _1.17.3_ install --path vendor/bundle --jobs=3 --retry=3
+

data/Changelog.md

@@ -0,0 +1,11 @@
+# Rasn1 Changelog
+
+## 0.7.0
+
+* add RASN1::Model#value to get value of a (potentially nested) element.
+* add RASN1::Types::Sequence#[]. Access to element by index or by name.
+* add frozen_string literal on all ruby files.
+* optimize RASN1::Types.tag2type.
+* refactoring of RASN1::Types::Base and RASN1::Types::Boolean.
+* fix bugs:
+  * RASN1::Types::Base#initialize_copy raises on ruby 2.3 when @value and/or @default were nil, true, false of Integer.

data/README.md

@@ -15,13 +15,22 @@ gem 'rasn1'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
     $ gem install rasn1
 
-## Usage
+## Simple usage
+
+To decode a DER/BER string without checking a model, do:
+
+```ruby
+decoded_der = RASN1.parse(der_string)
+decoded_ber = RASN1.parse(ber_string, ber: true)
+```
+
+## Advanced usage
 All examples below will be based on:
 
 ```

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,7 +43,7 @@ module RASN1
   # @return [Types::Base]
   def self.parse(der, ber: false)
     root = nil
-    while der.size > 0
+    until der.empty?
       type = Types.tag2type(der[0].ord)
       type.parse!(der, ber: ber)
       root = type if root.nil?
@@ -50,7 +51,7 @@ module RASN1
       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

data/lib/rasn1/model.rb

@@ -1,5 +1,6 @@
-module RASN1
+# frozen_string_literal: true
 
+module RASN1
   # @abstract
   # {Model} class is a base class to define ASN.1 models.
   # == Create a simple ASN.1 model
@@ -58,7 +59,6 @@ module RASN1
   # this method.
   # @author Sylvain Daubert
   class Model
-
     class << self
       # @return [Hash]
       attr_reader :options
@@ -92,7 +92,7 @@ module RASN1
       # @return [void]
       def inherited(klass)
         super
-        root = defined?(@root )? @root : nil
+        root = @root
         klass.class_eval { @root = root }
       end
 
@@ -108,16 +108,16 @@ module RASN1
       #  @param [Symbol,String] name name of object in model
       #  @param [Hash] options
       #  @see Types::Choice#initialize
-      %w(sequence set choice).each do |type|
+      %w[sequence set choice].each do |type|
         class_eval "def #{type}(name, options={})\n" \
                    "  options.merge!(name: name)\n" \
-                   "  proc = Proc.new do |opts|\n" \
+                   "  proc = proc do |opts|\n" \
                    "    Types::#{type.capitalize}.new(options.merge(opts))\n" \
                    "  end\n" \
                    "  @root = [name, proc]\n" \
                    "  @root << options[:content] unless options[:content].nil?\n" \
                    "  @root\n" \
-                   "end"
+                   'end'
       end
 
       # @method sequence_of(name, type, options)
@@ -130,15 +130,15 @@ module RASN1
       #  @param [Model, Types::Base] type type for SET OF
       #  @param [Hash] options
       #  @see Types::SetOf#initialize
-      %w(sequence set).each do |type|
+      %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.new do |opts|\n" \
+                   "  proc = proc do |opts|\n" \
                    "    #{klass_name}.new(type, options.merge(opts))\n" \
                    "  end\n" \
                    "  @root = [name, proc]\n" \
-                   "end"
+                   'end'
       end
 
       # @method boolean(name, options)
@@ -187,14 +187,15 @@ module RASN1
       #  @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.new do |opts|\n" \
-                   "    #{prim.to_s}.new(options.merge(opts))\n" \
+                   "  proc = proc do |opts|\n" \
+                   "    #{prim}.new(options.merge(opts))\n" \
                    "  end\n" \
                    "  @root = [name, proc]\n" \
-                   "end"
+                   'end'
       end
 
       # @param [Symbol,String] name name of object in model
@@ -204,7 +205,7 @@ module RASN1
       # @see Types::ObjectId#initialize
       def objectid(name, options={})
         options.merge!(name: name)
-        proc = Proc.new { |opts| Types::ObjectId.new(options.merge(opts)) }
+        proc = proc { |opts| Types::ObjectId.new(options.merge(opts)) }
         @root = [name, proc]
       end
 
@@ -213,7 +214,7 @@ module RASN1
       # @see Types::Any#initialize
       def any(name, options={})
         options.merge!(name: name)
-        proc = Proc.new { |opts| Types::Any.new(options.merge(opts)) }
+        proc = proc { |opts| Types::Any.new(options.merge(opts)) }
         @root = [name, proc]
       end
 
@@ -221,6 +222,7 @@ module RASN1
       # @return [String]
       def type
         return @type if defined? @type
+
         @type = self.to_s.gsub(/.*::/, '')
       end
 
@@ -256,7 +258,8 @@ module RASN1
     # @param [Object] value
     # @return [Object] value
     def []=(name, value)
-      raise Error, "cannot set value for a Model" if @elements[name].is_a? Model
+      raise Error, 'cannot set value for a Model' if @elements[name].is_a? Model
+
       @elements[name].value = value
     end
 
@@ -304,6 +307,32 @@ module RASN1
       @elements[@root].parse!(str.dup.force_encoding('BINARY'), ber: ber)
     end
 
+    # @overload value
+    #  Get value of root element
+    #  @return [Object,nil]
+    # @overload value(name)
+    #  Direct access to the value of +name+ (nested) element of model.
+    #  @param [String,Symbol] name
+    #  @return [Object,nil]
+    # @return [Object,nil]
+    def value(name=nil, *args)
+      if name.nil?
+        @elements[@root].value
+      else
+        elt = by_name(name)
+
+        unless args.empty?
+          elt = elt.root if elt.is_a?(Model)
+          args.each do |arg|
+            elt = elt.root if elt.is_a?(Model)
+            elt = elt[arg]
+          end
+        end
+
+        elt.value
+      end
+    end
+
     # Delegate some methods to root element
     # @param [Symbol] meth
     def method_missing(meth, *args)
@@ -314,6 +343,11 @@ module RASN1
       end
     end
 
+    # @return [Boolean]
+    def respond_to_missing?(meth, *)
+      @elements[@root].respond_to?(meth) || super
+    end
+
     # @return [String]
     def inspect(level=0)
       '  ' * level + "(#{type}) #{root.inspect(-level)}"
@@ -326,14 +360,29 @@ module RASN1
       (other.class == self.class) && (other.to_der == self.to_der)
     end
 
-    private
+    protected
+
+    # Give a (nested) element from its name
+    # @param [String, Symbol] name
+    # @return [Model, Types::Base]
+    def by_name(name)
+      elt = self[name]
+      return elt unless elt.nil?
+
+      keys.each do |subelt_name|
+        if self[subelt_name].is_a?(Model)
+          elt = self[subelt_name][name]
+          return elt unless elt.nil?
+        end
+      end
 
-    def is_composed?(el)
-      [Types::Sequence, Types::Set].include? el.class
+      nil
     end
 
-    def is_of?(el)
-      [Types::SequenceOf, Types::SetOf].include? el.class
+    private
+
+    def composed?(elt)
+      [Types::Sequence, Types::Set].include? elt.class
     end
 
     def get_type(proc_or_class, options={})
@@ -353,16 +402,16 @@ module RASN1
       root
     end
 
-    def set_elements(name, el, content=nil)
-      if content.is_a? Array
-        @elements[name].value = content.map do |name2, proc_or_class, content2|
-          subel = get_type(proc_or_class)
-          @elements[name2] = subel
-          if is_composed?(subel) and content2.is_a? Array
-            set_elements(name2, proc_or_class, content2)
-          end
-          subel
+    def set_elements(name, _elt, content=nil)
+      return unless content.is_a? Array
+
+      @elements[name].value = content.map do |name2, proc_or_class, content2|
+        subel = get_type(proc_or_class)
+        @elements[name2] = subel
+        if composed?(subel) && content2.is_a?(Array)
+          set_elements(name2, proc_or_class, content2)
         end
+        subel
       end
     end
 
@@ -410,10 +459,11 @@ module RASN1
                 end
               when Types::Sequence
                 seq = my_element.value.map do |el|
-                        next if el.optional? and el.value.nil?
-                        name = el.is_a?(Model) ? @elements.key(el) : el.name
-                        [name, private_to_h(el)]
-                      end
+                  next if el.optional? && el.value.nil?
+
+                  name = el.is_a?(Model) ? @elements.key(el) : el.name
+                  [name, private_to_h(el)]
+                end
                 seq.compact!
                 Hash[seq]
               else

data/lib/rasn1/types.rb

@@ -1,20 +1,21 @@
+# 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
 
     # Give ASN.1 type from an integer. If +tag+ is unknown, return a {Types::Base}
@@ -23,17 +24,19 @@ module RASN1
     # @return [Types::Base]
     # @raise [ASN1Error] +tag+ is out of range
     def self.tag2type(tag)
-      raise ASN1Error, "tag is out of range" if tag > 0xff
+      raise ASN1Error, 'tag is out of range' if tag > 0xff
 
-      if !defined? @tag2types
+      unless defined? @tag2types
         constructed = self.constructed - [Types::SequenceOf, Types::SetOf]
         primitives = self.primitives - [Types::Enumerated]
-        ary = [primitives, constructed].flatten.map do |type|
+        ary = (primitives + constructed).map do |type|
           next unless type.const_defined? :TAG
+
           [type::TAG, type]
         end
         @tag2types = Hash[ary]
         @tag2types.default = Types::Base
+        @tag2types.freeze
       end
 
       klass = @tag2types[tag & 0xdf] # Remove CONSTRUCTED bit

data/lib/rasn1/types/any.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
+
 module RASN1
   module Types
-
     # ASN.1 ANY: accepts any types
     #
     # If `any#value` is `nil` and Any object is not {#optional?}, `any` will be encoded as a {Null} object.
     # @author Sylvain Daubert
     class Any < Base
-
       # @return [String] DER-formated string
       def to_der
         case @value
@@ -25,30 +25,30 @@ module RASN1
       # @param [Boolean] ber if +true+, accept BER encoding
       # @return [Integer] total number of parsed bytes
       def parse!(der, ber: false)
-        if der.nil? or der.empty?
+        if der.nil? || der.empty?
           return 0 if optional?
 
-          raise ASN1Error, "Expected ANY but get nothing"
+          raise ASN1Error, 'Expected ANY but get nothing'
         end
 
-        total_length,  = get_data(der, ber)
+        total_length, = get_data(der, ber)
         @value = der[0, total_length]
         total_length
       end
 
       def inspect(level=0)
-        str = ''
-        str << '  ' * level if level > 0
+        lvl = level >= 0 ? level : 0
+        str = '  ' * lvl
         str << "#{@name} " unless @name.nil?
-        if @value.nil?
-          str << "(ANY) NULL"
-        elsif @value.is_a?(OctetString) or @value.is_a?(BitString)
-          str << "(ANY) #{@value.type}: #{value.value.inspect}"
-        elsif @value.class < Base
-          str << "(ANY) #{@value.type}: #{value.value}"
-        else
-          str << "ANY: #{value.to_s.inspect}"
-        end
+        str << if @value.nil?
+                 '(ANY) NULL'
+               elsif @value.is_a?(OctetString) || @value.is_a?(BitString)
+                 "(ANY) #{@value.type}: #{value.value.inspect}"
+               elsif @value.class < Base
+                 "(ANY) #{@value.type}: #{value.value}"
+               else
+                 "ANY: #{value.to_s.inspect}"
+               end
       end
     end
   end