RubyGems - sha256_seal - Versions diffs - 0.1.5 → 0.1.6 - Mend

sha256_seal 0.1.5 → 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d5bc9bfba878593900947fc081b861ecd4470df6721e41645088276663351ac
-  data.tar.gz: 6cc71d89a3aef7555dcb4343753c862764014c5948961fc3167d9e50bccf0335
+  metadata.gz: 315fdea0ce5a82dd8d67b01d083282acee522f691cc3f0aa9b1325efb3ee0866
+  data.tar.gz: a261366546c346d3e24e3ac1eae6d2d54ef7f01ed54a1fa157d2977c2e60bf92
 SHA512:
-  metadata.gz: c309221d7e727a863b89a4faae7b9f417d5ea42f10c59c9adb7c09a4d992e04e77e58eb0bbc86912abc2676fd2f0f98561d687699caca82054b8a04ba59b4f7e
-  data.tar.gz: 04d5c6640cb92472856166bdfb2dbb205c89fe8d040b33a790fb153acd56167bf3dc7bb8eedb1ba0e65b5fc852f70d90b377a184f98129f14d82eff161c1d726
+  metadata.gz: ab1a96fb6978c03e74d0648bcc4c9c79c272ad8ee91ae11794f179c401ce61e0a9414436f22b3195e929fc4580f7dbff5324dc02eecb7b6e6da9270fb850a6f5
+  data.tar.gz: 7a8cdedec7048247f4600cbaa9d84f3060223f45632eb0bd07111fbc19458a37212ea94df3cc7f973d26d6a3e4764e7425e542a4a55a7ba898f0dfe02dd58c05

data/LICENSE.md ADDED Viewed

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2017-2021 Cyril Kato
+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 CHANGED Viewed

@@ -7,7 +7,7 @@ A tiny library to sign documents, and check their integrity.
 Add this line to your application's Gemfile:
 ```ruby
-gem 'sha256_seal'
+gem "sha256_seal"
 ```
 And then execute:
@@ -27,27 +27,24 @@ Sign values and verify signatures of values.
 In the context of a Web application, CSRF tokens could be embedded in URLs.
 ```ruby
-SECRET = 'secret'
+SECRET = "secret".freeze
-document_string = '/.__SIGNATURE_HERE__/accounts/42?editable=false'
-signature_field = '__SIGNATURE_HERE__'
+document_string = "/.__SIGNATURE_HERE__/accounts/42?editable=false"
+signature_field = "__SIGNATURE_HERE__"
 builder = Sha256Seal::Builder.new(document_string, SECRET, signature_field)
 builder.signed_value? # => false
 builder.signed_value  # => "/.a31c3936f236684a8ebc51dcfef168ce124450d71ae1ec404552ec9e0090a8db/accounts/42?editable=false"
-document_string = '/.a31c3936f236684a8ebc51dcfef168ce124450d71ae1ec404552ec9e0090a8db/accounts/42?editable=false'
-signature_field = 'a31c3936f236684a8ebc51dcfef168ce124450d71ae1ec404552ec9e0090a8db'
+document_string = "/.a31c3936f236684a8ebc51dcfef168ce124450d71ae1ec404552ec9e0090a8db/accounts/42?editable=false"
+signature_field = "a31c3936f236684a8ebc51dcfef168ce124450d71ae1ec404552ec9e0090a8db"
 builder = Sha256Seal::Builder.new(document_string, SECRET, signature_field)
 builder.signed_value? # => true
 builder.signed_value  # => "/.a31c3936f236684a8ebc51dcfef168ce124450d71ae1ec404552ec9e0090a8db/accounts/42?editable=false"
-document_string = '/.a31c3936f236684a8ebc51dcfef168ce124450d71ae1ec404552ec9e0090a8db/accounts/42?editable=true'
-signature_field = 'a31c3936f236684a8ebc51dcfef168ce124450d71ae1ec404552ec9e0090a8db'
+document_string = "/.a31c3936f236684a8ebc51dcfef168ce124450d71ae1ec404552ec9e0090a8db/accounts/42?editable=true"
+signature_field = "a31c3936f236684a8ebc51dcfef168ce124450d71ae1ec404552ec9e0090a8db"
 builder = Sha256Seal::Builder.new(document_string, SECRET, signature_field)
 builder.signed_value? # => false
@@ -67,8 +64,8 @@ Route:
 ```ruby
 # config/routes.rb
 Rails.application.routes.draw do
