ecdsa_ext 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7deba9160e31d20d837d2fce03b555c8f9dee1cc40c1bbdb04958c0a489e1ad
-  data.tar.gz: ec8fea9687a956a1390311257ae71b4d22bd9aea47867c8ae69310198da42deb
+  metadata.gz: d034afcff3fe0f7bcdd0a201387242296617c4115c8a5e5c17be9c55727aa7b5
+  data.tar.gz: 94ca9bd31bd199527df5e77d82bfad340d81a869675ecaec0dec2f41c63a4ae7
 SHA512:
-  metadata.gz: 4938e0327a13cfc62fe1c009d840ebe7c8a36aac30393cd72c0729b0c985ee14d92b05aaccfd0d5d9997d3e43869529de1e7f55762c527be00908f48c63419bd
-  data.tar.gz: 63d3a4e725d737a4ba5a625ba811b448e707a5c0cb121e7546d3b9ec51caebe3f6efa8981d4f3186918ab5c56540db33fc68500b952696394dba8a744caa7674
+  metadata.gz: 57ce381df7da79e9e4853c1e0f9e7a67157a49c7e6701db9076eec31f41b6e87e6e03350280c833d9b5d91c125ca3619364c96b9e621688b5f5b0ea09456f7d5
+  data.tar.gz: 75ecb95e6e18a751dea27a435555b6ae4dc583c93c5dda206a7a9bfd24fbda045d6a09a715f4d962060165aad0c961366977d4092743f3755e0cc04080731e20

data/README.md

@@ -1,8 +1,10 @@
-# EcdsaExt
+# Extension of the ecdsa gem
 
-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/ecdsa_ext`. To experiment with that code, run `bin/console` for an interactive prompt.
+This library is an extension of the [ecdsa gem](https://github.com/DavidEGrayson/ruby_ecdsa/),
+which mainly speeds up the computation of points on elliptic curves by using projective rather than affine coordinates.
 
-TODO: Delete this and the text above, and describe your gem
+This gem was not written by a cryptography expert and has not been carefully checked as with the original gem.
+It is provided "as is" and it is the user's responsibility to make sure it will be suitable for the desired purpose.
 
 ## Installation
 
@@ -22,22 +24,55 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Convert coordinate from affine to projective
 
-## Development
+```ruby
+require 'ecdsa_ext'
+require 'securerandom'
 
-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.
+group = ECDSA::Group::Secp256k1
+private_key = 1 + SecureRandom.random_number(group.order - 1)
+affine_point = group.generator * private_key
+#<ECDSA::Point: secp256k1, 0x22a7d03cd6fec52e13d2713da6921cf8f374631ecea7d575d31c3f338a410ad, 0x530b82285b951582bc330fc0b1d26df56bf93277d1229676ab9c2d4749098a7c>
 
-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).
+# convert to projective point
+projective_point = affine_point.to_projective
+#<ECDSA::Ext::ProjectivePoint:0x00007f45baa7f5b0 @group=#<ECDSA::Group:secp256k1>, @x=979696094695476041658010915065787178569931130816884020506645009594358960301, @y=37562300065191370074864991137132392549749230653372621152572375247509483260540, @z=1>
+```
 
-## Contributing
+### Create directory
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ecdsa_ext. 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]/ecdsa_ext/blob/master/CODE_OF_CONDUCT.md).
+```ruby
+require 'ecdsa_ext'
+require 'securerandom'
 
-## License
+group = ECDSA::Group::Secp256k1
+private_key = 1 + SecureRandom.random_number(group.order - 1)
+projective_point = group.generator.to_projective * private_key
+#<ECDSA::Ext::ProjectivePoint:0x00007f45baa7f5b0 @group=#<ECDSA::Group:secp256k1>, @x=979696094695476041658010915065787178569931130816884020506645009594358960301, @y=37562300065191370074864991137132392549749230653372621152572375247509483260540, @z=1>
+```
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+### Operation
+
+`ECDSA::Ext::ProjectivePoint` instance supports point addition, scalar multiplication and negation.
+
+```ruby
+require 'ecdsa_ext'
 
-## Code of Conduct
+# addition
+projective_point3 = projective_point1 + projective_point2
+
+# multiplication
+projective_point4 = projective_point3 * 123
+
+# negation
+projective_point4_neg = projective_point4.negate
+```
+
+### Convert coordinate from projective to affine
+
+```ruby
+require 'ecdsa_ext'
 
-Everyone interacting in the EcdsaExt project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ecdsa_ext/blob/master/CODE_OF_CONDUCT.md).
+affine_point = projective_point4.to_affine
+```

data/lib/ecdsa/ext/projective_point.rb

@@ -103,11 +103,8 @@ module ECDSA
         if infinity?
           group.infinity
         else
-          ECDSA::Point.new(
-            group,
-            field.mod(x * field.inverse(z)),
-            field.mod(y * field.inverse(z))
-          )
+          z_inv = field.inverse(z)
+          ECDSA::Point.new(group, field.mod(x * z_inv), field.mod(y * z_inv))
         end
       end
 
@@ -145,7 +142,14 @@ module ECDSA
 
       def ==(other)
         return false unless other.is_a?(ProjectivePoint)
-        group == other.group && x == other.x && y == other.y && z == other.z
+        return true if infinity? && other.infinity?
+
+        lhs_x = field.mod(x * other.z)
+        rhs_x = field.mod(other.x * z)
+        lhs_y = field.mod(y * other.z)
+        rhs_y = field.mod(other.y * z)
+
+        lhs_x == rhs_x && lhs_y == rhs_y
       end
     end
   end

data/lib/ecdsa/ext/version.rb

@@ -2,6 +2,6 @@
 
 module ECDSA
   module Ext
-    VERSION = "0.1.1"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecdsa_ext
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - azuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-25 00:00:00.000000000 Z
+date: 2023-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ecdsa