eth-custom 0.5.7

data/lib/eth/key/encrypter.rb

@@ -0,0 +1,207 @@
+# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Provides the {Eth} module.
+module Eth
+
+  # The {Eth::Key::Encrypter} class to handle PBKDF2-SHA-256 encryption.
+  class Key::Encrypter
+
+    # Provides a specific encrypter error if decryption fails.
+    class EncrypterError < StandardError; end
+
+    # Class method {Eth::Key::Encrypter.perform} to performa an key-store
+    # encryption.
+    #
+    # @param key [Eth::Key] representing a secret key-pair used for encryption.
+    # @param options [Hash] the options to encrypt with.
+    # @option options [String] :kdf key derivation function defaults to pbkdf2.
+    # @option options [String] :id uuid given to the secret key.
+    # @option options [String] :iterations number of iterations for the hash function.
+    # @option options [String] :salt passed to PBKDF.
+    # @option options [String] :iv 128-bit initialisation vector for the cipher.
+    # @option options [Integer] :parallelization parallelization factor for scrypt, defaults to 8.
+    # @option options [Integer] :block_size for scrypt, defaults to 1.
+    # @return [JSON] formatted with encrypted key (cyphertext) and [other identifying data](https://github.com/ethereum/wiki/wiki/Web3-Secret-Storage-Definition#pbkdf2-sha-256).
+    def self.perform(key, password, options = {})
+      new(key, options).perform(password)
+    end
+
+    # Constructor of the {Eth::Key::Encrypter} class for secret key
+    # encryption. Should not be used; use {Eth::Key::Encrypter.perform}
+    # instead.
+    #
+    # @param key [Eth::Key] representing a secret key-pair used for encryption.
+    # @param options [Hash] the options to encrypt with.
+    # @option options [String] :kdf key derivation function defaults to pbkdf2.
+    # @option options [String] :id uuid given to the secret key.
+    # @option options [String] :iterations number of iterations for the hash function.
+    # @option options [String] :salt passed to PBKDF.
+    # @option options [String] :iv 128-bit initialisation vector for the cipher.
+    # @option options [Integer] :parallelization parallelization factor for scrypt, defaults to 8.
+    # @option options [Integer] :block_size for scrypt, defaults to 1.
+    def initialize(key, options = {})
+      key = Key.new(priv: key) if key.is_a? String
+      @key = key
+      @options = options
+
+      # the key derivation functions default to pbkdf2 if no option is specified
+      # however, if an option is given then it must be either pbkdf2 or scrypt
+      if kdf != "scrypt" && kdf != "pbkdf2"
+        raise EncrypterError, "Unsupported key derivation function: #{kdf}!"
+      end
+    end
+
+    # Encrypt the key with a given password.
+    #
+    # @param password [String] a secret key used for encryption
+    # @return [String] a JSON-formatted keystore string.
+    def perform(password)
+      derive_key password
+      encrypt
+      data.to_json
+    end
+
+    # Output containing the encrypted key and
+    # [other identifying data](https://github.com/ethereum/wiki/wiki/Web3-Secret-Storage-Definition#pbkdf2-sha-256)
+    #
+    # @return [Hash] the encrypted keystore data.
+    def data
+      # default to pbkdf2
+      kdfparams = if kdf == "scrypt"
+          {
+            dklen: 32,
+            n: iterations,
+            p: parallelization,
+            r: block_size,
+            salt: Util.bin_to_hex(salt),
+          }
+        else
+          {
+            c: iterations,
+            dklen: 32,
+            prf: prf,
+            salt: Util.bin_to_hex(salt),
+          }
+        end
+
+      {
+        crypto: {
+          cipher: cipher_name,
+          cipherparams: {
+            iv: Util.bin_to_hex(iv),
+          },
+          ciphertext: Util.bin_to_hex(encrypted_key),
+          kdf: kdf,
+          kdfparams: kdfparams,
+          mac: Util.bin_to_hex(mac),
+        },
+        id: id,
+        version: 3,
+      }
+    end
+
+    private
+
+    attr_reader :derived_key, :encrypted_key, :key, :options
+
+    def cipher
+      @cipher ||= OpenSSL::Cipher.new(cipher_name).tap do |cipher|
+        cipher.encrypt
+        cipher.iv = iv
+        cipher.key = derived_key[0, (key_length / 2)]
+      end
+    end
+
+    def digest
+      @digest ||= OpenSSL::Digest.new digest_name
+    end
+
+    def derive_key(password)
+      if kdf == "scrypt"
+        @derived_key = SCrypt::Engine.scrypt(password, salt, iterations, block_size, parallelization, key_length)
+      else
+        @derived_key = OpenSSL::PKCS5.pbkdf2_hmac(password, salt, iterations, key_length, digest)
+      end
+    end
+
+    def encrypt
+      @encrypted_key = cipher.update(Util.hex_to_bin key.private_hex) + cipher.final
+    end
+
+    def mac
+      Util.keccak256(derived_key[(key_length / 2), key_length] + encrypted_key)
+    end
+
+    def kdf
+      options[:kdf] || "pbkdf2"
+    end
+
+    def cipher_name
+      "aes-128-ctr"
+    end
+
+    def digest_name
+      "sha256"
+    end
+
+    def prf
+      "hmac-#{digest_name}"
+    end
+
+    def key_length
+      32
+    end
+
+    def salt_length
+      32
+    end
+
+    def iv_length
+      16
+    end
+
+    def id
+      @id ||= options[:id] || SecureRandom.uuid
+    end
+
+    def iterations
+      options[:iterations] || 262_144
+    end
+
+    def salt
+      @salt ||= if options[:salt]
+          Util.hex_to_bin options[:salt]
+        else
+          SecureRandom.random_bytes(salt_length)
+        end
+    end
+
+    def iv
+      @iv ||= if options[:iv]
+          Util.hex_to_bin options[:iv]
+        else
+          SecureRandom.random_bytes(iv_length)
+        end
+    end
+
+    def parallelization
+      options[:parallelization] || 8
+    end
+
+    def block_size
+      options[:block_size] || 1
+    end
+  end
+end

