aws-sdk-core 3.165.0 → 3.201.0

data/lib/aws-sdk-core/cbor/cbor_engine.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'encoder'
+require_relative 'decoder'
+
+module Aws
+  module Cbor
+    # Pure Ruby implementation of CBOR encode and decode
+    module CborEngine
+      def self.encode(data)
+        Encoder.new.add(data).bytes
+      end
+
+      def self.decode(bytes)
+        Decoder.new(bytes.force_encoding(Encoding::BINARY)).decode
+      end
+    end
+  end
+end

data/lib/aws-sdk-core/cbor/decoder.rb

@@ -0,0 +1,310 @@
+# frozen_string_literal: true
+
+module Aws
+  module Cbor
+    # Pure Ruby implementation of CBOR Decoder
+    class Decoder
+      def initialize(bytes)
+        @buffer = bytes
+        @pos = 0
+      end
+
+      def decode
+        return nil if @buffer.nil? || @buffer.empty?
+
+        val = decode_item
+        return val unless @pos != @buffer.size
+
+        raise ExtraBytesError.new(@pos, @buffer.size)
+      end
+
+      private
+
+      FIVE_BIT_MASK = 0x1F
+      TAG_TYPE_EPOCH = 1
+      TAG_TYPE_BIGNUM = 2
+      TAG_TYPE_NEG_BIGNUM = 3
+      TAG_TYPE_BIGDEC = 4
+
+      # high level, generic decode. Based on the next type. Consumes and returns
+      # the next item as a ruby object.
+      def decode_item
+        case (next_type = peek_type)
+        when :array
+          read_array.times.map { decode_item }
+        when :map
+          read_map.times.map { [read_string, decode_item] }.to_h
+        when :indefinite_array
+          read_start_indefinite_array
+          value = []
+          value << decode_item until peek_type == :break_stop_code
+          read_end_indefinite_collection
+          value
+        when :indefinite_map
+          read_start_indefinite_map
+          value = {}
+          value[read_string] = decode_item until peek_type == :break_stop_code
+          read_end_indefinite_collection
+          value
+        when :indefinite_binary_string
+          read_info
+          value = String.new
+          value << read_binary_string until peek_type == :break_stop_code
+          read_end_indefinite_collection
+          value
+        when :indefinite_string
+          read_info
+          value = String.new
+          value << read_string until peek_type == :break_stop_code
+          read_end_indefinite_collection
+          value.force_encoding(Encoding::UTF_8)
+        when :tag
+          case (tag = read_tag)
+          when TAG_TYPE_EPOCH
+            type = peek_type
+            item = decode_item
+            item /= 1000.0 if type == :integer
+            Time.at(item)
+          when TAG_TYPE_BIGNUM, TAG_TYPE_NEG_BIGNUM
+            read_bignum(tag)
+          when TAG_TYPE_BIGDEC
+            read_big_decimal
+          else
+            Tagged.new(tag, decode_item)
+          end
+        when :break_stop_code
+          raise UnexpectedBreakCodeError
+        else
+          send("read_#{next_type}")
+        end
+      end
+
+      # low level streaming interface
+      def peek_type
+        ib = peek(1).ord
+        add_info = ib & FIVE_BIT_MASK
+        major_type = ib >> 5
+        case major_type
+        when 0, 1 then :integer
+        when 2
+          add_info == 31 ? :indefinite_binary_string : :binary_string
+        when 3
+          add_info == 31 ? :indefinite_string : :string
+        when 4
+          add_info == 31 ? :indefinite_array : :array
+        when 5
+          add_info == 31 ? :indefinite_map : :map
+        when 6 then :tag
+        when 7 # simple or float
+          case add_info
+          when 20, 21 then :boolean
+          when 22 then :nil
+          when 23 then :undefined # for smithy, this should be parsed as nil
+          when 25 then :half
+          when 26 then :float
+          when 27 then :double
+          when 31 then :break_stop_code
+          else
+            :reserved_undefined
+          end
+        end
+      end
+
+      def read_break_stop_code
+        read_info
+        :break_stop_code
+      end
+
+      def read_integer
+        major_type, add_info = read_info
+
+        val = read_count(add_info)
+        case major_type
+        when 0 then val
+        when 1 then -1 - val
+        else
+          raise Error,
+                "Expected Integer (0,1) got major type: #{major_type}"
+        end
+      end
+
+      def read_binary_string
+        _major_type, add_info = read_info
+        take(read_count(add_info)).force_encoding(Encoding::BINARY)
+      end
+
+      def read_string
+        _major_type, add_info = read_info
+        take(read_count(add_info)).force_encoding(Encoding::UTF_8)
+      end
+
+      # returns only the length of the array, caller must read the correct number of values after this
+      def read_array
+        _major_type, add_info = read_info
+        read_count(add_info)
+      end
+
+      # returns nothing but consumes and checks the type/info.
+      # Caller must keep reading until encountering the stop sequence
+      def read_start_indefinite_array
+        read_info
+      end
+
+      # returns nothing but consumes and checks the type/info.
+      # Caller must keep reading until encountering the stop sequence
+      def read_start_indefinite_map
+        read_info
+      end
+
+      # returns nothing but consumes and checks the type/info.
+      def read_end_indefinite_collection
+        read_info
+      end
+
+      # returns only the length of the array, caller must read the correct number of key value pairs after this
+      def read_map
+        _major_type, add_info = read_info
+        read_count(add_info)
+      end
+
+      # returns only the tag, caller must interpret the tag and read another value as appropriate
+      def read_tag
+        _major_type, add_info = read_info
+        read_count(add_info)
+      end
+
+      def read_reserved_undefined
+        _major_type, add_info = read_info
+        raise Error,
+          "Undefined reserved additional information: #{add_info}"
+      end
+
+      def read_boolean
+        _major_type, add_info = read_info
+        case add_info
+        when 20 then false
+        when 21 then true
+        else
+          raise Error,
+                'Invalid Boolean simple type, expected add_info of 20 or 21, ' \
+                 "got: #{add_info}"
+        end
+      end
+
+      def read_nil
+        read_info
+        nil
+      end
+
+      def read_undefined
+        read_info
+        :undefined
+      end
+
+      # 16 bit IEEE 754 half-precision floats
+      # Support decoding only
+      # format:
+      # sign - 1 bit
+      # exponent - 5 bits
+      # precision - 10 bits
+      def read_half
+        read_info
+        b16 = take(2).unpack1('n')
+        exp = (b16 >> 10) & 0x1f
+        mant = b16 & 0x3ff
+        val =
+          case exp
+          when 0
+            Math.ldexp(mant, -24)
+          when 31
+            mant.zero? ? Float::INFINITY : Float::NAN
+          else
+            # exp bias is 15, but to use ldexp we divide by 1024 (2^10) to get
+            # exp-15-10
+            Math.ldexp(1024 + mant, exp - 25)
+          end
+        if (b16[15]).zero?
+          val
+        else
+          -val
+        end
+      end
+
+      def read_float
+        read_info
+        take(4).unpack1('g')
+      end
+
+      def read_double
+        read_info
+        take(8).unpack1('G')
+      end
+
+      # tag type 2 or 3
+      def read_bignum(tag_value)
+        _major_type, add_info = read_info
+        bstr = take(read_count(add_info))
+        v = bstr.bytes.inject(0) do |sum, b|
+          sum <<= 8
+          sum + b
+        end
+        case tag_value
+        when 2 then v
+        when 3 then -1 - v
+        else
+          raise Error,
+                'Invalid Tag value for BigNum, ' \
+                "expected 2 or 3, got: #{tag_value}"
+        end
+      end
+
+      # A decimal fraction or a bigfloat is represented as a tagged array
+      # that contains exactly two integer numbers:
+      # an exponent e and a mantissa m
+      # See: https://www.rfc-editor.org/rfc/rfc8949.html#name-decimal-fractions-and-bigfl
+      def read_big_decimal
+        unless (s = read_array) == 2
+          raise Error, "Expected array of length 2 but length is: #{s}"
+        end
+
+        e = read_integer
+        m = read_integer
+        BigDecimal(m) * (BigDecimal(10)**BigDecimal(e))
+      end
+
+      # return a tuple of major_type, add_info
+      def read_info
+        ib = take(1).ord
+        [ib >> 5, ib & FIVE_BIT_MASK]
+      end
+
+      def read_count(add_info)
+        case add_info
+        when 0..23 then add_info
+        when 24 then take(1).ord
+        when 25 then take(2).unpack1('n')
+        when 26 then take(4).unpack1('N')
+        when 27 then take(8).unpack1('Q>')
+        when 28 then take(16).unpack1('Q>')
+        when 29 then take(32).unpack1('Q>')
+        else raise UnexpectedAdditionalInformationError, add_info
+        end
+      end
+
+      def take(n_bytes)
+        opos = @pos
+        @pos += n_bytes
+
+        return @buffer[opos, n_bytes] if @pos <= @buffer.bytesize
+
+        raise OutOfBytesError.new(n_bytes, @buffer.bytesize - @pos)
+      end
+
+      def peek(n_bytes)
+        return @buffer[@pos, n_bytes] if (@pos + n_bytes) <= @buffer.bytesize
+
+        raise OutOfBytesError.new(n_bytes, @buffer.bytesize - @pos)
+      end
+    end
+  end
+end

