curve-secp256k1 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 906d28b20c856a8be44cf48232b5191f4a28fa14bf2d9d05d5d09d78f68367ec
+  data.tar.gz: 1643f68d77f29ceae8cc4826a9aae8bc1530c5e8a08d226897bc8dbb232e2808
+SHA512:
+  metadata.gz: 69edcc4edf833ed5f4bcbcf30b9fa49ce7715039cb120f832107ab86f746689af813de89c4734f05491d8bde5bc9a535361d508619df92ed43e9e6574268f644
+  data.tar.gz: 582c3bf177b3d9150cfb79bc3dc73d7c5180a42c71333810c7bb985112d72daf31bf69e466707d5e9d7c96bd65817ef015faef261a04a534baace3e91b001c2d

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2021 Crypto Jane
+
+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,44 @@
+# secp256k1 wrapper for Ruby
+
+This gem wraps libsecp256k1 from the Bitcoin source in a couple of Ruby classes.
+
+Use in a pipeline to generate crypto-currency addresses and for BIP32 operations (public key addition).
+
+**To use this gem, libsecp256k1 must be installed on your system**
+
+## Usage
+
+Generate a new private key:
+
+    key = Secp256k1::Key.new
+
+Get a compressed public key (used by most cryptocurrencies):
+
+    key.public_key
+
+Load an existing private key:
+
+    key = Secp256k1::Key.new("256-bit binary private key value")
+
+## Installing secp256k1
+
+### On a Debian/Ubuntu:
+
+    sudo apt install libsecp256k1-dev
+
+### On macOs:
+
+It still doesn't come packaged with brew by default but there are a few taps where you can find it.
+
+### Install from source:
+
+    git clone https://github.com/bitcoin-core/secp256k1
+    cd secp256k1
+    ./autogen.sh
+    ./configure --enable-module-recovery --enable-experimental --enable-module-ecdh --enable-module-schnorr
+    make && sudo make install
+
+## TODO
+
+- Signing and verification
+- Embed libsecp256k1 in `ext`? (as a git submodule)

data/lib/secp256k1.rb

@@ -0,0 +1,57 @@
+require 'ffi'
+
+require_relative './secp256k1/key'
+require_relative './secp256k1/pkey'
+
+module Secp256k1
+  extend FFI::Library
+  ffi_lib 'secp256k1'
+
+  ORDER = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141
+
+  # Args:
+  #   int: flags for context initialization. 0x301 prepares the context for signing and verifying
+  attach_function :secp256k1_context_create, [:int], :pointer
+
+  # Args:
+  #   pointer (1): context
+  #   pointer (2): 32 byte buffer with the private key
+  # Returns
+  #   1 if the private key is valid
+  attach_function :secp256k1_ec_seckey_verify, %i[pointer pointer], :int
+
+  # Args:
+  #   pointer (1): context
+  #   pointer (2): out pointer
+  #   pointer (3): private key
+  # Returns
+  #   1 if the private key is valid
+  attach_function :secp256k1_ec_pubkey_create, %i[pointer pointer pointer], :int
+
+  # Args:
+  #   pointer (1): context
+  #   pointer (2): out buffer
+  #   pointer (3): out buffer size
+  #   pointer (4): uncompressed public key
+  #   int: flags. 0x102 means "compress"
+  attach_function :secp256k1_ec_pubkey_serialize, %i[pointer pointer pointer pointer int], :int
+
+  # Args:
+  #   pointer (1): context
+  #   pointer (2): resulting public key
+  #   pointer (3): pointer to array of pointers to public keys
+  #   long (4): number of public keys
+  # Returns
+  #   1 on success
+  attach_function :secp256k1_ec_pubkey_combine, %i[pointer pointer pointer long], :int
+
+  def self.context
+    @context ||= secp256k1_context_create(0x301)
+  end
+
+  def self.key_to_pointer(key)
+    ptr = FFI::MemoryPointer.new(:uint8, 32)
+    ptr.write_bytes(key)
+    ptr
+  end
+end

