hmac 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0da92960c7fa56af039d5ff4422bf8639e3cabafd4a948bfafb5106c61f6370a
+  data.tar.gz: 9d060d4d8289a347d5ec042596c522080456fb48869a5827efb4cb6be9609820
+SHA512:
+  metadata.gz: 24ebf43647946a309f3538f4d1f379acc9687922de50500c77199e1faac1d07b7f6c81d7cba6e9eecf3de3880bdd06573cdb9b437f6e3bff6a0b45d8e69a2daa
+  data.tar.gz: d595bc49f1742dfaae7f8f3e2dc1ae931caf3cac3946503ccc08c2a8b9473aa91739bfd9d4718b3a25e9927866eb65636676828cbd68f6e70936d6f074ab6927

data/.circleci/config.yml

@@ -0,0 +1,13 @@
+version: 2.1
+jobs:
+  build:
+    docker:
+      - image: ruby:3.1
+    steps:
+      - checkout
+      - run:
+          name: Run the default task
+          command: |
+            gem install bundler -v 2.3.10
+            bundle install
+            bundle exec rake

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,226 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  Exclude:
+    - bin/**/*
+  <% `git status --ignored --porcelain`.scan(/^!!\s+(.*)$/).each do |match| %>
+    - <%= match[0] %>**/*
+  <% end %>
+
+# Extensions
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+# New rules
+Lint/DuplicateBranch: # (new in 1.3)
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
+  Enabled: true
+Lint/EmptyBlock: # (new in 1.1)
+  Enabled: true
+Lint/EmptyClass: # (new in 1.3)
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
+  Enabled: true
+Lint/ToEnumArguments: # (new in 1.1)
+  Enabled: true
+Lint/UnexpectedBlockArity: # (new in 1.5)
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
+  Enabled: true
+Style/ArgumentsForwarding: # (new in 1.1)
+  Enabled: true
+Style/CollectionCompact: # (new in 1.2)
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # (new in 1.1)
+  Enabled: true
+Style/NegatedIfElseCondition: # (new in 1.2)
+  Enabled: true
+Style/NilLambda: # (new in 1.3)
+  Enabled: true
+Style/RedundantArgument: # (new in 1.4)
+  Enabled: true
+Style/SwapValues: # (new in 1.1)
+  Enabled: true
+Gemspec/DateAssignment: # (new in 1.10)
+  Enabled: true
+Layout/SpaceBeforeBrackets: # (new in 1.7)
+  Enabled: true
+Lint/AmbiguousAssignment: # (new in 1.7)
+  Enabled: true
+Lint/DeprecatedConstants: # (new in 1.8)
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
+  Enabled: true
+Lint/NumberedParameterAssignment: # (new in 1.9)
+  Enabled: true
+Lint/OrAssignmentToConstant: # (new in 1.9)
+  Enabled: true
+Lint/RedundantDirGlobSort: # (new in 1.8)
+  Enabled: true
+Lint/SymbolConversion: # (new in 1.9)
+  Enabled: true
+Lint/TripleQuotes: # (new in 1.9)
+  Enabled: true
+Style/EndlessMethod: # (new in 1.8)
+  Enabled: true
+Style/HashConversion: # (new in 1.10)
+  Enabled: true
+Style/HashExcept: # (new in 1.7)
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # (new in 1.9)
+  Enabled: true
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  Enabled: true
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+Style/StringChars: # new in 1.12
+  Enabled: true
+RSpec/ExcessiveDocstringSpacing: # new in 2.5
+  Enabled: true
+RSpec/IdenticalEqualityAssertion: # new in 2.4
+  Enabled: true
+RSpec/SubjectDeclaration: # new in 2.5
+  Enabled: true
+RSpec/FactoryBot/SyntaxMethods: # new in 2.7
+  Enabled: true
+RSpec/Rails/AvoidSetupHook: # new in 2.4
+  Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+RSpec/BeEq: # new in 2.9.0
+  Enabled: true
+RSpec/BeNil: # new in 2.9.0
+  Enabled: true
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+
+# Alterations
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+Style/BlockComments:
+  Exclude:
+    - spec/**/*
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+RSpec/NestedGroups:
+  Enabled: false
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/ContextWording:
+  Prefixes:
+    - but
+    - if
+    - when
+    - with
+    - without
+RSpec/AnyInstance:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+Layout/ArgumentAlignment:
+  Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Layout/MultilineMethodCallBraceLayout:
+  EnforcedStyle: new_line
+Style/AsciiComments:
+  Enabled: false
+Layout/CaseIndentation:
+  EnforcedStyle: end
+Style/Lambda:
+  Enabled: false
+Layout/SpaceInLambdaLiteral:
+  Enabled: false
+Style/RedundantSelf:
+  Enabled: false
+Style/PreferredHashMethods:
+  EnforcedStyle: verbose
+Style/IfUnlessModifier:
+  Enabled: false
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+  AllowBracesOnProceduralOneLiners: true
+Style/GuardClause:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Naming/MethodParameterName:
+  AllowedNames:
+    - as
+    - id
+Metrics/AbcSize:
+  Enabled: false
+Style/IfUnlessModifierOfIfUnless:
+  Enabled: false
+Style/NestedModifier:
+  Enabled: false
+Style/SoleNestedConditional:
+  Enabled: false
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+RSpec/SubjectStub:
+  Enabled: false
+Layout/ArrayAlignment:
+  Enabled: false
+Layout/FirstArrayElementIndentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.1.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2022-04-13
+
+- Initial release

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hmac.gemspec
+gemspec
+
+gem "climate_control", "~> 1.0"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.11"
+gem "rubocop", "~> 1.7"
+gem "rubocop-rake", "~> 0.6"
+gem "rubocop-rspec", "~> 2.9"

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    hmac (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    climate_control (1.0.1)
+    diff-lcs (1.5.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.3.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.27.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.9.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-darwin-21
+
+DEPENDENCIES
+  climate_control (~> 1.0)
+  hmac!
+  rake (~> 13.0)
+  rspec (~> 3.11)
+  rubocop (~> 1.7)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 2.9)
+
+BUNDLED WITH
+   2.3.10

data/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Smart/Casual Ltd
+
+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,31 @@
+# HMAC
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hmac'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install hmac
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, 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/SmartCasual/hmac.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+require "rspec/core/rake_task"
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop spec]

