sr25519 0.4.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4410fbe296d51933ad70ac7d650dc3f284415679a202bbd31a8b241ecc197aa5
-  data.tar.gz: 240b6a8ded57e70fb19ff1a9cb827feea667db6b8f94043a1df3e36f3c475f3f
+  metadata.gz: f850eb36c7764e13d17631a64774c526e4358d6943d22148e8fe73ef3dc4fba1
+  data.tar.gz: 23599472953b497a43cd86b4f3352315bb5b5fca9b8ee26fead4c8f3ee50a672
 SHA512:
-  metadata.gz: dfb7ca72c9d855583601be1a6dd6aafa49b1ff79bf372dcf52a65d848b4ee708263dd2644570d6fbc14f20dbea98c75721c03c42c40330f51c67972039ce0367
-  data.tar.gz: ab2ecfcc66ea295b22fd933edaadeae188801ca0d18b856351eead3ae30fa0c511f5cd29184926e79d7ce440e189693fc9928ad049899d1386f040a899d8c6e2
+  metadata.gz: 868da7d03a1d747a65d093704c160f37e61714aa273f186da73ed38587ccd08bbfbc20df40e2d6344ee2d305a2f83f7d6e1876fe4ed5433dd60faf8ec53a5962
+  data.tar.gz: 97679a83b7680568aaf8a709ce165fd24af6e048e114b4a43b75c06971abf5eedbfb2ac0aa717e3ac50f4df9c3cdc8440149ac08b75f9f7f835eaed6262ca4bd

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    sr25519 (0.4.0)
+    sr25519 (0.8.0)
       base58
       blake2b
+      ed25519 (~> 1.2, >= 1.2.4)
 
 GEM
   remote: https://rubygems.org/
@@ -11,6 +12,7 @@ GEM
     base58 (0.2.3)
     blake2b (0.10.0)
     diff-lcs (1.4.4)
+    ed25519 (1.2.4)
     ffi (1.15.4)
     rake (13.0.6)
     rspec (3.10.0)

data/README.md

@@ -22,21 +22,21 @@ Or install it yourself as:
 
 ## Usage
 
-1. Require ed25519.rb in your Ruby program:
+#### 1. Require ed25519.rb in your Ruby program:
 ```ruby
 require "sr25519"
 ```
 
-2.  Generate keypair
+#### 2. SR25519 Generate keypair
 
 ```ruby
 # seed is priviate key, is a hex string.
-# example: SR25519.sr25519_keypair_from_seed("0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e")
-keypaire = SR25519.sr25519_keypair_from_seed(seed)
+# example: SR25519.keypair_from_seed("0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e")
+keypair = SR25519.keypair_from_seed(seed)
 
 ```
 
-3. Generate public_key
+#### 3. SR25519 Generate public_key
 
 ```ruby
 public_key = SR25519.get_public_key_from_seed(seed)
@@ -46,30 +46,58 @@ public_key_str = public_key.to_s
 
 ```
 
-4. Encode address
+#### 4. Encode address
 ```ruby
 address = Address.encode(public_key.to_s)
 ```
 
-5. Decode address
+#### 5. Decode address
 
 ```ruby
-address = Address.decode(address)
+public_key_str = Address.decode(address)
 ```
 
-6. Sign message
+#### 6. SR25519 Sign message
 
 ```ruby
+# message = "Hello World"
 signature_result = SR25519.sign(message, keypair)
 
 ```
 
-7. Verify message
+#### 7. SR25519 Verify message
 
 ```ruby
-SR25519.verify(address, message, signature_result)
+verify_result = SR25519.verify(address, message, signature_result)
 ```
 
+#### 8.  ED25519 Generate keypair
+
+```ruby
+keypair = ED25519.keypair_from_seed(seed)
+```
+
+#### 9.  ED25519 Sign message
+
+```ruby
+signature_result = ED25519.sign(message, keypair)
+```
+
+#### 10. ED25519 Get public key
+
+```ruby
+pulick_key_str = ED25519.get_public_key_from_seed(seed)
+```
+
+#### 11. ED25519 Verify message
+
+```ruby
+# public_key_str = ED25519.get_public_key_from_seed(seed)
+# address = Address.encode(public_key_str)
+verify_result = ED25519.verify(address, message, signature_result)
+```
+
+
 ## Running tests
 1. Run all tests
 

data/lib/address.rb

