rbsecp256k1 6.0.0 → 6.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbd0a847d061c266d044174528f14b1351484f58a703e7ec76719122689ae6d4
-  data.tar.gz: c7bbdaf0dc9bdaf24dd5de7c40d95c16f08b72d466216af6789e523ee14bba8b
+  metadata.gz: 713b484c223a4c3fec618c6d8050c964657a26ff73d9f4022a87b26b6009812b
+  data.tar.gz: c87b25bee566a967d8d3f9f28b5f99a4841942bb46ee062fbf9734e8082b02dc
 SHA512:
-  metadata.gz: cf695d750f38e4d27de61caa0e1ec8d9160925d7c10cc556691c7335478137f71f7f49901d50ade3c9e2c917779b38a3d4ee49ca931a8691cc99e7a751fd8243
-  data.tar.gz: 7b5a75562a90c3e845a0b42477873562991d19ca610b89aef95581e0f7dc010f123e8ed4055225978cb2ad4b6667e184d18915114f69cfdaabb993bfcf4b06a7
+  metadata.gz: ad34fd4905564c2afd5694966ff783a05e851048530c255996f496db35f5ef109558609a2a28d944b9a7c6a9b4c3a9d4cc0d95b4e5be63473bfc4d489913fae3
+  data.tar.gz: a8b5a50de652d42050f42d38a3dbc87b7c2a923747d9cedd1b2c5651fbf995131b1a43cd0fb9253bfed304eb6e3215ca80dc73906a053f080c391a36e7542c2c

data/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

data/README.md

@@ -84,6 +84,11 @@ the following command to set up your local environment:
 make setup
 ```
 
+### Line Endings
+
+.gitattributes keeps text files in Unix LF format across Windows, Linux, and
+macOS. Git detects binary files automatically and leaves their contents unchanged.
+
 ### Compiling Extension
 
 To compile the extension gem run the following (this is required to run tests):

data/Rakefile

@@ -4,8 +4,13 @@ require "rake/extensiontask"
 require "ruby_memcheck"
 require "rspec/core/rake_task"
 require 'ruby_memcheck/rspec/rake_task'
+require 'shellwords'
 
-RubyMemcheck.config(binary_name: "rbsecp256k1")
+memcheck_options = RubyMemcheck::Configuration::DEFAULT_VALGRIND_OPTIONS.dup
+if ENV['MEMCHECK_DEBUGINFO_PATH']
+  memcheck_options << "--extra-debuginfo-path=#{Shellwords.escape(File.expand_path(ENV['MEMCHECK_DEBUGINFO_PATH']))}"
+end
+RubyMemcheck.config(binary_name: "rbsecp256k1", valgrind_options: memcheck_options)
 
 # See: https://guides.rubygems.org/gems-with-extensions/
 Rake::ExtensionTask.new "rbsecp256k1" do |ext|

data/documentation/context.md

@@ -18,6 +18,18 @@ initialization if given `context_randomization_bytes`. The
 32 bytes of random data, if not provided then the Context is not randomized and
 may be vulnerable to side-channel attacks.
 
+`dup` and `clone` create independently owned native contexts using
+`secp256k1_context_clone`. The original and copy can be used and collected
+independently. Copying preserves the source context state; it does not provide
+fresh randomization. Use `Context.create` for a newly randomized context.
+Normal Ruby copy behavior applies: `clone` preserves frozen state, while `dup`
+returns an unfrozen copy. Copying an uninitialized context raises
+`Secp256k1::Error`.
+
+Native operations on an allocated context that has not completed initialization raise
+`Secp256k1::Error`. Reinitializing an existing context also raises
+`Secp256k1::Error` and leaves the existing context usable.
+
 Class Methods
 -------------
 
@@ -75,16 +87,31 @@ new [RecoverableSignature](recoverable_signature.md). The `private_key` is expec
 
 #### sign_schnorr(keypair, message)
 
+Signs a Ruby `String` containing any number of bytes, including zero bytes.
+
 Same as `sign_schnorr_custom(keypair, message, auxrand)` but generates
 `auxrand` for you using `SecureRandom`. This should almost always be the method
 used for Schnorr signing.
 
 #### sign_schnorr_custom(keypair, message, auxrand)
 
-Sign the given 32-byte binary string `message` using the given `keypair`. It is
-recommend that `message` be generated using `tagged_sha256`. `auxrand` should
-be 32-bytes of fresh randomness, but can optionally be `nil` if generating
-randomness is expensive.
+Signs the bytes of the Ruby `String` `message` using the given [KeyPair](key_pair.md)
+and returns a [SchnorrSignature](schnorr_signature.md). Messages may have any byte
+length, including zero, and may contain null bytes. String encoding does not
+change the bytes being signed.
+
+The message is signed directly, without implicit hashing, padding, or truncation.
+If your protocol requires a tagged hash for domain separation, compute it
+explicitly with `tagged_sha256` before signing. Verification must use the same
+message bytes.
+
+`auxrand` must be a `String` containing exactly 32 bytes of fresh randomness,
+or `nil`. With `nil`, the default BIP-340 nonce function treats auxiliary
+randomness as 32 zero bytes. Prefer `sign_schnorr`, which generates fresh
+randomness automatically.
+
+Non-string messages or non-string, non-`nil` randomness raise `TypeError`.
+Randomness strings with a byte length other than 32 raise `Secp256k1::Error`.
 
 #### tagged_sha256(tag, message)
 

data/documentation/index.md

@@ -43,7 +43,7 @@ of a piece of data.
 **[RecoverableSignature](recoverable_signature.md)** is a recoverable ECDSA signature of the SHA-256 message
 hash of a piece of data.
 
-**[SchnorrSignature](schnorr_signature.md)** is a Schnorr signature of a 32-byte message.
+**[SchnorrSignature](schnorr_signature.md)** is a 64-byte Schnorr signature of a message of any byte length.
 
 Examples
 --------
@@ -245,6 +245,19 @@ schnorr_sig.serialized
 => "\x16\xEF\x04\xB0JP\xE9\x90\xC2\xB1\xE6-l\xDB\x1D\xAE\xAAc\xBF@9s\x02\xC2\xD5[\xFB\x19Q\xFAI^Hj\xD1)\xBE\xEA\xA5!a\xAD\xBEO\xCE7\x9Em\x13;\xE8R\x8A\x81$\nv\xF4\xD3\xB25\xA9\xF9\xC0"
 ```
 
