bitcoinrb 0.3.0 → 0.6.0

data/lib/bitcoin/script/tx_checker.rb

@@ -4,28 +4,67 @@ module Bitcoin
     attr_reader :tx
     attr_reader :input_index
     attr_reader :amount
+    attr_reader :prevouts
+    attr_accessor :error_code
 
-    def initialize(tx: nil, amount: 0, input_index: nil)
+    def initialize(tx: nil, amount: 0, input_index: nil, prevouts: [])
       @tx = tx
-      @amount = amount
       @input_index = input_index
+      @prevouts = prevouts
+      @amount = input_index && prevouts[input_index] ? prevouts[input_index].value : amount
     end
 
-    # check signature
-    # @param [String] script_sig
-    # @param [String] pubkey
+    # check ecdsa signature
+    # @param [String] sig signature with hex format
+    # @param [String] pubkey with hex format.
     # @param [Bitcoin::Script] script_code
     # @param [Integer] sig_version
-    def check_sig(script_sig, pubkey, script_code, sig_version)
-      return false if script_sig.empty?
-      script_sig = script_sig.htb
-      hash_type = script_sig[-1].unpack('C').first
-      sig = script_sig[0..-2]
-      sighash = tx.sighash_for_input(input_index, script_code, hash_type: hash_type,
-                                     amount: amount, sig_version: sig_version)
+    # @return [Boolean] verification result
+    def check_sig(sig, pubkey, script_code, sig_version, allow_hybrid: false)
+      return false if sig.empty?
+      sig = sig.htb
+      hash_type = sig[-1].unpack1('C')
+      sig = sig[0..-2]
+      sighash = tx.sighash_for_input(input_index, script_code, opts: {amount: amount}, hash_type: hash_type, sig_version: sig_version)
       key_type = pubkey.start_with?('02') || pubkey.start_with?('03') ? Key::TYPES[:compressed] : Key::TYPES[:uncompressed]
-      key = Key.new(pubkey: pubkey, key_type: key_type)
-      key.verify(sig, sighash)
+      begin
+        key = Key.new(pubkey: pubkey, key_type: key_type, allow_hybrid: allow_hybrid)
+        key.verify(sig, sighash)
+      rescue Exception
+        false
+      end
+    end
+
+    # check schnorr signature.
+    # @param [String] sig schnorr signature with hex format.
+    # @param [String] pubkey a public key with hex fromat.
+    # @param [Symbol] sig_version whether :taproot or :tapscript
+    # @return [Boolean] verification result
+    def check_schnorr_sig(sig, pubkey, sig_version, opts = {})
+      return false unless [:taproot, :tapscript].include?(sig_version)
+      return false if prevouts.size < input_index
+
+      sig = sig.htb
+      return set_error(SCRIPT_ERR_SCHNORR_SIG_SIZE) unless [64, 65].include?(sig.bytesize)
+
+      hash_type = SIGHASH_TYPE[:default]
+      if sig.bytesize == 65
+        hash_type = sig[-1].unpack1('C')
+        sig = sig[0..-2]
+        return set_error(SCRIPT_ERR_SCHNORR_SIG_HASHTYPE) if hash_type == SIGHASH_TYPE[:default] # hash type can not specify 0x00.
+      end
+
+      return set_error(SCRIPT_ERR_SCHNORR_SIG_HASHTYPE) unless (hash_type <= 0x03 || (hash_type >= 0x81 && hash_type <= 0x83))
+
+      opts[:prevouts] = prevouts
+
+      begin
+        sighash = tx.sighash_for_input(input_index, opts: opts, hash_type: hash_type, sig_version: sig_version)
+        key = Key.new(pubkey: "02#{pubkey}", key_type: Key::TYPES[:compressed])
+        key.verify(sig, sighash, algo: :schnorr)
+      rescue ArgumentError
+        return set_error(SCRIPT_ERR_SCHNORR_SIG_HASHTYPE)
+      end
     end
 
     def check_locktime(locktime)
@@ -77,5 +116,16 @@ module Bitcoin
       sequence_masked <= tx_sequence_masked
     end
 