-  scope module: :verified_requests, path: '.:csrf', as: 'verified_request' do
-    get '/accounts/:id', to: 'accounts#show', as: 'account'
+  scope module: :verified_requests, path: ".:csrf", as: "verified_request" do
+    get "/accounts/:id", to: "accounts#show", as: "account"
   end
 end
 ```
@@ -77,42 +74,44 @@ Controller:
 ```ruby
 # app/controllers/verified_requests/base_controller.rb
-class VerifiedRequests::BaseController < ApplicationController
+module VerifiedRequests
+  class BaseController < ApplicationController
   # @see https://api.rubyonrails.org/classes/ActionController/RequestForgeryProtection.html#method-i-verified_request-3F
-  def verified_request?
-    secret          = ENV.fetch('CSRF_SECRET_KEY')
-    document_string = request.original_url.force_encoding('utf-8')
-    signature_field = request.path_parameters.fetch(:csrf)
-    builder = Sha256Seal::Builder.new(document_string, secret, signature_field)
-    builder.signed_value? || Rails.env.test?
-  end
-  def signed_url(route_method, **options)
-    url_route_method  = "#{route_method}_url".to_sym
-    incorrect_csrf    = '__CSRF_SECRET_KEY__'
-    url_route_string  = public_send(url_route_method, csrf: incorrect_csrf, **options)
-    replace_incorrect_csrf_by_correct_csrf(url_route_string, incorrect_csrf: incorrect_csrf)
-  end
-  helper_method :signed_url
-  def replace_incorrect_csrf_by_correct_csrf(value, incorrect_csrf:)
-    secret  = ENV.fetch('CSRF_SECRET_KEY')
-    field   = incorrect_csrf
-    builder = Sha256Seal::Builder.new(value, secret, field)
-    value   = builder.signed_value
-    field   = builder.send(:signature)
-    builder = Sha256Seal::Builder.new(value, secret, field)
-    builder.signed_value
+    def verified_request?
+      secret          = ENV.fetch("CSRF_SECRET_KEY")
+      document_string = request.original_url.force_encoding("utf-8")
+      signature_field = request.path_parameters.fetch(:csrf)
+      builder = Sha256Seal::Builder.new(document_string, secret, signature_field)
+      builder.signed_value? || Rails.env.test?
+    end
+    def signed_url(route_method, **options)
+      url_route_method  = "#{route_method}_url".to_sym
+      incorrect_csrf    = "__CSRF_SECRET_KEY__"
+      url_route_string  = public_send(url_route_method, csrf: incorrect_csrf, **options)
+      replace_incorrect_csrf_by_correct_csrf(url_route_string, incorrect_csrf: incorrect_csrf)
+    end
+    helper_method :signed_url
+    def replace_incorrect_csrf_by_correct_csrf(value, incorrect_csrf:)
+      secret  = ENV.fetch("CSRF_SECRET_KEY")
+      field   = incorrect_csrf
+      builder = Sha256Seal::Builder.new(value, secret, field)
+      value   = builder.signed_value
+      field   = builder.send(:signature)
+      builder = Sha256Seal::Builder.new(value, secret, field)
+      builder.signed_value
+    end
   end
 end
 ```
 View:
-```ruby
+```erb
 # app/views/verified_requests/accounts/show.html.erb
 <%
@@ -120,6 +119,10 @@ View:
 %>
 ```
