bitcoin-secp256k1 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6035dfb23c9b97f481f98bf2bdee8aa281776cb0
-  data.tar.gz: 31d82871124f52d7f3e8cbbd21ff35756ffca425
+SHA256:
+  metadata.gz: '038eab383cf48791b0fec41361ffd2d12ebc0e8f237e1c8610abef9884380400'
+  data.tar.gz: 50a54d28c8ed10245ffa16dab0c73e7a336505dca71ce859416028428878a9ea
 SHA512:
-  metadata.gz: bab2b773ca043cfb475f83f46b7e81496ec6c9c582408ea598a4da3ef9a14d090758680f3e78ea048a5d25250fd866f25424279e94052cb081cbd45f1e784280
-  data.tar.gz: 3ac36d282caf5d578121f209fdfd2937483bdbc7126c74bdedea1cd955610724ef1554231378aef4f7ec9a5e43c92dcd3e46f0d930f1c4725bae67773fbe1990
+  metadata.gz: bdbf5f0f3b92a943d37db6c352e078f6bdcafae23a4d04a72d9fa51e499b0f94211d80898084457ee349fc846f217e4c46bcd0c10251854dd3210b66171ce163
+  data.tar.gz: fa51063d85e791793c9314efe3aee7084005d8f854e5f941d725529aa37d69b89542136b2592d567a3aba9ae70d2c240c9f556864f656de4706ccecbfb301f16

data/.gitmodules

@@ -1,3 +1,3 @@
 [submodule "secp256k1"]
 	path = secp256k1
-	url = git@github.com:bitcoin/secp256k1.git
+	url = https://github.com/bitcoin-core/secp256k1.git

data/.travis.yml

@@ -0,0 +1,61 @@
+################
+# CI Workflow:
+# feature development, trigger by `git push`:
+#   test -> code_audit(code_security_audit and code_quality_audit)
+#
+# feature deploy, trigger by `git push --tags`
+#   test -> deploy
+#
+# Stages:
+# - test: run `rake test`
+# - code_audit: run `code_quality security_audit` and `code_quality quality_audit`
+# - deploy: auto build and upload a gem package to rubygems.org after `git push --tags`
+#
+# Principle:
+# - fail fast
+# - done is better than perfect
+################
+
+stages:
+  - test
+  - code_audit
+  - deploy
+
+sudo: false
+language: ruby
+rvm:
+  - 2.4.4
+  - 2.5.3
+before_install:
+  - gem install bundler
+  - git submodule update --init --recursive
+  - ./install_lib.sh
+
+# config GitHub OAuth Token
+env:
+  global:
+    secure: ENV_GLOBAL_SECURE
+
+jobs:
+  include:
+    - stage: code_audit
+      if: branch != master
+      install: gem install code_quality --no-ri --no-rdoc
+      script:
+        - bundle install # to generate Gemfile.lock
+        - code_quality security_audit:bundler_audit
+        - code_quality quality_audit fail_fast=false generate_index=true lowest_score=80 rubocop_max_offenses=200
+
+# automatically release Ruby gem to RubyGems after a successful build with `git push --tags`
+# refs: https://docs.travis-ci.com/user/deployment/rubygems/
+# 1. how to get your api_key: https://rubygems.org/profile/edit
+# 2. intall `travis` cli: $ gem install travis
+# 3. get encrypted api_key secure: $ travis setup rubygems
+deploy:
+  - provider: rubygems
+    api_key:
+      secure: oAeCF8k1NW3a94NXJoQs6kBRJG5TY9zdGJAVgvMxFuEnDVgjmuoKceTLdeQzKin+2PS2KRzGhT5E27wrNvCnQGfjKmQA9kPDqSQeJNnRBkbTjxKwkbi2P4g2EE1wR5PYgKq0mJ/4BMxVWZOleYT+ihwMiZDzoadAglbs5PSlC1HNnaQbnPQ3nfN1iG7o1KXdva5Bw4mcm86QPDrSoR9Fl/7ZJvteVouvC71Qt4QhkcaVV3piDUDM6JRbxa6ydsDOV6zq4nZP7UwufgK1GIpVNiLnVZtL3jCndY84a4MYz5sgBbvSEmSVbF1OdrPgllCV2wnauOtuzTqRYF5ATYyM3Hx58jYLUyd6YwXQrEoirHCyt2XaKSF1r2f9zvllVdXSCj+6/CJ70HkHrJTO3K2C9/uZEYIfNbTFZjMASWKyB52Vch5dFmlTloI/eLF2vp5jjY4iYTInPeb59UzqyBkMT4jtwconbre8eVKW/9qHTdTJDKQqmp4jKD+raeia/FbVaOTKyZ9nWxSQI3mVy49diK2j+Pd1LVw3nXY9zMz5f5W/D/zyGVf/Xt6gRNo0aj8UdMvZJm3awvruwQpJTa2tcp5m/iv74JzsFMdgit1pEbimF6xs7Ph8wVAI7eKVctZtI/zeaw+nv3mcg3+/GNGzSSj0RsjdXetrFSh6eh+qfL0=
+    gem: bitcoin-secp256k1
+    on:
+      tags: true
+      repo: cryptape/ruby-bitcoin-secp256k1