+    def has_error?
+      !@error_code.nil?
+    end
+
+    private
+
+    def set_error(code)
+      @error_code = code
+      false
+    end
+
   end
 end

data/lib/bitcoin/secp256k1.rb

@@ -6,6 +6,7 @@ module Bitcoin
 
     autoload :Ruby, 'bitcoin/secp256k1/ruby'
     autoload :Native, 'bitcoin/secp256k1/native'
+    autoload :RFC6979, 'bitcoin/secp256k1/rfc6979'
 
   end
 

data/lib/bitcoin/secp256k1/native.rb

@@ -50,6 +50,10 @@ module Bitcoin
         attach_function(:secp256k1_ecdsa_signature_parse_der, [:pointer, :pointer, :pointer, :size_t], :int)
         attach_function(:secp256k1_ecdsa_signature_normalize, [:pointer, :pointer, :pointer], :int)
         attach_function(:secp256k1_ecdsa_verify, [:pointer, :pointer, :pointer, :pointer], :int)
+        attach_function(:secp256k1_schnorrsig_sign, [:pointer, :pointer, :pointer, :pointer, :pointer, :pointer], :int)
+        attach_function(:secp256k1_schnorrsig_verify, [:pointer, :pointer, :pointer, :pointer], :int)
+        attach_function(:secp256k1_keypair_create, [:pointer, :pointer, :pointer], :int)
+        attach_function(:secp256k1_xonly_pubkey_parse, [:pointer, :pointer, :pointer], :int)
       end
 
       def with_context(flags: (SECP256K1_CONTEXT_VERIFY | SECP256K1_CONTEXT_SIGN))
@@ -97,13 +101,117 @@ module Bitcoin
 
       # sign data.
       # @param [String] data a data to be signed with binary format
-      # @param [String] privkey a private key using sign
-      # @param [String] extra_entropy a extra entropy for rfc6979
+      # @param [String] privkey a private key with hex format using sign
+      # @param [String] extra_entropy a extra entropy with binary format for rfc6979
+      # @param [Symbol] algo signature algorithm. ecdsa(default) or schnorr.
       # @return [String] signature data with binary format
-      def sign_data(data, privkey, extra_entropy)
+      def sign_data(data, privkey, extra_entropy = nil, algo: :ecdsa)
+        case algo
+        when :ecdsa
+          sign_ecdsa(data, privkey, extra_entropy)
+        when :schnorr
+          sign_schnorr(data, privkey, extra_entropy)
+        else
+          nil
+        end
+      end
+
+      # verify signature
+      # @param [String] data a data with binary format.
+      # @param [String] sig signature data with binary format
+      # @param [String] pubkey a public key with hex format using verify.
+      # # @param [Symbol] algo signature algorithm. ecdsa(default) or schnorr.
+      # @return [Boolean] verification result.
+      def verify_sig(data, sig, pubkey, algo: :ecdsa)
+        case algo
+        when :ecdsa
+          verify_ecdsa(data, sig, pubkey)
+        when :schnorr
+          verify_schnorr(data, sig, pubkey)
+        else
+          false
+        end
+      end
+
+      # # validate whether this is a valid public key (more expensive than IsValid())
+      # @param [String] pub_key public key with hex format.
+      # @param [Boolean] allow_hybrid whether support hybrid public key.
+      # @return [Boolean] If valid public key return true, otherwise false.
+      def parse_ec_pubkey?(pub_key, allow_hybrid = false)
+        pub_key = pub_key.htb
+        return false if !allow_hybrid && ![0x02, 0x03, 0x04].include?(pub_key[0].ord)
+        with_context do |context|
+          pubkey = FFI::MemoryPointer.new(:uchar, pub_key.bytesize).put_bytes(0, pub_key)
+          internal_pubkey = FFI::MemoryPointer.new(:uchar, 64)
+          result = secp256k1_ec_pubkey_parse(context, internal_pubkey, pubkey, pub_key.bytesize)
+          result == 1
+        end
+      end
+
+      # Create key pair data from private key.
+      # @param [String] priv_key with hex format
+      # @return [String] key pair data with hex format. data  = private key(32 bytes) | public key(64 bytes).
+      def create_keypair(priv_key)
+        with_context do |context|
+          priv_key = priv_key.htb
+          secret = FFI::MemoryPointer.new(:uchar, priv_key.bytesize).put_bytes(0, priv_key)
+          raise 'priv_key is invalid.' unless secp256k1_ec_seckey_verify(context, secret)
+          keypair = FFI::MemoryPointer.new(:uchar, 96)
+          raise 'priv_key is invalid.' unless secp256k1_keypair_create(context, keypair, secret) == 1
+          keypair.read_string(96).bth
+        end
+      end
+
+      # Check whether valid x-only public key or not.
+      # @param [String] pub_key x-only public key with hex format(32 bytes).
+      # @return [Boolean] result.
+      def valid_xonly_pubkey?(pub_key)
+        begin
+          full_pubkey_from_xonly_pubkey(pub_key)
+        rescue Exception
+          return false
+        end
+        true
+      end
+
+      private
+
+      # Calculate full public key(64 bytes) from public key(32 bytes).
+      # @param [String] pub_key x-only public key with hex format(32 bytes).
+      # @return [String] x-only public key with hex format(64 bytes).
+      def full_pubkey_from_xonly_pubkey(pub_key)
+        with_context do |context|
+          pubkey = pub_key.htb
+          raise ArgumentError, 'Pubkey size must be 32 bytes.' unless pubkey.bytesize == 32
+          xonly_pubkey = FFI::MemoryPointer.new(:uchar, pubkey.bytesize).put_bytes(0, pubkey)
+          full_pubkey = FFI::MemoryPointer.new(:uchar, 64)
+          raise ArgumentError, 'An invalid public key was specified.' unless secp256k1_xonly_pubkey_parse(context, full_pubkey, xonly_pubkey) == 1
+          full_pubkey.read_string(64).bth
+        end
+      end
+
+      def generate_pubkey_in_context(context, privkey, compressed: true)
+        internal_pubkey = FFI::MemoryPointer.new(:uchar, 64)
+        result = secp256k1_ec_pubkey_create(context, internal_pubkey, privkey.htb)
+        raise 'error creating pubkey' unless result
+
+        pubkey = FFI::MemoryPointer.new(:uchar, 65)
+        pubkey_len = FFI::MemoryPointer.new(:uint64)
+        result = if compressed
+                   pubkey_len.put_uint64(0, 33)
+                   secp256k1_ec_pubkey_serialize(context, pubkey, pubkey_len, internal_pubkey, SECP256K1_EC_COMPRESSED)
+                 else
+                   pubkey_len.put_uint64(0, 65)
+                   secp256k1_ec_pubkey_serialize(context, pubkey, pubkey_len, internal_pubkey, SECP256K1_EC_UNCOMPRESSED)
+                 end
+        raise 'error serialize pubkey' unless result || pubkey_len.read_uint64 > 0
+        pubkey.read_string(pubkey_len.read_uint64).bth
+      end
+
+      def sign_ecdsa(data, privkey, extra_entropy)
         with_context do |context|
           secret = FFI::MemoryPointer.new(:uchar, privkey.htb.bytesize).put_bytes(0, privkey.htb)
-          raise 'priv_key invalid' unless secp256k1_ec_seckey_verify(context, secret)
+          raise 'priv_key is invalid' unless secp256k1_ec_seckey_verify(context, secret)
 
           internal_signature = FFI::MemoryPointer.new(:uchar, 64)
           msg32 = FFI::MemoryPointer.new(:uchar, 32).put_bytes(0, data)
@@ -126,11 +234,23 @@ module Bitcoin
         end
       end
 
-      def verify_sig(data, sig, pub_key)
+      def sign_schnorr(data, privkey, aux_rand = nil)
         with_context do |context|