data/lib/secp256k1/key.rb

@@ -0,0 +1,60 @@
+require 'securerandom'
+
+module Secp256k1
+  class Key
+    def initialize(key = nil)
+      if key
+        if valid_key?(key)
+          @key = key.force_encoding('BINARY')
+        else
+          raise ArgumentError, "Invalid secp256k1 private key"
+        end
+      else
+        @key = random_key
+      end
+    end
+
+    def private_key
+      @key
+    end
+
+    def public_key
+      PKey.new(to_pubkey)
+    end
+
+    def ==(other)
+      @key == other.private_key
+    end
+
+    private
+
+    def random_key
+      loop do
+        key = SecureRandom.random_bytes(32)
+        return key if valid_key?(key)
+      end
+    end
+
+    def valid_key?(key)
+      kptr = Secp256k1.key_to_pointer(key)
+      valid = Secp256k1.secp256k1_ec_seckey_verify(Secp256k1.context, kptr) == 1
+
+      kptr.free
+
+      valid
+    end
+
+    # Caller must call #free
+    def to_pubkey
+      out = FFI::MemoryPointer.new(64)
+      priv = Secp256k1.key_to_pointer(@key)
+      Secp256k1.secp256k1_ec_pubkey_create(Secp256k1.context, out, priv)
+
+      val = out.read_bytes(64)
+      out.free
+      priv.free
+
+      val
+    end
+  end
+end

data/lib/secp256k1/pkey.rb

@@ -0,0 +1,75 @@
+require 'securerandom'
+
+module Secp256k1
+  class PKey
+    def initialize(uncompressed)
+      @raw = uncompressed.force_encoding('BINARY')
+    end
+
+    def to_s
+      @to_s ||= to_compressed
+    end
+
+    def uncompressed
+      @raw
+    end
+
+    def +(other)
+      cptrs = [to_pointer, other.send(:to_pointer)]
+      cptrs_ptr = FFI::MemoryPointer.new(:pointer, 2)
+
+      cptrs_ptr.put_pointer(0, cptrs[0])
+      cptrs_ptr.put_pointer(8, cptrs[1])
+
+      out = FFI::MemoryPointer.new(64)
+
+      valid = Secp256k1.secp256k1_ec_pubkey_combine(
+        Secp256k1.context,
+        out,
+        cptrs_ptr,
+        2
+      )
+
+      result = PKey.new(out.read_bytes(64)) if valid == 1
+
+      out.free
+      cptrs[0].free
+      cptrs[1].free
+      cptrs_ptr.free
+
+      result
+    end
+
+    def ==(other)
+      @raw == other.uncompressed
+    end
+
+    private
+
+    # Caller must call #free
+    def to_pointer
+      out = FFI::MemoryPointer.new(64)
+      out.write_bytes(@raw)
+      out
+    end
+
+    def to_compressed
+      cptr = to_pointer
+
+      out = FFI::MemoryPointer.new(:char, 33)
+      size_pointer = FFI::MemoryPointer.new(:long)
+      size_pointer.write(:long, 33)
+      Secp256k1.secp256k1_ec_pubkey_serialize(
+        Secp256k1.context, out, size_pointer, cptr, 0x102
+      )
+
+      result = out.read_bytes(33)
+
+      out.free
+      size_pointer.free
+      cptr.free
+
+      result
+    end
+  end
+end

data/lib/secp256k1/version.rb

@@ -0,0 +1,3 @@
+module Secp256k1
+  VERSION = '0.3.0'.freeze
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: curve-secp256k1
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Crypto Jane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- cryptojanedoe@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/secp256k1.rb
+- lib/secp256k1/key.rb
+- lib/secp256k1/pkey.rb
+- lib/secp256k1/version.rb
+homepage: https://gitlab.com/cryptojane/secp256k1
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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 wrapper for secp256k1 elliptic curve library. Commonly used to manage
+  Cryptocurrency addresses
+test_files: []