data/lib/eth/key.rb

@@ -0,0 +1,167 @@
+# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "json"
+require "openssl"
+require "rbsecp256k1"
+require "scrypt"
+require "securerandom"
+
+# Provides the {Eth} module.
+module Eth
+
+  # The {Eth::Key} class to handle Secp256k1 private/public key-pairs.
+  class Key
+
+    # The {Eth::Key::Decrypter} class to handle PBKDF2-SHA-256 decryption.
+    autoload :Decrypter, "eth/key/decrypter"
+
+    # The {Eth::Key::Encrypter} class to handle PBKDF2-SHA-256 encryption.
+    autoload :Encrypter, "eth/key/encrypter"
+
+    # The `Secp256k1::PrivateKey` of the {Eth::Key} pair.
+    attr_reader :private_key
+
+    # The `Secp256k1::PublicKey` of the {Eth::Key} pair.
+    attr_reader :public_key
+
+    # Constructor of the {Eth::Key} class. Creates a new random key-pair
+    # if no `priv` key is provided.
+    #
+    # @param priv [String] binary string of private key data.
+    def initialize(priv: nil)
+
+      # Creates a new, randomized libsecp256k1 context.
+      ctx = Secp256k1::Context.new context_randomization_bytes: SecureRandom.random_bytes(32)
+
+      # Creates a new random key pair (public, private).
+      key = ctx.generate_key_pair
+
+      unless priv.nil?
+
+        # Converts hex private keys to binary strings.
+        priv = Util.hex_to_bin priv if Util.is_hex? priv
+
+        # Creates a keypair from existing private key data.
+        key = ctx.key_pair_from_private_key priv
+      end
+
+      # Sets the attributes.
+      @private_key = key.private_key
+      @public_key = key.public_key
+    end
+
+    # Signs arbitrary data without validation. Should not be used unless really
+    # desired. See also: {Key.personal_sign}, {Key.sign_typed_data}, and
+    # {Signature.recover}.
+    #
+    # @param blob [Object] that arbitrary data to be signed.
+    # @param chain_id [Integer] the chain id the signature should be generated on.
+    # @return [String] a hexa-decimal signature.
+    def sign(blob, chain_id = nil)
+      context = Secp256k1::Context.new
+      compact, recovery_id = context.sign_recoverable(@private_key, blob).compact
+      signature = compact.bytes
+      v = Chain.to_v recovery_id, chain_id
+      is_leading_zero = true
+      [v].pack("N").unpack("C*").each do |byte|
+        is_leading_zero = false if byte > 0 and is_leading_zero
+        signature.append byte unless is_leading_zero and byte === 0
+      end
+      Util.bin_to_hex signature.pack "c*"
+    end
+
+    # Prefixes a message with `\x19Ethereum Signed Message:` and signs
+    # it in the common way used by many web3 wallets. Complies with
+    # EIP-191 prefix `0x19` and version byte `0x45` (`E`). See also
+    # {Signature.personal_recover}.
+    # Ref: https://eips.ethereum.org/EIPS/eip-191
+    #
+    # @param message [String] the message string to be prefixed and signed.
+    # @param chain_id [Integer] the chain id the signature should be generated on.
+    # @return [String] an EIP-191 conform, hexa-decimal signature.
+    def personal_sign(message, chain_id = nil)
+      prefixed_message = Signature.prefix_message message
+      hashed_message = Util.keccak256 prefixed_message
+      sign hashed_message, chain_id
+    end
+
+    # Prefixes, hashes, and signes a typed data structure in the common
+    # way used by many web3 wallets. Complies with EIP-191 prefix `0x19`
+    # and EIP-712 version byte `0x01`. Supports `V3`, `V4`. See also
+    # {Signature.recover_typed_data}.
+    # Ref: https://eips.ethereum.org/EIPS/eip-712
+    #
+    # @param typed_data [Array] all the data in the typed data structure to be signed.
+    # @param chain_id [Integer] the chain id the signature should be generated on.
+    # @return [String] an EIP-712 conform, hexa-decimal signature.
+    def sign_typed_data(typed_data, chain_id = nil)
+      hash_to_sign = Eip712.hash typed_data
+      sign hash_to_sign, chain_id
+    end
+
+    # Converts the private key data into a hexa-decimal string.
+    #
+    # @return [String] private key as hexa-decimal string.
+    def private_hex
+      Util.bin_to_hex @private_key.data
+    end
+
+    # Exports the private key bytes in a wrapper function to maintain
+    # backward-compatibility with older versions of {Eth::Key}.
+    #
+    # @return [String] private key as packed byte-string.
+    def private_bytes
+      @private_key.data
+    end
+
+    # Converts the public key data into an uncompressed
+    # hexa-decimal string.
+    #
+    # @return [String] public key as uncompressed hexa-decimal string.
+    def public_hex
+      Util.bin_to_hex @public_key.uncompressed
+    end
+
+    # Converts the public key data into an compressed
+    # hexa-decimal string.
+    #
+    # @return [String] public key as compressed hexa-decimal string.
+    def public_hex_compressed
+      Util.bin_to_hex @public_key.compressed
+    end
+
+    # Exports the uncompressed public key bytes in a wrapper function to
+    # maintain backward-compatibility with older versions of {Eth::Key}.
+    #
+    # @return [String] uncompressed public key as packed byte-string.
+    def public_bytes
+      @public_key.uncompressed
+    end
+
+    # Exports the compressed public key bytes.
+    #
+    # @return [String] compressed public key as packed byte-string.
+    def public_bytes_compressed
+      @public_key.compressed
+    end
+
+    # Exports the checksummed public address.
+    #
+    # @return [Eth::Address] compressed address as packed hex prefixed string.
+    def address
+      Util.public_key_to_address public_bytes
+    end
+  end
+end