-          return false if data.bytesize == 0
+          keypair = create_keypair(privkey).htb
+          keypair = FFI::MemoryPointer.new(:uchar, 96).put_bytes(0, keypair)
+          signature = FFI::MemoryPointer.new(:uchar, 64)
+          msg32 = FFI::MemoryPointer.new(:uchar, 32).put_bytes(0, data)
+          aux_rand = FFI::MemoryPointer.new(:uchar, 32).put_bytes(0, aux_rand) if aux_rand
+          raise 'Failed to generate schnorr signature.' unless secp256k1_schnorrsig_sign(context, signature, msg32, keypair, nil, aux_rand) == 1
+          signature.read_string(64)
+        end
+      end
 
-          pubkey = FFI::MemoryPointer.new(:uchar, pub_key.htb.bytesize).put_bytes(0, pub_key.htb)
+      def verify_ecdsa(data, sig, pubkey)
+        with_context do |context|
+          return false if data.bytesize == 0
+          pubkey = pubkey.htb
+          pubkey = FFI::MemoryPointer.new(:uchar, pubkey.bytesize).put_bytes(0, pubkey)
           internal_pubkey = FFI::MemoryPointer.new(:uchar, 64)
           result = secp256k1_ec_pubkey_parse(context, internal_pubkey, pubkey, pubkey.size)
           return false unless result
@@ -150,25 +270,18 @@ module Bitcoin
         end
       end
 
-      private
-
-      def generate_pubkey_in_context(context, privkey, compressed: true)
-        internal_pubkey = FFI::MemoryPointer.new(:uchar, 64)
-        result = secp256k1_ec_pubkey_create(context, internal_pubkey, privkey.htb)
-        raise 'error creating pubkey' unless result
-
-        pubkey = FFI::MemoryPointer.new(:uchar, 65)
-        pubkey_len = FFI::MemoryPointer.new(:uint64)
-        result = if compressed
-                   pubkey_len.put_uint64(0, 33)
-                   secp256k1_ec_pubkey_serialize(context, pubkey, pubkey_len, internal_pubkey, SECP256K1_EC_COMPRESSED)
-                 else
-                   pubkey_len.put_uint64(0, 65)
-                   secp256k1_ec_pubkey_serialize(context, pubkey, pubkey_len, internal_pubkey, SECP256K1_EC_UNCOMPRESSED)
-                 end
-        raise 'error serialize pubkey' unless result || pubkey_len.read_uint64 > 0
-        pubkey.read_string(pubkey_len.read_uint64).bth
+      def verify_schnorr(data, sig, pubkey)
+        with_context do |context|
+          return false if data.bytesize == 0
+          pubkey = full_pubkey_from_xonly_pubkey(pubkey).htb
+          xonly_pubkey = FFI::MemoryPointer.new(:uchar, pubkey.bytesize).put_bytes(0, pubkey)
+          signature = FFI::MemoryPointer.new(:uchar, sig.bytesize).put_bytes(0, sig)
+          msg32 = FFI::MemoryPointer.new(:uchar, 32).put_bytes(0, data)
+          result = secp256k1_schnorrsig_verify(context, signature, msg32, xonly_pubkey)
+          result == 1
+        end
       end
+
     end
   end
 end

data/lib/bitcoin/secp256k1/rfc6979.rb

@@ -0,0 +1,43 @@
+module Bitcoin
+  module Secp256k1
+    module RFC6979
+
+      INITIAL_V = '0101010101010101010101010101010101010101010101010101010101010101'.htb
+      INITIAL_K = '0000000000000000000000000000000000000000000000000000000000000000'.htb
+      ZERO_B = '00'.htb
+      ONE_B = '01'.htb
+
+      module_function
+
+      # generate temporary key k to be used when ECDSA sign.
+      # https://tools.ietf.org/html/rfc6979#section-3.2
+      # @param [String] key_data a data contains private key and message.
+      # @param [String] extra_entropy extra entropy with binary format.
+      # @return [Integer] a nonce.
+      def generate_rfc6979_nonce(key_data, extra_entropy)
+        v = INITIAL_V # 3.2.b
+        k = INITIAL_K # 3.2.c
+        # 3.2.d
+        k = Bitcoin.hmac_sha256(k, v + ZERO_B + key_data + extra_entropy)
+        # 3.2.e
+        v = Bitcoin.hmac_sha256(k, v)
+        # 3.2.f
+        k = Bitcoin.hmac_sha256(k, v + ONE_B + key_data + extra_entropy)
+        # 3.2.g
+        v = Bitcoin.hmac_sha256(k, v)
+        # 3.2.h
+        t = ''
+        10000.times do
+          v = Bitcoin.hmac_sha256(k, v)
+          t = (t + v)
+          t_num = t.bth.to_i(16)
+          return t_num if 1 <= t_num && t_num < Bitcoin::Secp256k1::GROUP.order
+          k = Bitcoin.hmac_sha256(k, v + '00'.htb)
+          v = Bitcoin.hmac_sha256(k, v)
+        end
+        raise 'A valid nonce was not found.'
+      end
+
+    end
+  end
+end