data/lib/aws-sdk-core/cbor/encoder.rb

@@ -0,0 +1,243 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+
+module Aws
+  module Cbor
+    # Pure ruby implementation of CBOR encoder.
+    class Encoder
+      def initialize
+        @buffer = String.new
+      end
+
+      # @return the encoded bytes in CBOR format for all added data
+      def bytes
+        @buffer
+      end
+
+      # generic method for adding generic Ruby data based on its type
+      def add(value)
+        case value
+        when BigDecimal then add_big_decimal(value)
+        when Integer then add_auto_integer(value)
+        when Numeric then add_auto_float(value)
+        when Symbol then add_string(value.to_s)
+        when true, false then add_boolean(value)
+        when nil then add_nil
+        when Tagged
+          add_tag(value.tag)
+          add(value.value)
+        when String
+          if value.encoding == Encoding::BINARY
+            add_byte_string(value)
+          else
+            add_string(value)
+          end
+        when Array
+          start_array(value.size)
+          value.each { |di| add(di) }
+        when Hash
+          start_map(value.size)
+          value.each do |k, v|
+            add(k)
+            add(v)
+          end
+        when Time
+          add_time(value)
+        else
+          raise UnknownTypeError, value
+        end
+        self
+      end
+
+      private
+
+      MAJOR_TYPE_UNSIGNED_INT = 0x00 # 000_00000 - Major Type 0 - unsigned int
+      MAJOR_TYPE_NEGATIVE_INT = 0x20 # 001_00000 - Major Type 1 - negative int
+      MAJOR_TYPE_BYTE_STR = 0x40 # 010_00000 - Major Type 2 (Byte String)
+      MAJOR_TYPE_STR = 0x60 # 011_00000 - Major Type 3 (Text String)
+      MAJOR_TYPE_ARRAY = 0x80 # 100_00000 - Major Type 4 (Array)
+      MAJOR_TYPE_MAP = 0xa0 # 101_00000 - Major Type 5 (Map)
+      MAJOR_TYPE_TAG = 0xc0 # 110_00000 - Major type 6 (Tag)
+      MAJOR_TYPE_SIMPLE = 0xe0 # 111_00000 - Major type 7 (111) + 5 bit 0
+
+      FLOAT_BYTES = 0xfa # 111_11010 - Major type 7 (Float) + value: 26
+      DOUBLE_BYTES = 0xfb # 111_ 11011 - Major type 7 (Float) + value: 26
+
+      # https://www.rfc-editor.org/rfc/rfc8949.html#tags
+      TAG_TYPE_EPOCH = 1
+      TAG_BIGNUM_BASE = 2
+      TAG_TYPE_BIGDEC = 4
+
+      MAX_INTEGER = 18_446_744_073_709_551_616 # 2^64
+
+      def head(major_type, value)
+        @buffer <<
+          case value
+          when 0...24
+            [major_type + value].pack('C') # 8-bit unsigned
+          when 0...256
+            [major_type + 24, value].pack('CC')
+          when 0...65_536
+            [major_type + 25, value].pack('Cn')
+          when 0...4_294_967_296
+            [major_type + 26, value].pack('CN')
+          when 0...MAX_INTEGER
+            [major_type + 27, value].pack('CQ>')
+          else
+            raise Error, "Value is too large to encode: #{value}"
+          end
+      end
+
+      # streaming style, lower level interface
+      def add_integer(value)
+        major_type =
+          if value.negative?
+            value = -1 - value
+            MAJOR_TYPE_NEGATIVE_INT
+          else
+            MAJOR_TYPE_UNSIGNED_INT
+          end
+        head(major_type, value)
+      end
+
+      def add_bignum(value)
+        major_type =
+          if value.negative?
+            value = -1 - value
+            MAJOR_TYPE_NEGATIVE_INT
+          else
+            MAJOR_TYPE_UNSIGNED_INT
+          end
+        s = bignum_to_bytes(value)
+        head(MAJOR_TYPE_TAG, TAG_BIGNUM_BASE + (major_type >> 5))
+        head(MAJOR_TYPE_BYTE_STR, s.bytesize)
+        @buffer << s
+      end
+
+      # A decimal fraction or a bigfloat is represented as a tagged array
+      # that contains exactly two integer numbers:
+      # an exponent e and a mantissa m
+      # decimal fractions are always represented with a base of 10
+      # See: https://www.rfc-editor.org/rfc/rfc8949.html#name-decimal-fractions-and-bigfl
+      def add_big_decimal(value)
+        if value.infinite? == 1
+          return add_float(value.infinite? * Float::INFINITY)
+        elsif value.nan?
+          return add_float(Float::NAN)
+        end
+
+        head(MAJOR_TYPE_TAG, TAG_TYPE_BIGDEC)
+        sign, digits, base, exp = value.split
+        # Ruby BigDecimal digits of XXX are used as 0.XXX, convert
+        exp = exp - digits.size
+        digits = sign * digits.to_i
+        start_array(2)
+        add_auto_integer(exp)
+        add_auto_integer(digits)
+      end
+
+      def add_auto_integer(value)
+        major_type =
+          if value.negative?
+            value = -1 - value
+            MAJOR_TYPE_NEGATIVE_INT
+          else
+            MAJOR_TYPE_UNSIGNED_INT
+          end
+
+        if value >= MAX_INTEGER
+          s = bignum_to_bytes(value)
+          head(MAJOR_TYPE_TAG, TAG_BIGNUM_BASE + (major_type >> 5))
+          head(MAJOR_TYPE_BYTE_STR, s.bytesize)
+          @buffer << s
+        else
+          head(major_type, value)
+        end
+      end
+
+      def add_float(value)
+        @buffer << [FLOAT_BYTES, value].pack('Cg') # single-precision
+      end
+
+      def add_double(value)
+        @buffer << [DOUBLE_BYTES, value].pack('CG') # double-precision
+      end
+
+      def add_auto_float(value)
+        if value.nan?
+          @buffer << FLOAT_BYTES << [value].pack('g')
+        else
+          ss = [value].pack('g') # single-precision
+          if ss.unpack1('g') == value
+            @buffer << FLOAT_BYTES << ss
+          else
+            @buffer << [DOUBLE_BYTES, value].pack('CG') # double-precision
+          end
+        end
+      end
+
+      def add_nil
+        head(MAJOR_TYPE_SIMPLE, 22)
+      end
+
+      def add_boolean(value)
+        value ? head(MAJOR_TYPE_SIMPLE, 21) : head(MAJOR_TYPE_SIMPLE, 20)
+      end
+
+      # Encoding MUST already be Encoding::BINARY
+      def add_byte_string(value)
+        head(MAJOR_TYPE_BYTE_STR, value.bytesize)
+        @buffer << value
+      end
+
+      def add_string(value)
+        value = value.encode(Encoding::UTF_8).force_encoding(Encoding::BINARY)
+        head(MAJOR_TYPE_STR, value.bytesize)
+        @buffer << value
+      end
+
+      # caller is responsible for adding length values
+      def start_array(length)
+        head(MAJOR_TYPE_ARRAY, length)
+      end
+
+      def start_indefinite_array
+        head(MAJOR_TYPE_ARRAY + 31, 0)
+      end
+
+      # caller is responsible for adding length key/value pairs
+      def start_map(length)
+        head(MAJOR_TYPE_MAP, length)
+      end
+
+      def start_indefinite_map
+        head(MAJOR_TYPE_MAP + 31, 0)
+      end
+
+      def end_indefinite_collection
+        # write the stop sequence
+        head(MAJOR_TYPE_SIMPLE + 31, 0)
+      end
+
+      def add_tag(tag)
+        head(MAJOR_TYPE_TAG, tag)
+      end
+
+      def add_time(value)
+        head(MAJOR_TYPE_TAG, TAG_TYPE_EPOCH)
+        epoch_ms = (value.to_f * 1000).to_i
+        add_integer(epoch_ms)
+      end
+
+      def bignum_to_bytes(value)
+        s = String.new
+        while value != 0
+          s << (value & 0xFF)
+          value >>= 8
+        end
+        s.reverse!
+      end
+    end
+  end
+end