data/lib/eth/rlp/decoder.rb

@@ -0,0 +1,114 @@
+# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# -*- encoding : ascii-8bit -*-
+
+# Provides the {Eth} module.
+module Eth
+
+  # Provides an recursive-length prefix (RLP) encoder and decoder.
+  module Rlp
+
+    # Provides an RLP-decoder.
+    module Decoder
+      extend self
+
+      # Decodes an RLP-encoded object.
+      #
+      # @param rlp [String] an RLP-encoded object.
+      # @return [Object] the decoded and maybe deserialized object.
+      # @raise [Eth::Rlp::DecodingError] if the input string does not end after
+      #     the root item.
+      def perform(rlp)
+        rlp = Util.hex_to_bin rlp if Util.is_hex? rlp
+        rlp = Util.str_to_bytes rlp
+        begin
+          item, next_start = consume_item rlp, 0
+        rescue Exception => e
+          raise DecodingError, "Cannot decode rlp string: #{e}"
+        end
+        raise DecodingError, "RLP string ends with #{rlp.size - next_start} superfluous bytes" if next_start != rlp.size
+        return item
+      end
+
+      private
+
+      # Consume an RLP-encoded item from the given start.
+      def consume_item(rlp, start)
+        t, l, s = consume_length_prefix rlp, start
+        consume_payload rlp, s, t, l
+      end
+
+      # Consume an RLP length prefix at the given position.
+      def consume_length_prefix(rlp, start)
+        b0 = rlp[start].ord
+        if b0 < Constant::PRIMITIVE_PREFIX_OFFSET
+
+          # single byte
+          [:str, 1, start]
+        elsif b0 < Constant::PRIMITIVE_PREFIX_OFFSET + Constant::SHORT_LENGTH_LIMIT
+          raise DecodingError, "Encoded as short string although single byte was possible" if (b0 - Constant::PRIMITIVE_PREFIX_OFFSET == 1) && rlp[start + 1].ord < Constant::PRIMITIVE_PREFIX_OFFSET
+
+          # short string
+          [:str, b0 - Constant::PRIMITIVE_PREFIX_OFFSET, start + 1]
+        elsif b0 < Constant::LIST_PREFIX_OFFSET
+          enforce_no_zero_bytes rlp, start
+
+          # long string
+          ll = b0 - Constant::PRIMITIVE_PREFIX_OFFSET - Constant::SHORT_LENGTH_LIMIT + 1
+          l = Util.big_endian_to_int rlp[(start + 1)...(start + 1 + ll)]
+          raise DecodingError, "Long string prefix used for short string" if l < Constant::SHORT_LENGTH_LIMIT
+          [:str, l, start + 1 + ll]
+        elsif b0 < Constant::LIST_PREFIX_OFFSET + Constant::SHORT_LENGTH_LIMIT
+
+          # short list
+          [:list, b0 - Constant::LIST_PREFIX_OFFSET, start + 1]
+        else
+          enforce_no_zero_bytes rlp, start
+
+          # long list
+          ll = b0 - Constant::LIST_PREFIX_OFFSET - Constant::SHORT_LENGTH_LIMIT + 1
+          l = Util.big_endian_to_int rlp[(start + 1)...(start + 1 + ll)]
+          raise DecodingError, "Long list prefix used for short list" if l < Constant::SHORT_LENGTH_LIMIT
+          [:list, l, start + 1 + ll]
+        end
+      end
+
+      # Enforce RLP slices to not start with empty bytes.
+      def enforce_no_zero_bytes(rlp, start)
+        raise DecodingError, "Length starts with zero bytes" if rlp.slice(start + 1) == Constant::BYTE_ZERO
+      end
+
+      # Consume an RLP payload at the given position of given type and size.
+      def consume_payload(rlp, start, type, length)
+        case type
+        when :str
+          [rlp[start...(start + length)], start + length]
+        when :list
+          items = []
+          next_item_start = start
+          payload_end = next_item_start + length
+          while next_item_start < payload_end
+            item, next_item_start = consume_item rlp, next_item_start
+            items.push item
+          end
+          raise DecodingError, "List length prefix announced a too small length" if next_item_start > payload_end
+          [items, next_item_start]
+        else
+          raise TypeError, "Type must be either :str or :list"
+        end
+      end
+    end
+  end
+end