data/lib/bitcoin/secp256k1/ruby.rb

@@ -12,8 +12,8 @@ module Bitcoin
         private_key = 1 + SecureRandom.random_number(GROUP.order - 1)
         public_key = GROUP.generator.multiply_by_scalar(private_key)
         privkey = ECDSA::Format::IntegerOctetString.encode(private_key, 32)
-        pubkey = ECDSA::Format::PointOctetString.encode(public_key, compression: compressed)
-        [privkey.bth, pubkey.bth]
+        pubkey = public_key.to_hex(compressed)
+        [privkey.bth, pubkey]
       end
 
       # generate bitcoin key object
@@ -24,18 +24,87 @@ module Bitcoin
 
       def generate_pubkey(privkey, compressed: true)
         public_key = ECDSA::Group::Secp256k1.generator.multiply_by_scalar(privkey.to_i(16))
-        ECDSA::Format::PointOctetString.encode(public_key, compression: compressed).bth
+        public_key.to_hex(compressed)
+      end
+
+      # Check whether valid x-only public key or not.
+      # @param [String] pub_key x-only public key with hex format(32 bytes).
+      # @return [Boolean] result.
+      def valid_xonly_pubkey?(pub_key)
+        pubkey = pub_key.htb
+        return false unless pubkey.bytesize == 32
+        begin
+          ECDSA::Format::PointOctetString.decode(pubkey, ECDSA::Group::Secp256k1)
+        rescue Exception
+          return false
+        end
+        true
       end
 
       # sign data.
       # @param [String] data a data to be signed with binary format
       # @param [String] privkey a private key using sign
+      # @param [String] extra_entropy a extra entropy with binary format for rfc6979
+      # @param [Symbol] algo signature algorithm. ecdsa(default) or schnorr.
       # @return [String] signature data with binary format
-      def sign_data(data, privkey, extra_entropy)
+      def sign_data(data, privkey, extra_entropy = nil, algo: :ecdsa)
+        case algo
+        when :ecdsa
+          sign_ecdsa(data, privkey, extra_entropy)
+        when :schnorr
+          sign_schnorr(data, privkey, extra_entropy)
+        else
+          nil
+        end
+      end
+
+      # verify signature using public key
+      # @param [String] data a SHA-256 message digest with binary format
+      # @param [String] sig a signature for +data+ with binary format
+      # @param [String] pubkey a public key with hex format.
+      # @return [Boolean] verify result
+      def verify_sig(data, sig, pubkey, algo: :ecdsa)
+        case algo
+        when :ecdsa
+          verify_ecdsa(data, sig, pubkey)
+        when :schnorr
+          verify_schnorr(data, sig, pubkey)
+        else
+          false
+        end
+      end
+
+      # if +pubkey+ is hybrid public key format, it convert uncompressed format.
+      # https://lists.linuxfoundation.org/pipermail/bitcoin-dev/2012-June/001578.html
+      def repack_pubkey(pubkey)
+        p = pubkey.htb
+        case p[0]
+          when "\x06", "\x07"
+            p[0] = "\x04"
+            p
+          else
+            pubkey.htb
+        end
+      end
+
+      # validate whether this is a valid public key (more expensive than IsValid())
+      # @param [String] pubkey public key with hex format.
+      # @param [Boolean] allow_hybrid whether support hybrid public key.
+      # @return [Boolean] If valid public key return true, otherwise false.
+      def parse_ec_pubkey?(pubkey, allow_hybrid = false)
+        begin
+          point = ECDSA::Format::PointOctetString.decode(pubkey.htb, ECDSA::Group::Secp256k1, allow_hybrid: allow_hybrid)
+          ECDSA::Group::Secp256k1.valid_public_key?(point)
+        rescue ECDSA::Format::DecodeError
+          false
+        end
+      end
+
+      def sign_ecdsa(data, privkey, extra_entropy)
         privkey = privkey.htb
         private_key = ECDSA::Format::IntegerOctetString.decode(privkey)
         extra_entropy ||= ''
