branca-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed83738a4d8fa5af4ce11072867964581233d64b
+  data.tar.gz: 3bd9e2a9a4ec544199ff8fc4b412e5a8aee1c168
+SHA512:
+  metadata.gz: 57467de90627d3d71cf6c44678a73eff888ab63d8af956d3e8349c62f3370a4f4aefa5328df416ed99a579beae383ad1ca88a5136d57d0b5007513ea11f967bf
+  data.tar.gz: fad2dd6948928afea94699b963500585fe7d95ee2a59cb08dcd77cca3e30d1a5a85a4e19c8c5c8c58d6880c5e11b5e5c1a86cf46a3ca392df92f89b3907e522e

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/.idea/
+.ruby-version
+.byebug_history
+.DS_store
+*.gem

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'branca.gemspec'
+    - 'spec/**/*.rb'

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in branca.gemspec
+gemspec
+
+gem "byebug", "~> 10.0", :group => :test

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Thadeu Esteves Jr
+
+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,77 @@
+#  Branca Tokens for Ruby
+
+Authenticated and encrypted API tokens using modern crypto.
+
+[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
+
+## What?
+
+[Branca](https://github.com/thadeu/branca-ruby) is a secure easy to use token format which makes it hard to shoot yourself in the foot. It uses IETF XChaCha20-Poly1305 AEAD symmetric encryption to create encrypted and tamperproof tokens. Payload itself is an arbitrary sequence of bytes. You can use for example a JSON object, plain text string or even binary data serialized by [MessagePack](http://msgpack.org/) or [Protocol Buffers](https://developers.google.com/protocol-buffers/).
+
+It is possible to use [Branca as an alternative to JWT](https://appelsiini.net/2017/branca-alternative-to-jwt/).
+
+## Install
+
+Add this line to your application's Gemfile, Note that you also must have [libsodium](https://download.libsodium.org/doc/) installed.
+
+```ruby
+gem 'branca-ruby', '~> 1.0.0'
+```
+
+## Configure
+
+You must be configure `secret_key` and `ttl` using this.
+
+```ruby
+Branca.configure do |config|
+  config.secret_key = 'supersecretkeyyoushouldnotcommit'.b
+  config.ttl = 86_400 # in seconds
+end
+```
+
+## Usage
+
+The payload of the token can be anything, like a simple string.
+
+### Encode
+
+```ruby
+Branca.encode('with string')
+
+# 1y48BiLKOcB4N8xjazwFpas3DwOovXzu6vtbiUr4bDAGLaVyFjIN5Xwz5p3qvNYsi5kWjk7ilgnS
+```
+
+or JSON stringified
+
+```ruby
+Branca.encode(JSON.generate({ permissions: [] }))
+
+# ATkzLjriA1ijbBcuZOJ1zMR0z5oVXDGDVjUWwrqJWszynAM4GLGiTwZnC6nUvtVIuavAVCMbwcsYqlYKejOI4
+```
+
+You can also pass `timestamp` to encode
+
+```ruby
+Branca.encode('with string', Time.now.utc)
+
+# 1y48BiV0jaalTYiARPdbm52IKgGEhfwq8DlP9ulKBx8LMLFrjNKe88vIGIUxsWzybIwBhmVvIam5
+```
+
+### Decode
+
+If you branca token isnt expired. You will receive something like this
+
+```ruby
+decode = Branca.decode('1y48BiV0jaalTYiARPdbm52IKgGEhfwq8DlP9ulKBx8LMLFrjNKe88vIGIUxsWzybIwBhmVvIam5')
+
+# <Branca::Decoder:0x00007fde4e3e6398 @message="with string", @timestamp=2020-10-27 03:44:03 UTC>
+
+decode.message
+# "with string"
+```
+
+## Exceptions
+
+Token is expired, will receive exception `Branca::ExpiredTokenError`
+
+Invalid Version, will receive exception `Branca::VersionError`

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'branca'
+
+# 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,9 @@
+#!/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/branca-ruby.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'branca/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'branca-ruby'
+  spec.version       = Branca::VERSION
+  spec.authors       = ['Thadeu Esteves']
+  spec.email         = ['tadeuu@gmail.com']
+  spec.summary       = 'Authenticated and encrypted API tokens using modern crypto'
+  spec.description   = 'Authenticated and encrypted API tokens using modern crypto'
+  spec.homepage      = 'https://github.com/thadeu/branca-ruby'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'base_x', '~> 0.8.1'
+  spec.add_dependency 'rbnacl', '~> 7.0'
+  spec.add_development_dependency 'bundler', '>= 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.70'
+end

data/lib/branca.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'rbnacl'
+require 'base_x'
+
+require 'branca/version'
+require 'branca/exceptions'
+require 'branca/decoder'
+
+module Branca
+  VERSION = 0xBA
+
+  class << self
+    attr_writer :secret_key, :ttl
+
+    def encode(message, timestamp = Time.now.utc)
+      nonce = RbNaCl::Random.random_bytes(cipher.nonce_bytes)
+
+      header = [VERSION, timestamp.to_i].pack('C N') + nonce
+      ciphertext = cipher.encrypt(nonce, message, header)
+      raw_token = header + ciphertext
+
+      BaseX::Base62.encode(raw_token)
+    end
+
+    def decode(token)
+      header, bytes = token_explode(token)
+      version, timestamp, nonce = header_explode(header)
+
+      raise VersionError unless version == VERSION
+      raise ExpiredTokenError if (timestamp + Branca.ttl) < Time.now.utc.to_i
+
+      message = cipher.decrypt(nonce, bytes.pack('C*'), header.pack('C*'))
+      Decoder.new(message, Time.at(timestamp).utc)
+    end
+
+    def ttl
+      @ttl ||= ttl_default
+    end
+
+    def secret_key
+      @secret_key ||= RbNaCl::Random.random_bytes(32)
+    end
+
+    def configure
+      yield self if block_given?
+    end
+
+    private
+
+    def cipher
+      @cipher ||= RbNaCl::AEAD::XChaCha20Poly1305IETF.new(Branca.secret_key&.b)
+    end
+
+    def token_explode(token)
+      bytes = BaseX::Base62.decode(token).unpack('C C4 C24 C*')
+      header = bytes.shift(1 + 4 + 24)
+
+      [header, bytes]
+    end
+
+    def header_explode(header)
+      version = header[0]
+      nonce = header[5..header.size].pack('C*')
+      timestamp = header[1..4].pack('C*').unpack('N')&.first
+
+      [version, timestamp, nonce]
+    end
+
+    def ttl_default
+      @ttl_default ||= 86_400
+    end
+  end
+end

data/lib/branca/decoder.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Branca
+  class Decoder
+    attr_reader :message, :timestamp
+
+    def initialize(message, timestamp)
+      @message = message
+      @timestamp = timestamp
+    end
+  end
+end

data/lib/branca/exceptions.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Branca
+  class VersionError < StandardError; end
+
+  class DecodeError < StandardError
+    def to_s
+      "Can't decode token"
+    end
+  end
+
+  class ExpiredTokenError < StandardError
+    def to_s
+      'Token is expired'
+    end
+  end
+end

data/lib/branca/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Branca
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: branca-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Thadeu Esteves
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base_x
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: rbnacl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.70'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.70'
+description: Authenticated and encrypted API tokens using modern crypto
+email:
+- tadeuu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- branca-ruby.gemspec
+- lib/branca.rb
+- lib/branca/decoder.rb
+- lib/branca/exceptions.rb
+- lib/branca/version.rb
+homepage: https://github.com/thadeu/branca-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.5.2.2
+signing_key:
+specification_version: 4
+summary: Authenticated and encrypted API tokens using modern crypto
+test_files: []