bip-schnorr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c22da99e3fed7eea60436b7007532b752066996c9f2dd87f1f71028d7eaec357
+  data.tar.gz: 87bf98d7796bb6a31aad59e12914dd2f67584b852d45a7561e505061b3876284
+SHA512:
+  metadata.gz: aa3263695c27d8453971bb881c19f5b05c5d69bea52770823de956fc5cfe8d65fdd5393790fbd282eb8a78a13f56fbde3046f0222d9bbfefc668fedb099d150d
+  data.tar.gz: f828993f5d2c149aebc61dbd51c3569bf3ba97fe71aaab5e5aafbf1c7742d880e55b2db6dfa698e7dae521c50eea5d43c7ace1eb1e750b389ab11e8c2a0d9991

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/Gemfile.lock

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+schnorrrb

data/.ruby-version

@@ -0,0 +1 @@
+2.7.0

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.7.0
+  - 2.6.3
+  - 2.5.5
+  - 2.4.6
+
+bundler_args: --jobs=2
+
+script:
+  - bundle exec rake spec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at azuchi@haw.co.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bip-schnorrrb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018-2019 Chaintope, Inc.
+
+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,76 @@
+# bip-schnorrrb [![Build Status](https://travis-ci.org/chaintope/bip-schnorrrb.svg?branch=master)](https://travis-ci.org/chaintope/bip-schnorrrb) [![Gem Version](https://badge.fury.io/rb/bip-schnorr.svg)](https://badge.fury.io/rb/bip-schnorr) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE) 
+
+This is a Ruby implementation of the Schnorr signature scheme over the elliptic curve. 
+This implementation relies on the [ecdsa gem](https://github.com/DavidEGrayson/ruby_ecdsa) for operate elliptic curves.
+
+The code is based upon the initial proposal of Pieter Wuille's [bip-schnorr](https://github.com/sipa/bips/blob/bip-schnorr/bip-schnorr.mediawiki).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bip-schnorr', require: 'schnorr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bip-schnorr
+
+## Usage
+
+### Singing
+
+```ruby
+require 'schnorr'
+
+private_key = 0xB7E151628AED2A6ABF7158809CF4F3C762E7160F38B4DA56A784D9045190CFEF
+
+message = ['5E2D58D8B3BCDF1ABADEC7829054F90DDA9805AAB56C77333024B9D0A508B75C'].pack('H*')
+
+# create signature
+signature = Schnorr.sign(message, private_key)
+
+# signature r value
+signature.r 
+
+# signature s value
+signature.s 
+
+# convert signature to binary
+
+signature.encode
+
+```
+
+### Verification
+
+```ruby
+require 'schnorr'
+
+# public key does not start with 02 or 03.
+public_key = ['DFF1D77F2A671C5F36183726DB2341BE58FEAE1DA2DECED843240F7B502BA659'].pack('H*')
+
+signature = ['e7758e20e67a0607433cf8a1f0383a02c7b56792aab71763173ab7085cab8768082aae167787bc3572d15176dc26c073d9b03726aed0b59c728aa6538dc03d57'].pack('H*')
+
+message = ['5E2D58D8B3BCDF1ABADEC7829054F90DDA9805AAB56C77333024B9D0A508B75C'].pack('H*')
+
+# verify signature.(result is true or false)
+result = Schnorr.valid_sig?(message, public_key, signature) 
+
+# signature convert to Signature object
+sig = Schnorr::Signature.decode(signature) 
+```
+
+## Note
+
+This library changes the following functions of `ecdsa` gem in `lib/schnorr/ec_point_ext.rb`.
+
+* `ECDSA::Point` class has following two instance methods.
+    * `#has_square_y?` check this point does not infinity and square?(y coordinate)
+    * `#square?(x)` check whether `x` is a quadratic residue modulo p.
+* `ECDSA::Format::PointOctetString#decode` supports decoding only from x coordinate.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "schnorr"
+
+# 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/bip-schnorrrb.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "schnorr/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bip-schnorr"
+  spec.version       = Schnorr::VERSION
+  spec.authors       = ["azuchi"]
+  spec.email         = ["azuchi@chaintope.com"]
+
+  spec.summary       = %q{The ruby implementation of bip-schnorr.}
+  spec.description   = %q{The ruby implementation of bip-schnorr.}
+  spec.homepage      = "https://github.com/chaintope/bip-schnorrrb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "ecdsa", "~> 1.2.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/schnorr.rb

@@ -0,0 +1,118 @@
+require 'ecdsa'
+require 'securerandom'
+require_relative 'schnorr/ec_point_ext'
+require_relative 'schnorr/signature'
+
+module Schnorr
+
+  module_function
+
+  GROUP = ECDSA::Group::Secp256k1
+
+  # Generate schnorr signature.
+  # @param message (String) A message to be signed with binary format.
+  # @param private_key (Integer) The private key.
+  # (The number of times to add the generator point to itself to get the public key.)
+  # @return (Schnorr::Signature)
+  def sign(message, private_key)
+    raise 'The message must be a 32-byte array.' unless message.bytesize == 32
+    p = GROUP.new_point(private_key)
+    seckey = p.has_square_y? ? private_key : GROUP.order - private_key
+    secret = ECDSA::Format::IntegerOctetString.encode(seckey, GROUP.byte_length)
+
+    k0 = ECDSA::Format::IntegerOctetString.decode(tagged_hash('BIPSchnorrDerive', secret + message)) % GROUP.order
+    raise 'Creation of signature failed. k is zero' if k0.zero?
+
+    r = GROUP.new_point(k0)
+
+    k = r.has_square_y? ? k0 : GROUP.order - k0
+
+    e = create_challenge(r.x, p, message, GROUP)
+
+    Schnorr::Signature.new(r.x, (k + e * seckey) % GROUP.order)
+  end
+
+  # Verifies the given {Signature} and returns true if it is valid.
+  # @param message (String) A message to be signed with binary format.
+  # @param public_key (String) The public key with binary format.
+  # @param signature (String) The signature with binary format.
+  # @return (Boolean) whether signature is valid.
+  def valid_sig?(message, public_key, signature)
+    check_sig!(message, public_key, signature)
+  rescue InvalidSignatureError, ECDSA::Format::DecodeError
+    false
+  end
+
+  # Verifies the given {Signature} and raises an {InvalidSignatureError} if it is invalid.
+  # @param message (String) A message to be signed with binary format.
+  # @param public_key (String) The public key with binary format.
+  # @param signature (String) The signature with binary format.
+  # @return (Boolean)
+  def check_sig!(message, public_key, signature)
+    sig = Schnorr::Signature.decode(signature)
+    pubkey = ECDSA::Format::PointOctetString.decode(public_key, GROUP)
+    field = GROUP.field
+
+    raise Schnorr::InvalidSignatureError, 'Invalid signature: r is not in the field.' unless field.include?(sig.r)
+    raise Schnorr::InvalidSignatureError, 'Invalid signature: s is not in the field.' unless field.include?(sig.s)
+    raise Schnorr::InvalidSignatureError, 'Invalid signature: r is zero.' if sig.r.zero?
+    raise Schnorr::InvalidSignatureError, 'Invalid signature: s is zero.' if sig.s.zero?
+    raise Schnorr::InvalidSignatureError, 'Invalid signature: r is larger than field size.' if sig.r >= field.prime
+    raise Schnorr::InvalidSignatureError, 'Invalid signature: s is larger than group order.' if sig.s >= GROUP.order
+
+    e = create_challenge(sig.r, pubkey, message, GROUP)
+
+    r = GROUP.new_point(sig.s) + pubkey.multiply_by_scalar(GROUP.order - e)
+
+    if r.infinity? || !r.has_square_y? || r.x != sig.r
+      raise Schnorr::InvalidSignatureError, 'signature verification failed.'
+    end
+
+    true
+  end
+
+  # create signature digest.
+  # @param (Integer) x a x coordinate for R.
+  # @param (ECDSA::Point) p a public key.
+  # @param (ECDSA::Group) group the group of elliptic curve.
+  # @return (Integer) digest e.
+  def create_challenge(x, p, message, group)
+    r_x = ECDSA::Format::IntegerOctetString.encode(x, group.byte_length)
+    p_x = ECDSA::Format::IntegerOctetString.encode(p.x, group.byte_length)
+    (ECDSA.normalize_digest(tagged_hash('BIPSchnorr', r_x + p_x + message), group.bit_length)) % group.order
+  end
+
+  # Generate tagged hash value.
+  def tagged_hash(tag, msg)
+    tag_hash = Digest::SHA256.digest(tag)
+    Digest::SHA256.digest(tag_hash + tag_hash + msg)
+  end
+
+  class ::Integer
+
+    def to_hex
+      hex = to_s(16)
+      hex.rjust((hex.length / 2.0).ceil * 2, '0')
+    end
+
+    def method_missing(method, *args)
+      return mod_pow(args[0], args[1]) if method == :pow && args.length < 3
+      super
+    end
+
+    # alternative implementation of Integer#pow for ruby 2.4 and earlier.
+    def mod_pow(x, y)
+      return self ** x unless y
+      b = self
+      result = 1
+      while x > 0
+        result = (result * b) % y if (x & 1) == 1
+        x >>= 1
+        b = (b * b) % y
+      end
+      result
+    end
+
+  end
+
+end

data/lib/schnorr/ec_point_ext.rb

@@ -0,0 +1,57 @@
+# ECDSA gem elliptic curve point extension for bip-schnorr.
+module ECDSA
+  class Point
+
+    # Check this point does not infinity and square?(y coordinate)
+    # @return (Boolean)
+    def has_square_y?
+      !infinity? && square?(y)
+    end
+
+    # Check whether +x+ is a quadratic residue modulo p.
+    # @param x (Integer)
+    # @return (Boolean)
+    def square?(x)
+      x.pow((group.field.prime - 1) / 2, group.field.prime) == 1
+    end
+
+  end
+
+  module Format
+
+    module PointOctetString
+
+      def self.decode(string, group)
+        string = string.dup.force_encoding('BINARY')
+
+        raise DecodeError, 'Point octet string is empty.' if string.empty?
+
+        case string[0].ord
+        when 0
+          check_length string, 1
+          return group.infinity
+        when 2
+          decode_compressed string, group, 0
+        when 3
+          decode_compressed string, group, 1
+        when 4
+          decode_uncompressed string, group
+        else
+          return decode_from_x(string, group) if string.bytesize == 32
+          raise DecodeError, 'Unrecognized start byte for point octet string: 0x%x' % string[0].ord
+        end
+      end
+
+      # decode from x coordinate.
+      def self.decode_from_x(x_string, group)
+        x = ECDSA::Format::FieldElementOctetString.decode(x_string, group.field)
+        y_sq = group.field.mod(x.pow(3, group.field.prime) + 7)
+        y = y_sq.pow((group.field.prime + 1)/4, group.field.prime)
+        raise DecodeError, 'Public key not on the curve.' unless y.pow(2, group.field.prime) == y_sq
+        finish_decode(x, y, group)
+      end
+
+    end
+
+  end
+end

data/lib/schnorr/signature.rb

@@ -0,0 +1,38 @@
+module Schnorr
+
+  class InvalidSignatureError < StandardError; end
+
+  # Instances of this class represents Schnorr signatures,
+  # which are simply a pair of integers named `r` and `s`.
+  class Signature
+
+    attr_reader :r
+    attr_reader :s
+
+    # @param r (Integer) the value of r.
+    # @param s (Integer) the value of s.
+    def initialize(r, s)
+      @r, @s = r, s
+      r.is_a?(Integer) or raise ArgumentError, 'r is not an integer.'
+      s.is_a?(Integer) or raise ArgumentError, 's is not an integer.'
+    end
+
+    # Parse a string to a {Signature}.
+    # @param string (String) signature string with binary format.
+    # @return (Signature) signature instance.
+    def self.decode(string)
+      raise InvalidSignatureError, 'Invalid schnorr signature length.' unless string.bytesize == 64
+      r = string[0...32].unpack('H*').first.to_i(16)
+      s = string[32..-1].unpack('H*').first.to_i(16)
+      new(r, s)
+    end
+
+    # Encode signature to string.
+    # @return (String) encoded signature.
+    def encode
+      ECDSA::Format::IntegerOctetString.encode(r, 32) + ECDSA::Format::IntegerOctetString.encode(s, 32)
+    end
+
+  end
+
+end

data/lib/schnorr/version.rb

@@ -0,0 +1,3 @@
+module Schnorr
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: bip-schnorr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- azuchi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ecdsa
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: The ruby implementation of bip-schnorr.
+email:
+- azuchi@chaintope.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bip-schnorrrb.gemspec
+- lib/schnorr.rb
+- lib/schnorr/ec_point_ext.rb
+- lib/schnorr/signature.rb
+- lib/schnorr/version.rb
+homepage: https://github.com/chaintope/bip-schnorrrb
+licenses:
+- MIT
+metadata: {}
+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.0.3
+signing_key: 
+specification_version: 4
+summary: The ruby implementation of bip-schnorr.
+test_files: []