x25519 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e14a38927066f9bf0bb89efc17aa433b42d3fbd
-  data.tar.gz: 7ccda465a96b34ada8f593b1461861a72f2ec253
+  metadata.gz: ea3f150ae564aadb87e3bb463b2f4b7d8d8756b9
+  data.tar.gz: be24c272b97043d3f1385def5543fca88b9ff859
 SHA512:
-  metadata.gz: 0540a115042091e9bd19b45db8b44fa3e0453720ed5d03cb0379e217ebe7a75b784df3510118820fe4e5277de369dfb3c095b1bb4f57975aa2876dff3445be39
-  data.tar.gz: 3b230f900fac4f7b183b62a7e53c2385b9e7581fc39ded633a8f0e766f68a5f06805421b0c16f7cb38cad14ed430659a4eed845f8cee02ecfab6aa0ef2e0f78e
+  metadata.gz: 2b598f77e90d1fafbcb0b820d29966ba259a68c3bc1b44674f955a6ccbf010c30a8cc4339321bb55ddc3d27b3b3bce5e19ff1b4540855ee81235e8a55bf85675
+  data.tar.gz: 577ed0233e0a4a73452798c344531df9fbb498625c85526c02ca6658782559dce24538574b23a8eafb2f5adaf500331243ebd0a29dfb80a5bef6c03ee264c2e8

data/CHANGES.md

@@ -1,3 +1,9 @@
+# [1.0.1] (2017-12-12)
+
+[1.0.1]: https://github.com/cryptosphere/x25519/compare/v1.0.0...v1.0.1
+
+* Have `X25519.self_test` return true on success
+
 # [1.0.0] (2017-12-12)
 
 [1.0.0]: https://github.com/cryptosphere/x25519/compare/v0.2.0...v1.0.0

data/README.md

@@ -70,68 +70,66 @@ bob_secret = bob_sk.diffie_hellman(alice_pk).to_bytes
 alice_secret == bob_secret # true
 ```
 
-## API
-
-### `X25519::Scalar`: private keys
+## X25519::Scalar: private keys
 
 The `X25519::Scalar` class represents secret integers used as X25519 private
 keys. These secret integers are multiplied by a well-known base point to
 obtain X25519 public keys (`X25519::MontgomeryU`).
 
-#### `X25519::Scalar.generate()`: make a random private key
+### `X25519::Scalar.generate()`: make a random private key
 
 Generate a random private scalar (using `SecureRandom`)
 
-##### Example
+**Example:**
 
 ```ruby
 secret_key = X25519::Scalar.generate
 ```
 
-#### `X25519::Scalar.new(bytes)`: load existing private key
+### `X25519::Scalar.new(bytes)`: load existing private key
 
 * `bytes`: a 32-byte `String` value containing the private key
 
-##### Example
+**Example:**
 
 ```ruby
 secret_key = X25519::Scalar.new(File.read("alice.key"))
 ```
 
-#### `X25519::Scalar#public_key()`: obtain public key for this scalar
+### `X25519::Scalar#public_key()`: obtain public key for this scalar
 
 NOTE: The `#multiply_base` method is an alias of this one.
 
 Performs fixed-base scalar multiplication (i.e. calculates public key)
 
-##### Return Value
+**Return Value:**
 
 Returns a `X25519::MontgomeryU` object which represents the public key for this private key/scalar.
 
-##### Example
+**Example:**
 
 ```ruby
 secret_key = X25519::Scalar.generate
 public_key = secret_key.public_key
 ```
 
-#### `X25519::Scalar#diffie_hellman(other_public_key)`: obtain public key for this scalar
+### `X25519::Scalar#diffie_hellman(other_public_key)`: obtain public key for this scalar
 
 NOTE: The `#multiply` method is an alias of this one.
 
 Performs variable-base scalar multiplication, computing a shared secret between
 our private scalar and someone else's public key/point.
 
-##### Return Value
-
-Returns a `X25519::MontgomeryU` object which represents the shared secret.
-
-##### Arguments
+**Arguments:**
 
 * `other_public_key`: a `X25519::MontgomeryU` object containing the public key
   with which we'd like to compute a shared secret.
 
-##### Example
+**Return Value:**
+
+Returns a `X25519::MontgomeryU` object which represents the shared secret.
+
+**Example:**
 
 ```ruby
 secret_key = X25519::Scalar.generate
@@ -144,63 +142,63 @@ shared_secret = secret_key.multiply(public_key)
 shared_secret_bytes = shared_secret.to_bytes
 ```
 
-#### `X25519::Scalar#to_bytes`: serialize a scalar as a `String`
+### `X25519::Scalar#to_bytes`: serialize a scalar as a `String`
 
-##### Return Value
+**Return Value:**
 
 Returns a `String` containing a byte representation of this scalar:
 
-##### Example
+**Example:**
 
 ```ruby
 secret_key = X25519::Scalar.new(...)
 File.write("alice.key", secret_key.to_bytes)
 ```
 
-### `X25519::MontgomeryU`: public keys and shared secrets
+## X25519::MontgomeryU: public keys and shared secrets
 
 The `X25519::MontgomeryU` class represents a coordinate (specifically a
 Montgomery-u coordinate) on the elliptic curve. In the X25519 Diffie-Hellman
 function, these serve both as public keys and as shared secrets.
 
-#### `X25519::MontgomeryU.new(bytes)`: load existing public key
+### `X25519::MontgomeryU.new(bytes)`: load existing public key
 
-##### Arguments
+**Arguments:**
 
 * `bytes`: a 32-byte `String` value containing the public key
 
-##### Example
+**Example:**
 
 ```ruby
 public_key = X25519::MontgomeryU.new(File.read("bob.pub"))
 ```
 
-#### `X25519::MontgomeryU#to_bytes`: serialize a Montgomery-u coordinate as a `String`
+### `X25519::MontgomeryU#to_bytes`: serialize a Montgomery-u coordinate as a `String`
 
-##### Return Value
+**Return Value:**
 
 Returns a `String` containing a byte representation of a compressed Montgomery-u coordinate:
 
-##### Example
+**Example:**
 
 ```ruby
 public_key = X25519::MontgomeryU..new(...)
 File.write("bob.pub", public_key.to_bytes)
 ```
 
-### `X25519`: module-level functionality
+## X25519: module-level functionality
 
-#### `X25519.diffie_hellman(secret_key, public_key)`: shorthand `String`-oriented API
+### `X25519.diffie_hellman(secret_key, public_key)`: shorthand `String`-oriented API
 
 If you'd like to avoid the object-oriented API, you can use a simplified API which
 acts entirely on bytestrings.
 
-##### Arguments
+**Arguments:**
 
 * `secret_key`: a 32-byte `String` containing a private scalar
 * `public_key`: a 32-byte `String` containing a compressed Montgomery-u coordinate
 
-##### Return Value
+**Return Value:**
 
 Returns a `String` containing a 32-byte compressed Montgomery-u coordinate
 

data/lib/x25519.rb

@@ -63,6 +63,8 @@ module X25519
       public_key = provider.scalarmult_base([v.scalar].pack("H*"))
       raise "self test failed!" unless public_key.unpack("H*").first == v.output_coord
     end
+
+    true
   end
 end
 

data/lib/x25519/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module X25519
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: x25519
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Tony Arcieri