secret_sharing 0.0.4 → 0.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGRmOTk3Y2EyYTJhY2FiODk2YWYwODNlNWZlMzI5ZTJlY2M0MDk3Yg==
+    YjQ4ZTU3ZjUxMDRlNWUxNGQ2MDJlYzg2OWQyYTY1NzliNjFjM2Q4ZA==
   data.tar.gz: !binary |-
-    ZTVkODUxZjRkMGUzZWYyMzRkYzFiNTYyNWU2OWUyMzJjYzhkNjU3OA==
+    ZTljYjJkOTc0MDEzOGU0OTlkNTNjYWM4ZGNjZmEyMjE1NjlhMjYxZg==
 SHA512:
   metadata.gz: !binary |-
-    MjY5OTQ3ZTU4NjA1MzhkMmY0MzkwM2U0NTVkYmJjOTg3MDMyZjIyNmUwZWUw
-    OGRmZDAzZWFjYzBiMDlkNzdhZmMyMjU5N2Y5MzNmOTA3ZTc2YTY3Zjg4ZDFk
-    NDRhYmZmZTc4NjFkY2FlOGRlZmQ1ZmZhZjdjOGI5MmRjYWE5NGM=
+    MTA2ZGYxZWIyNjRiNDMxYjhmOWE5YmNmNTg2MDY3Y2YyYTJkYzk3NzZhNWU3
+    ZDM5MmUzZTFmOGEwMTAzZTNlOGNmMDYxMjk1YWUzMzYyZmE1ZTkzNDRiNTNl
+    ZDhiMDFlMmZiNjY1M2YyMDVmM2Q3MzI1MzJiZjMzNGZhYzc1NDY=
   data.tar.gz: !binary |-
-    Y2YwZjQ1YjVjMGJlOGU2YzVlZTA4NTJhZWEzMDFiYjRlNzU0NGQ1M2ViNjZj
-    NTQ0MTc4NjNmYjI1NWIyNTkwOWYzYmE2ZjBkOGRhMDQ3MTdjZTk2Zjk0YmY4
-    NTEyYzg1NzU2NDhkN2YwMTE2ZGQ0ZjE5MzY2Y2U1NjQ1ZTQ0MTQ=
+    MTY5OTlmOTZmZDg2ODlhMjU3NzMxZWZmOTExZWEwMmVkYWI2OWU5MTEwZTYw
+    MTcwNTEzM2I3MGMyM2U2NjYyYWQxOTVhYmQzMjZiMGM5YTJhMWJmNjA1MWJi
+    OGU0YTZjOTRkMDdkNDNjOTU2OWJmZDRlZjE4Yjg4YzI4OTViMmY=

data/README.md

@@ -9,7 +9,8 @@
 > **Warning:** This implementation has not been tested in production nor has it
 > been examined by a security audit. All uses are your own responsibility.
 