data/bin/console

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "lib/hmac/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hmac"
+  spec.version       = HMAC::VERSION
+  spec.authors       = ["Elliot Crosby-McCullough"]
+  spec.email         = ["elliot.cm@gmail.com"]
+
+  spec.summary       = "A utility for generating and validating HMAC signatures"
+  spec.homepage      = "https://github.com/SmartCasual/hmac"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/SmartCasual/hmac/blob/#{spec.version}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) {
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  }
+  spec.require_paths = ["lib"]
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

data/lib/hmac/generator.rb

@@ -0,0 +1,33 @@
+module HMAC
+  class Generator
+    def initialize(context:, public: false)
+      @context = context
+      @public = public
+      @digest = OpenSSL::Digest.new("SHA256")
+      @hmac_key = ENV.fetch("HMAC_SECRET")
+    end
+
+    def generate(id:)
+      OpenSSL::HMAC
+        .new(hmac_key, digest)
+        .update(id.to_s)
+        .update(context)
+        .tap { |hmac| hmac.update("public") if public? }
+        .hexdigest
+    end
+
+  private
+
+    attr_reader(
+      *%I[
+        context
+        digest
+        hmac_key
+      ],
+    )
+
+    def public?
+      !!@public
+    end
+  end
+end

data/lib/hmac/validator.rb

@@ -0,0 +1,17 @@
+module HMAC
+  class Validator
+    def initialize(...)
+      @generator = HMAC::Generator.new(...)
+    end
+
+    def validate(hmac, against_id:)
+      present?(hmac) && hmac == @generator.generate(id: against_id)
+    end
+
+  private
+
+    def present?(string)
+      !string.nil? && !string.empty?
+    end
+  end
+end

data/lib/hmac/version.rb

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

data/lib/hmac.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module HMAC; end
+
+require_relative "hmac/generator"
+require_relative "hmac/validator"

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: hmac
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Elliot Crosby-McCullough
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-13 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- elliot.cm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENCE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hmac.gemspec
+- lib/hmac.rb
+- lib/hmac/generator.rb
+- lib/hmac/validator.rb
+- lib/hmac/version.rb
+homepage: https://github.com/SmartCasual/hmac
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/SmartCasual/hmac
+  source_code_uri: https://github.com/SmartCasual/hmac
+  changelog_uri: https://github.com/SmartCasual/hmac/blob/1.0.0/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A utility for generating and validating HMAC signatures
+test_files: []