tapyrus 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1abedf80b636e2bfd80db4617ca9f92e703148f07e59c08b14860c13ac57689
-  data.tar.gz: 21b478051eb01354e410475e15761f24773fe164fcd9abf3307acb231b5c8ae3
+  metadata.gz: 3838e6da04049e2e82adfa960eb79f538ac4c6778fb3010b9a1423a7c8f2977d
+  data.tar.gz: 7c14929d2b2d7dcc388107e2ebbfdbd3891ecfc76a79a12282c518ee5cd160f0
 SHA512:
-  metadata.gz: 61c8cc2439074666abffc6ff85ffaa40811e8e0992edb19846876dabf9a300f4822af522a6f621271f310a9b1ea3f9429f30e86452d29b0f2216052568a72a6a
-  data.tar.gz: f3845015c030c7ccf915700eb45ac2f743c3f0c19dbe077c72c4afe19327252d1f3a64ffb29c1f5790997c8f6f2317930ab5ae99a894687a86f6381154c5429d
+  metadata.gz: 828f2fb6bf0a3bf120dab92afb04e4e7e8fce663108328ef6a6be122ff002a197807e0135310b225b65c493492afd0ccf7316b1e499eaa1ac92c0a38e9771199
+  data.tar.gz: 2ddd51984e99b5e8d1742d2d2c21b48ab50fd3efbcb64e08eb7908bfa678f788b6caff53029005af5a2ccbfc423d8e4aeab38607654ec73a1c9d199e6a446e84

data/README.md

@@ -12,7 +12,7 @@ Tapyrusrb supports following feature:
 * Tapyrus script interpreter
 * De/serialization of Tapyrus protocol network messages
 * De/serialization of blocks and transactions
-* Key generation and verification for ECDSA, including [BIP-32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) and [BIP-39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) supports.
+* Key generation and verification for Schnorr and ECDSA (including [BIP-32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) and [BIP-39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) supports).
 * ECDSA signature(RFC6979 -Deterministic ECDSA, LOW-S, LOW-R support)
 * [WIP] SPV node
 * [WIP] 0ff-chain protocol

data/lib/tapyrus/key.rb

@@ -96,10 +96,13 @@ module Tapyrus
     # @return [String] signature data with binary format
     def sign(data, low_r = true, extra_entropy = nil, algo: :ecdsa)
       raise ArgumentError, "Unsupported algorithm has been specified." unless SIG_ALGO.include?(algo)
-      if algo == :ecdsa
+      case algo
+      when :ecdsa
         sign_ecdsa(data, low_r, extra_entropy)
+      when :schnorr
+        secp256k1_module.sign_data(data, priv_key, extra_entropy, algo: algo)
       else
-        sign_schnorr(data)
+        false
       end
     end
 
@@ -112,11 +115,8 @@ module Tapyrus
       return false unless valid_pubkey?
       begin
         raise ArgumentError, "Unsupported algorithm has been specified." unless SIG_ALGO.include?(algo)
-        if algo == :ecdsa
-          verify_ecdsa_sig(sig, origin)
-        else
-          verify_schnorr_sig(sig, origin)
-        end
+        sig = ecdsa_signature_parse_der_lax(sig) if algo == :ecdsa
+        secp256k1_module.verify_sig(origin, sig, pubkey, algo: algo)
       rescue Exception
         false
       end
@@ -225,13 +225,7 @@ module Tapyrus
 
     # fully validate whether this is a valid public key (more expensive than IsValid())
     def fully_valid_pubkey?(allow_hybrid = false)
-      return false unless valid_pubkey?
-      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
+      valid_pubkey? && secp256k1_module.parse_ec_pubkey?(pubkey, allow_hybrid)
     end
 
     private
@@ -292,34 +286,18 @@ module Tapyrus
 
     # generate ecdsa signature
     def sign_ecdsa(data, low_r, extra_entropy)
-      sig = secp256k1_module.sign_data(data, priv_key, extra_entropy)
+      sig = secp256k1_module.sign_data(data, priv_key, extra_entropy, algo: :ecdsa)
       if low_r && !sig_has_low_r?(sig)
         counter = 1
         until sig_has_low_r?(sig)
           extra_entropy = [counter].pack('I*').bth.ljust(64, '0').htb
-          sig = secp256k1_module.sign_data(data, priv_key, extra_entropy)
+          sig = secp256k1_module.sign_data(data, priv_key, extra_entropy,  algo: :ecdsa)
           counter += 1
         end
       end
       sig
     end
 
-    # generate schnorr signature
-    def sign_schnorr(msg)
-      Schnorr.sign(msg, priv_key.to_i(16)).encode
-    end
-
-    # verify ecdsa signature
-    def verify_ecdsa_sig(sig, message)
-      sig = ecdsa_signature_parse_der_lax(sig)
-      secp256k1_module.verify_sig(message, sig, pubkey)
-    end
-
-    # verify schnorr signature
-    def verify_schnorr_sig(sig, message)
-      Schnorr.valid_sig?(message, sig, pubkey.htb)
-    end
-
   end
 
 end

data/lib/tapyrus/secp256k1/native.rb

@@ -50,6 +50,8 @@ module Tapyrus
         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_schnorr_sign, [:pointer, :pointer, :pointer, :pointer, :pointer, :pointer], :int)
+        attach_function(:secp256k1_schnorr_verify, [:pointer, :pointer, :pointer, :pointer], :int)
       end
 
       def with_context(flags: (SECP256K1_CONTEXT_VERIFY | SECP256K1_CONTEXT_SIGN))
@@ -100,7 +102,68 @@ module Tapyrus
       # @param [String] privkey a private key using sign
       # @param [String] extra_entropy a extra entropy for rfc6979
       # @return [String] signature data with binary format
-      def sign_data(data, privkey, extra_entropy)
+      def sign_data(data, privkey, extra_entropy, algo: :ecdsa)
+        case algo
+        when :ecdsa
+          sign_ecdsa(data, privkey, extra_entropy)
+        when :schnorr
+          sign_schnorr(data, privkey)
+        else
+          nil
+        end
+      end
+
+      # verify signature.
+      # @param[String] data a data.
+      # @param [String] sig signature data with binary format
+      # @param [String] pub_key a public key using verify.
+      def verify_sig(data, sig, pub_key, algo: :ecdsa)
+        case algo
+        when :ecdsa
+          verify_ecdsa(data, sig, pub_key)
+        when :schnorr
+          verify_schnorr(data, sig, pub_key)
+        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
+
+      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
+      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)
@@ -126,7 +189,19 @@ module Tapyrus
         end
       end
 
-      def verify_sig(data, sig, pub_key)
+      def sign_schnorr(data, privkey)
+        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)
+
+          signature = FFI::MemoryPointer.new(:uchar, 64)
+          msg32 = FFI::MemoryPointer.new(:uchar, 32).put_bytes(0, data)
+          raise 'Failed to generate schnorr signature.' unless secp256k1_schnorr_sign(context, signature, msg32, secret, nil, nil) == 1
+          signature.read_string
+        end
+      end
+
+      def verify_ecdsa(data, sig, pub_key)
         with_context do |context|
           return false if data.bytesize == 0
 
@@ -150,25 +225,23 @@ module Tapyrus
         end
       end
 
-      private
+      def verify_schnorr(data, sig, pub_key)
+        with_context do |context|
+          return false if data.bytesize == 0
+          pubkey = FFI::MemoryPointer.new(:uchar, pub_key.htb.bytesize).put_bytes(0, pub_key.htb)
+          internal_pubkey = FFI::MemoryPointer.new(:uchar, 64)
+          result = secp256k1_ec_pubkey_parse(context, internal_pubkey, pubkey, pubkey.size)
+          return false unless result
 
-      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
+          signature = FFI::MemoryPointer.new(:uchar, sig.bytesize).put_bytes(0, sig)
 
-        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
+          msg32 = FFI::MemoryPointer.new(:uchar, 32).put_bytes(0, data)
+          result = secp256k1_schnorr_verify(context, signature, msg32, internal_pubkey)
+
+          result == 1
+        end
       end
+
     end
   end
 end

data/lib/tapyrus/secp256k1/ruby.rb

@@ -31,7 +31,64 @@ module Tapyrus
       # @param [String] data a data to be signed with binary format
       # @param [String] privkey a private key using sign
       # @return [String] signature data with binary format
-      def sign_data(data, privkey, extra_entropy)
+      def sign_data(data, privkey, extra_entropy, algo: :ecdsa)
+        case algo
+        when :ecdsa
+          sign_ecdsa(data, privkey, extra_entropy)
+        when :schnorr
+          Schnorr.sign(data, privkey.to_i(16)).encode
+        else
+          nil
+        end
+      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, algo: :ecdsa)
+        case algo
+        when :ecdsa
+          verify_ecdsa(digest, sig, pubkey)
+        when :schnorr
+          Schnorr.valid_sig?(digest, sig, pubkey.htb)
+        else
+          false
+        end
+      end
+
+      alias :valid_sig? :verify_sig
+
+      module_function :valid_sig?
+
+      # 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
+
+      # 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
+
+      def sign_ecdsa(data, privkey, extra_entropy)
         privkey = privkey.htb
         private_key = ECDSA::Format::IntegerOctetString.decode(privkey)
         extra_entropy ||= ''
@@ -59,12 +116,7 @@ module Tapyrus
         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 verify_ecdsa(digest, sig, pubkey)
         begin
           k = ECDSA::Format::PointOctetString.decode(repack_pubkey(pubkey), GROUP)
           signature = ECDSA::Format::SignatureDerString.decode(sig)
@@ -74,23 +126,6 @@ module Tapyrus
         end
       end
 
-      alias :valid_sig? :verify_sig
-
-      module_function :valid_sig?
-
-      # 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
-
     end
 
   end

data/lib/tapyrus/version.rb

@@ -1,3 +1,3 @@
 module Tapyrus
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tapyrus
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - azuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-10 00:00:00.000000000 Z
+date: 2020-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ecdsa