data/lib/aws-sdk-core/cbor.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Aws
+  # @api private
+  module Cbor
+
+    # CBOR Tagged data (Major type 6).
+    # A Tag consists of a tag number and a value.
+    # In the extended generic data model, a tag number's definition
+    # describes the additional semantics conveyed with the tag number.
+    # # @!method initialize(*args)
+    #   @option args [Integer] :tag The tag number.
+    #   @option args [Object] :value The tag's content.
+    # @!attribute tag
+    #   The tag number.
+    #   @return [Integer]
+    # @!attribute value
+    #   The tag's content.
+    #   @return [Object]
+    Tagged = Struct.new(:tag, :value)
+
+    class Error < StandardError; end
+
+    class OutOfBytesError < Error
+      def initialize(n, left)
+        super("Out of bytes. Trying to read #{n} bytes but buffer contains only #{left}")
+      end
+    end
+
+    class UnknownTypeError < Error
+      def initialize(type)
+        super("Unable to encode #{type}")
+      end
+    end
+
+    class ExtraBytesError < Error
+      def initialize(pos, size)
+        super("Extra bytes follow after decoding item. Read #{pos} / #{size} bytes")
+      end
+    end
+
+    class UnexpectedBreakCodeError < Error; end
+
+    class UnexpectedAdditionalInformationError < Error
+      def initialize(add_info)
+        super("Unexpected additional information: #{add_info}")
+      end
+    end
+
+    class << self
+      # @param [Symbol,Class] engine
+      #   Must be one of the following values:
+      #
+      #   * :cbor
+      #
+      def engine=(engine)
+        @engine = Class === engine ? engine : load_engine(engine)
+      end
+
+      # @return [Class] Returns the default engine.
+      #   One of:
+      #
+      #   * {CborEngine}
+      #
+      def engine
+        set_default_engine unless @engine
+        @engine
+      end
+
+      def encode(data)
+        @engine.encode(data)
+      end
+
+      def decode(bytes)
+        bytes.force_encoding(Encoding::BINARY)
+        @engine.decode(bytes)
+      end
+
+      def set_default_engine
+        [:cbor].each do |name|
+          @engine ||= try_load_engine(name)
+        end
+
+        unless @engine
+          raise 'Unable to find a compatible cbor library.'
+        end
+      end
+
+      private
+
+      def load_engine(name)
+        require "aws-sdk-core/cbor/#{name}_engine"
+        const_name = name[0].upcase + name[1..-1] + 'Engine'
+        const_get(const_name)
+      end
+
+      def try_load_engine(name)
+        load_engine(name)
+      rescue LoadError
+        false
+      end
+    end
+
+    set_default_engine
+  end
+end