secp256k1rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b1d7e33a444d5bbf4bf5cdfb3d57870bf810a568dbd5ff739c19b8f06a5e9329
+  data.tar.gz: 40a5994a593fef14c7f8a9993d9917d27b66405e5ab545f744f03f1d99554f9b
+SHA512:
+  metadata.gz: 65a12acd88ec6e5b01faed7d98b950d1de72c08d0aab286266d4aceba2844f03319e86fb4a9d687107e94b6729f6c24d93897285c7c92cb036c2c43af2a40b55
+  data.tar.gz: 4b0f6b2e4b2faf1ebd7e59a07f28396eaf0bc07681ff429ad9189ecbc1fec7259458a53accd1cc618df14fccf240f9635b6ae596cbf88b56a2e297f7dbb73948

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-05-07
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at azuchi@chaintope.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in secp256k1.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 azuchi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

data/README.md

@@ -0,0 +1,43 @@
+# secp256k1rb
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/secp256k1`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'secp256k1rb', require: 'secp256k1'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install secp256k1rb
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/secp256k1. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/secp256k1/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Secp256k1 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/secp256k1/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "secp256k1"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/secp256k1/c.rb

@@ -0,0 +1,39 @@
+require 'ffi'
+
+module Secp256k1
+
+  # C interface
+  module C
+    extend FFI::Library
+
+    ffi_lib(ENV['SECP256K1_LIB_PATH'])
+
+    attach_function(:secp256k1_context_create, [:uint], :pointer)
+    attach_function(:secp256k1_context_destroy, [:pointer], :void)
+    attach_function(:secp256k1_context_randomize, [:pointer, :pointer], :int)
+    attach_function(:secp256k1_ec_pubkey_create, [:pointer, :pointer, :pointer], :int)
+    attach_function(:secp256k1_ec_seckey_verify, [:pointer, :pointer], :int)
+    attach_function(:secp256k1_ecdsa_sign, [:pointer, :pointer, :pointer, :pointer, :pointer, :pointer], :int)
+    attach_function(:secp256k1_ec_pubkey_serialize, [:pointer, :pointer, :pointer, :pointer, :uint], :int)
+    attach_function(:secp256k1_ecdsa_signature_serialize_der, [:pointer, :pointer, :pointer, :pointer], :int)
+    attach_function(:secp256k1_ec_pubkey_parse, [:pointer, :pointer, :pointer, :size_t], :int)
+    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_sign32, [:pointer, :pointer, :pointer, :pointer, :pointer], :int)
+    attach_function(:secp256k1_schnorrsig_verify, [:pointer, :pointer, :pointer, :size_t, :pointer], :int)
+    attach_function(:secp256k1_keypair_create, [:pointer, :pointer, :pointer], :int)
+    attach_function(:secp256k1_xonly_pubkey_parse, [:pointer, :pointer, :pointer], :int)
+    attach_function(:secp256k1_ecdsa_sign_recoverable, [:pointer, :pointer, :pointer, :pointer, :pointer, :pointer], :int)
+    attach_function(:secp256k1_ecdsa_recoverable_signature_serialize_compact, [:pointer, :pointer, :pointer, :pointer], :int)
+    attach_function(:secp256k1_ecdsa_recover, [:pointer, :pointer, :pointer, :pointer], :int)
+    attach_function(:secp256k1_ecdsa_recoverable_signature_parse_compact, [:pointer, :pointer, :pointer, :int], :int)
+    attach_function(:secp256k1_ellswift_decode, [:pointer, :pointer, :pointer], :int)
+    attach_function(:secp256k1_ellswift_create, [:pointer, :pointer, :pointer, :pointer], :int)
+    # Define function pointer
+    callback(:secp256k1_ellswift_xdh_hash_function, [:pointer, :pointer, :pointer, :pointer, :pointer], :int)
+    attach_variable(:secp256k1_ellswift_xdh_hash_function_bip324, :secp256k1_ellswift_xdh_hash_function)
+    attach_function(:secp256k1_ellswift_xdh, [:pointer, :pointer, :pointer, :pointer, :pointer, :int, :pointer, :pointer], :int)
+
+  end
+end

data/lib/secp256k1/ellswift.rb

@@ -0,0 +1,74 @@
+module Secp256k1
+  module ELLSwift
+    # Decode ellswift public key.
+    # @param [String] ell_key ElligatorSwift key with binary format.
+    # @return [String] Decoded public key with hex format.
+    # @raise [Secp256k1::Error] If decode failed.
+    # @raise [ArgumentError] If invalid arguments specified.
+    def ellswift_decode(ell_key)
+      raise ArgumentError, "ell_key must be String." unless ell_key.is_a?(String)
+      ell_key = hex2bin(ell_key)
+      raise ArgumentError, "ell_key must be 64 bytes." unless ell_key.bytesize == 64
+      with_context do |context|
+        ell64 = FFI::MemoryPointer.new(:uchar, ell_key.bytesize).put_bytes(0, ell_key)
+        internal = FFI::MemoryPointer.new(:uchar, 64)
+        result = secp256k1_ellswift_decode(context, internal, ell64)
+        raise Error, 'Decode failed.' unless result == 1
+        serialize_pubkey_internal(context, internal, true)
+      end
+    end
+
+    # Compute an ElligatorSwift public key for a secret key.
+    # @param [String] private_key private key with hex format
+    # @return [String] ElligatorSwift public key with hex format.
+    # @raise [Secp256k1::Error] If failed to create elligattor swhift public key.
+    # @raise [ArgumentError] If invalid arguments specified.
+    def ellswift_create(private_key)
+      raise ArgumentError, "private_key must be String." unless private_key.is_a?(String)
+      private_key = hex2bin(private_key)
+      raise ArgumentError, "private_key must be 32 bytes." unless private_key.bytesize == 32
+      with_context(flags: SECP256K1_CONTEXT_SIGN) do |context|
+        ell64 = FFI::MemoryPointer.new(:uchar, 64)
+        seckey32 = FFI::MemoryPointer.new(:uchar, 32).put_bytes(0, private_key)
+        result = secp256k1_ellswift_create(context, ell64, seckey32, nil)
+        raise Error, 'Failed to create ElligatorSwift public key.' unless result == 1
+        ell64.read_string(64).unpack1('H*')
+      end
+    end
+
+    # Compute X coordinate of shared ECDH point between elswift pubkey and private_key.
+    # @param [String] their_ell_pubkey Their EllSwift public key.
+    # @param [String] our_ell_pubkey Our EllSwift public key.
+    # @param [String] private_key private key with hex format.
+    # @param [Boolean] initiating Whether your initiator or not.
+    # @return [String] x coordinate with hex format.
+    # @raise [Secp256k1::Error] If secret is invalid or hashfp return 0.
+    def ellswift_ecdh_xonly(their_ell_pubkey, our_ell_pubkey, private_key, initiating)
+      raise ArgumentError, "their_ell_pubkey must be String." unless their_ell_pubkey.is_a?(String)
+      raise ArgumentError, "our_ell_pubkey must be String." unless our_ell_pubkey.is_a?(String)
+      raise ArgumentError, "private_key must be String." unless private_key.is_a?(String)
+      their_ell_pubkey = hex2bin(their_ell_pubkey)
+      our_ell_pubkey = hex2bin(our_ell_pubkey)
+      private_key = hex2bin(private_key)
+      raise ArgumentError, "their_ell_pubkey must be #{ELL_SWIFT_KEY_SIZE} bytes." unless their_ell_pubkey.bytesize == ELL_SWIFT_KEY_SIZE
+      raise ArgumentError, "our_ell_pubkey must be #{ELL_SWIFT_KEY_SIZE} bytes." unless our_ell_pubkey.bytesize == ELL_SWIFT_KEY_SIZE
+      raise ArgumentError, "private_key must be 32 bytes." unless private_key.bytesize == 32
+
+      with_context(flags: SECP256K1_CONTEXT_SIGN) do |context|
+        output = FFI::MemoryPointer.new(:uchar, 32)
+        our_ell_ptr = FFI::MemoryPointer.new(:uchar, 64).put_bytes(0, our_ell_pubkey)
+        their_ell_ptr = FFI::MemoryPointer.new(:uchar, 64).put_bytes(0, their_ell_pubkey)
+        seckey32 = FFI::MemoryPointer.new(:uchar, 32).put_bytes(0, private_key)
+        hashfp = secp256k1_ellswift_xdh_hash_function_bip324
+        result = secp256k1_ellswift_xdh(context, output,
+                                        initiating ? our_ell_ptr : their_ell_ptr,
+                                        initiating ? their_ell_ptr : our_ell_ptr,
+                                        seckey32,
+                                        initiating ? 0 : 1,
+                                        hashfp, nil)
+        raise Error, "secret was invalid or hashfp returned 0." unless result == 1
+        output.read_string(32).unpack1('H*')
+      end
+    end
+  end
+end

data/lib/secp256k1/recovery.rb

@@ -0,0 +1,66 @@
+module Secp256k1
+  module Recover
+    # Sign data with compact format.
+    # @param [String] data The 32-byte message hash being signed.
+    # @param [String] private_key a private key using sign with hex format
+    # @return [Array] Array of signature and recovery id.
+    # @raise [Secp256k1::Error] If recovery failed.
+    # @raise [ArgumentError] If invalid arguments specified.
+    def sign_recoverable(data, private_key)
+      raise ArgumentError, "private_key must be String." unless private_key.is_a?(String)
+      raise ArgumentError, "data must by String." unless data.is_a?(String)
+      private_key = hex2bin(private_key)
+      raise ArgumentError, "private_key must be 32 bytes." unless private_key.bytesize == 32
+      data = hex2bin(data)
+      raise ArgumentError, "data must be 32 bytes." unless data.bytesize == 32
+
+      with_context do |context|
+        sig = FFI::MemoryPointer.new(:uchar, 65)
+        hash =FFI::MemoryPointer.new(:uchar, data.bytesize).put_bytes(0, data)
+        sec_key = FFI::MemoryPointer.new(:uchar, private_key.bytesize).put_bytes(0, private_key)
+        result = secp256k1_ecdsa_sign_recoverable(context, sig, hash, sec_key, nil, nil)
+        raise Error, 'secp256k1_ecdsa_sign_recoverable failed.' if result == 0
+
+        output = FFI::MemoryPointer.new(:uchar, 64)
+        rec = FFI::MemoryPointer.new(:uint64)
+        result = secp256k1_ecdsa_recoverable_signature_serialize_compact(context, output, rec, sig)
+        raise Error, 'secp256k1_ecdsa_recoverable_signature_serialize_compact failed.' unless result == 1
+
+        sig = output.read_string(64).unpack1('H*')
+        [sig, rec.read(:int)]
+      end
+    end
+
+    # Recover public key from compact signature.
+    # @param [String] data The 32-byte message hash assumed to be signed.
+    # @param [String] signature The signature with binary format (65 bytes).
+    # @param [Boolean] compressed whether compressed public key or not.
+    # @return [String] Recovered public key with hex format.
+    # @raise [Secp256k1::Error] If recover failed.
+    # @raise [ArgumentError] If invalid arguments specified.
+    def recover(data, signature, compressed)
+      raise ArgumentError, "data must be String." unless data.is_a?(String)
+      raise ArgumentError, "signature must be String." unless signature.is_a?(String)
+      signature = hex2bin(signature)
+      raise ArgumentError, "signature must be 64 bytes." unless signature.bytesize == 65
+      data = hex2bin(data)
+      raise ArgumentError, "data must be 32 bytes." unless data.bytesize == 32
+      rec = (signature[0].ord - 0x1b) & 3
+      raise ArgumentError, "rec must be between 0 and 3." if rec < 0 || rec > 3
+
+      with_context do |context|
+        sig = FFI::MemoryPointer.new(:uchar, 65)
+        input = FFI::MemoryPointer.new(:uchar, 64).put_bytes(0, signature[1..-1])
+        result = secp256k1_ecdsa_recoverable_signature_parse_compact(context, sig, input, rec)
+        raise Error, 'secp256k1_ecdsa_recoverable_signature_parse_compact failed.' unless result == 1
+
+        pubkey = FFI::MemoryPointer.new(:uchar, 64)
+        msg = FFI::MemoryPointer.new(:uchar, data.bytesize).put_bytes(0, data)
+        result = secp256k1_ecdsa_recover(context, pubkey, sig, msg)
+        raise Error, 'secp256k1_ecdsa_recover failed.' unless result == 1
+
+        serialize_pubkey_internal(context, pubkey.read_string(64), compressed)
+      end
+    end
+  end
+end

data/lib/secp256k1/schnorrsig.rb

@@ -0,0 +1,55 @@
+module Secp256k1
+  module SchnorrSig
+
+    # Sign to data using schnorr.
+    # @param [String] data The 32-byte message hash being signed with binary format.
+    # @param [String] private_key a private key with hex format using sign.
+    # @param [String] aux_rand a extra entropy.
+    # @return [String] signature data with binary format. If unsupported algorithm specified, return nil.
+    # @raise [ArgumentError] If invalid arguments specified.
+    def sign_schnorr(data, private_key, aux_rand = nil)
+      raise ArgumentError, "private_key must be String." unless private_key.is_a?(String)
+      raise ArgumentError, "data must by String." unless data.is_a?(String)
+      raise ArgumentError, "aux_rand must be String." if !aux_rand.nil? && !aux_rand.is_a?(String)
+      private_key = hex2bin(private_key)
+      raise ArgumentError, "private_key must be 32 bytes." unless private_key.bytesize == 32
+      data = hex2bin(data)
+      raise ArgumentError, "data must be 32 bytes." unless data.bytesize == 32
+
+      with_context do |context|
+        keypair = [create_keypair(private_key)].pack('H*')
+        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 Error, 'Failed to generate schnorr signature.' unless secp256k1_schnorrsig_sign32(context, signature, msg32, keypair, aux_rand) == 1
+        signature.read_string(64)
+      end
+    end
+
+    # Verify ecdsa signature.
+    # @param [String] data The 32-byte message hash assumed to be signed.
+    # @param [String] signature signature data with binary format
+    # @param [String] pubkey a public key with hex format using verify.
+    # @return [Boolean] verification result.
+    # @raise [ArgumentError] If invalid arguments specified.
+    def verify_schnorr(data, signature, pubkey)
+      raise ArgumentError, "sig must be String." unless signature.is_a?(String)
+      raise ArgumentError, "pubkey must be String." unless pubkey.is_a?(String)
+      raise ArgumentError, "data must be String." unless data.is_a?(String)
+      data = hex2bin(data)
+      raise ArgumentError, "data must be 32 bytes." unless data.bytesize == 32
+      pubkey = hex2bin(pubkey)
+      signature = hex2bin(signature)
+      with_context do |context|
+        return false if data.bytesize == 0
+        pubkey = [full_pubkey_from_xonly_pubkey(pubkey)].pack('H*')
+        xonly_pubkey = FFI::MemoryPointer.new(:uchar, pubkey.bytesize).put_bytes(0, pubkey)
+        signature = FFI::MemoryPointer.new(:uchar, signature.bytesize).put_bytes(0, signature)
+        msg32 = FFI::MemoryPointer.new(:uchar, 32).put_bytes(0, data)
+        result = secp256k1_schnorrsig_verify(context, signature, msg32, 32, xonly_pubkey)
+        result == 1
+      end
+    end
+  end
+end

data/lib/secp256k1/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Secp256k1
+  VERSION = "0.1.0"
+end

data/lib/secp256k1.rb

@@ -0,0 +1,285 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require_relative "secp256k1/version"
+require_relative 'secp256k1/c'
+require_relative 'secp256k1/recovery'
+require_relative 'secp256k1/ellswift'
+require_relative 'secp256k1/schnorrsig'
+
+# Binding for secp256k1 (https://github.com/bitcoin-core/secp256k1/)
+module Secp256k1
+
+  class Error < StandardError; end
+
+  include C
+  include Recover
+  include SchnorrSig
+  include ELLSwift
+
+  FLAGS_TYPE_MASK = ((1 << 8) - 1)
+  FLAGS_TYPE_CONTEXT = (1 << 0)
+  FLAGS_TYPE_COMPRESSION = (1 << 1)
+
+  FLAGS_BIT_CONTEXT_VERIFY = (1 << 8)
+  FLAGS_BIT_CONTEXT_SIGN = (1 << 9)
+  FLAGS_BIT_COMPRESSION = (1 << 8)
+
+  # Flags to pass to context_create.
+  CONTEXT_VERIFY = (FLAGS_TYPE_CONTEXT | FLAGS_BIT_CONTEXT_VERIFY)
+  CONTEXT_SIGN = (FLAGS_TYPE_CONTEXT | FLAGS_BIT_CONTEXT_SIGN)
+
+  # Flag to pass to ec_pubkey_serialize and ec_privkey_export.
+  EC_COMPRESSED = (FLAGS_TYPE_COMPRESSION | FLAGS_BIT_COMPRESSION)
+  EC_UNCOMPRESSED = (FLAGS_TYPE_COMPRESSION)
+
+  X_ONLY_PUBKEY_SIZE = 32
+  ELL_SWIFT_KEY_SIZE = 64
+
+  # Creates a secp256k1 context object, performs the operations passed in the block,
+  # and then ensures that the secp256k1 context object is destroyed at the end.
+  # @param [Integer] flags The flag to use when performing the operation.
+  # @raise [Secp256k1::Error] If secp256k1_context_randomize failed.
+  def with_context(flags: (CONTEXT_VERIFY | CONTEXT_SIGN))
+    begin
+      context = secp256k1_context_create(flags)
+      ret, tries, max = 0, 0, 20
+      while ret != 1
+        raise Error, 'secp256k1_context_randomize failed.' if tries >= max
+        tries += 1
+        ret = secp256k1_context_randomize(context, FFI::MemoryPointer.from_string(SecureRandom.random_bytes(32)))
+      end
+      yield(context) if block_given?
+    ensure
+      secp256k1_context_destroy(context)
+    end
+  end
+
+  # Randomly generate ec private key and public key.
+  # @param [Boolean] compressed Whether to generate a compressed public key.
+  # @return [Array] Array of public key and public key (Both are hex values).
+  # @raise [Secp256k1::Error] If secp256k1_ec_seckey_verify in generate_key_pair failed.
+  def generate_key_pair(compressed: true)
+    with_context do |context|
+      ret, tries, max = 0, 0, 20
+      while ret != 1
+        raise Error, 'secp256k1_ec_seckey_verify in generate_key_pair failed.' if tries >= max
+        tries += 1
+        private_key = FFI::MemoryPointer.new(:uchar, 32).put_bytes(0, SecureRandom.random_bytes(32))
+        ret = secp256k1_ec_seckey_verify(context, private_key)
+      end
+      private_key =  private_key.read_string(32).unpack1('H*')
+      [private_key , generate_pubkey_in_context(context,  private_key, compressed: compressed) ]
+    end
+  end
+
+  # Generate public key from +private_key+.
+  # @param [String] private_key Private key with hex format.
+  # @param [Boolean] compressed Whether to generate a compressed public key.
+  # @return [String] Public key with hex format.
+  # @raise [ArgumentError] If invalid arguments specified.
+  def generate_pubkey(private_key, compressed: true)
+    raise  ArgumentError, "private_key must be String." unless private_key.is_a?(String)
+    private_key = hex2bin(private_key)
+    raise ArgumentError, "private_key must by 32 bytes." unless private_key.bytesize == 32
+    with_context do |context|
+      generate_pubkey_in_context(context, private_key, compressed: compressed)
+    end
+  end
+
+  # Sign to data.
+  # @param [String] data The 32-byte message hash being signed with binary format.
+  # @param [String] private_key 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. If unsupported algorithm specified, return nil.
+  # @raise [ArgumentError] If invalid arguments specified.
+  def sign_data(data, private_key, extra_entropy = nil, algo: :ecdsa)
+
+    case algo
+    when :ecdsa
+      sign_ecdsa(data, private_key, extra_entropy)
+    when :schnorr
+      sign_schnorr(data, private_key, extra_entropy)
+    else
+      raise ArgumentError, "unknown algo: #{algo}"
+    end
+  end
+
+
+  # Validate whether this is a valid public key.
+  # @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.
+  # @raise [ArgumentError] If invalid arguments specified.
+  def parse_ec_pubkey?(pubkey, allow_hybrid = false)
+    raise ArgumentError, "pubkey must be String." unless pubkey.is_a?(String)
+    pubkey = hex2bin(pubkey)
+    return false if !allow_hybrid && ![0x02, 0x03, 0x04].include?(pubkey[0].ord)
+    with_context do |context|
+      pubkey_size = pubkey.bytesize
+      pubkey = FFI::MemoryPointer.new(:uchar, pubkey_size).put_bytes(0, pubkey)
+      internal_pubkey = FFI::MemoryPointer.new(:uchar, 64)
+      result = secp256k1_ec_pubkey_parse(context, internal_pubkey, pubkey, pubkey_size)
+      result == 1
+    end
+  end
+
+  # Create key pair data from private key.
+  # @param [String] private_key with hex format
+  # @return [String] key pair data with hex format. data = private key(32 bytes) | public key(64 bytes).
+  # @raise [Secp256k1::Error] If private_key is invalid.
+  # @raise [ArgumentError] If invalid arguments specified.
+  def create_keypair(private_key)
+    raise ArgumentError, "private_key must be String." unless private_key.is_a?(String)
+    private_key = hex2bin(private_key)
+    raise ArgumentError, "private_key must be 32 bytes." unless private_key.bytesize == 32
+    with_context do |context|
+      secret = FFI::MemoryPointer.new(:uchar, private_key.bytesize).put_bytes(0, private_key)
+      raise Error, 'private_key is invalid.' unless secp256k1_ec_seckey_verify(context, secret)
+      keypair = FFI::MemoryPointer.new(:uchar, 96)
+      raise Error 'private_key is invalid.' unless secp256k1_keypair_create(context, keypair, secret) == 1
+      keypair.read_string(96).unpack1('H*')
+    end
+  end
+
+  # Check whether valid x-only public key or not.
+  # @param [String] pubkey x-only public key with hex format(32 bytes).
+  # @return [Boolean] result.
+  def valid_xonly_pubkey?(pubkey)
+    return false unless pubkey.is_a?(String)
+    begin
+      full_pubkey_from_xonly_pubkey(hex2bin(pubkey))
+    rescue Exception
+      return false
+    end
+    true
+  end
+
+  # Sign to data using ecdsa.
+  # @param [String] data The 32-byte message hash being signed with binary format.
+  # @param [String] private_key a private key with hex format using sign.
+  # @param [String] extra_entropy a extra entropy with binary format for rfc6979.
+  # @return [String] signature data with binary format. If unsupported algorithm specified, return nil.
+  # @raise [ArgumentError] If invalid arguments specified.
+  def sign_ecdsa(data, private_key, extra_entropy)
+    raise ArgumentError, "private_key must be String." unless private_key.is_a?(String)
+    raise ArgumentError, "data must by String." unless data.is_a?(String)
+    raise ArgumentError, "extra_entropy must be String." if !extra_entropy.nil? && !extra_entropy.is_a?(String)
+    private_key = hex2bin(private_key)
+    raise ArgumentError, "private_key must be 32 bytes." unless private_key.bytesize == 32
+    data = hex2bin(data)
+    raise ArgumentError, "data must be 32 bytes." unless data.bytesize == 32
+
+    with_context do |context|
+      secret = FFI::MemoryPointer.new(:uchar, private_key.bytesize).put_bytes(0, private_key)
+      raise Error, 'private_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)
+      entropy = extra_entropy ? FFI::MemoryPointer.new(:uchar, 32).put_bytes(0, extra_entropy) : nil
+
+      ret, tries, max = 0, 0, 20
+
+      while ret != 1
+        raise Error, 'secp256k1_ecdsa_sign failed.' if tries >= max
+        tries += 1
+        ret = secp256k1_ecdsa_sign(context, internal_signature, msg32, secret, nil, entropy)
+      end
+
+      signature = FFI::MemoryPointer.new(:uchar, 72)
+      signature_len = FFI::MemoryPointer.new(:uint64).put_uint64(0, 72)
+      result = secp256k1_ecdsa_signature_serialize_der(context, signature, signature_len, internal_signature)
+      raise Error, 'secp256k1_ecdsa_signature_serialize_der failed' unless result
+
+      signature.read_string(signature_len.read_uint64)
+    end
+  end
+
+  # Verify ecdsa signature.
+  # @param [String] data The 32-byte message hash assumed to be signed.
+  # @param [String] signature signature data with binary format
+  # @param [String] pubkey a public key with hex format using verify.
+  # @return [Boolean] verification result.
+  # @raise [ArgumentError] If invalid arguments specified.
+  def verify_ecdsa(data, signature, pubkey)
+    raise ArgumentError, "sig must be String." unless signature.is_a?(String)
+    raise ArgumentError, "pubkey must be String." unless pubkey.is_a?(String)
+    raise ArgumentError, "data must be String." unless data.is_a?(String)
+    data = hex2bin(data)
+    raise ArgumentError, "data must be 32 bytes." unless data.bytesize == 32
+    pubkey = hex2bin(pubkey)
+    signature = hex2bin(signature)
+    with_context do |context|
+      return false if data.bytesize == 0
+      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
+
+      signature = FFI::MemoryPointer.new(:uchar, signature.bytesize).put_bytes(0, signature)
+      internal_signature = FFI::MemoryPointer.new(:uchar, 64)
+      result = secp256k1_ecdsa_signature_parse_der(context, internal_signature, signature, signature.size)
+      return false unless result
+
+      # libsecp256k1's ECDSA verification requires lower-S signatures, which have not historically been enforced in Bitcoin, so normalize them first.
+      secp256k1_ecdsa_signature_normalize(context, internal_signature, internal_signature)
+
+      msg32 = FFI::MemoryPointer.new(:uchar, 32).put_bytes(0, data)
+      result = secp256k1_ecdsa_verify(context, internal_signature, msg32, internal_pubkey)
+
+      result == 1
+    end
+  end
+
+  private
+
+  # Calculate full public key(64 bytes) from public key(32 bytes).
+  # @param [String] pubkey x-only public key with hex format(32 bytes).
+  # @return [String] x-only public key with hex format(64 bytes).
+  # @raise ArgumentError
+  def full_pubkey_from_xonly_pubkey(pubkey)
+    with_context do |context|
+      raise ArgumentError, "Pubkey size must be #{X_ONLY_PUBKEY_SIZE} bytes." unless pubkey.bytesize == X_ONLY_PUBKEY_SIZE
+      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).unpack1('H*')
+    end
+  end
+
+  def generate_pubkey_in_context(context, private_key, compressed: true)
+    internal_pubkey = FFI::MemoryPointer.new(:uchar, 64)
+    priv_ptr = FFI::MemoryPointer.new(:uchar, 32).put_bytes(0, hex2bin(private_key))
+    result = secp256k1_ec_pubkey_create(context, internal_pubkey, priv_ptr)
+    raise 'error creating pubkey' unless result
+    serialize_pubkey_internal(context, internal_pubkey, compressed)
+  end
+
+  # Serialize public key.
+  def serialize_pubkey_internal(context, pubkey_input, compressed)
+    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, pubkey_input, EC_COMPRESSED)
+             else
+               pubkey_len.put_uint64(0, 65)
+               secp256k1_ec_pubkey_serialize(context, pubkey, pubkey_len, pubkey_input, EC_UNCOMPRESSED)
+             end
+    raise Error, 'error serialize pubkey' unless result || pubkey_len.read_uint64 > 0
+    pubkey.read_string(pubkey_len.read_uint64).unpack1('H*')
+  end
+
+  def hex_string?(str)
+    return false if str.bytes.any? { |b| b > 127 }
+    return false if str.length % 2 != 0
+    hex_chars = str.chars.to_a
+    hex_chars.all? { |c| c =~ /[0-9a-fA-F]/ }
+  end
+
+  def hex2bin(str)
+    hex_string?(str) ? [str].pack('H*') : str
+  end
+end
+

data/secp256k1rb.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/secp256k1/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "secp256k1rb"
+  spec.version = Secp256k1::VERSION
+  spec.authors = ["azuchi"]
+  spec.email = ["azuchi@chaintope.com"]
+
+  spec.summary = "Ruby binding for libsecp256k1."
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/azuchi/secp256k1rb"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "ffi", ">= 1.16.3"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/secp256k1.rbs

@@ -0,0 +1,4 @@
+module Secp256k1
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: secp256k1rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- azuchi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.3
+description: Ruby binding for libsecp256k1.
+email:
+- azuchi@chaintope.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/secp256k1.rb
+- lib/secp256k1/c.rb
+- lib/secp256k1/ellswift.rb
+- lib/secp256k1/recovery.rb
+- lib/secp256k1/schnorrsig.rb
+- lib/secp256k1/version.rb
+- secp256k1rb.gemspec
+- sig/secp256k1.rbs
+homepage: https://github.com/azuchi/secp256k1rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/azuchi/secp256k1rb
+  source_code_uri: https://github.com/azuchi/secp256k1rb
+  changelog_uri: https://github.com/azuchi/secp256k1rb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Ruby binding for libsecp256k1.
+test_files: []