rasn1 0.1.0

data/lib/rasn1/types/bit_string.rb

@@ -0,0 +1,70 @@
+module RASN1
+  module Types
+
+    # ASN.1 Bit String
+    # @author Sylvain Daubert
+    class BitString < Primitive
+      TAG = 0x03
+
+      # @return [Integer] bit length of bit string
+      attr_accessor :bit_length
+
+      # @param [Symbol, String] name name for this tag in grammar
+      # @param [Hash] options
+      # @option options [Symbol] :class ASN.1 tag class. Default value is +:universal+
+      # @option options [::Boolean] :optional define this tag as optional. Default
+      #   is +false+
+      # @option options [Object] :default default value for DEFAULT tag
+      # @option options [Object] :bit_length default bit_length value. Should be
+      #   present if +:default+ is set
+      def initialize(name, options={})
+        super
+        if @default
+          if options[:bit_length].nil?
+            raise ASN1Error, "TAG #@name: default bit length is not defined"
+          end
+          @default_bit_length = options[:bit_length]
+        end
+      end
+
+      private
+
+      def build_tag?
+        !(!@default.nil? and (@value.nil? or @value == @default and
+                              @bit_length == @default_bit_length)) and
+          !(optional? and @value.nil?)
+      end
+
+      def value_to_der
+        raise ASN1Error, "TAG #@name: bit length is not set" if @bit_length.nil?
+
+        while @value.length * 8 < @bit_length
+          @value << "\x00"
+        end
+        @value.force_encoding('BINARY')
+
+        if @value.length * 8 > @bit_length
+          max_len = @bit_length / 8 + (@bit_length % 8 > 0 ? 1 : 0)
+          @value = @value[0, max_len]
+        end
+
+        unused = @value.length * 8 - @bit_length
+        der = [unused, @value].pack('CA*')
+
+        if unused > 0
+          last_byte = @value[-1].unpack('C').first
+          last_byte &= (0xff >> unused) << unused
+          der[-1] = [last_byte].pack('C')
+        end
+
+        der
+      end
+
+      def der_to_value(der, ber:false)
+        unused, @value = der.unpack('CA*')
+        @bit_length = @value.length * 8 - unused
+      end
+    end
+  end
+end
+

data/lib/rasn1/types/boolean.rb

@@ -0,0 +1,36 @@
+module RASN1
+  module Types
+
+    # ASN.1 Boolean
+    # @author Sylvain Daubert
+    class Boolean < Primitive
+      TAG = 0x01
+
+      private
+
+      def value_to_der
+        [@value ? 0xff : 0x00].pack('C')
+      end
+
+      def der_to_value(der, ber: false)
+        unless der.size == 1
+          raise ASN1Error, "tag #@name: BOOLEAN should have a length of 1"
+        end
+
+        bool = der.unpack('C').first
+        case bool
+        when 0
+          @value = false
+        when 0xff
+          @value = true
+        else
+          if ber
+            @value = true
+          else
+            raise ASN1Error, "tag #@name: bad value 0x%02x for BOOLEAN" % bool
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rasn1/types/choice.rb

@@ -0,0 +1,97 @@
+module RASN1
+  module Types
+
+    # A ASN.1 CHOICE is a choice between different types.
+    #
+    # == Create a CHOICE
+    # A CHOICE is defined this way:
+    #   choice = Choice.new(:a_choice)
+    #   choice.value = [Integer.new(:int1, implicit: 0, class: :context),
+    #                   Integer.new(:int2, implicit: 1, class: :context),
+    #                   OctetString.new(:os, implicit: 2, class: :context)]
+    # The chosen type may be set this way:
+    #   choice.chosen = 0   # choose :int1
+    # The chosen value may be set these ways:
+    #   choise.value[choice.chosen].value = 1
+    #   choise.set_chosen_value 1
+    # The chosen value may be got these ways:
+    #   choise.value[choice.chosen].value # => 1
+    #   choice.chosen_value               # => 1
+    #
+    # == Encode a CHOICE
+    # {#to_der} only encodes the chosen value:
+    #   choise.to_der   # => "\x80\x01\x01"
+    #
+    # == Parse a CHOICE
+    # Parsing a CHOICE set {#chosen} and set value to chosen type. If parsed string does
+    # not contain a type from CHOICE, a {RASN1::ASN1Error} is raised.
+    #   str = "\x04\x03abc"
+    #   choice.parse! str
+    #   choice.chosen        # => 2
+    #   choice.chosen_value  # => "abc"
+    # @author Sylvain Daubert
+    class Choice < Base
+
+      # Chosen type
+      # @return [Integer] index of type in choice value
+      attr_accessor :chosen
+
+      # Set chosen value.
+      # @note {#chosen} MUST be set before calling this method
+      # @param [Object] value
+      # @return [Object] value
+      # @raise [ChoiceError] {#chosen} not set
+      def set_chosen_value(value)
+        check_chosen
+        @value[@chosen].value = value
+      end
+
+      # Get chosen value
+      # @note {#chosen} MUST be set before calling this method
+      # @return [Object] value
+      # @raise [ChoiceError] {#chosen} not set
+      def chosen_value
+        check_chosen
+        @value[@chosen].value
+      end
+
+      # @note {#chosen} MUST be set before calling this method
+      # @return [String] DER-formated string
+      # @raise [ChoiceError] {#chosen} not set
+      def to_der
+        check_chosen
+        @value[@chosen].to_der
+      end
+
+      # Parse a DER string. This method updates object by setting {#chosen} and
+      # chosen value.
+      # @param [String] der DER string
+      # @param [Boolean] ber if +true+, accept BER encoding
+      # @return [Integer] total number of parsed bytes
+      # @raise [ASN1Error] error on parsing
+      def parse!(der, ber: false)
+        parsed = false
+        @value.each_with_index do |element, i|
+          begin
+            @chosen = i
+            nb_bytes = element.parse!(der)
+            parsed = true
+            break nb_bytes
+          rescue ASN1Error
+            @chosen = nil
+            next
+          end
+        end
+        raise ASN1Error, "CHOICE #@name: no type matching #{der.inspect}" unless parsed
+      end
+
+      private
+
+      def check_chosen
+        raise ChoiceError if @chosen.nil?
+      end
+    end
+  end
+end
+
+      

data/lib/rasn1/types/constructed.rb

@@ -0,0 +1,13 @@
+module RASN1
+  module Types
+
+    # @abstract This class SHOULD be used as base class for all ASN.1 primitive
+    #  types.
+    # Base class for all ASN.1 constructed types
+    # @author Sylvain Daubert
+    class Constructed < Base
+      # Constructed value
+      ASN1_PC = 0x20
+    end
+  end
+end

data/lib/rasn1/types/enumerated.rb

@@ -0,0 +1,119 @@
+module RASN1
+  module Types
+
+    # ASN.1 Enumerated
+    #
+    # An enumerated type permits to assign names to integer values. It may be defined
+    # different ways:
+    #  enum = RASN1::Types::Enumerated.new(:name, enum: { 'a' => 0, 'b' => 1, 'c' => 2 })
+    #  enum = RASN1::Types::Enumerated.new(:name, enum: { a: 0, b: 1, c: 2 })
+    # Its value should be setting as an Integer or a String/symbol:
+    #  enum.value = :b
+    #  enum.value = 1   # equivalent to :b
+    # But its value is always stored as named integer:
+    #  enum.value = :b
+    #  enum.value      # => :b
+    #  enum.value = 0
+    #  enum.value      # => :a
+    # A {EnumeratedError} is raised when set value is not in enumeration.
+    # @author Sylvain Daubert
+    class Enumerated < Integer
+
+      # @param [Symbol, String] name name for this tag in grammar
+      # @param [Hash] options
+      # @option options [Symbol] :class ASN.1 tag class. Default value is +:universal+
+      # @option options [::Boolean] :optional define this tag as optional. Default
+      #   is +false+
+      # @option options [Object] :default default value for DEFAULT tag
+      # @option options [Hash] :enum enumeration hash. Keys are names, and values
+      #   are integers. This key is mandatory.
+      # @raise [EnumeratedError] +:enum+ key is not present
+      # @raise [EnumeratedError] +:default+ value is unknown
+      def initialize(name, options={})
+        super
+        raise EnumeratedError, 'no enumeration given' unless options.has_key? :enum
+        @enum = options[:enum]
+
+        case @default
+        when String,Symbol
+          unless @enum.has_key? @default
+            raise EnumeratedError, "TAG #@name: unknwon enumerated default value #@default"
+          end
+        when ::Integer
+          if @enum.has_value? @default
+            @default = @enum.key(@default)
+          else
+            raise EnumeratedError, "TAG #@name: default value #@defalt not in enumeration"
+          end
+        when nil
+        else
+          raise TypeError, "TAG #@name: #{@value.class} not handled as default value"
+        end
+      end
+
+      # @param [Integer,String,Symbol,nil] v
+      # @return [String,Symbol,nil]
+      def value=(v)
+        case v
+        when String,Symbol
+          unless @enum.has_key? v
+            raise EnumeratedError, "TAG #@name: unknwon enumerated value #{v}"
+          end
+          @value = v
+        when ::Integer
+          unless @enum.has_value? v
+            raise EnumeratedError, "TAG #@name: #{v} not in enumeration"
+          end
+          @value = @enum.key(v)
+        when nil
+          @value = nil
+        else
+          raise EnumeratedError, "TAG #@name: not in enumeration"
+        end
+      end
+
+      # @return [Integer]
+      def to_i
+        case @value
+        when String, Symbol
+            @enum[@value]
+        when ::Integer
+          super
+        when nil
+          if @default
+            @enum[@default]
+          else
+            0
+          end
+        else
+          raise TypeError, "TAG #@name: #{@value.class} not handled"
+        end
+      end
+
+      # @return [Hash]
+      def to_h
+        @enum
+      end
+
+      private
+
+      def value_to_der
+        case @value
+        when String, Symbol
+          super @enum[@value]
+        when ::Integer
+          super
+        else
+          raise TypeError, "TAG #@name: #{@value.class} not handled"
+        end
+      end
+
+      def der_to_value(der, ber:false)
+        super
+        v = @value
+        @value = @enum.key(v)
+        raise EnumeratedError, "TAG #@name: value #{v} not in enumeration" if @value.nil?
+      end
+    end
+  end
+end

