sha256_seal 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe08fdd230f937e58fbd4448b7e241f5687cd43fb2f9d8b7f67cb7734c02cc12
-  data.tar.gz: d4c1b22c1d1337b351dcd670072d424feaa67d910b6e80c525da31cf5fa31149
+  metadata.gz: 64db1f61edfc475755906217a51b68ae2fb6cc73b222464c57a5a8c2225d7ca5
+  data.tar.gz: cb01c03364b3e87db6e8f8765c820bf97a56e52007313a8ca03d3843cf91bb93
 SHA512:
-  metadata.gz: 4268d5e1ee0612166bdc36552cc146dc5b4e921c0ae5c53c0ff7d5176ac5429bdfc79ea16d8850f66eca35dce59875e57e9a3a1aa9a97fb5567b9ec46d1a665b
-  data.tar.gz: af917520858852378c7bfa2799f88df5266051056df5d881ab7c0d6d7a399adb1b6d5ee4e932b52b1466628fa441d0529a8e9111450ef1a3f6905f1d5b2fd627
+  metadata.gz: ff9b8f59a96112330fd803d01f3cffb360aaf9cc3adcc30fa0f03a8a13db849bfc4a5b10c19648e78baa2a22141fabd645b3d100730afb6fc615e0589abbdb83
+  data.tar.gz: 7439cb713a0696d19e129980d5269aa9d1af7a03b02b372888e57191b78ae78d5ea26337decf2561a1b4fff61f27cd3732e419362f59415c40c602eecff3fe26

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/tmp/
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/LineLength:
+  Max: 176
+
+Metrics/BlockLength:
+  Exclude:
+    - 'fix/**/*'

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.0.pre.2

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}.rb" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    sha256_seal (0.1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    aw (0.1.1)
+    defi (1.1.3)
+    docile (1.3.1)
+    fix (0.17.1)
+      aw (~> 0.1.1)
+      defi (~> 1.1.3)
+      spectus (~> 3.0.6)
+    jaro_winkler (1.5.1)
+    json (2.1.0)
+    matchi (1.0.2)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (12.3.1)
+    rubocop (0.58.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    spectus (3.0.6)
+      aw (~> 0.1.1)
+      defi (~> 1.1.1)
+      matchi (~> 1.0.2)
+    unicode-display_width (1.4.0)
+    yard (0.9.16)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  fix (~> 0.17)
+  rake (~> 12.3)
+  rubocop (~> 0.58)
+  sha256_seal!
+  simplecov (~> 0.16)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,47 @@
+# Sha256Seal
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sha256_seal'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sha256_seal
+
+## Usage
+
+Sign values and verify signatures of values.
+
+## Example
+
+In the context of a Web application, CSRF tokens could be embedded in URLs.
+
+```ruby
+secret  = 'secret'
+
+value   = '/~bob/.__SIGNATURE_HERE__/documents/'
+field   = '__SIGNATURE_HERE__'
+
+builder = Sha256Seal::Builder.new(value, secret, field)
+builder.signed_value  # => "/~bob/.8aa1d38b5c16d077d5ac1360c8a6f0248419ff5a3e6dca28a3233894ddcdf3c4/documents/"
+builder.signed_value? # => false
+
+value   = '/~bob/.8aa1d38b5c16d077d5ac1360c8a6f0248419ff5a3e6dca28a3233894ddcdf3c4/documents/'
+field   = '8aa1d38b5c16d077d5ac1360c8a6f0248419ff5a3e6dca28a3233894ddcdf3c4'
+
+builder = Sha256Seal::Builder.new(value, secret, field)
+builder.signed_value  # => "/~bob/.8aa1d38b5c16d077d5ac1360c8a6f0248419ff5a3e6dca28a3233894ddcdf3c4/documents/"
+builder.signed_value? # => true
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cyril/sha256_seal.rb.

data/Rakefile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.warning = true
+  t.pattern = File.join('fix', '**', '*_fix.rb')
+end
+
+namespace :test do
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task['test'].invoke
+  end
+end
+
+task default: %i[test]

data/VERSION.semver

@@ -0,0 +1 @@
+0.1.4

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'sha256_seal'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/sha256_seal.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'digest/sha2'
+
+# Namespace for the Sha256Seal library.
+module Sha256Seal
+  # Main class for the Sha256Seal library.
+  class Builder
+    attr_reader :value, :secret, :field
+
+    def initialize(value, secret, field)
+      @value  = value.to_s
+      @secret = secret.to_s
+      @field  = field.to_s
+
+      i = @value.scan(@field).length
+
+      raise ArgumentError, "#{i} #{@field.inspect} occurrences instead of 1." unless i.equal?(1)
+    end
+
+    def signed_value
+      value.gsub(field, signature)
+    end
+
+    def signed_value?
+      signature.eql?(field)
+    end
+
+    private
+
+    def signature
+      Digest::SHA256.hexdigest(salt_value)
+    end
+
+    def salt_value
+      value.gsub(field, secret)
+    end
+  end
+end

data/sha256_seal.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sha256_seal'
+  spec.version       = File.read('VERSION.semver').chomp
+  spec.authors       = ['Cyril Kato']
+  spec.email         = ['contact@cyril.email']
+
+  spec.summary       = 'Seal device with SHA-256 hash function.'
+  spec.description   = 'Seal device with SHA-256 hash function, for Ruby.'
+  spec.homepage      = 'https://github.com/cyril/sha256_seal.rb'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(fix)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',    '~> 1.16'
+  spec.add_development_dependency 'fix',        '~> 0.17'
+  spec.add_development_dependency 'rake',       '~> 12.3'
+  spec.add_development_dependency 'rubocop',    '~> 0.58'
+  spec.add_development_dependency 'simplecov',  '~> 0.16'
+  spec.add_development_dependency 'yard',       '~> 0.9'
+end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: sha256_seal
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Cyril Kato
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 2018-08-25 00:00:00.000000000 Z
 dependencies:
@@ -100,7 +100,19 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION.semver
+- bin/console
+- bin/setup
+- lib/sha256_seal.rb
+- sha256_seal.gemspec
 homepage: https://github.com/cyril/sha256_seal.rb
 licenses:
 - MIT