@@ -1,7 +1,30 @@
+
+# The MIT License (MIT)
+
+# Copyright (c) 2019 Wu Minzhe
+
+# 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.
+
 require 'base58'
 require 'blake2b'
 
- # The code is copy from https://github.com/itering/scale.rb/blob/develop/lib/common.rb
+# The code is copy from https://github.com/itering/scale.rb/blob/develop/lib/common.rb
 class Address
     SS58_PREFIX = 'SS58PRE'
   

data/lib/ed25519_lib.rb

@@ -0,0 +1,77 @@
+require "ed25519"
+class ED25519
+  
+  # Sign the given message
+  # @param message [String] the message
+  # @param key_pair [Class] ED25519 keypair
+  # @return [String] sign result as a hex string
+  # @example
+  #   message = "Hello world"
+  #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   keypair = ED25519.keypair_from_seed(seed)
+  #   signature_result = ED25519.sign(message, keypair)
+
+  def self.sign(message, key_pair)
+    "0x" + key_pair.sign(message).unpack1("H*")
+  end
+
+  ##
+  # Verify the sign result
+  # @param message [String] the message
+  # @param key_pair [Class] ED25519 keypair
+  # @return [String] sign result as a hex string
+  # @example
+  #   message = "Hello world"
+  #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   public_key = ED25519.get_public_key_from_seed(seed)
+  #   address = Address.encode(public_key)
+  #   keypair = ED25519.keypair_from_seed(seed)
+  #   signature_result = ED25519.sign(message, keypair)
+  #   verify_result = ED25519.verify(address, message, signature_result)
+
+  def self.verify(address, message, signature_result)
+    if signature_result.start_with?("0x")
+      signature_result = signature_result.sub(/0x/, "")
+    end
+    signature = [signature_result].pack("H*")
+    public_key = Address.decode(address)
+    verify_key_bytes = [public_key].pack("H*")
+    verify_key  = Ed25519::VerifyKey.new(verify_key_bytes)
+    begin
+      verify_key.verify(signature, message)
+    rescue
+      return false
+    end
+  end
+
+  ##
+  # Generate ED25519 keypair
+  # @param seed [String] private key
+  # @return [Class] ED25519 keypair
+  # @example
+  #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   keypair = ED25519.keypair_from_seed(seed)
+
+  def self.keypair_from_seed(seed)
+    if seed.start_with?("0x")
+      seed = seed.sub(/0x/, "")
+    end
+    seed = "".tap { |binary| seed.scan(/../) { |hn| binary << hn.to_i(16).chr } }
+    signing_key = Ed25519::SigningKey.new(seed)
+    return signing_key
+  end
+
+  ##
+  # Get ED25519 public key
+  # @param seed [String] private key
+  # @return [String] public key
+  # @example
+  #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   public_key = ED25519.get_public_key_from_seed(seed)
+
+  def self.get_public_key_from_seed(seed)
+    signing_key = self.keypair_from_seed(seed)
+    return signing_key.verify_key.to_bytes.unpack1('H*')
+  end
+
+end

data/lib/sr25519/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sr25519
-  VERSION = "0.4.0"
+  VERSION = "0.8.0"
 end

data/lib/sr25519.rb

@@ -3,6 +3,7 @@
 require_relative "sr25519/version"
 require "address"
 require "sr25519_lib"
+require "ed25519_lib"
 
 module Sr25519
   class Error < StandardError; end

data/lib/sr25519_lib.rb

@@ -5,7 +5,6 @@ module SR25519Lib
  
   ffi_lib FFI::Library::LIBC
 
-  # The library is compile from https://github.com/Warchant/sr25519-crust
   ffi_lib File.dirname(__FILE__) + '/libsr25519crust.so' if RUBY_PLATFORM =~ /linux/
   ffi_lib File.dirname(__FILE__) + '/libsr25519crust.dylib' if RUBY_PLATFORM =~ /darwin/
 
@@ -19,6 +18,8 @@ class KeyPair < FFI::Struct
   # [32b key | 32b nonce | 32b public]
   layout :String, [:uint8, 96]
 
+  ##
+  # Return the keypair public key
   def public_key
     pub_key = self[:String].to_a[64..96]
     public_key = PublicKey.new
@@ -55,6 +56,8 @@ end
 class SigMessage < FFI::Struct
   layout :String, [:uint8, 64]
 