data/lib/eth/rlp/encoder.rb

@@ -0,0 +1,78 @@
+# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# -*- encoding : ascii-8bit -*-
+
+# Provides the {Eth} module.
+module Eth
+
+  # Provides an recursive-length prefix (RLP) encoder and decoder.
+  module Rlp
+
+    # Provides an RLP-encoder.
+    module Encoder
+      extend self
+
+      # Encodes a Ruby object in RLP format.
+      #
+      # @param obj [Object] a Ruby object.
+      # @return [String] the RLP encoded item.
+      # @raise [Eth::Rlp::EncodingError] in the rather unlikely case that the item
+      #     is too big to encode (will not happen).
+      # @raise [Eth::Rlp::SerializationError] if the serialization fails.
+      def perform(obj)
+        item = Sedes.infer(obj).serialize(obj)
+        result = encode_raw item
+      end
+
+      private
+
+      # Encodes the raw item.
+      def encode_raw(item)
+        return item if item.instance_of? Rlp::Data
+        return encode_primitive item if Util.is_primitive? item
+        return encode_list item if Util.is_list? item
+        raise EncodingError "Cannot encode object of type #{item.class.name}"
+      end
+
+      # Encodes a single primitive.
+      def encode_primitive(item)
+        return Util.str_to_bytes item if item.size == 1 && item.ord < Constant::PRIMITIVE_PREFIX_OFFSET
+        payload = Util.str_to_bytes item
+        prefix = length_prefix payload.size, Constant::PRIMITIVE_PREFIX_OFFSET
+        "#{prefix}#{payload}"
+      end
+
+      # Encodes a single list.
+      def encode_list(list)
+        payload = list.map { |item| encode_raw item }.join
+        prefix = length_prefix payload.size, Constant::LIST_PREFIX_OFFSET
+        "#{prefix}#{payload}"
+      end
+
+      # Determines a length prefix.
+      def length_prefix(length, offset)
+        if length < Constant::SHORT_LENGTH_LIMIT
+          (offset + length).chr
+        elsif length < Constant::LONG_LENGTH_LIMIT
+          length_string = Util.int_to_big_endian length
+          length_len = (offset + Constant::SHORT_LENGTH_LIMIT - 1 + length_string.size).chr
+          "#{length_len}#{length_string}"
+        else
+          raise EncodingError, "Length greater than 256**8: #{length}"
+        end
+      end
+    end
+  end
+end

