rsa-tools 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65968de63d290da2bd846edecf503aa38d5e6376b24febd522b243af6ef9d0aa
-  data.tar.gz: 89f43d09a673470842ef3adc722d79f7b4681a7097b1dd0a10c0a9157fb1c066
+  metadata.gz: 87c32d05e60ad507b21efc98df0e21d84bec0f03a305f8843a32b60a1ebdddd0
+  data.tar.gz: 0e991bc21db0d654d622c509a6c6a5ee39d001187e793bdfed8c1535bb006a26
 SHA512:
-  metadata.gz: 5d448f1b8f20eca0ca7df34deec0c2ccf65eeb39d864d5000b8daa12ec724fc4a293c96006be656ace8367f44b3eaa0e5a9fb6251689ea5149e33311c4efaed5
-  data.tar.gz: 6ef7a1ba0433997b194006c250cea82d346598a73ae07387ad685d9e21088a6284f33202ea3cc04b68d6592694232593cc7ab1ec4583632d67277eedb2cdc276
+  metadata.gz: '092306579ed871ef15eea6a2be9e0c467656668f769941b915e71503e25a094588cb6031138081d6b8f12eb638a79ed7a931ea06070c8a0fd957134b063ffbb8'
+  data.tar.gz: 8d19aca66995578c280ba8bca24f1cf497e961eaf2a9f74f7e02a2a6f0da3a2aa859b8c9c9c37cf4d452d418a5888e2b7b1b04d71720c20b5f1d6727f4d45a24

data/.gitignore

@@ -6,6 +6,10 @@
 /pkg/
 /spec/reports/
 /tmp/
+/keys/public_key.pem
+/keys/private_key.pem
+
+*.gem
 
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -1,8 +1,6 @@
 # Rsa::Tools
 
-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/rsa/tools`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This Gem offered 8 frequently uesed methods for Sign & Verify & Encrypt & Decrypt with RSA.
 
 ## Installation
 
@@ -22,7 +20,57 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+I offered 3 pairs of methods and 2 generator method in this tool
+
+#### 2 Generator method
+
+* `Rsa::Tools#key_pairs` 
+
+```ruby
+# This method will return an array of text, the first text string is private_key and the last text is public_key
+
+Rsa::Tools.key_pairs
+```
+
+* `Rsa::Tools#pem_pairs(pub_path = nil, pri_path = nil)`
+
+```ruby
+# This method intend to offer you pems of key pairs, the first param is the path you want to store your private key
+# And the default path is keys/private_key.pem & keys/public_key.pem
+# Use the default path is my advice
+
+Rsa::Tools.pem_pairs
+```
+
+#### 3 pairs of methods
+
+* `Sign & Verify`
+
+```ruby
+# This pair of method offer the ablity to verify the source of data
+# The returned signature were encoded by Base64
+
+Rsa::Tools.sign(private_key, data)                 # this returns the signature
+Rsa::Tools.verify(public_key, data, original_data) # this returns true or false
+```
+
+* `Encrypt & Decrypt`
+
+```ruby
+# I advice you use this pair while your user do not need have his own private_key (ToC)
+
+Rsa::Tools.encrypt(private_key, data)       # this returns the encrypted string
+Rsa::Tools.decrypt(public_key, encrypted)   # this returns the original data
+```
+
+* `PubEncrypt & PriDecrypt`
+
+```ruby
+# I advice you use this pair while your user should offer his public key to you (Which means ToB)
+
+Rsa::Tools.pub_encrypt(public_key, data)         # this returns the encrypted string
+Rsa::Tools.pri_decrypt(private_key, encrypted)   # this returns the original data
+```
 
 ## Development
 