+  ##
+  # Return the sign message as hex string
   def to_s
     self[:String].to_a.pack("c*").unpack1("H*")
   end
@@ -62,17 +65,32 @@ end
 
 class SR25519
 
+  # Sign message result
+  # @param message [String] message
+  # @param private_key [String] private_key
+  # @return [String] sign result
+  # @example
+  #   message = "Hello World"
+  #   private_key = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   signature_result = SR25519.sr25519_sign(message, private_key)
   def self.sr25519_sign(message, private_key)
     sig = SigMessage.new
     msg = FFI::MemoryPointer.from_string(message)
-    key_pair = self.sr25519_keypair_from_seed(private_key)
+    key_pair = self.keypair_from_seed(private_key)
     public_key = key_pair.public_key
     SR25519Lib.sr25519_sign(sig, public_key, key_pair, msg, message.length)
     sig.to_s
   end
 
-
-  # Creates a signature for given data
+  # Sign message result
+  # @param message [String] message
+  # @param key_pair [KeyPair] Sr25519 keypair
+  # @return [String] sign result
+  # @example
+  #   message = "Hello World"
+  #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   keypair = SR25519.keypair_from_seed(seed)
+  #   signature_result = SR25519.sign(message, keypair)
   def self.sign(message, key_pair)
     sig = SigMessage.new
     msg = FFI::MemoryPointer.from_string(message)
@@ -81,6 +99,19 @@ class SR25519
     sig.to_s
   end
 
+  # Verify the sign result
+  # @param address [String] account address
+  # @param message [String] message
+  # @param signature_result [String] Sr25519 sign result
+  # @return [boolean] sign result
+  # @example
+  #   message = "Hello World"
+  #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   keypair = SR25519.keypair_from_seed(seed)
+  #   public_key = SR25519.get_public_key_from_seed(seed)
+  #   address = Address.encode(public_key.to_s)
+  #   signature_result = SR25519.sign(message, keypair)
+  #   verify_result = SR25519.verify(address, message, signature_result)
   def self.verify(address, message, signature_result)
     pk = PublicKey.new
     public_key = self.decode_address(address)
@@ -97,7 +128,13 @@ class SR25519
     verify = SR25519Lib.sr25519_verify(sig, msg, message.size, pk)
   end
 
-  def self.sr25519_keypair_from_seed(seed)
+  # Generate SR25519 keypair
+  # @param seed [String] private key
+  # @return [KeyPair] SR25519 keypair
+  # @example
+  #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   keypair = SR25519.keypair_from_seed(seed)
+  def self.keypair_from_seed(seed)
     if seed.start_with?("0x")
       seed = seed.sub(/0x/, "")
     end
@@ -109,11 +146,26 @@ class SR25519
     return key_pair
   end
 
+  # Get SR25519 public key
+  # @param seed [String] private key
+  # @return [String] public key
+  # @example
+  #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   public_key = SR25519.get_public_key_from_seed(seed)
   def self.get_public_key_from_seed(seed)
-    key_pair = self.sr25519_keypair_from_seed(seed)
+    key_pair = self.keypair_from_seed(seed)
     key_pair.public_key
   end
 
+  # Get SR25519 public key
+  # @param address [String] account address
+  # @param addr_type [Interger] address type
+  # @return [String] public key
+  # @example
+  #   seed = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e"
+  #   public_key = SR25519.get_public_key_from_seed(seed)
+  #   address = Address.encode(public_key.to_s)
+  #   public_key = SR25519.decode_address(address)
   def self.decode_address(address,addr_type=42)
     public_address = Address.decode(address,addr_type)
   end

data/sr25519.gemspec

@@ -28,11 +28,14 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.extra_rdoc_files = [
+    "README.md"
+  ]
 
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_dependency "blake2b"
   spec.add_dependency "base58"
   spec.add_development_dependency "ffi", "~> 1.15.0"
-
+  spec.add_dependency "ed25519", '~> 1.2', '>= 1.2.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sr25519
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.8.0
 platform: ruby
 authors:
 - xuxh
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-12 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,12 +80,33 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.15.0
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.4
 description: Sign and verify message with sr25519
 email:
 - xxh2611@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
@@ -100,6 +121,7 @@ files:
 - bin/console
 - bin/setup
 - lib/address.rb
+- lib/ed25519_lib.rb
 - lib/libsr25519crust.dylib
 - lib/libsr25519crust.so
 - lib/sr25519.rb