akero 1.0.4 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f225c55aea3201c19c20e56f02ee12a390a0f34
+  data.tar.gz: 1b786e1ba1de3bd0d4842d233eb55cc320edb3b3
+SHA512:
+  metadata.gz: fd0e126c6fd6fbd211d1ef49edba1d37f704df66870026c750ed83c5e04aa57485d5a0effe2557b1f56d8f6066650133b4036465dce125d8c4bccdedfcf0351e
+  data.tar.gz: c8768afdfecda7c928aee36890176f4ee8f1d1bac9b821dc8be311dd85f575bfd228dc4ead7f950edec5db9afae8db38bbdf08ced65248dd762f0d3a684ba15b

data/.gitattributes

@@ -0,0 +1,3 @@
+doc/* linguist-documentation
+coverage/* linguist-documentation
+benchmark/* linguist-documentation

data/.gitignore

@@ -8,8 +8,6 @@
 Gemfile.lock
 InstalledFiles
 _yardoc
-coverage
-doc/
 lib/bundler/man
 pkg
 rdoc

data/.rubocop.yml

@@ -0,0 +1,43 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+# Offense count: 13
+Lint/AmbiguousRegexpLiteral:
+  Exclude:
+    - 'spec/akero_spec.rb'
+
+# Offense count: 1
+Lint/UnderscorePrefixedVariableName:
+  Exclude:
+    - 'lib/akero/benchmark.rb'
+
+# Offense count: 8
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/akero/benchmark.rb'
+    - 'spec/akero_spec.rb'
+
+# Offense count: 9
+Lint/Void:
+  Exclude:
+    - 'spec/akero_spec.rb'
+
+# Offense count: 7
+Metrics/AbcSize:
+  Max: 60
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 164
+
+# Offense count: 45
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 150
+
+# Offense count: 8
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 51

data/.travis.yml

@@ -1,9 +1,5 @@
 language: ruby
+before_install:
+  - gem install bundler
 rvm:
-  - "1.8.7"
-  - "1.9.2"
-  - "1.9.3"
-#  - jruby-18mode # JRuby in 1.8 mode
-#  - jruby-19mode # JRuby in 1.9 mode
-  - rbx-18mode
-  - rbx-19mode
+  - "2.3.1"

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in smime.gemspec

data/Guardfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 my_code = <<'RUBY_CODE'
   if type == 'failed'
     system "ssh 192.168.1.106 '~/bin/keyboard_leds -c1 >/dev/null'"
@@ -9,10 +10,10 @@ my_code = <<'RUBY_CODE'
   end
 RUBY_CODE
 
-notification :eval_notifier, :code => my_code
+notification :eval_notifier, code: my_code
 
-guard 'rspec', :cli => '--color --format doc' do
+guard 'rspec', cli: '--color --format doc' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch('spec/spec_helper.rb')  { 'spec' }
 end

data/Makefile

@@ -0,0 +1,26 @@
+# 0. make test
+# 1. commit changes
+# 2. bump
+# 3. make release
+
+.PHONY: test doc release
+
+test:
+	bundle exec rubocop
+	bundle exec rake
+
+doc:
+	bundle exec yardoc
+
+push: test doc
+	git add doc coverage README.md
+	git commit -m 'Documentation update' doc coverage README.md
+	git checkout gh-pages
+	git checkout master -- doc coverage
+	git commit -m 'Documentation update'
+	git checkout master
+	git push origin gh-pages
+
+release: test doc push
+	bundle exec rake release
+

data/README.md

@@ -1,10 +1,10 @@
-# Akero [![Build Status](https://travis-ci.org/busyloop/akero.png?branch=master)](https://travis-ci.org/busyloop/akero) [![Dependency Status](https://gemnasium.com/busyloop/akero.png)](https://gemnasium.com/busyloop/akero)
+# Akero [![Build Status](https://travis-ci.org/busyloop/akero.png?branch=master)](https://travis-ci.org/busyloop/akero) [![Dependency Status](https://gemnasium.com/busyloop/akero.png)](https://gemnasium.com/busyloop/akero) [![Gem Version](https://badge.fury.io/rb/akero.svg)](https://badge.fury.io/rb/akero)
 
 Akero ([ἄγγελος](http://en.wiktionary.org/wiki/%F0%90%80%80%F0%90%80%90%F0%90%80%AB), messenger) is an easy-to-use library for peer-to-peer [public key cryptography](http://en.wikipedia.org/wiki/Public-key_cryptography). It enables two or more endpoints to exchange encrypted and/or signed messages without requiring a pre-shared secret.
 
 Under the hood Akero uses standard OpenSSL primitives. Each instance wraps a [RSA](http://en.wikipedia.org/wiki/RSA)-keypair, a corresponding [X.509 certificate](http://en.wikipedia.org/wiki/X.509) and exchanges self-signed messages ([PKCS#7](https://tools.ietf.org/html/rfc2315)) with other instances.
 
-Akero does not try to be a substitute for a fully featured [PKI](http://en.wikipedia.org/wiki/Public_key_infrastructure). It is meant to be used as a building block in scenarios where trust-relationships and keyrings can be externally managed, and where the complexity of traditional solutions (X.509 PKI, OpenPGP, custom RSA) yields no tangible benefits.
+Akero does not try to be a substitute for a fully featured [PKI](http://en.wikipedia.org/wiki/Public_key_infrastructure). It is meant to be used as a building block in scenarios where trust-relationships and keyrings can be managed externally, and where the complexity of traditional solutions (X.509 PKI, OpenPGP, custom RSA) yields no tangible benefits.
 
 ## Features
 
@@ -12,7 +12,7 @@ Akero does not try to be a substitute for a fully featured [PKI](http://en.wikip
 * Low complexity; easy to use, understand and review (only 192 lines of code)
 * Transport agnostic; messages and certificates are self-contained and optionally ascii-armored (base64)
 * Built on standard OpenSSL primitives, no homegrown algorithms
-* [100%](https://busyloop.net/oss/akero/coverage/) test coverage
+* [100%](http://busyloop.github.com/akero/coverage/) test coverage
 
 
 ## Installation
@@ -20,7 +20,7 @@ Akero does not try to be a substitute for a fully featured [PKI](http://en.wikip
 `gem install akero`
 
 
-## Usage
+## Usage (API)
 
 ```ruby
 require 'akero'
@@ -40,15 +40,17 @@ signed_msg = alice.sign("Hello world!")
 # Alice's fingerprint and public key from it
 msg = bob.receive(signed_msg)
 msg.body # => "Hello world!"
+msg.type # => :signed
 msg.from # => "AK:12:34:56:..."
 msg.from_pk # => "(alice-public-key)"
 
 # Bob encrypts a message for Alice
 bobs_msg = bob.encrypt(msg.from_pk, "Hello Alice!")
- 
+
 # Alice can receive it...
 msg = alice.receive(bobs_msg)
 msg.body # => "Hello Alice!"
+msg.type # => :encrypted
 msg.from # => "AK:ab:cd:ef:..."
 msg.from_pk # => "(bob-public-key)"
 
@@ -68,20 +70,36 @@ new_alice = Akero.load(File.read('/tmp/alice.akr'))
 # In production Alice disables the armoring
 # for better performance.
 signed_msg = alice.sign("Hello world!", false)
-msg = alice.encrypt(alice.public_key, "Hello!", false)
-puts alice.receive(msg).body # => "Hello!"
+encrypted_msg = alice.encrypt(alice.public_key, "Hello!", false)
+puts alice.receive(encrypted_msg).body # => "Hello!"
+```
+
+## Usage (CLI)
+
+```bash
+$ akero id -i /tmp/alice.akr
+Private key not found. Generating a new 4096 bits RSA key and saving to /tmp/alice.akr ...
+AK:8B:33:5B:AB:4C:78:CA:5E:CC:F5:FE:D7:75:F2:A4:74:16:28:FB:C2
+
+$ akero id -i /tmp/bob.akr
+Private key not found. Generating a new 4096 bits RSA key and saving to /tmp/bob.akr ...
+AK:CF:B3:4C:BA:7C:9C:2E:31:2D:0D:1D:3F:F9:F4:05:F6:C7:B2:38:3F
+
+$ akero pk -i /tmp/bob.akr >/tmp/bob.pk
 
+$ echo "Hello" | akero encrypt -i /tmp/alice.akr /tmp/bob.pk | akero receive -i /tmp/bob.akr
+Hello
 ```
 
 ## Documentation
 
-* [API Docs](http://rubydoc.info/gems/akero/Akero)
+* [API Docs](http://busyloop.github.com/akero/doc/frames.html)
 * [Spec](https://github.com/busyloop/akero/blob/master/spec/akero_spec.rb)
 
 ## Benchmarks
 
-![Throughput](http://github.com/busyloop/akero/raw/master/benchmark/bm_rate.png)
-![Message size](http://github.com/busyloop/akero/raw/master/benchmark/bm_size.png)
+![Throughput](https://github.com/busyloop/akero/raw/master/benchmark/bm_rate.png?raw=true)
+![Message size](https://github.com/busyloop/akero/raw/master/benchmark/bm_size.png?raw=true)
 
 The above charts were generated using MRI 1.9.3p362 (x86_64-linux) on an [AMD Turion II Neo N40L](http://www.cpubenchmark.net/cpu.php?cpu=AMD+Turion+II+Neo+N40L+Dual-Core) CPU.
 You may run the benchmarks on your own machine with `rake benchmark`.

data/Rakefile

@@ -1,29 +1,20 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
 
-task :default => :test
+task default: :test
 
-RSpec::Core::RakeTask.new("test:spec") do |t|
-    t.pattern = 'spec/**/*_spec.rb'
-    t.rspec_opts = '--fail-fast -b -c -f documentation --tag ~benchmark'
+RSpec::Core::RakeTask.new('test:spec') do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = '--fail-fast -b -c -f documentation --tag ~benchmark'
 end
 
 desc 'Run test suite'
