x25519-termux 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee5eb8bfcee462043f9c9c8aef984036bd5b34ce725773daa3059a15c816aeaa
+  data.tar.gz: 7c7999df6f486669061284c5a6b5effd1db5fc79d84de6805b9621b5b261a25e
+SHA512:
+  metadata.gz: d85751d67074a4505ad6804f0828b9ef550d6e83170c12d8800f9d24ad5040994d38add58b07448f81f2c8e4829c274cff87487d6f0f3aad5cfc52f71371d5e7
+  data.tar.gz: 9995df92c30c9db2362aa1af1ee0a931ca91fa3bd6b1b1a2bfd019f573804ad4f8ccdb3249b1fde4444db2c31c53994a0c34115f3f43f1aff78c7e2231cdae05

data/.gitignore

@@ -0,0 +1,15 @@
+/Gemfile.lock
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.o
+*.so
+*.bundle
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,5 @@
+--color
+--format documentation
+--order random
+--warnings
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,38 @@
+AllCops:
+  TargetRubyVersion: 2.2
+  DisplayCopNames: true
+
+#
+# Metrics
+#
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/BlockLength:
+  Max: 100
+
+Metrics/ClassLength:
+  Max: 100
+
+Metrics/LineLength:
+  Max: 128
+
+Metrics/MethodLength:
+  Max: 25
+
+#
+# Style
+#
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+cache: bundler
+
+before_install:
+  - gem update --system
+  - gem --version
+  - gem install bundler -v 1.16.1
+  - bundle --version
+
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4.3
+  - 2.5.0
+
+matrix:
+  fast_finish: true
+
+branches:
+  only:
+    - master

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at bascule@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem "coveralls", require: false
+  gem "rake", require: false
+  gem "rake-compiler", "~> 1.0", require: false
+  gem "rspec", "~> 3.7", require: false
+  gem "rubocop", "0.52.1", require: false
+end

data/LICENSE

