ordo 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e890f80f24a48de13e03ddb187dddfc55f43b72e
-  data.tar.gz: cc31473804b28bd97c56322e10c38601b77fb68b
+  metadata.gz: 859241b0c0396d87392134cbcd910097b386c300
+  data.tar.gz: 767bbecacd458fbd61d8b1faa61c529a83396cb6
 SHA512:
-  metadata.gz: b52f17efb54461bdf5b3ff16f7e7f8915e8c3609d2501869862324a19f0712f3e9e2e2505c1a7502aa7bff25ff6c21f5527f55b38d7e6fc8a2833484e28387f6
-  data.tar.gz: 47eb0af405a792ffe5858f82086995845dfc5e40171181df477ac715110210b136d90fb7119ca31ea3b4b624668d99b75a99cb773c446c1c07f6a610f4df14ac
+  metadata.gz: 2f10f47305efd9b0cc9b0598b28cc4f555239147f9dec543a6cb18dc7cc45e33457f739739d972f227a22007efdf7aaccac03f15c25b98d05d08772a6a9f28ad
+  data.tar.gz: 5c3045c41570bdcbe9e93c42dc3227c79ecb77c6bc165260fce485d9900a8824c8ea61d9a0ebc7755e657b90bbda937d1dd725669219f03ff29e7cf804c23678

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,5 @@
+LineLength:
+  Max: 99
+
+Encoding:
+   Enabled: false

data/.travis.yml

@@ -0,0 +1,17 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+  - ruby-head
+  - jruby
+  - jruby-head
+  - rbx-2
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-2
+
+notifications:
+  irc: "irc.freenode.org#cryptosphere"

data/Gemfile

@@ -1,4 +1,8 @@
 source 'https://rubygems.org'
 
+group :test do
+  gem 'coveralls', require: false
+end
+
 # Specify your gem's dependencies in ordo.gemspec
 gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Tony Arcieri
+Copyright (c) 2014 Tony Arcieri
 
 MIT License
 

data/README.md

@@ -1,27 +1,48 @@
-# Ordo (Ordered Representation for Disinguished Objects)
+![ORDO: Ordered Representation for Distinguished Objects](https://raw.githubusercontent.com/cryptosphere/ordo/master/logo.png)
+=========================================================
 
-Ordo is a data interchange format with the main intended use case of
-representing certificates and cryptographic keys.
+[![Build Status](https://travis-ci.org/cryptosphere/ordo.png?branch=master)](https://travis-ci.org/cryptosphere/ordo)
+[![Code Climate](https://codeclimate.com/github/cryptosphere/ordo.png)](https://codeclimate.com/github/cryptosphere/ordo)
+[![Coverage
+Status](https://coveralls.io/repos/cryptosphere/ordo/badge.png?branch=master)](https://coveralls.io/r/cryptosphere/ordo?branch=master)
 
-## Why?
+ORDO is a data interchange format intended for representing certificates and
+cryptographic keys. We seek to achieve the following:
+
+* Security
+* Human Readability
+* Ease of Use
+* Simplicity
+
+ORDO is being used in the following projects:
+
+* [Cryptor](https://github.com/cryptosphere/cryptor/)
+* [Confusion](https://github.com/cryptosphere/confusion/)
+* [Cryptosphere](https://github.com/cryptosphere/cryptosphere/)
+
+## The Case for a New Certificate Format
+
+Creating a new certificate format is not a task we undertake lightly. It's
+something we do as day-to-day users of X.509 certificates who strive to
+understand X.509's motivations and why the system exists as it is today.
 
 X.509 has a number of shortcomings, both in terms of usability and formal
-language theory. Ordo seeks to address these.
+language theory. ORDO seeks to address these.
 
 We realize that reinventing the wheel can be unhelpful (cue [obligatory XKCD
 comic][standards-comic]) but we also feel like the wheels we're rolling on now
 may be somewhat misshapen.
 
-Ordo has been designed with the following goals in mind:
+ORDO has been designed with the following goals in mind:
 
 * **Human-readable**: Documents can be read and written by humans without
   the need for special tools, so long as the grammar is adhered to. They should
   also be pleasant to read!
-* **Unambiguous**: Ordo seeks to actively identify any possible ambiguities in
+* **Unambiguous**: ORDO seeks to actively identify any possible ambiguities in
   the format and aggressively specify answers for what must and should be done
   depending on the context. The goal is a format which is strict and rigorous
   where all conforming implementations agree on all details of the format.
-* **Distinguished**: The structure of an Ordo document is exactingly described
+* **Distinguished**: The structure of an ORDO document is exactingly described
   in such a way that there is one and only one possible representation of
   a given set of data, such that tools given the same inputs to generate a
   certificate will always produce the same document every time in a fully
@@ -32,11 +53,9 @@ Ordo has been designed with the following goals in mind:
   combining certificates with private keys.
 * **LANGSEC friendly**: the most popular existing certificate format, X.509,
   was designed without a proper understanding of the [security applications
-  of formal language theory][langsec]. Ordo solves these concerns by describing
+  of formal language theory][langsec]. ORDO solves these concerns by describing
   the format in terms of a [context free grammar][cfg] which is unambiguous and
   should be possible to implement consistently everywhere from the description.
-  This project implements the Ordo format using a [Parsing Expression
-  Grammar][peg], specifically [kpeg][kpeg] by Evan Phoenix.
 
 For more information on LANGSEC, please check out [Occupy Babel][occupy]:
 
@@ -51,7 +70,7 @@ For more information on LANGSEC, please check out [Occupy Babel][occupy]:
 
 ## Inspirations
 
-Ordo is inspired by a number of sources:
+ORDO is inspired by a number of sources:
 
 * X.509
 * HTTP
@@ -66,12 +85,16 @@ The following certificate represents a user with a Curve25519 public key:
 
 ```
 -----BEGIN ORDO CERTIFICATE BLOCK-----
-email: bascule@gmail.com
-id-scheme: ordo.id+blake2b
-public-key: ordo.public-key+curve25519:4uj6lwvvsx3bfl6novr36wdzl
-            r6uuovkkfrovmckd5uakwdlwiva
-subject: ordo.dn://c=US/ST=California/L=San+Francisco/O=Cryptosp
-         here+Foundation/OU=Certificate+Department/cn=Ordo
+email:
+  root@eruditorum.org
+expires:
+  2025-01-01T00:00:00Z
+public-key:
+  ordo.public-key+curve25519:4uj6lwvvsx3bfl6novr36wdzlr6uuovkkf
+  rovmckd5uakwdlwiva
+subject:
+  ordo.dn:///C=US/ST=California/L=San+Francisco/O=Cryptosphere+
+  Foundation/OU=Certificate+Department/CN=ORDO
 -----END ORDO CERTIFICATE BLOCK-----
 ```
 
@@ -86,13 +109,12 @@ Some quick things to note:
 * Binary data is encoded using Base32
 * Spaces, not tabs. Trailing whitespace is not allowed.
 
-The `id-scheme` field allows us to compute a content hash which
-uniquely identifies this certificate. This particular cert has chosen
-to identify itself by its Blake2b hash. So its public ID is the
-following URI:
+We identify individual certificates using a content hashing scheme inspired
+by RFC6920 "Naming Things with Hashes". The following URI uniquely identifies
+this particular certificate:
 
 ```
-ordo.id+blake2b:lwxgjvaph2mode3zhrogwdhobuuaej4buc5nl6kbqiubshozocda
+ordo.id:///blake2b;lwxgjvaph2mode3zhrogwdhobuuaej4buc5nl6kbqiubshozocda
 ```
 
 This URI acts as a sort of universally unique identifier, and also

data/Rakefile

@@ -1 +1,5 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+
+Dir['tasks/**/*.rake'].each { |task| load task }
+
+task default: %w(spec rubocop)

data/lib/ordo.rb

@@ -1,5 +1,10 @@
-require "ordo/version"
+# encoding: utf-8
 
-module Ordo
-  # Your code goes here...
+require 'ordo/version'
+require 'ordo/message'
+
+# Ordered Representation of Distinguished Objects
+module ORDO
+  # Couldn't parse the given message
+  ParseError = Class.new(StandardError)
 end

data/lib/ordo/message.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'forwardable'
+require 'ordo/message/parser'
+
+module ORDO
+  # Parse and generate valid ORDO messages
+  class Message
+    # Current version number of the message format
+    MESSAGE_VERSION = 0
+
+    extend Forwardable
+
+    attr_reader :fields, :body
+    def_delegator :@fields, :[]
+
+    def self.parse(message_bytes)
+      Parser.new.parse(message_bytes).to_ordo_message
+    end
+
+    def initialize(body, fields = {})
+      @body   = body
+
+      # TODO: validate fields
+      @fields = fields
+    end
+
+    def to_string
+      result = "---ORDO MSG v#{MESSAGE_VERSION}---\r\n"
+      fields.each do |key, value|
+        result << "#{key}: #{value}\r\n"
+      end
+      result << "\r\n"
+      result << body
+    end
+  end
+end

data/lib/ordo/message/parser.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+
+require 'strscan'
+
+module ORDO
+  class Message
+    # Parses valid ORDO messages
+    class Parser
+      attr_reader :version, :fields, :body
+
+      def initialize
+        @scanner = nil
+        @line    = nil
+        @version = nil
+        @fields  = nil
+        @body    = nil
+      end
+
+      def parse(message_bytes)
+        @line = 1
+        @scanner = StringScanner.new(message_bytes)
+        parse_prefix
+
+        @fields = {}
+        parse_field until body
+
+        self
+      end
+
+      def to_ordo_message
+        Message.new(body, fields)
+      end
+
+      private
+
+      def parse_prefix
+        header = @scanner.scan(/---ORDO MSG v/)
+        parse_error!('no ORDO MSG header') unless header
+
+        version = @scanner.scan(/[0-9]/)
+        parse_error!('invalid version number') unless version
+        @version = Integer(version, 10)
+
+        header_rest = @scanner.scan(/---\r\n/)
+        parse_error!('invalid ORDO MSG header') unless header_rest
+
+        @line += 1
+      end
+
+      # From RFC 3986
+      RESERVED_CHARACTERS   = /[!*'();:@&=+$,\/?#\[\]]/
+      UNRESERVED_CHARACTERS = /[A-Za-z0-9\-_.~]/
+
+      HEADER_VALUE = /(#{RESERVED_CHARACTERS}|#{UNRESERVED_CHARACTERS})*\r\n/
+
+      def parse_field
+        return parse_body if @scanner.scan(/\r\n/)
+
+        name = @scanner.scan(/([A-Z][a-z]*)(-[A-Z][a-z]*)*/)
+        parse_error!('invalid header field name') unless name
+
+        colon = @scanner.scan(/: /)
+        parse_error!('expecting ": " but none found') unless colon
+
+        value = @scanner.scan(HEADER_VALUE)
+        parse_error!('invalid characters in header value') unless value
+
+        @fields[name] = value.chomp
+        @line += 1
+      end
+
+      def parse_body
+        @body = @scanner.rest
+      end
+
+      def parse_error(message)
+        buffer = @scanner.rest.split(/\r|\n/).first
+        buffer = "#{buffer[0, 20]}..." if buffer.length > 20
+
+        ParseError.new("#{message} (line: #{@line}): #{buffer}")
+      end
+
+      def parse_error!(message)
+        fail parse_error(message)
+      end
+    end
+  end
+end

data/lib/ordo/version.rb

@@ -1,3 +1,6 @@
-module Ordo
-  VERSION = "0.0.0"
+# encoding: utf-8
+
+# Ordered Representation of Distinguished Objects
+module ORDO
+  VERSION = '0.0.1'
 end

data/ordo.gemspec

@@ -4,22 +4,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ordo/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ordo"
-  spec.version       = Ordo::VERSION
-  spec.authors       = ["Tony Arcieri"]
-  spec.email         = ["tony.arcieri@gmail.com"]
-  spec.description   = "Tools for working with the Ordo certificate format"
-  spec.summary       = "Ordo is a data interchange format for cryptographic identities, keys, and signatures"
-  spec.homepage      = "https://github.com/cryptosphere/ordo"
-  spec.license       = "MIT"
+  spec.name          = 'ordo'
+  spec.version       = ORDO::VERSION
+  spec.authors       = ['Tony Arcieri']
+  spec.email         = ['bascule@gmail.com']
+  spec.description   = 'Tools for working with the Ordo certificate format'
+  spec.summary       = 'Interchange format for cryptographic identities, keys, and signatures'
+  spec.homepage      = 'https://github.com/cryptosphere/ordo'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency "kpeg"
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'rubocop'
 end

data/spec/ordo/message/parser_spec.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe ORDO::Message::Parser do
+  let(:example_version)  { 0 }
+  let(:example_cipher)   { 'ordo.symmetric-encryption:///xsalsa20poly1305' }
+  let(:example_encoding) { 'binary' }
+  let(:example_header) do
+    [
+      '---ORDO MSG v' + example_version.to_s + '---',
+      'Cipher: ' + example_cipher,
+      'Content-Length: ' + example_body.length.to_s,
+      'Content-Transfer-Encoding: ' + example_encoding
+    ].join("\r\n") + "\r\n\r\n"
+  end
+  let(:example_body)    { 'Some things are better left unread' }
+  let(:example_message) { example_header + example_body }
+
+  it 'parses messages' do
+    parser = subject.parse(example_message)
+
+    expect(parser.version).to eq example_version
+    expect(parser.fields).to eq(
+      'Cipher'                    => example_cipher,
+      'Content-Length'            => example_body.length.to_s,
+      'Content-Transfer-Encoding' => example_encoding
+    )
+
+    expect(parser.body).to eq example_body
+  end
+
+  it 'raises ParseError if no ORDO MSG header found' do
+    begin
+      subject.parse('garbage')
+    rescue ORDO::ParseError => ex # rubocop:disable all
+    end
+
+    expect(ex).to be_a ORDO::ParseError
+    expect(ex.to_s).to match(/no.*header/)
+  end
+
+  it 'raises ParseError if version is invalid' do
+    begin
+      subject.parse('---ORDO MSG vX---')
+    rescue ORDO::ParseError => ex # rubocop:disable all
+    end
+
+    expect(ex).to be_a ORDO::ParseError
+    expect(ex.to_s).to match(/invalid version/)
+  end
+
+  it 'raises ParseError if invalid fields are encountered' do
+    begin
+      subject.parse("---ORDO MSG v0---\r\nfoo: bar\r\n\r\n")
+    rescue ORDO::ParseError => ex # rubocop:disable all
+    end
+
+    expect(ex).to be_a ORDO::ParseError
+    expect(ex.to_s).to match(/invalid.*field name/)
+  end
+end

data/spec/ordo/message_spec.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe ORDO::Message do
+  let(:example_cipher)   { 'ordo.symmetric-encryption:///xsalsa20poly1305' }
+  let(:example_encoding) { 'binary' }
+  let(:example_body)     { 'Some things are better left unread' }
+
+  it 'parses messages' do
+    message = described_class.parse test_vector('example_message.txt')
+    expect(message['Cipher']).to eq example_cipher
+    expect(message['Content-Transfer-Encoding']).to eq example_encoding
+    expect(message.body).to eq example_body
+  end
+
+  it 'emits messages' do
+    message = described_class.new(
+      example_body,
+      'Cipher' => example_cipher,
+      'Content-Length' => example_body.bytesize,
+      'Content-Transfer-Encoding' => 'binary'
+    )
+
+    expect(message.to_string).to eq test_vector('example_message.txt')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+require 'json'
+require 'coveralls'
+Coveralls.wear!
+
+require 'bundler/setup'
+require 'ordo'
+
+def test_vector(name)
+  test_vectors_dir = File.expand_path('../test_vectors', __FILE__)
+  File.read File.join(test_vectors_dir, name)
+end

data/spec/test_vectors/example_message.txt

@@ -0,0 +1,6 @@
+---ORDO MSG v0---
+Cipher: ordo.symmetric-encryption:///xsalsa20poly1305
+Content-Length: 34
+Content-Transfer-Encoding: binary
+
+Some things are better left unread

data/tasks/rspec.rake

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+RSpec::Core::RakeTask.new(:rcov) do |task|
+  task.rcov = true
+end

data/tasks/rubocop.rake

@@ -0,0 +1,3 @@
+require 'rubocop/rake_task'
+
+Rubocop::RakeTask.new

metadata

@@ -1,72 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: ordo
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Tony Arcieri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-10 00:00:00.000000000 Z
+date: 2014-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: kpeg
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Tools for working with the Ordo certificate format
 email:
-- tony.arcieri@gmail.com
+- bascule@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/ordo.rb
+- lib/ordo/message.rb
+- lib/ordo/message/parser.rb
 - lib/ordo/version.rb
+- logo.png
 - ordo.gemspec
+- spec/ordo/message/parser_spec.rb
+- spec/ordo/message_spec.rb
+- spec/spec_helper.rb
+- spec/test_vectors/example_message.txt
+- tasks/rspec.rake
+- tasks/rubocop.rake
 homepage: https://github.com/cryptosphere/ordo
 licenses:
 - MIT
@@ -77,19 +104,22 @@ 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.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Ordo is a data interchange format for cryptographic identities, keys, and
-  signatures
-test_files: []
+summary: Interchange format for cryptographic identities, keys, and signatures
+test_files:
+- spec/ordo/message/parser_spec.rb
+- spec/ordo/message_spec.rb
+- spec/spec_helper.rb
+- spec/test_vectors/example_message.txt