-A ruby implementation of shamir's secret sharing.
+A ruby implementation of [Shamir's Secret
+Sharing](http://en.wikipedia.org/wiki/Shamir%27s_Secret_Sharing).
 
 ## Installation
 
@@ -27,8 +28,8 @@ Or install it yourself as:
 
 ## Implementation details
 
-This implementation of shamir's secret sharing has initially been developed to
-be used in [duse](https://duse.io/), however, it is designed to be used in any
+This implementation of Shamir's Secret Sharing has initially been developed to
+be used in [duse](http://duse.io/), however, it is designed to be used in any
 other context just as well.
 
 The representation of a share is simply `x-hex(y)`. We chose this

data/lib/secret_sharing.rb

@@ -15,7 +15,7 @@ module SecretSharing
   #
   # Example
   #
-  #   SecretSharing.split_secret('secret', 2, 3)
+  #   SecretSharing.split('secret', 2, 3)
   #   # => ["1-1e489c32507823aa", "2-1c9134c644739461", "3-1ad9cd5a386f0518"]
   #
   # @param secret_string [String] Secret to split.
@@ -23,7 +23,7 @@ module SecretSharing
   # @param num_shares [Integer] Total number of shares to generate.
   #
   # @return [Array] Array of shares that can be used to recover the secret.
-  def split_secret(secret_string, share_threshold, num_shares)
+  def split(secret_string, share_threshold, num_shares)
     secret_int = Charset::ASCIICharset.s_to_i(secret_string)
     points = Polynomial.points_from_secret(secret_int,
                                            share_threshold,
@@ -35,17 +35,17 @@ module SecretSharing
   end
 
   # Recover a secret with an array of string shares generated with
-  # {#split_secret}.
+  # {#split}.
   #
   # Example
   #
-  #   SecretSharing.recover_secret ["1-1e489c32507823aa", "2-1c9134c644739461"]
+  #   SecretSharing.reconstruct ["1-1e489c32507823aa", "2-1c9134c644739461"]
   #   # => "secret"
   #
   # @param raw_shares [Array] Shares (array of strings) to recover the secret
   #
   # @return [String] Recovered secret in a string representation.
-  def recover_secret(raw_shares)
+  def reconstruct(raw_shares)
     shares = raw_shares.map { |raw_share| Share.from_string raw_share }
     points = shares.map(&:point)
     secret_int = Polynomial.modular_lagrange_interpolation(points)

data/lib/secret_sharing/version.rb

@@ -1,4 +1,4 @@
 module SecretSharing
   # gem version
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/spec/secret_sharing_spec.rb

@@ -5,41 +5,41 @@ RSpec.describe SecretSharing do
     50.times do
       secret = SecureRandom.base64(130)
       num_of_shares = 2 + SecureRandom.random_number(100)
-      shares = SecretSharing.split_secret(secret, 2, num_of_shares)
-      expect(SecretSharing.recover_secret(shares[0..1])).to eq(secret)
+      shares = SecretSharing.split(secret, 2, num_of_shares)
+      expect(SecretSharing.reconstruct(shares[0..1])).to eq(secret)
     end
   end
 
   context 'threshold 2 out of 4 shares' do
-    subject(:shares) { SecretSharing.split_secret('secret', 2, 4) }
+    subject(:shares) { SecretSharing.split('secret', 2, 4) }
 
     it 'generates 4 shares' do
       expect(shares.length). to eq 4
     end
 
     it 'cannot reconstruct with only one share' do
-      expect(SecretSharing.recover_secret(shares[0, 1])).not_to eq 'secret'
+      expect(SecretSharing.reconstruct(shares[0, 1])).not_to eq 'secret'
     end
 
     it 'can reconstruct the secret with any combination of 2 shares' do
       shares.permutation(2).each do |share_combination|
-        expect(SecretSharing.recover_secret(share_combination)).to eq 'secret'
+        expect(SecretSharing.reconstruct(share_combination)).to eq 'secret'
       end
     end
 
     it 'can reconstruct the secret with any combination of 3 shares' do
       shares.permutation(3).each do |share_combination|
-        expect(SecretSharing.recover_secret(share_combination)).to eq 'secret'
+        expect(SecretSharing.reconstruct(share_combination)).to eq 'secret'
       end
     end
 
     it 'can reconstruct the secret with all shares' do
-      expect(SecretSharing.recover_secret(shares)).to eq 'secret'
+      expect(SecretSharing.reconstruct(shares)).to eq 'secret'
     end
   end
 
   context 'threshold 2 out of 11 shares' do
-    subject(:shares) { SecretSharing.split_secret('secret', 2, 11) }
+    subject(:shares) { SecretSharing.split('secret', 2, 11) }
 
     it 'adds zero padding for shares 1 to 9' do
       shares[0, 9].each_with_index do |share, index|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: secret_sharing
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - flower-pot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-25 00:00:00.000000000 Z
+date: 2015-05-03 00:00:00.000000000 Z
 dependencies: []
 description: Split and reconstruct secrets using the shamir's secret sharing algorithm
 email: