paseto 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 511f7637a0d6963e65acfd2cbaaf7dd00dabf788
+  data.tar.gz: 74a86c0ef1aae46ec7f2dc850c9c584e9a637b3b
+SHA512:
+  metadata.gz: '05862baa88aaeb0d3867c2862dc5a10ee1ab5fe4a9347abf12a6ff106f5b8306618a572fa9613d778f13aa566eb3aeee0f32c9a689151cc2b90a82105720e0dc'
+  data.tar.gz: 0ecb74d4b10ec7ce169825a606321b27e6e3ccd75da35146b9b0ab54c2dc09f293449966507b33924d8c79a86bb3a11fc07723867c12a17f790386fd25b5e208

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.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 mguymon@instructure.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,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in paseto.gemspec
+gemspec
+
+gem 'rbnacl', :git => 'https://github.com/anirishduck/rbnacl'

data/Gemfile.lock

@@ -0,0 +1,53 @@
+GIT
+  remote: https://github.com/anirishduck/rbnacl
+  revision: ff58f9e5dcae0617a3ead398aadd51553c6baed1
+  specs:
+    rbnacl (5.0.0)
+      ffi
+
+PATH
+  remote: .
+  specs:
+    paseto (0.2.0)
+      rbnacl-libsodium (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ffi (1.9.23)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rbnacl-libsodium (1.0.16)
+      rbnacl (>= 3.0.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  paseto!
+  pry (~> 0.11)
+  rake (~> 10.0)
+  rbnacl!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Michael Guymon
+
+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,84 @@
+# Paseto
+
+![](https://travis-ci.org/mguymon/paseto.rb.svg?branch=master)
+
+Ruby implementation of [Paseto](https://github.com/paragonie/paseto) using [libsodium](https://github.com/crypto-rb/rbnacl) that currently only supports [Version 2](https://github.com/paragonie/paseto/blob/master/docs/01-Protocol-Versions/Version2.md).
+
+> Paseto (Platform-Agnostic SEcurity TOkens) is a specification for secure stateless tokens.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paseto'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paseto
+
+## Usage
+
+For all examples:
+
+    require 'paseto'
+
+## Signing Plaintext Public Messages
+
+    Public = Paseto::V2::Public
+    key = Public::SecretKey.generate
+    token = key.sign('too many secrets')
+
+    saved_key = key.public_key.encode64 # you can save this string to a db
+    decoded_key = Public::PublicKey.decode64(saved_key)
+    decoded_key.verify(token) # => 'too many secrets'
+
+## Encrypting Messages with a Shared Secret
+
+    Key = Paseto::V2::Local::Key
+    key = Key.generate
+    token = key.encrypt('a fancy message')
+
+    saved_key = key.encode64 # a base64 string representation of the key
+    decoded_key = Key.decode64(saved_key)
+    decoded_key.decrypt(token) # => 'a fancy message'
+
+## Using the Message Footer
+
+The message footer is transmitted plaintext, and can be used for key lookup.
+Note that you still must always verify the token via `#decrypt`,  or `#verify`,
+as this also verifies the integrity of the footer:
+
+    Local = Paseto::V2::Local
+    token = Paseto.parse(raw_data)
+    # NOTE: this has not yet been verified! You will always want to call
+    # .decrypt or .verify *immediately* after using this value. Otherwise, you
+    # will be using data that has not been authenticated.
+    kid = token.footer
+
+    saved_key = database.find_key(kid) # find the previously stored key
+    decoded_key = Local::Key.decode64(saved_key)
+    decoded_key.decrypt(token) # => 'too many secrets'
+
+## 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]/paseto. 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 Paseto project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/paseto/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,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "paseto"
+require 'pry'
+
+# 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.
+
+Pry.start

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/lib/paseto.rb

@@ -0,0 +1,45 @@
+require 'base64'
+require 'rbnacl/libsodium'
+
+require 'paseto/version'
+require 'paseto/error'
+require 'paseto/token'
+require 'paseto/public'
+require 'paseto/local'
+
+module Paseto
+
+  # https://github.com/paragonie/paseto/blob/master/docs/01-Protocol-Versions/Common.md#pae-definition
+  def self.encode_length(n)
+    str = []
+    (0..7).each do |i|
+      # Clear the MSB for interoperability
+      n &= 127 if (i === 7)
+
+      str << (n & 255)
+      n = n >> 8
+    end
+
+    str.pack('Q')
+  end
+
+  # https://github.com/paragonie/paseto/blob/master/docs/01-Protocol-Versions/Common.md#pae-definition
+  def self.pre_auth_encode(*pieces)
+    compacted_pieces = pieces.compact
+
+    initial_output = encode_length(compacted_pieces.length)
+    compacted_pieces.reduce(initial_output) do |output, piece|
+      output += encode_length(piece.length)
+      output += piece
+    end
+  end
+
+  def self.decode64(str)
+    Base64.urlsafe_decode64(str)
+  end
+
+  def self.encode64(bin)
+    # Remove the padding on the encode64
+    Base64.urlsafe_encode64(bin).gsub(/=+$/, '')
+  end
+end

data/lib/paseto/error.rb

@@ -0,0 +1,6 @@
+module Paseto
+  Error = Class.new(StandardError)
+  HeaderError = Class.new(Error)
+  TokenError = Class.new(Error)
+  AuthenticationError = Class.new(Error)
+end

data/lib/paseto/local.rb

@@ -0,0 +1,84 @@
+module Paseto
+  module V2
+    module Local
+      HEADER = 'v2.local'
+      NONCE_BYTES = RbNaCl::AEAD::XChaCha20Poly1305IETF.nonce_bytes
+
+      NonceError = Class.new(Paseto::Error)
+
+      class Key
+        def self.generate
+          new(RbNaCl::Random.random_bytes(RbNaCl::AEAD::XChaCha20Poly1305IETF.key_bytes))
+        end
+
+        def self.decode64(encoded_key)
+          new(Paseto.decode64(encoded_key))
+        end
+
+        def initialize(key)
+          @key = key
+          @aead = RbNaCl::AEAD::XChaCha20Poly1305IETF.new(key)
+        end
+
+        def encode64
+          Paseto.encode64(@key)
+        end
+
+        def encrypt(message, footer = nil)
+          # Make a nonce: A single-use value never repeated under the same key
+          nonce = generate_nonce(message)
+
+          # Encrypt a message with the AEAD
+          ciphertext = @aead.encrypt(nonce, message, additional_data(nonce, footer))
+
+          Paseto::Token.new(HEADER, nonce + ciphertext, footer).to_message
+        end
+
+        def decrypt(token, footer = nil)
+          footer ||= token.footer if token.is_a? Paseto::Token
+          parsed = Paseto.verify_token(token, HEADER, footer)
+
+          nonce = parsed.payload[0, NONCE_BYTES]
+          ciphertext = parsed.payload[NONCE_BYTES..-1]
+
+          raise BadMessageError.new('Unable to process message') if nonce.nil? || ciphertext.nil?
+
+          begin
+            data = additional_data(nonce, footer)
+            @aead.decrypt(nonce, ciphertext, data)
+          rescue RbNaCl::LengthError
+            raise NonceError, 'Invalid nonce'
+          rescue RbNaCl::CryptoError
+            raise AuthenticationError, 'Token signature invalid'
+          rescue
+            raise TokenError, 'Unable to process message'
+          end
+        end
+
+        private
+
+        def generate_nonce_key
+          RbNaCl::Random.random_bytes(NONCE_BYTES)
+        end
+
+        def generate_nonce(message)
+          RbNaCl::Hash::Blake2b.digest(message,
+                                       key: generate_nonce_key,
+                                       digest_size: NONCE_BYTES)
+        end
+
+        def additional_data(nonce, footer)
+          Paseto.pre_auth_encode(HEADER + '.', nonce, footer)
+        end
+      end
+
+      def self.encrypt(message, key, footer = nil)
+        key.encrypt(message, footer)
+      end
+
+      def self.decrypt(token, key, footer = nil)
+        key.decrypt(token, footer)
+      end
+    end
+  end
+end

data/lib/paseto/public.rb

@@ -0,0 +1,96 @@
+module Paseto
+  module V2
+    module Public
+      HEADER = 'v2.public'
+      SIGNATURE_BYTES = RbNaCl::SigningKey.signature_bytes
+      BadMessageError = Class.new(Paseto::Error)
+
+      module Encoder
+        private
+        def encode_message(message, footer)
+          Paseto.pre_auth_encode(HEADER + '.', message, footer)
+        end
+      end
+
+      class SecretKey
+        include Encoder
+
+        def self.generate
+          new(RbNaCl::SigningKey.generate)
+        end
+
+        def self.decode64(encoded_key)
+          new(Paseto.decode64(encoded_key))
+        end
+
+        def initialize(key)
+          @key = key
+          @nacl = RbNaCl::SigningKey.new(key)
+        end
+
+        def sign(message, footer = nil)
+          data = encode_message(message, footer)
+          # Sign a message with the signing key
+          signature = @nacl.sign(data)
+
+          Paseto::Token.new(HEADER, message + signature, footer).to_message
+        end
+
+        def verify(message, footer = nil)
+          public_key.verify(message, footer)
+        end
+
+        def public_key
+          PublicKey.new(@nacl.verify_key.to_bytes)
+        end
+
+        def encode64
+          Paseto.encode64(@key)
+        end
+      end
+
+      class PublicKey
+        include Encoder
+
+        def self.decode64(encoded_key)
+          new(Paseto.decode64(encoded_key))
+        end
+
+        def initialize(key)
+          @key = key
+          @nacl = RbNaCl::VerifyKey.new(key)
+        end
+
+        def encode64
+          Paseto.encode64(@key)
+        end
+
+        def verify(token, footer = nil)
+          footer ||= token.footer if token.is_a? Paseto::Token
+          parsed = Paseto.verify_token(token, HEADER, footer)
+
+          decoded_message = parsed.payload[0..-(SIGNATURE_BYTES + 1)]
+          signature = parsed.payload[-SIGNATURE_BYTES..-1]
+
+          raise BadMessageError.new('Unable to process message') if decoded_message.nil? || signature.nil?
+
+          begin
+            data = encode_message(decoded_message, footer)
+            @nacl.verify(signature, data)
+            decoded_message
+          rescue RbNaCl::BadSignatureError
+            raise AuthenticationError.new('Token signature invalid')
+          end
+        end
+      end
+
+      def self.sign(message, key, footer = nil)
+        key.sign(message, footer)
+      end
+
+      def self.verify(token, key, footer = nil)
+        key.verify(token, footer)
+      end
+    end
+  end
+end

data/lib/paseto/token.rb

@@ -0,0 +1,37 @@
+module Paseto
+  Token = Struct.new(:header, :payload, :footer) do
+    def to_message
+      message = [
+        header,
+        Paseto.encode64(payload)
+      ]
+
+      message << Paseto.encode64(footer) if footer
+
+      message.join('.')
+    end
+  end
+
+  def self.verify_token(token, expected_header, expected_footer)
+    token = parse(token) unless token.is_a? Token
+    if token.header != expected_header
+      raise HeaderError.new("Invalid message header: #{token.header}")
+    end
+
+    if token.footer != expected_footer
+      raise TokenError.new("Invalid message footer: #{token.footer.inspect}")
+    end
+
+    token
+  end
+
+  def self.parse(raw)
+    version, purpose, payload, footer = raw.split('.')
+
+    header = "#{version}.#{purpose}"
+    footer = Paseto.decode64(footer) unless footer.nil?
+    payload = Paseto.decode64(payload) unless payload.nil?
+
+    Token.new(header, payload, footer)
+  end
+end

data/lib/paseto/version.rb

@@ -0,0 +1,3 @@
+module Paseto
+  VERSION = "0.2.0"
+end

data/paseto.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'paseto/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'paseto'
+  spec.version       = Paseto::VERSION
+  spec.authors       = ['Michael Guymon', 'Frank Murphy']
+  spec.email         = ['mguymon@instructure.com', 'fmurphy@instructure.com']
+
+  spec.summary       = %q{Ruby impl of Paseto}
+  spec.description   = %q{Ruby impl of Paseto}
+  spec.homepage      = 'https://github.com/mguymon/paseto.rb'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rbnacl-libsodium', '~> 1.0'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.11'
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: paseto
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Michael Guymon
+- Frank Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbnacl-libsodium
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Ruby impl of Paseto
+email:
+- mguymon@instructure.com
+- fmurphy@instructure.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/paseto.rb
+- lib/paseto/error.rb
+- lib/paseto/local.rb
+- lib/paseto/public.rb
+- lib/paseto/token.rb
+- lib/paseto/version.rb
+- paseto.gemspec
+homepage: https://github.com/mguymon/paseto.rb
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Ruby impl of Paseto
+test_files: []