ed448 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ecdab667956e9b9d45514788a635260f120ac6a12fdefd98f7954c08d52f9850
+  data.tar.gz: 1a95183ddb62962350332cdf6e00ab9e0dcbc605636ef104ac298fa0376072f4
+SHA512:
+  metadata.gz: 36b3b2023c0aa5cb4dbfc61513b158f7b82ed00276ba54f7a6840ff60f7070d8fcb840921f8a38748ec0c555fbe9d3272636ca47814ec4f96f4c4c566488beb6
+  data.tar.gz: 7fed6db9aa41f0034caf5b0dceb6622b66a96f1b70ad956bc1e72adc948934d4560ef91244bd6fc7e675f219a10c4608d87246bbf51724daa8352d5fc7e92935

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 2.0.1

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 gen.yamaguchi0@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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ed448rb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Hajime Yamaguchi
+
+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.

data/README.md

@@ -0,0 +1,43 @@
+# Ed448rb
+
+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/ed448rb`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ed448rb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ed448rb
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ed448rb. 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
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ed448rb project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ed448rb/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ed448"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ed448.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ed448/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ed448"
+  spec.version       = Ed448::VERSION
+  spec.authors       = ["Hajime Yamaguchi"]
+  spec.email         = ["gen.yamaguchi0@gmail.com"]
+
+  spec.summary       = 'Ruby wrapper for libgoldilocks'
+  spec.description   = 'Ruby wrapper for libgoldilocks'
+  spec.homepage      = "https://github.com/Yamaguchi/ed448rb"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'ffi'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/ed448.rb

@@ -0,0 +1,151 @@
+require 'ed448/version'
+require 'ffi'
+require 'securerandom'
+
+module Ed448
+  extend ::FFI::Library
+
+  module_function
+
+  autoload :X448, 'ed448/x448'
+
+  EDDSA_448_PUBLIC_BYTES = 57
+  EDDSA_448_PRIVATE_BYTES = 57
+  EDDSA_448_SIGNATURE_BYTES = EDDSA_448_PRIVATE_BYTES + EDDSA_448_PUBLIC_BYTES
+
+  # macOS
+  # ENV['LIBGOLDILOCKS'] = '/usr/local/lib/libgoldilocks.dylib'
+  def init
+    raise 'libgoldilocks library dose not found.' unless File.exist?(ENV['LIBGOLDILOCKS'])
+
+    ffi_lib(ENV['LIBGOLDILOCKS'])
+    load_functions
+  end
+
+  def load_functions
+    # @brief EdDSA key generation.  This function uses a different (non-Decaf)
+    # encoding.
+    #     
+    # @param [out] pubkey The public key.
+    # @param [in] privkey The private key.
+    #
+    # void goldilocks_ed448_derive_public_key (
+    #     uint8_t pubkey[GOLDILOCKS_EDDSA_448_PUBLIC_BYTES],
+    #     const uint8_t privkey[GOLDILOCKS_EDDSA_448_PRIVATE_BYTES]
+    # )
+    attach_function(:goldilocks_ed448_derive_public_key, [:pointer, :pointer], :void)
+
+    # @brief EdDSA signing.
+    #
+    # @param [out] signature The signature.
+    # @param [in] privkey The private key.
+    # @param [in] pubkey The public key.
+    # @param [in] message The message to sign.
+    # @param [in] message_len The length of the message.
+    # @param [in] prehashed Nonzero if the message is actually the hash of something you want to sign.
+    # @param [in] context A "context" for this signature of up to 255 bytes.
+    # @param [in] context_len Length of the context.
+    #
+    # @warning For Ed25519, it is unsafe to use the same key for both prehashed and non-prehashed
+    # messages, at least without some very careful protocol-level disambiguation.  For Ed448 it is
+    # safe.  The C++ wrapper is designed to make it harder to screw this up, but this C code gives
+    # you no seat belt.
+    # void goldilocks_ed448_sign (
+    #   uint8_t signature[GOLDILOCKS_EDDSA_448_SIGNATURE_BYTES],
+    #   const uint8_t privkey[GOLDILOCKS_EDDSA_448_PRIVATE_BYTES],
+    #   const uint8_t pubkey[GOLDILOCKS_EDDSA_448_PUBLIC_BYTES],
+    #   const uint8_t *message,
+    #   size_t message_len,
+    #   uint8_t prehashed,
+    #   const uint8_t *context,
+    #   uint8_t context_len
+    # )
+    attach_function(:goldilocks_ed448_sign, [:pointer, :pointer, :pointer, :pointer,:int, :int, :pointer, :int], :void)
+
+    # @brief EdDSA signature verification.
+    #
+    # Uses the standard (i.e. less-strict) verification formula.
+    #
+    # @param [in] signature The signature.
+    # @param [in] pubkey The public key.
+    # @param [in] message The message to verify.
+    # @param [in] message_len The length of the message.
+    # @param [in] prehashed Nonzero if the message is actually the hash of something you want to verify.
+    # @param [in] context A "context" for this signature of up to 255 bytes.
+    # @param [in] context_len Length of the context.
+    #
+    # @warning For Ed25519, it is unsafe to use the same key for both prehashed and non-prehashed
+    # messages, at least without some very careful protocol-level disambiguation.  For Ed448 it is
+    # safe.  The C++ wrapper is designed to make it harder to screw this up, but this C code gives
+    # you no seat belt.
+    #
+    # goldilocks_error_t goldilocks_ed448_verify (
+    #     const uint8_t signature[GOLDILOCKS_EDDSA_448_SIGNATURE_BYTES],
+    #     const uint8_t pubkey[GOLDILOCKS_EDDSA_448_PUBLIC_BYTES],
+    #     const uint8_t *message,
+    #     size_t message_len,
+    #     uint8_t prehashed,
+    #     const uint8_t *context,
+    #     uint8_t context_len
+    # )
+    attach_function(:goldilocks_ed448_verify, [:pointer, :pointer, :pointer,:int, :int, :pointer, :int], :int)
+
+    # @brief RFC 7748 Diffie-Hellman scalarmul, used to compute shared secrets.
+    # This function uses a different (non-Decaf) encoding.
+    #
+    # @param [out] shared The shared secret base*scalar
+    # @param [in] base The other party's public key, used as the base of the scalarmul.
+    # @param [in] scalar The private scalar to multiply by.
+    #
+    # @retval GOLDILOCKS_SUCCESS The scalarmul succeeded.
+    # @retval GOLDILOCKS_FAILURE The scalarmul didn't succeed, because the base
+    # point is in a small subgroup.
+    #
+    # goldilocks_error_t goldilocks_x448 (
+    #     uint8_t shared[GOLDILOCKS_X448_PUBLIC_BYTES],
+    #     const uint8_t base[GOLDILOCKS_X448_PUBLIC_BYTES],
+    #     const uint8_t scalar[GOLDILOCKS_X448_PRIVATE_BYTES]
+    # ) GOLDILOCKS_API_VIS GOLDILOCKS_NONNULL GOLDILOCKS_WARN_UNUSED GOLDILOCKS_NOINLINE;
+    attach_function(:goldilocks_x448, [:pointer, :pointer, :pointer], :int)
+
+    # @brief RFC 7748 Diffie-Hellman base point scalarmul.  This function uses
+    # a different (non-Decaf) encoding.
+    #
+    # @param [out] out The public key base*scalar
+    # @param [in] scalar The private scalar.
+    #
+    # void goldilocks_x448_derive_public_key (
+    #     uint8_t out[GOLDILOCKS_X448_PUBLIC_BYTES],
+    #     const uint8_t scalar[GOLDILOCKS_X448_PRIVATE_BYTES]
+    # ) GOLDILOCKS_API_VIS GOLDILOCKS_NONNULL GOLDILOCKS_NOINLINE;
+    attach_function(:goldilocks_x448_derive_public_key, [:pointer, :pointer], :void)
+  end
+
+  def derive_public_key(private_key)
+    private_key = FFI::MemoryPointer.new(:uchar, EDDSA_448_PRIVATE_BYTES).put_bytes(0, private_key)
+    public_key = FFI::MemoryPointer.new(:uchar, EDDSA_448_PUBLIC_BYTES)
+    goldilocks_ed448_derive_public_key(public_key, private_key)
+    public_key.read_string(EDDSA_448_PUBLIC_BYTES)
+  end
+
+  def sign(private_key, public_key, message)
+    signature = FFI::MemoryPointer.new(:uchar, EDDSA_448_SIGNATURE_BYTES)
+    private_key = FFI::MemoryPointer.new(:uchar, EDDSA_448_PRIVATE_BYTES).put_bytes(0, private_key)
+    public_key = FFI::MemoryPointer.new(:uchar, EDDSA_448_PUBLIC_BYTES).put_bytes(0, public_key)
+    message_len = message.bytesize
+    message = FFI::MemoryPointer.new(:uchar, message_len).put_bytes(0, message)
+    context = FFI::MemoryPointer.new(:uchar, 0)
+    goldilocks_ed448_sign(signature, private_key, public_key, message, message_len, 0, context, 0)
+    signature.read_string(EDDSA_448_SIGNATURE_BYTES)
+  end
+
+  def verify(signature, public_key, message)
+    signature = FFI::MemoryPointer.new(:uchar, EDDSA_448_SIGNATURE_BYTES).put_bytes(0, signature)
+    public_key = FFI::MemoryPointer.new(:uchar, EDDSA_448_PUBLIC_BYTES).put_bytes(0, public_key)
+    message_len = message.bytesize
+    message = FFI::MemoryPointer.new(:uchar, message_len).put_bytes(0, message)
+    context = FFI::MemoryPointer.new(:uchar, 0)
+    result = goldilocks_ed448_verify(signature, public_key, message, message_len, 0, context, 0)
+    result == -1
+  end
+end

data/lib/ed448/version.rb

@@ -0,0 +1,3 @@
+module Ed448
+  VERSION = "0.1.0"
+end

data/lib/ed448/x448.rb

@@ -0,0 +1,25 @@
+module Ed448
+  module X448
+    module_function
+
+    X448_PRIVATE_BYTES = 56
+    X448_PUBLIC_BYTES = 56
+
+    def derive_public_key(private_key)
+      private_key = FFI::MemoryPointer.new(:uchar, X448_PRIVATE_BYTES).put_bytes(0, private_key)
+      public_key = FFI::MemoryPointer.new(:uchar, X448_PUBLIC_BYTES)
+      Ed448.goldilocks_x448_derive_public_key(public_key, private_key)
+      public_key.read_string(X448_PUBLIC_BYTES)
+    end
+
+    def dh(public_key, private_key)
+      private_key = FFI::MemoryPointer.new(:uchar, X448_PRIVATE_BYTES).put_bytes(0, private_key)
+      public_key = FFI::MemoryPointer.new(:uchar, X448_PUBLIC_BYTES).put_bytes(0, public_key)
+      shared_key = FFI::MemoryPointer.new(:uchar, X448_PUBLIC_BYTES)
+      result = Ed448.goldilocks_x448(shared_key, public_key, private_key)
+      raise 'goldilocks_x448 failed.' if result != -1
+
+      shared_key.read_bytes(X448_PUBLIC_BYTES)
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: ed448
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hajime Yamaguchi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby wrapper for libgoldilocks
+email:
+- gen.yamaguchi0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ed448.gemspec
+- lib/ed448.rb
+- lib/ed448/version.rb
+- lib/ed448/x448.rb
+homepage: https://github.com/Yamaguchi/ed448rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for libgoldilocks
+test_files: []