ffi-hydrogen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fcf7222814e1b73a17b3ea735aea98e9b8ba25af66e140cf44930fe8c933d80d
+  data.tar.gz: 7beeae085e1a733aeefbfed6107bfc7c8649ebd37037dace6945ca264bd4185b
+SHA512:
+  metadata.gz: d9ebfc742fb3a4e8065328f7e5262188f805d2a42d658d17346be91a389aebbcc3835ae67a96ff933faea709add7b82b5ea262e9d887b3969835dd085d6f7966
+  data.tar.gz: 4b37a7cd2c2b60c5a422bd5e72cee11f8cdeb2badefb2c0c724de35c525205cd78073a6d68062f38175fb7f71eef8d011647f33293120a4354298271813a0aeb

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,30 @@
+# Styles are inherited from Mad Rubocop
+
+inherit_gem:
+  mad_rubocop: .rubocop.yml
+
+# Styles that are modified from the defaults
+AllCops:
+  TargetRubyVersion: 2.3
+
+Style/BlockDelimiters:
+  Description: >-
+                Avoid using {...} for multi-line blocks (multiline chaining is
+                always ugly).
+                Prefer {...} over do...end for single-line blocks.
+  StyleGuide: 'https://git.moneydesktop.com/dev/ruby-style-guide#single-line-blocks'
+  Exclude:
+    - 'spec/**/*'
+
+Style/HashSyntax:
+  Description: >-
+                 Prefer Ruby 1.8 hash syntax { :a => 1, :b => 2 }
+                 over 1.9 syntax { a: 1, b: 2 }.
+  StyleGuide: 'https://git.moneydesktop.com/dev/ruby-style-guide#hash-literals'
+  EnforcedStyle: hash_rockets
+  Exclude:
+    - 'Gemfile'
+
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'mx-aggregation_status.gemspec'

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+sudo: false
+cache: bundler
+
+rvm:
+  - 2.5.3
+  - 2.3.1
+
+before_script:
+  - cc --version

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ffi-hydrogen.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Marcos Minond
+
+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,72 @@
+[![Build Status](https://travis-ci.org/minond/ffi-hydrogen.svg?branch=master)](https://travis-ci.org/minond/ffi-hydrogen)
+
+# FFI::Hydrogen
+
+Combine [libhydrogen](https://github.com/jedisct1/libhydrogen) with a good
+implementation of string encoding in C, Nick Galbreath's
+[base64](https://github.com/client9/stringencoders) implementation in this
+case, and the end result is hopefully a fast method of encrypting data in a way
+that is URL safe.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "ffi-hydrogen"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ffi-hydrogen
+
+## Usage
+
+```ruby
+key = ::FFI::Hydrogen.hydro_secretbox_keygen
+context = "examples"
+
+message = "0123456789"
+encrypted = ::FFI::Hydrogen.hydro_secretbox_encrypt(message, context, key)
+encoded = ::FFI::Hydrogen.modp_b64_encode(encrypted)
+decoded = ::FFI::Hydrogen.modp_b64_decode(encoded)
+decrypted = ::FFI::Hydrogen.hydro_secretbox_decrypt(decoded, context, key)
+
+puts "message: #{message}"
+puts "encrypted: #{encrypted}"
+puts "encoded: #{encoded}"
+puts "decoded: #{decoded}"
+puts "decrypted: #{decrypted}"
+```
+
+### `::FFI::Hydrogen::Secretbox`
+
+```ruby
+ctx = "examples"
+key = ::FFI::Hydrogen.hydro_secretbox_keygen
+box = ::FFI::Hydrogen::Secretbox.new(ctx, key)
+
+message = "0123456789"
+boxed = box.encrypt_encode(message)
+unboxed = box.decode_decrypt(boxed)
+
+puts "message: #{message}"
+puts "boxed: #{boxed}"
+puts "unboxed: #{unboxed}"
+```
+
+## 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 `ffi-hydrogen.gemspec`, 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).

data/Rakefile

@@ -0,0 +1,46 @@
+require "bundler/gem_tasks"
+require "ffi"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+def sys(cmd)
+  puts "#{cmd}"
+  ret = system(cmd)
+  raise "ERROR: '#{cmd}' failed" unless ret
+  ret
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Run RuboCop"
+task :rubocop do
+  RuboCop::RakeTask.new
+end
+
+desc "Compile shared library"
+task :compile do
+  wflags = "-Wall -Wextra -Wmissing-prototypes -Wdiv-by-zero"\
+    " -Wbad-function-cast -Wcast-align -Wcast-qual -Wfloat-equal"\
+    " -Wmissing-declarations -Wnested-externs -Wno-unknown-pragmas"\
+    " -Wpointer-arith -Wredundant-decls -Wstrict-prototypes -Wswitch-enum"\
+    " -Wno-type-limits"
+
+  cflags = "-O3 -march=native -fPIC -fno-exceptions #{wflags}"
+
+  # main.o: main.c
+  #   $(CC) -c $(CFLAGS) $< -o $@
+  sys("cc -c #{cflags} vendor/main.c -o vendor/main.o")
+
+  # main.dylib: main.o
+  # 	$(CC) $< -shared -o $@
+  sys("cc vendor/main.o -shared -o vendor/main.#{::FFI::Platform::LIBSUFFIX}")
+end
+
+desc "Run all benchmarks"
+task :bench do
+  ruby "bench/both.rb"
+  ruby "bench/encode.rb"
+  ruby "bench/encrypt.rb"
+end
+
+task :default => [:compile, :rubocop, :spec]

data/bench/both.rb

@@ -0,0 +1,86 @@
+require "base64"
+require "benchmark/ips"
+require "rbnacl"
+require "urlcrypt"
+
+require "ffi/hydrogen"
+
+require_relative "./init.rb"
+
+def suite(str)
+  puts "============================ Test string length: #{str.size} ============================"
+
+  label = "#{str.size}_char"
+
+  hydrogen_key = ::FFI::Hydrogen.hydro_secretbox_keygen
+  hydrogen_context = "benched1"
+  hydrogen_box = ::FFI::Hydrogen::Secretbox.new(hydrogen_context, hydrogen_key)
+  hydrogen_encrypted_encoded = hydrogen_box.encrypt_encode(str)
+
+  rbnacl_key = ::RbNaCl::Random.random_bytes(::RbNaCl::SecretBox.key_bytes)
+  rbnacl_box = ::RbNaCl::SimpleBox.from_secret_key(rbnacl_key)
+  rbnacl_encrypted_encoded = ::Base64.encode64(rbnacl_box.encrypt(str))
+
+  urlcrypt_key = "h34j4k3l25gh342o5jk46ghjk5nbjkl7nhljk34532j4k5b43hjk5g432jk6v4gjhk6f5j6gv5hj2k3g54hjk321g4hjk25g4hjk35gf4yu6f5jg5b43jk25h4jk325d"
+  ::URLcrypt.key = [urlcrypt_key].pack("H*")
+  urlcrypt_encrypted = ::URLcrypt.encrypt(str)
+
+  Benchmark.ips do |b|
+    b.time = 2
+    b.warmup = 1
+
+    b.report("boxed_encrypt_encode_#{label}") do |n|
+      i = 0
+      while i < n
+        hydrogen_box.encrypt_encode(str)
+        i += 1
+      end
+    end
+
+    b.report("boxed_decode_decrypt_#{label}") do |n|
+      i = 0
+      while i < n
+        hydrogen_box.decode_decrypt(hydrogen_encrypted_encoded)
+        i += 1
+      end
+    end
+
+    b.report("urlcrypt_encrypt_#{label}") do |n|
+      i = 0
+      while i < n
+        ::URLcrypt.encrypt(str)
+        i += 1
+      end
+    end
+
+    b.report("urlcrypt_decrypt_#{label}") do |n|
+      i = 0
+      while i < n
+        ::URLcrypt.decrypt(urlcrypt_encrypted)
+        i += 1
+      end
+    end
+
+    b.report("boxed_rbnacl_simplebox_encrypt_plus_base64_#{label}") do |n|
+      i = 0
+      while i < n
+        ::Base64.encode64(rbnacl_box.encrypt(str))
+        i += 1
+      end
+    end
+
+    b.report("boxed_rbnacl_simplebox_decrypt_plus_base64_#{label}") do |n|
+      i = 0
+      while i < n
+        rbnacl_box.decrypt(::Base64.decode64(rbnacl_encrypted_encoded))
+        i += 1
+      end
+    end
+
+    b.compare!
+  end
+end
+
+TEST_STRINGS.each do |str|
+  suite(str)
+end

data/bench/encode.rb

@@ -0,0 +1,57 @@
+require "base64"
+require "benchmark/ips"
+
+require "ffi/hydrogen"
+
+require_relative "./init.rb"
+
+def suite(str)
+  puts "============================ Test string length: #{str.size} ============================"
+
+  label = "#{str.size}_char"
+
+  encoded = ::FFI::Hydrogen.modp_b64_encode(str)
+
+  Benchmark.ips do |b|
+    b.time = 2
+    b.warmup = 1
+
+    b.report("modp_b64_encode_#{label}") do |n|
+      i = 0
+      while i < n
+        ::FFI::Hydrogen.modp_b64_encode(str)
+        i += 1
+      end
+    end
+
+    b.report("modp_b64_decode_#{label}") do |n|
+      i = 0
+      while i < n
+        ::FFI::Hydrogen.modp_b64_decode(encoded)
+        i += 1
+      end
+    end
+
+    b.report("base64_encode64_#{label}") do |n|
+      i = 0
+      while i < n
+        ::Base64.encode64(str)
+        i += 1
+      end
+    end
+
+    b.report("base64_decode64_#{label}") do |n|
+      i = 0
+      while i < n
+        ::Base64.decode64(str)
+        i += 1
+      end
+    end
+
+    b.compare!
+  end
+end
+
+TEST_STRINGS.each do |str|
+  suite(str)
+end

data/bench/encrypt.rb

@@ -0,0 +1,80 @@
+require "benchmark/ips"
+require "rbnacl"
+
+require "ffi/hydrogen"
+
+require_relative "./init.rb"
+
+def suite(str)
+  puts "============================ Test string length: #{str.size} ============================"
+
+  label = "#{str.size}_char"
+
+  hydrogen_key = ::FFI::Hydrogen.hydro_secretbox_keygen
+  hydrogen_context = "benched1"
+  hydrogen_box = ::FFI::Hydrogen::Secretbox.new(hydrogen_context, hydrogen_key)
+  hydrogen_encrypted = hydrogen_box.encrypt(str)
+
+  rbnacl_key = ::RbNaCl::Random.random_bytes(::RbNaCl::SecretBox.key_bytes)
+  rbnacl_box = ::RbNaCl::SimpleBox.from_secret_key(rbnacl_key)
+  rbnacl_encrypted = rbnacl_box.encrypt(str)
+
+  Benchmark.ips do |b|
+    b.time = 2
+    b.warmup = 1
+
+    b.report("hydro_secretbox_encrypt_#{label}") do |n|
+      i = 0
+      while i < n
+        ::FFI::Hydrogen.hydro_secretbox_encrypt(str, hydrogen_context, hydrogen_key)
+        i += 1
+      end
+    end
+
+    b.report("hydro_secretbox_decrypt_#{label}") do |n|
+      i = 0
+      while i < n
+        ::FFI::Hydrogen.hydro_secretbox_decrypt(hydrogen_encrypted, hydrogen_context, hydrogen_key)
+        i += 1
+      end
+    end
+
+    b.report("boxed_hydro_secretbox_encrypt_#{label}") do |n|
+      i = 0
+      while i < n
+        hydrogen_box.encrypt(str)
+        i += 1
+      end
+    end
+
+    b.report("boxed_hydro_secretbox_decrypt_#{label}") do |n|
+      i = 0
+      while i < n
+        hydrogen_box.decrypt(hydrogen_encrypted)
+        i += 1
+      end
+    end
+
+    b.report("boxed_rbnacl_simplebox_encrypt_#{label}") do |n|
+      i = 0
+      while i < n
+        rbnacl_box.encrypt(str)
+        i += 1
+      end
+    end
+
+    b.report("boxed_rbnacl_simplebox_decrypt_#{label}") do |n|
+      i = 0
+      while i < n
+        rbnacl_box.decrypt(rbnacl_encrypted)
+        i += 1
+      end
+    end
+
+    b.compare!
+  end
+end
+
+TEST_STRINGS.each do |str|
+  suite(str)
+end

data/bench/init.rb

@@ -0,0 +1,5 @@
+TEST_STRINGS = [
+  "0123456789",
+  "<abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuv>",
+  "<abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz0123456789!@#^&*()_+>",
+]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ffi/hydrogen"
+
+# 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/ffi-hydrogen.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "ffi-hydrogen"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Marcos Minond"]
+  spec.email         = ["marcos.minond@mx.com"]
+
+  spec.summary       = "libhydrogen + encoding = cryptographically sound, URL safe string = libhydrogen + encoding"
+  spec.homepage      = "https://github.com/minond/ffi-hydrogen"
+
+  # 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_dependency "ffi"
+
+  spec.add_development_dependency "benchmark-ips", "~> 2.7.2"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "mad_rubocop"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rbnacl", "~> 6.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "urlcrypt"
+end