-task :test => [ 'test:spec' ]
+task test: ['test:spec']
 
-desc "Run benchmark suite"
+desc 'Run benchmark suite'
 task :benchmark do
   require 'akero/benchmark'
   Akero::Benchmark.run!
 end
-
-namespace :docs do
-  task :push do
-    `bl_www_sync akero coverage`
-  end
-
-  task :loc do
-    puts `grep -v '^\\s*#' lib/akero.rb | grep -v '^$' | wc -l`
-  end
-end

data/akero.gemspec

@@ -1,29 +1,36 @@
 # -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'akero/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "akero"
+  gem.name          = 'akero'
   gem.version       = Akero::VERSION
-  gem.authors       = ["Moe"]
-  gem.email         = ["moe@busyloop.net"]
-  gem.description   = %q{Easy peer-to-peer public key cryptography}
-  gem.summary       = %q{Easy peer-to-peer public key cryptography}
-  gem.homepage      = "https://github.com/busyloop/akero"
+  gem.authors       = ['Moe']
+  gem.email         = ['moe@busyloop.net']
+  gem.description   = 'Easy peer-to-peer public key cryptography'
+  gem.summary       = 'Easy peer-to-peer public key cryptography'
+  gem.homepage      = 'https://github.com/busyloop/akero'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version = '>= 2.3.1'
+
+  gem.add_dependency 'optix'
 
   gem.add_development_dependency 'rb-inotify'
   gem.add_development_dependency 'guard'
   gem.add_development_dependency 'guard-rspec'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'simplecov'
-  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec', '= 2.12.0'
   gem.add_development_dependency 'b'
   gem.add_development_dependency 'gnuplot'
   gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'bump'
+  gem.add_development_dependency 'rubocop'
 end

data/bin/akero

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'akero/cli'
+
+Optix.invoke!

data/coverage/.last_run.json

@@ -0,0 +1,5 @@
+{
+  "result": {
+    "covered_percent": 100.0
+  }
+}

data/coverage/.resultset.json

@@ -0,0 +1,367 @@
+{
+  "RSpec": {
+    "coverage": {
+      "/Users/moe/code/akero/lib/akero.rb": [
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        1,
+        null,
+        1,
+        1,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        1,
+        null,
+        1,
+        null,
+        1,
+        null,
+        1,
+        null,
+        null,
+        1,
+        9,
+        9,
+        9,
+        null,
+        null,
+        null,
+        1,
+        1,
+        null,
+        null,
+        null,
+        null,
+        1,
+        3,
+        null,
+        null,
+        null,
+        null,
+        1,
+        2,
+        null,
+        null,
+        null,
+        null,
+        null,
+        1,
+        1,
+        1,
+        1,
+        1,
+        1,
+        1,
+        1,
+        1,
+        1,
+        1,
+        null,
+        1,
+        1,
+        1,
+        1,
+        1,
+        null,
+        1,
+        1,
+        null,
+        null,
+        null,
+        null,
+        1,
+        19,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        1,
+        60,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        1,
+        2,
+        2,
+        1,
+        null,
+        1,
+        1,
+        1,
+        1,
+        1,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        1,
+        27,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        1,
+        null,
+        null,
+        4,
+        4,
+        4,
+        4,
+        4,
+        4,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        1,
+        6,
+        6,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        1,
+        13,
+        13,
+        23,
+        null,
+        21,
+        21,
+        null,
+        2,
+        null,
+        null,
+        2,
+        null,
+        null,
+        9,
+        7,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        1,
+        19,
+        11,
+        null,
+        19,
+        19,
+        null,
+        2,
+        null,
+        null,
+        15,
+        null,
+        null,
+        5,
+        null,
+        null,
+        8,
+        6,
+        4,
+        4,
+        null,
+        2,
+        null,
+        null,
+        null,
+        1,
+        3,
+        null,
+        null,
+        null,
+        1,
+        1,
+        null,
+        null,
+        null,
+        2,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        1,
+        74,
+        74,
+        null,
+        null,
+        null,
+        null,
+        null,
+        1,
+        23,
+        44,
+        null,
+        1,
+        null,
+        null,
+        null,
+        1,
+        null,
+        1,
+        8,
+        null,
+        2,
+        null,
+        null,
+        1,
+        9,
+        9,
+        null,
+        null,
+        1,
+        26,
+        26,
+        null,
+        15,
+        null,
+        9,
+        null,
+        2,
+        null,
+        24,
+        24,
+        null,
+        null,
+        1,
+        26,
+        24,
+        null,
+        24,
+        18,
+        2,
+        null,
+        null,
+        16,
+        null,
+        null,
+        22,
+        3,
+        null,
+        null,
+        19,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        1,
+        61,
+        61,
+        null,
+        61,
+        61,
+        61,
+        61,
+        61,
+        61,
+        61,
+        null,
+        61,
+        61,
+        null,
+        61,
+        61,
+        61,
+        null,
+        null,
+        null,
+        61,
+        null,
+        61,
+        61,
+        61,
+        null,
+        null
+      ]
+    },
+    "timestamp": 1465614139
+  }
+}