-        nonce = generate_rfc6979_nonce(data, privkey, extra_entropy)
+        nonce = RFC6979.generate_rfc6979_nonce(privkey + data, extra_entropy)
 
         # port form ecdsa gem.
         r_point = GROUP.new_point(nonce)
@@ -59,65 +128,24 @@ module Bitcoin
         signature
       end
 
-      # verify signature using public key
-      # @param [String] digest a SHA-256 message digest with binary format
-      # @param [String] sig a signature for +data+ with binary format
-      # @param [String] pubkey a public key corresponding to the private key used for sign
-      # @return [Boolean] verify result
-      def verify_sig(digest, sig, pubkey)
+      def sign_schnorr(data, privkey, aux_rand)
+        aux_rand ? Schnorr.sign(data, privkey.htb, aux_rand).encode : Schnorr.sign(data, privkey.htb).encode
+      end
+
+      def verify_ecdsa(data, sig, pubkey)
         begin
           k = ECDSA::Format::PointOctetString.decode(repack_pubkey(pubkey), GROUP)
           signature = ECDSA::Format::SignatureDerString.decode(sig)
-          ECDSA.valid_signature?(k, digest, signature)
+          ECDSA.valid_signature?(k, data, signature)
         rescue Exception
           false
         end
       end
 
-      # if +pubkey+ is hybrid public key format, it convert uncompressed format.
-      # https://lists.linuxfoundation.org/pipermail/bitcoin-dev/2012-June/001578.html
-      def repack_pubkey(pubkey)
-        p = pubkey.htb
-        case p[0]
-          when "\x06", "\x07"
-            p[0] = "\x04"
-            p
-          else
-            pubkey.htb
-        end
+      def verify_schnorr(data, sig, pubkey)
+        Schnorr.valid_sig?(data, pubkey.htb, sig)
       end
 
-      INITIAL_V = '0101010101010101010101010101010101010101010101010101010101010101'.htb
-      INITIAL_K = '0000000000000000000000000000000000000000000000000000000000000000'.htb
-      ZERO_B = '00'.htb
-      ONE_B = '01'.htb
-
-      # generate temporary key k to be used when ECDSA sign.
-      # https://tools.ietf.org/html/rfc6979#section-3.2
-      def generate_rfc6979_nonce(data, privkey, extra_entropy)
-        v = INITIAL_V # 3.2.b
-        k = INITIAL_K # 3.2.c
-        # 3.2.d
-        k = Bitcoin.hmac_sha256(k, v + ZERO_B + privkey + data + extra_entropy)
-        # 3.2.e
-        v = Bitcoin.hmac_sha256(k, v)
-        # 3.2.f
-        k = Bitcoin.hmac_sha256(k, v + ONE_B + privkey + data + extra_entropy)
-        # 3.2.g
-        v = Bitcoin.hmac_sha256(k, v)
-        # 3.2.h
-        t = ''
-        10000.times do
-          v = Bitcoin.hmac_sha256(k, v)
-          t = (t + v)
-          t_num = t.bth.to_i(16)
-          return t_num if 1 <= t_num && t_num < GROUP.order
-          k = Bitcoin.hmac_sha256(k, v + '00'.htb)
-          v = Bitcoin.hmac_sha256(k, v)
-        end
-        raise 'A valid nonce was not found.'
-      end
     end
-
   end
 end