+Messages can also be signed directly, including empty strings. No implicit
+hashing, padding, or truncation is performed; use the same bytes for verification.
+The tagged hash above is an explicit application choice.
+
+```ruby
+message = 'a message of any byte length'.b
+signature = context.sign_schnorr(key_pair, message)
+signature.verify(message, key_pair.xonly_public_key)
+# => true
+signature.serialized.bytesize
+# => 64
+```
+
 ### 4. Load a Schnorr signature from binary serialized version
 
 ```ruby

data/documentation/schnorr_signature.md

@@ -3,7 +3,8 @@
 Secp256k1::SchnorrSignature
 ===========================
 
-Secp256k1::SchnorrSignature represents an Schnorr signature signing a 32-byte message.
+Secp256k1::SchnorrSignature represents a 64-byte Schnorr signature of a message
+of any byte length, including zero.
 
 Class Methods
 -------------
@@ -25,6 +26,9 @@ Returns the 64-byte binary `String` of the serialized Schnorr signature.
 Returns `true` if the schnorr signature is a valid signing of `msg` with the
 private key for `xonly_pubkey`, `false` otherwise.
 
+`msg` must be a Ruby `String` containing the exact bytes passed to signing.
+It may have any byte length, including zero. No implicit hashing is performed.
+
 #### ==(other)
 
 Returns `true` if this signature matches `other`.

data/ext/rbsecp256k1/extconf.rb

@@ -1,72 +1,7 @@
 # frozen_string_literal: true
 
-require 'mini_portile2'
 require 'mkmf'
-require 'zip'
-
-# Enable the recovery module by default
-WITH_RECOVERY = ENV.fetch('WITH_RECOVERY', '1') == '1'
-
-# Recipe for downloading and building libsecp256k1 as part of installation
-class Secp256k1Recipe < MiniPortile
-  # Hard-coded URL for libsecp256k1 zipfile (Official release v0.2.0)
-  LIBSECP256K1_ZIP_URL = 'https://github.com/bitcoin-core/secp256k1/archive/refs/tags/v0.2.0.zip'
-
-  # Expected SHA-256 of the zipfile above (computed using sha256sum)
-  LIBSECP256K1_SHA256 = '6ece280c0e6ea9d861051077c28a25b7f48800c43a4098a800b7d3b0c124e406'
-
-  def initialize
-    super('libsecp256k1', '0.2.0')
-    @tarball = File.join(Dir.pwd, "/ports/archives/libsecp256k1.zip")
-    @files = ["file://#{@tarball}"]
-    self.configure_options += [
-      "--with-pic=yes"
-    ]
-
-    # ECDH is enabled by default in release v0.2.0, but recovery still needs to
-    # be enabled manually.
-    configure_options << "--enable-module-recovery" if WITH_RECOVERY
-  end
-
-  def configure
-    # Need to run autogen.sh before configure since it creates it
-    if RUBY_PLATFORM =~ /mingw|mswin/
-      # Windows doesn't recognize the shebang.
-      execute('autogen', %w[sh ./autogen.sh])
-    else
-      execute('chmod', %w[chmod +x ./autogen.sh])
-      execute('autogen', %w[./autogen.sh])
-    end
-
-    super
-  end
-
-  def download
-    download_file_http(LIBSECP256K1_ZIP_URL, @tarball)
-    verify_file(local_path: @tarball, sha256: LIBSECP256K1_SHA256)
-  end
-
-  def downloaded?
-    File.exist?(@tarball)
-  end
-
-  def extract_zip_file(file, destination)
-    FileUtils.mkdir_p(destination)
-
-    Zip::File.open(file) do |zip_file|
-      zip_file.each do |f|
-        fpath = File.join(destination, f.name)
-        zip_file.extract(f, fpath) unless File.exist?(fpath)
-      end
-    end
-  end
-
-  def extract
-    files_hashs.each do |file|
-      extract_zip_file(file[:local_path], tmp_path)
-    end
-  end
-end
+require_relative 'secp256k1_recipe'
 
 if with_config('system-library')
   # Require that libsecp256k1 be installed using `make install` or similar.
@@ -88,6 +23,9 @@ else
       "-Wall"
     ]
   )
+  # Since libsecp256k1 v0.4.0, consumers of the static library on Windows must
+  # define SECP256K1_STATIC before including secp256k1.h.
+  append_cflags("-DSECP256K1_STATIC") if RUBY_PLATFORM =~ /mingw|mswin/
   append_ldflags(
     [
       "-Wl,--no-as-needed"
@@ -102,6 +40,9 @@ else
   have_library("gmp")
 end
 
+# Reject ABI-incompatible pointer arguments when the compiler supports it.
+append_cflags('-Werror=incompatible-pointer-types')
+
 # Sanity check for the basic library
 have_header('secp256k1.h')