-## Contributing
+## Versioning
+__Sha256Seal__ uses [Semantic Versioning 2.0.0](https://semver.org/)
+## License
-Bug reports and pull requests are welcome on GitHub at https://github.com/cyril/sha256_seal.rb.
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/sha256_seal.rb CHANGED Viewed

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'digest/sha2'
+require "digest/sha2"
 # Namespace for the Sha256Seal library.
 module Sha256Seal

metadata CHANGED Viewed

@@ -1,124 +1,169 @@
 --- !ruby/object:Gem::Specification
 name: sha256_seal
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Cyril Kato
-autorequire:
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2019-10-09 00:00:00.000000000 Z
+date: 2021-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: fix
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: 1.0.0.beta4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: 1.0.0.beta4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-md
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.75'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.75'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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-rake
+  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-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-thread_safety
+  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: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 description: Seal device with SHA-256 hash function, for Ruby.
-email:
-- contact@cyril.email
+email: contact@cyril.email
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
-- Gemfile
-- Gemfile.lock
+- LICENSE.md
 - 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
 metadata: {}
-post_install_message:
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -126,15 +171,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Seal device with SHA-256 hash function.
 test_files: []

data/.gitignore DELETED Viewed

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

data/.rubocop.yml DELETED Viewed

	@@ -1 +0,0 @@
1	- inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml DELETED Viewed

@@ -1,20 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2019-10-09 21:12:32 +0200 using RuboCop version 0.75.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-# Offense count: 1
-# Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
-Metrics/BlockLength:
-  Max: 32
-# Offense count: 6
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 176

data/.travis.yml DELETED Viewed

@@ -1,22 +0,0 @@
----
-language: ruby
-sudo: false
-cache: bundler
-before_install:
-  - gem install bundler
-script:
-  - bundle exec rubocop
-  - bundle exec rake test
-rvm:
-  - 2.3.8
-  - 2.4.5
-  - 2.5.3
-  - 2.6.3
-  - ruby-head
-  - jruby-head
-  - rbx-3
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: rbx-3

data/Gemfile DELETED Viewed

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

data/Gemfile.lock DELETED Viewed

@@ -1,58 +0,0 @@
-PATH
-  remote: .
-  specs:
-    sha256_seal (0.1.5)
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.0)
-    aw (0.1.6)
-    defi (1.1.5)
-    docile (1.3.2)
-    fix (0.18.2)
-      aw (~> 0.1.6)
-      defi (~> 1.1.5)
-      spectus (~> 3.0.9)
-    jaro_winkler (1.5.3)
-    json (2.2.0)
-    matchi (1.0.4)
-    parallel (1.18.0)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
-    rainbow (3.0.0)
-    rake (13.0.0)
-    rubocop (0.75.0)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.6)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    simplecov (0.17.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    spectus (3.0.9)
-      aw (~> 0.1.6)
-      defi (~> 1.1.5)
-      matchi (~> 1.0.4)
-    unicode-display_width (1.6.0)
-    yard (0.9.20)
-PLATFORMS
-  ruby
-DEPENDENCIES
-  bundler (~> 2.0)
-  fix (~> 0.18)
-  rake (~> 13.0)
-  rubocop (~> 0.75)
-  sha256_seal!
-  simplecov (~> 0.17)
-  yard (~> 0.9)
-BUNDLED WITH
-   2.0.2

data/Rakefile DELETED Viewed

@@ -1,22 +0,0 @@
-# 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 DELETED Viewed

	@@ -1 +0,0 @@
1	- 0.1.5

data/bin/console DELETED Viewed

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

data/bin/setup DELETED Viewed

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

data/sha256_seal.gemspec DELETED Viewed

@@ -1,27 +0,0 @@
-# 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',    '~> 2.0'
-  spec.add_development_dependency 'fix',        '~> 0.18'
-  spec.add_development_dependency 'rake',       '~> 13.0'
-  spec.add_development_dependency 'rubocop',    '~> 0.75'
-  spec.add_development_dependency 'simplecov',  '~> 0.17'
-  spec.add_development_dependency 'yard',       '~> 0.9'
-end