@@ -0,0 +1,32 @@
+BSD-3 License.
+
+Copyright (c) 2017, Armando Faz <armfazh@ic.unicamp.br>. All rights reserved.
+Institute of Computing.
+University of Campinas, Brazil.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+ * Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above
+   copyright notice, this list of conditions and the following
+   disclaimer in the documentation and/or other materials provided
+   with the distribution.
+ * Neither the name of University of Campinas nor the names of its
+   contributors may be used to endorse or promote products derived
+   from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,301 @@
+# x25519.rb [![Latest Version][gem-shield]][gem-link] [![Build Status][build-image]][build-link] [![Appveyor CI Status][appveyor-image]][appveyor-link] [![Yard Docs][docs-image]][docs-link] [![License: BSD 3-Clause][license-image]][license-link] [![Gitter Chat][gitter-image]][gitter-link]
+
+[gem-shield]: https://badge.fury.io/rb/x25519.svg
+[gem-link]: https://rubygems.org/gems/x25519
+[build-image]: https://travis-ci.org/crypto-rb/x25519.svg?branch=master
+[build-link]: https://travis-ci.org/crypto-rb/x25519
+[appveyor-image]: https://ci.appveyor.com/api/projects/status/4s05bcae0mow85v1?svg=true
+[appveyor-link]: https://ci.appveyor.com/project/tarcieri/x25519
+[docs-image]: https://img.shields.io/badge/yard-docs-blue.svg
+[docs-link]: http://www.rubydoc.info/gems/x25519/1.0.6
+[license-image]: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
+[license-link]: https://spdx.org/licenses/BSD-3-Clause.html
+[gitter-image]: https://badges.gitter.im/badge.svg
+[gitter-link]: https://gitter.im/crypto-rb/Lobby
+
+An efficient public key cryptography library for Ruby providing key
+exchange/agreement.
+
+This gem implements X25519 (a.k.a. Curve25519) Elliptic Curve Diffie-Hellman
+function as described in [RFC7748] as a C extension using the
+high performance [rfc7748_precomputed] implementation based on the paper
+[How to (pre-)compute a ladder]
+(with fallback to the ref10 C implementation).
+
+X25519 is one of two notable algorithms implemented atop the Curve25519
+elliptic curve. The [ed25519 gem] is a related project of this one,
+and implements the Ed25519 signature scheme on the twisted Edwards form of
+Curve25519.
+
+[RFC7748]: https://tools.ietf.org/html/rfc7748
+[How to (pre-)compute a ladder]: https://eprint.iacr.org/2017/264
+[rfc7748_precomputed]: https://github.com/armfazh/rfc7748_precomputed
+[ed25519 gem]: https://github.com/crypto-rb/ed25519
+
+### Is it any good?
+
+[Yes.](http://news.ycombinator.com/item?id=3067434)
+
+### What is it useful for?
+
+X25519 is a key exchange/agreement algorithm generally used as a low-level
+building block in cryptographic protocols.
+
+### Can I use X25519 to encrypt things?
+
+Please use [RbNaCl::Box] or the (experimental) [XSTREAM] library if you would
+like to use X25519 for public-key encryption. Otherwise, the X25519 algorithm
+is not directly useful for encryption without a higher-level encryption protocol
+built on top of it.
+
+[RbNaCl::Box]: https://github.com/crypto-rb/rbnacl/wiki/Public-Key-Encryption
+[XSTREAM]: https://github.com/miscreant/xstream
+
+## Help and Discussion
+
+Have questions? Want to suggest a feature or change? Join a discussion group:
+
+* [Crypto.rb Gitter]: web-based chat about Ruby crypto projects including **x25519**.
+* [Crypto.rb Google Group]: join via web or email ([crypto-rb+subscribe@googlegroups.com])
+
+[Crypto.rb Gitter]: https://gitter.im/crypto-rb/Lobby
+[Crypto.rb Google Group]: https://groups.google.com/forum/#!forum/crypto-rb
+[crypto-rb+subscribe@googlegroups.com]: mailto:crypto-rb+subscribe@googlegroups.com?subject=subscribe
+
+## Requirements
+
+**x25519.rb** is supported on and tested against the following platforms:
+
+* MRI 2.2, 2.3, 2.4, 2.5
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "x25519"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install x25519
+
+## Usage
+
+The example below shows how to perform a full Diffie-Hellman key exchange:
+
+```ruby
+require "x25519"
+
+# Alice generates random scalar (private key)
+alice_sk = X25519::Scalar.generate
+
+# Alice obtains public key for her private key/scalar
+alice_pk = alice_sk.public_key
+
+# Bob generates random scalar (private key)
+# Ostensibly this would be on a different computer somewhere
+bob_sk = X25519::Scalar.generate
+bob_pk = bob_sk.public_key
+
+# Alice can perform Diffie-Hellman with Bob's public key
+alice_secret = alice_sk.diffie_hellman(bob_pk).to_bytes
+
+# Bob can perform Diffie-Hellman with Alice's public key
+bob_secret = bob_sk.diffie_hellman(alice_pk).to_bytes
+
+# The resulting secrets should be the same
+alice_secret == bob_secret # true
+```
+
+## 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
+
+Generate a random private scalar (using `SecureRandom`)
+
+**Example:**
+
+```ruby
+secret_key = X25519::Scalar.generate
+```
+
+### `X25519::Scalar.new(bytes)`: load existing private key
+
+* `bytes`: a 32-byte `String` value containing the private key
+
+**Example:**
+
+```ruby
+secret_key = X25519::Scalar.new(File.read("alice.key"))
+```
+
+### `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:**
+
+Returns a `X25519::MontgomeryU` object which represents the public key for this private key/scalar.
+
+**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
+
+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.
+
+**Arguments:**
+
+* `other_public_key`: a `X25519::MontgomeryU` object containing the public key
+  with which we'd like to compute a shared secret.
+
+**Return Value:**
+
+Returns a `X25519::MontgomeryU` object which represents the shared secret.
+
+**Example:**
+
+```ruby
+secret_key = X25519::Scalar.generate
+public_key = X25519::MontgomeryU.new(File.read("bob.pub"))
+
+# Returns an X25519::MontgomeryU
+shared_secret = secret_key.multiply(public_key)
+
+# Obtain the shared secret as a serialized byte representation
+shared_secret_bytes = shared_secret.to_bytes
+```
+
+### `X25519::Scalar#to_bytes`: serialize a scalar as a `String`
+
+**Return Value:**
+
+Returns a `String` containing a byte representation of this scalar:
+
+**Example:**
+
+```ruby
+secret_key = X25519::Scalar.new(...)
+File.write("alice.key", secret_key.to_bytes)
+```
+
+## 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
+
+**Arguments:**
+
+* `bytes`: a 32-byte `String` value containing the public key
+
+**Example:**
+
+```ruby
+public_key = X25519::MontgomeryU.new(File.read("bob.pub"))
+```
+
+### `X25519::MontgomeryU#to_bytes`: serialize a Montgomery-u coordinate as a `String`
+
+**Return Value:**
+
+Returns a `String` containing a byte representation of a compressed Montgomery-u coordinate:
+
+**Example:**
+
+```ruby
+public_key = X25519::MontgomeryU..new(...)
+File.write("bob.pub", public_key.to_bytes)
+```
+
+## X25519: module-level functionality
+
+### `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:**
+
+* `secret_key`: a 32-byte `String` containing a private scalar
+* `public_key`: a 32-byte `String` containing a compressed Montgomery-u coordinate
+
+**Return Value:**
+
+Returns a `String` containing a 32-byte compressed Montgomery-u coordinate
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/crypto-rb/x25519.
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the [Contributor Covenant](https://contributor-covenant.org)
+code of conduct.
+
+## Implementation Details
+
+This gem contains two implementations of X25519: an optimized assembly
+implementation and a portable C implementation. Implementations are selected
+based on available CPU features.
+
+### [rfc7748_precomputed]: optimized assembly implementation
+
+* Prime field arithmetic is optimized for the 4th and 6th generation of Intel Core processors
+  (Haswell and Skylake micro-architectures).
+* Efficient integer multiplication using MULX instruction.
+* Integer additions accelerated with ADCX/ADOX instructions.
+* Key generation uses a read-only table of 8 KB for X25519.
+
+### ref10: portable C implementation
+
+* Taken from the [SUPERCOP] cryptographic benchmarking suite (supercop-20171020)
+* Portable C code which should compile on any architecture
+
+[SUPERCOP]: https://bench.cr.yp.to/supercop.html
+
+## Designers
+
+The X25519 Diffie-Hellman function was originally designed by Dan Bernstein:
+
+https://cr.yp.to/ecdh.html
+
+The optimized [rfc7748_precomputed] implementation was designed by:
+
+* Thomaz Oliveira, Computer Science Department, Cinvestav-IPN, Mexico.
+* Julio López, University of Campinas, Brazil.
+* Hüseyin Hisil, Yasar University, Turkey.
+* Armando Faz-Hernández, University of Campinas, Brazil.
+* Francisco Rodríguez-Henríquez, Computer Science Department, Cinvestav-IPN, Mexico.
+
+## License
+
+Copyright (c) 2017-2018 Armando Faz, Tony Arcieri
+
+This gem is available as open source under the terms of the
+BSD-3 Clause License ([LICENSE](./LICENSE))
+
+## Code of Conduct
+
+Everyone interacting in the x25519.rb project’s codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the [code of conduct].
+
+[code of conduct]: https://github.com/crypto-rb/x25519/blob/master/CODE_OF_CONDUCT.md