data/Gemfile.lock

@@ -1,25 +1,25 @@
 PATH
   remote: .
   specs:
-    bitcoin-secp256k1 (0.4.0)
-      ffi (>= 1.9.10)
+    bitcoin-secp256k1 (0.5.0)
+      ffi (>= 1.9.25)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ffi (1.9.10)
-    minitest (5.8.3)
-    rake (10.5.0)
-    yard (0.8.7.6)
+    ffi (1.9.25)
+    minitest (5.11.3)
+    rake (12.3.2)
+    yard (0.9.16)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bitcoin-secp256k1!
-  minitest (= 5.8.3)
-  rake (~> 10.5)
-  yard (= 0.8.7.6)
+  minitest (= 5.11.3)
+  rake (~> 12.3)
+  yard (= 0.9.16)
 
 BUNDLED WITH
-   1.11.2
+   1.17.2

data/README.md

@@ -1,16 +1,26 @@
 # ruby-bitcoin-secp256k1
 
-## Prerequiste
+## Prerequisite
 
-In order to use this gem, [libsecp256k1](https://github.com/bitcoin/secp256k1) with recovery module enabled must be in place.
+In order to use this gem, [libsecp256k1](https://github.com/bitcoin/secp256k1) must be in place.
 
-If you have cloned the project and in project root:
+```
+$ git clone https://github.com/bitcoin-core/secp256k1.git && cd secp256k1
+$ ./autogen.sh
+$ ./configure
+$ make
+$ sudo make install
+```
+
+Or if you have cloned the project, you could go to project root and run this install script:
 
 ```
 git submodule update --init --recursive
 ./install_lib.sh
 ```
 
+The recovery and ecdh modules are optional. If your local installation of secp256k1 doesn't enable them then the gem would throw `LoadModuleError` when related functions are invoked.
+
 ## Install
 
 ```

data/bitcoin-secp256k1.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Secp256k1::VERSION
   s.authors     = ["Jan Xie"]
   s.email       = ["jan.h.xie@gmail.com"]
-  s.homepage    = "https://github.com/janx/ruby-bitcoin-secp256k1"
+  s.homepage    = "https://github.com/cryptape/ruby-bitcoin-secp256k1"
   s.summary     = "Ruby binding to bitcoin's secp256k1 implementation."
   s.description = "Ruby binding to bitcoin's secp256k1 implementation."
   s.license     = 'MIT'
@@ -15,9 +15,9 @@ Gem::Specification.new do |s|
   s.files      = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
 
-  s.add_dependency('ffi', '>= 1.9.10')
+  s.add_dependency('ffi', '>= 1.9.25')
 
-  s.add_development_dependency('rake', '~> 10.5')
-  s.add_development_dependency('minitest', '5.8.3')
-  s.add_development_dependency('yard', '0.8.7.6')
+  s.add_development_dependency('rake', '~> 12.3')
+  s.add_development_dependency('minitest', '5.11.3')
+  s.add_development_dependency('yard', '0.9.16')
 end

data/lib/secp256k1.rb

@@ -16,5 +16,6 @@ module Secp256k1
   ALL_FLAGS = FLAG_SIGN | FLAG_VERIFY
 
   class AssertError < StandardError; end
+  class LoadModuleError < StandardError; end
 
 end

data/lib/secp256k1/c.rb

@@ -64,26 +64,44 @@ module Secp256k1
     # int secp256k1_ecdsa_sign(const secp256k1_context* ctx, secp256k1_ecdsa_signature *sig, const unsigned char *msg32, const unsigned char *seckey, secp256k1_nonce_function noncefp, const void *ndata)
     attach_function :secp256k1_ecdsa_sign, [:pointer, :pointer, :pointer, :pointer, :pointer, :pointer], :int
 
-    # int secp256k1_ecdsa_sign_recoverable(const secp256k1_context* ctx, secp256k1_ecdsa_recoverable_signature *sig, const unsigned char *msg32, const unsigned char *seckey, secp256k1_nonce_function noncefp, const void *ndata)
-    attach_function :secp256k1_ecdsa_sign_recoverable, [:pointer, :pointer, :pointer, :pointer, :pointer, :pointer], :int
-
-    # int secp256k1_ecdsa_recover(const secp256k1_context* ctx, secp256k1_pubkey* pubkey, secp256k1_ecdsa_recoverable_signature *sig, const unsigned char *msg32)
-    attach_function :secp256k1_ecdsa_recover, [:pointer, :pointer, :pointer, :pointer], :int
-
     # int secp256k1_ecdsa_verify(const secp256k1_context *ctx, const secp256k1_ecdsa_signature *sig, const unsigned char *msg32, const secp256k1_pubkey *pubkey)
     attach_function :secp256k1_ecdsa_verify, [:pointer, :pointer, :pointer, :pointer], :int
 
     # int secp256k1_ecdsa_signature_normalize(const secp256k1_context *ctx, const secp256k1_ecdsa_signature *sigout, const secp256k1_ecdsa_signature *sigin)
     attach_function :secp256k1_ecdsa_signature_normalize, [:pointer, :pointer, :pointer], :int
 
-    # int secp256k1_ecdsa_recoverable_signature_serialize_compact(const secp256k1_context *ctx, unsigned char *output64, int *recid, const secp256k1_ecdsa_recoverable_signature *sig)
-    attach_function :secp256k1_ecdsa_recoverable_signature_serialize_compact, [:pointer, :pointer, :pointer, :pointer], :int
+    # recovery module
+    begin
+      # int secp256k1_ecdsa_recoverable_signature_parse_compact(const secp256k1_context *ctx, secp256k1_ecdsa_recoverable_signature *sig, const unsigned char *input64, int recid)
+      attach_function :secp256k1_ecdsa_recoverable_signature_parse_compact, [:pointer, :pointer, :pointer, :int], :int
+
+      # int secp256k1_ecdsa_recoverable_signature_convert(const secp256k1_context *ctx, secp256k1_ecdsa_signature *sig, const secp256k1_ecdsa_recoverable_signature *sigin)
+      attach_function :secp256k1_ecdsa_recoverable_signature_convert, [:pointer, :pointer, :pointer], :int
+
+      # int secp256k1_ecdsa_recoverable_signature_serialize_compact(const secp256k1_context *ctx, unsigned char *output64, int *recid, const secp256k1_ecdsa_recoverable_signature *sig)
+      attach_function :secp256k1_ecdsa_recoverable_signature_serialize_compact, [:pointer, :pointer, :pointer, :pointer], :int
+
+      # int secp256k1_ecdsa_sign_recoverable(const secp256k1_context* ctx, secp256k1_ecdsa_recoverable_signature *sig, const unsigned char *msg32, const unsigned char *seckey, secp256k1_nonce_function noncefp, const void *ndata)
+      attach_function :secp256k1_ecdsa_sign_recoverable, [:pointer, :pointer, :pointer, :pointer, :pointer, :pointer], :int
 
-    # int secp256k1_ecdsa_recoverable_signature_parse_compact(const secp256k1_context *ctx, secp256k1_ecdsa_recoverable_signature *sig, const unsigned char *input64, int recid)
-    attach_function :secp256k1_ecdsa_recoverable_signature_parse_compact, [:pointer, :pointer, :pointer, :int], :int
+      # int secp256k1_ecdsa_recover(const secp256k1_context* ctx, secp256k1_pubkey* pubkey, secp256k1_ecdsa_recoverable_signature *sig, const unsigned char *msg32)
+      attach_function :secp256k1_ecdsa_recover, [:pointer, :pointer, :pointer, :pointer], :int
+    rescue FFI::NotFoundError
+    end
 
-    # int secp256k1_ecdsa_recoverable_signature_convert(const secp256k1_context *ctx, secp256k1_ecdsa_signature *sig, const secp256k1_ecdsa_recoverable_signature *sigin)
-    attach_function :secp256k1_ecdsa_recoverable_signature_convert, [:pointer, :pointer, :pointer], :int
+    def self.module_recovery_enabled?
+      respond_to? :secp256k1_ecdsa_recover
+    end
 
+    # ecdh module
+    begin
+      # int secp256k1_ecdh(const secp256k1_context* ctx, unsigned char *result, const secp256k1_pubkey *point, const unsigned char *scalar)
+      attach_function :secp256k1_ecdh, [:pointer, :pointer, :pointer, :pointer], :int
+    rescue FFI::NotFoundError
+    end
+
+    def self.module_ecdh_enabled?
+      respond_to :secp256k1_ecdh
+    end
   end
 end

data/lib/secp256k1/key.rb

@@ -171,6 +171,8 @@ module Secp256k1
     end
 
     def ecdsa_sign_recoverable(msg, raw: false, digest: Digest::SHA256)
+      raise LoadModuleError, "libsecp256k1 recovery module is not enabled" unless C.module_recovery_enabled?
+
       msg32 = hash32 msg, raw, digest
       raw_sig = C::ECDSARecoverableSignature.new.pointer
 

data/lib/secp256k1/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding : ascii-8bit -*-
 module Secp256k1
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/test/secp256k1_test.rb

@@ -61,7 +61,7 @@ class Secp256k1Test < Minitest::Test
 
     had_to_normalize, normsig = pk.ecdsa_signature_normalize(raw_sig, check_only: true)
     assert_equal false, had_to_normalize
-    assert_equal nil, normsig
+    assert_nil normsig
 
     sig = "\xAA" + "\xFF"*31 + "\xAA" + "\xFF"*31
     raw_sig = pk.ecdsa_deserialize_compact sig
@@ -72,10 +72,12 @@ class Secp256k1Test < Minitest::Test
 
     normalized, normsig = pk.ecdsa_signature_normalize raw_sig, check_only: true
     assert_equal true, normalized
-    assert_equal nil, normsig
+    assert_nil normsig
   end
 
   def test_ecdsa_recover
+    return unless C.module_recovery_enabled?
+
     pk = PrivateKey.new
     unrelated = MyECDSA.new
 
@@ -85,7 +87,7 @@ class Secp256k1Test < Minitest::Test
     assert_equal pubser, pk.pubkey.serialize
 
     recsig_ser = unrelated.ecdsa_recoverable_serialize recsig
-    recsig2 = unrelated.ecdsa_recoverable_deserialize *recsig_ser
+    recsig2 = unrelated.ecdsa_recoverable_deserialize(*recsig_ser)
     pubkey2 = unrelated.ecdsa_recover 'hello', recsig2
     pubser2 = PublicKey.new(pubkey: pubkey2).serialize
     assert_equal pubser, pubser2

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitcoin-secp256k1
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jan Xie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-17 00:00:00.000000000 Z
+date: 2018-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.10
+        version: 1.9.25
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.10
+        version: 1.9.25
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.8.3
+        version: 5.11.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.8.3
+        version: 5.11.3
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.7.6
+        version: 0.9.16
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.7.6
+        version: 0.9.16
 description: Ruby binding to bitcoin's secp256k1 implementation.
 email:
 - jan.h.xie@gmail.com
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".gitmodules"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -91,7 +92,7 @@ files:
 - test/fixtures/ecdsa_sig.json
 - test/fixtures/pubkey.json
 - test/secp256k1_test.rb
-homepage: https://github.com/janx/ruby-bitcoin-secp256k1
+homepage: https://github.com/cryptape/ruby-bitcoin-secp256k1
 licenses:
 - MIT
 metadata: {}
@@ -111,12 +112,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Ruby binding to bitcoin's secp256k1 implementation.
-test_files:
-- test/fixtures/ecdsa_sig.json
-- test/fixtures/pubkey.json
-- test/secp256k1_test.rb
-has_rdoc: 
+test_files: []