data/lib/eth/rlp/sedes/big_endian_int.rb

@@ -0,0 +1,66 @@
+# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# -*- encoding : ascii-8bit -*-
+
+# Provides the {Eth} module.
+module Eth
+
+  # Provides an recursive-length prefix (RLP) encoder and decoder.
+  module Rlp
+
+    # Provides serializable and deserializable types (SeDes).
+    module Sedes
+
+      # A serializable, big-endian, unsigned integer type.
+      class BigEndianInt
+
+        # Create a serializable, big-endian, unsigned integer.
+        #
+        # @param size [Integer] the size of the big endian.
+        def initialize(size = nil)
+          @size = size
+        end
+
+        # Serialize a big-endian integer.
+        #
+        # @param obj [Integer] the integer to be serialized.
+        # @return [String] a serialized big-endian integer.
+        # @raise [SerializationError] if provided object is not an integer.
+        # @raise [SerializationError] if provided integer is negative.
+        # @raise [SerializationError] if provided integer is too big for @size.
+        def serialize(obj)
+          raise SerializationError, "Can only serialize integers" unless obj.is_a?(Integer)
+          raise SerializationError, "Cannot serialize negative integers" if obj < 0
+          raise SerializationError, "Integer too large (does not fit in #{@size} bytes)" if @size && obj >= 256 ** @size
+          s = obj == 0 ? Constant::BYTE_EMPTY : Util.int_to_big_endian(obj)
+          @size ? "#{Constant::BYTE_ZERO * [0, @size - s.size].max}#{s}" : s
+        end
+
+        # Deserializes an unsigned integer.
+        #
+        # @param serial [String] the serialized integer.
+        # @return [Integer] a number.
+        # @raise [DeserializationError] if provided serial is of wrong size.
+        # @raise [DeserializationError] if provided serial is not of minimal length.
+        def deserialize(serial)
+          raise DeserializationError, "Invalid serialization (wrong size)" if @size && serial.size != @size
+          raise DeserializationError, "Invalid serialization (not minimal length)" if !@size && serial.size > 0 && serial[0] == Constant::BYTE_ZERO
+          serial = serial || Constant::BYTE_ZERO
+          Util.big_endian_to_int(serial)
+        end
+      end
+    end
+  end
+end