@@ -32,7 +80,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rsa-tools. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at [Here](https://github.com/w-zengtao/rsa-tools). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +88,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Rsa::Tools project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rsa-tools/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Rsa::Tools project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/w-zengtao/rsa-tools/blob/master/CODE_OF_CONDUCT.md).

data/lib/rsa/tools.rb

@@ -4,23 +4,38 @@ require "rsa/tools/generator"
 
 module Rsa::Tools
   # 验签 & 用对方的公钥验签
-  def self.verify(public_key, data)
+  def self.verify(public_key, data, original_data)
+    Utility.verify(public_key, data, original_data)
   end
 
   # 签名 & 用自己私钥签名 & RSAWithSha256 的签名
   def self.sign(private_key, data)
-    pri_key = OpenSSL::PKey::RSA.new private_key
+    Utility.sign(private_key, data)
   end
 
-  def self.key_pairs
-    return Generator.key_pairs
+  # TO C的业务 & 私钥加密 公钥解密
+  def self.encrypt(private_key, data)
+    Utility.encrypt(private_key, data)
+  end
+
+  def self.decrypt(public_key, encrypted)
+    Utility.decrypt(public_key, encrypted)
+  end
+
+  # TO B的业务 & 公钥加密 私钥解密
+  def self.pub_encrypt(public_key, data)
+    Utility.pub_encrypt(public_key, data)
+  end
+
+  def self.pri_decrypt(private_key, encrypted)
+    Utility.pri_decrypt(private_key, encrypted)
   end
 
-  def self.pem_pairs(pub_path = nil, pri_path = nil)
-    
+  def self.key_pairs
+    return Generator.key_pairs
   end
 
-  def self.test 
-    Utility.new.test
+  def self.pem_pairs(pri_path = nil, pub_path = nil)
+    return Generator.pem_pairs(pri_path, pub_path)
   end
 end

data/lib/rsa/tools/generator.rb

@@ -2,7 +2,7 @@ require 'openssl'
 
 module Rsa::Tools
   class Generator
-    
+
     # call this function if you just want to save it to your database & send string to others
     def self.key_pairs
       private_key, public_key = generate_pairs
@@ -10,7 +10,7 @@ module Rsa::Tools
     end
 
     # call this function if pem files were wanted
-    def self.pem_pairs(pub_path = nil, pri_path = nil)
+    def self.pem_pairs(pri_path = nil, pub_path = nil)
       private_key, public_key = generate_pairs
       open 'keys/private_key.pem', 'w' do |io| io.write private_key.to_pem end
       open 'keys/public_key.pem',  'w' do |io| io.write public_key.to_pem  end
@@ -22,4 +22,4 @@ module Rsa::Tools
         return pri_key, pri_key.public_key
       end
   end
-end
+end

data/lib/rsa/tools/utility.rb

@@ -1,16 +1,40 @@
+require "base64"
+
 module Rsa::Tools
   class Utility
 
     #  我们是服务端的时候验证别人的请求的时候用这个方法
-    def verify(public_key, data)
+    def self.verify(public_key, data, original_data)
+      key = OpenSSL::PKey::RSA.new(public_key)
+      key.verify(OpenSSL::Digest::SHA256.new, Base64.decode64(data), Digest::MD5.hexdigest(original_data.force_encoding("utf-8")))
     end
 
     # 三方要求我们私钥加签的时候调用这方法签名
-    def sign(private_key, data)
+    def self.sign(private_key, data)
+      key = OpenSSL::PKey::RSA.new(private_key)
+      sign = key.sign(OpenSSL::Digest::SHA256.new, Digest::MD5.hexdigest(data.force_encoding("utf-8")))
+      Base64.strict_encode64(sign)
+    end
+
+    def self.encrypt(private_key, data)
+      key = OpenSSL::PKey::RSA.new(private_key)
+      return Base64.strict_encode64(key.private_encrypt(data))
+    end
+
+    def self.decrypt(public_key, encrypted)
+      key = OpenSSL::PKey::RSA.new(public_key)
+      return key.public_decrypt(Base64.decode64(encrypted))
+    end
+
+
+    def self.pub_encrypt(public_key, data)
+      key = OpenSSL::PKey::RSA.new(public_key)
+      return Base64.strict_encode64(key.public_encrypt(data))
     end
 
-    def test
-      puts "abc"
+    def self.pri_decrypt(private_key, encrypted)
+      key = OpenSSL::PKey::RSA.new(private_key)
+      return key.private_decrypt(Base64.decode64(encrypted))
     end
   end
-end
+end

data/lib/rsa/tools/version.rb

@@ -1,5 +1,5 @@
 module Rsa
   module Tools
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsa-tools
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - 我天真无邪
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-15 00:00:00.000000000 Z
+date: 2018-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler