schnorr_sig 0.0.0.4 → 0.1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cd55fdf9335f6ea817837d76d3ce130f9752ab7cbf582c822e061dc68574583
-  data.tar.gz: dbc20c45aac2f0d9443d278a93ff6e7ae88cea2fc26b68eaf5226c6dd47979bc
+  metadata.gz: 151da6ed14b8d23233e92c09c4354d00454d9c10a4abbbb6f8429f17bba10cfb
+  data.tar.gz: 9391ae74a60a5275bf2704b8fef73b6d69591313c924f3bb9cddb24ee08e7372
 SHA512:
-  metadata.gz: e180ad80feddacf2ee05dd4a66d8518a53233ac56ba393917bac45e19e5cae25530e87aacdcd330523ce6751e2fb754efc5359571a564db21197d7063bb3e737
-  data.tar.gz: fc67524a97a42b517efff14b7c4bcc21732d8f6e83a353d51220f3e7627aab646edce9e25fd9676f6f7e13bc62eceb3d52062bdbc234a0d640dfe3eba7f78086
+  metadata.gz: dc77694c5a19118374eab690d7fe6a2bf04e24a009e7c62108397a4dcb4fdf4e002d5e980018a9d83875c6fff93d4c132a9b6b8f1ffd1394304d584447706ab1
+  data.tar.gz: 76aceaed2e98afacc253c20549d3b16a48f3d7159aed457f51d2a7f37ea4a9b7a3bfee239b92b04b9b40f8de9f855e5330aef96ec446e01ddec260505d6f0254

data/README.md

@@ -14,6 +14,24 @@ and specifications similar to
 [IETF RFCs](https://en.wikipedia.org/wiki/Request_for_Comments).
 BIP340 specifies elliptic curve `secp256k1` for use with Schnorr signatures.
 
+Two separate implementations are provided.
+
+## Ruby Implementation
+
+This is the default implementation: entirely Ruby code within this library,
+with mostly-Ruby dependencies:
+
+* [ecdsa_ext](https://github.com/azuchi/ruby_ecdsa_ext)
+  - [ecdsa](https://github.com/DavidEGrayson/ruby_ecdsa/)
+
+## "Fast" Implementation
+
+This is based on the [rbsecp256k1](https://github.com/etscrivner/rbsecp256k1)
+gem, which is not installed by default.  The gem wraps the
+[secp256k1](https://github.com/bitcoin-core/secp256k1) library from the
+Bitcoin project, which provides battle-tested performance, correctness, and
+security guarantees.
+
 # Usage
 
 This library is provided as a RubyGem.  It has a single dependency on
@@ -77,9 +95,9 @@ require 'schnorr_sig/fast' # not 'schnorr_sig'
 # Elliptic Curves
 
 Note that [elliptic curves](https://en.wikipedia.org/wiki/Elliptic_curve)
-are not ellipses, but can instead be described by cubic equations of
+are not ellipses, but are instead described by cubic equations of
 the form: `y^2 = x^3 + ax + b` where `a` and `b` are the parameters of the
-resulting curve.  All points `(x, y)` which satisfy a given parameterized
+resulting equation.  All points `(x, y)` which satisfy a given parameterized
 equation provide the exact definition of an elliptic curve.
 
 ## Curve `secp256k1`
@@ -104,11 +122,11 @@ Here is one
 }
 ```
 
-* `p` is the prime for the Field, below INTMAX(32) (256^32)
+* `p` is the prime for the Field, below `INTMAX(32)` (256^32)
 * `a` is zero, as above
 * `b` is seven, as above
-* `g` is the generator point: [x, y]
-* `n` is the Group order, significantly below INTMAX(32)
+* `g` is the generator point: `[x, y]`
+* `n` is the Group order, significantly below `INTMAX(32)`
 
 Elliptic curves have algebraic structures called
 [Groups](https://en.wikipedia.org/wiki/Group_\(mathematics\)) and
@@ -224,6 +242,7 @@ required.
 * For any given x-value on the curve, the y-value is easily generated
 * For most curves, there are two different y-values for an x-value
 * We are always dealing with 32-byte integers: **Bignums**
+* Bignum math can be expensive
 * Converting between integer format and 32-byte strings can be expensive
 * The Schnorr algorithm requires lots of `string <--> integer` conversion
 * Hex strings are never used internally

data/VERSION

@@ -1 +1 @@
-0.0.0.4
+0.1.0.1

data/lib/schnorr_sig/util.rb

@@ -18,7 +18,7 @@ module SchnorrSig
   def self.bytestring!(str, size)
     string!(str)
     raise(EncodingError, str.encoding) unless str.encoding == Encoding::BINARY
-    str.size == size or raise(SizeError, str.size)
+    str.bytesize == size or raise(SizeError, str.bytesize)
   end
 
   # likely returns a Bignum, larger than a 64-bit hardware integer

data/lib/schnorr_sig.rb

@@ -9,6 +9,7 @@ module SchnorrSig
   class BoundsError < Error; end
   class SanityCheck < Error; end
   class VerifyFail < Error; end
+  class InfinityPoint < Error; end
 
   GROUP = ECDSA::Group::Secp256k1
   P = GROUP.field.prime # smaller than 256**32
@@ -40,7 +41,7 @@ module SchnorrSig
       big2bin(val)
     when ECDSA::Point
       # BIP340: The function bytes(P), where P is a point, returns bytes(x(P)).
-      val.infinity? ? ("\x00" * B).b : big2bin(val.x)
+      val.infinity? ? raise(InfinityPoint, va.inspect) : big2bin(val.x)
     else
       raise(SanityCheck, val.inspect)
     end
@@ -150,7 +151,7 @@ module SchnorrSig
   end
 
   # BIP340: The function lift_x(x), where x is a 256-bit unsigned integer,
-  #         returns the point P for which x(P) = x[10] and has_even_y(P),
+  #         returns the point P for which x(P) = x and has_even_y(P),
   #         or fails if x is greater than p-1 or no such point exists.
   # Input
   #   A large integer, x

data/test/vectors.rb

@@ -29,4 +29,4 @@ puts "Failure: #{failure.count}"
 
 puts failure unless failure.empty?
 
-exit failure.count
+# exit failure.count

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schnorr_sig
 version: !ruby/object:Gem::Version
-  version: 0.0.0.4
+  version: 0.1.0.1
 platform: ruby
 authors:
 - Rick Hull