data/lib/rasn1/types/integer.rb

@@ -0,0 +1,42 @@
+module RASN1
+  module Types
+
+    # ASN.1 Integer
+    # @author Sylvain Daubert
+    class Integer < Primitive
+      TAG = 0x02
+
+      # @return [Integer]
+      def to_i
+        @value || @default || 0
+      end
+
+      private
+
+      def value_to_der(value=nil)
+        v = value || @value
+        size = v.bit_length / 8 + (v.bit_length % 8 > 0 ? 1 : 0)
+        size = 1 if size == 0
+        comp_value = if v > 0
+                       # If MSB is 1, increment size to set initial octet
+                       # to 0 to amrk it as a positive integer
+                       size += 1 if v >> (size * 8 - 1) == 1
+                       v
+                     else
+                       ~(v.abs) + 1
+                     end
+        ary = []
+        size.times { ary << (comp_value & 0xff); comp_value >>= 8 }
+        ary.reverse.pack('C*')
+      end
+
+      def der_to_value(der, ber: false)
+        ary = der.unpack('C*')
+        @value = ary.reduce(0) { |len, b| (len << 8) | b }
+        if ary[0] & 0x80 == 0x80
+          @value = -((~@value & ((1 << @value.bit_length) - 1)) + 1)
+        end
+      end
+    end
+  end
+end

data/lib/rasn1/types/null.rb

@@ -0,0 +1,19 @@
+module RASN1
+  module Types
+
+    # ASN.1 Null
+    # @author Sylvain Daubert
+    class Null < Primitive
+      TAG = 0x05
+
+      def value_to_der
+        ''
+      end
+
+      def der_to_value(der, ber: false)
+        raise ASN1Error, "NULL TAG should not have content!" if der.length > 0
+        @value = nil
+      end
+    end
+  end
+end

data/lib/rasn1/types/object_id.rb

@@ -0,0 +1,79 @@
+module RASN1
+  module Types
+
+    # ASN.1 Object ID
+    # @author Sylvain Daubert
+    class ObjectId < Primitive
+      TAG = 6
+
+      private
+
+      def value_to_der
+        ids = @value.split('.').map! { |str| str.to_i }
+
+        if ids[0] > 2
+          raise ASN1Error, 'OBJECT ID #@name: first subidentifier should be less than 3'
+        end
+        if ids[0] < 2 and ids[1] > 39
+          raise ASN1Error, 'OBJECT ID #@name: second subidentifier should be less than 40'
+        end
+
+        ids[0, 2] = ids[0] * 40 + ids[1]
+        ids.map! do |v|
+          next v if v < 128
+
+          ary = []
+          while v > 0
+            ary.unshift (v & 0x7f) | 0x80
+            v >>= 7
+          end
+          ary[-1] &= 0x7f
+          ary
+        end
+        ids.flatten.pack('C*')
+      end
+
+      def der_to_value(der, ber: false)
+        bytes = der.unpack('C*')
+        ids = if bytes[0] < 80
+                remove = 1
+                [ bytes[0] / 40, bytes[0] % 40]
+              elsif bytes[0] < 128
+                remove = 1
+                [2, bytes[0] - 80]
+              else
+                remove = 1
+                second_id = bytes[0] & 0x7f
+                bytes[1..-1].each do |byte|
+                  remove += 1
+                  second_id <<= 7
+                  if byte < 128
+                    second_id |= byte
+                    break
+                  else
+                    second_id |= byte & 0x7f
+                  end
+                end
+                [2, second_id - 80]
+              end
+
+        id = 0
+        bytes.shift(remove)
+        bytes.each do |byte|
+          if byte < 128
+            if id == 0
+              ids << byte
+            else
+              ids << ((id << 7) | byte)
+              id = 0
+            end
+          else
+            id = (id << 7) | (byte & 0x7f)
+          end
+        end
+
+        @value = ids.join('.')
+      end
+    end
+  end
+end