token_checksum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 14d770b16d0d2063bd7fccb11c4d6a2c6fd748545ffe08cb7a6f66a5fcbcd0da
+  data.tar.gz: 350aaaff96ae975c1e727bdabb987bcb34c610b6249bb2398c173ee12d5d51f9
+SHA512:
+  metadata.gz: cd520256bd3f79799296f298fe3d074ac698df8cb8a834d75aa9c70148fb2217a286246a5bad46488fe593f2455a8a54a6aa5ae103774704ac9cfff5688de121
+  data.tar.gz: f2130b655f599decab22827b6519f792211bae0d057a51905377cc0a6097502b224b8cf3ee5caf2d80d5ef0f9aeddb10c6ab9885e2526c2a655e66fdf3b1cd9b

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_gem:
+  rubocop-standard:
+    - config/default.yml
+    - config/minitest.yml
+
+Naming/FileName:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-08-30
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in token_checksum.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop-standard"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Garen J. Torikian
+
+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,43 @@
+# TokenChecksum
+
+Generates a 37 character long random token, with an (optional) prefix and a 32-bit checksum in the last 6 digits. Inspired by:
+
+* https://github.blog/2021-04-05-behind-githubs-new-authentication-token-formats/
+* https://github.com/stefansundin/token-checksum
+* https://github.com/alexanderschau/access_token
+
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add token_checksum
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install token_checksum
+
+## Usage
+
+```ruby
+token_one = TokenChecksum.generate("xoxo")
+# "xoxo_3Q8oOwJyFzbuUaYIv2CPyu12K6gjmy2O8PIK"
+
+# highly recommended that you introduce a secret as well
+token_two = TokenChecksum.generate("xoxo", secret: "foo")
+# "xoxo_4ftnAniunUKy6x0V75sMVg1VerpU2y1FoRT2"
+
+# can also validate checksums
+TokenChecksum.valid?(token_one)
+# true
+
+TokenChecksum.valid?(token_two, secret: "foo")
+# true
+
+TokenChecksum.valid?(token_two, secret: "bleh")
+# FALSE
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: [:test, :rubocop]

data/lib/token_checksum/base_62.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module TokenChecksum
+  module Base62
+    PRIMITIVES = ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9"] + \
+      ["A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z"] + \
+      ["a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z"]
+    PRIMITIVES_SIZE = 62
+
+    class << self
+      def encode(int, min_length: 0)
+        return "".rjust(min_length, PRIMITIVES[0]) if int <= 0
+
+        result = ""
+        while int > 0
+          result = PRIMITIVES[int % PRIMITIVES_SIZE] + result
+          int /= PRIMITIVES_SIZE
+        end
+
+        result.rjust(min_length, PRIMITIVES[0])
+      end
+    end
+  end
+end

data/lib/token_checksum/version.rb

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

data/lib/token_checksum.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "token_checksum/base_62"
+require_relative "token_checksum/version"
+
+require "zlib"
+require "securerandom"
+require "securecompare"
+
+if ENV.fetch("DEBUG", "false")
+  require "debug"
+end
+
+module TokenChecksum
+  class << self
+    def generate(prefix, secret: "")
+      suffix = (random_base62 + random_base62)[0...30]
+      first_part = "#{prefix}_#{suffix}"
+      checksum = generate_checksum("#{first_part}#{secret}")
+      "#{first_part}#{checksum}"
+    end
+
+    def valid?(token, secret: "")
+      return false if token.empty?
+
+      provided_checksum = token[-6..-1]
+      return false if provided_checksum.empty?
+
+      # This is the token without the final checksum
+      checksumless_string = token[0..-7]
+      return false if checksumless_string.empty?
+
+      calculated_checksum = generate_checksum("#{checksumless_string}#{secret}")
+
+      SecureCompare.compare(calculated_checksum, provided_checksum)
+    end
+
+    private def generate_checksum(string)
+      checksum = Zlib.crc32(string)
+      Base62.encode(checksum, min_length: 6)
+    end
+
+    private def random_base62
+      Base62.encode(SecureRandom.uuid.delete("-").hex)
+    end
+  end
+end

data/sig/token_checksum.rbs

@@ -0,0 +1,4 @@
+module TokenChecksum
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/token_checksum.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/token_checksum/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "token_checksum"
+  spec.version = TokenChecksum::VERSION
+  spec.authors = ["Garen J. Torikian"]
+  spec.email = ["gjtorikian@users.noreply.github.com"]
+
+  spec.summary = "A token generator with an identifiable prefix and a 32-bit checksum suffix."
+  spec.homepage = "https://github.com/gjtorikian/token_checksum"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0", "< 4.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # 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(__dir__) do
+    %x(git ls-files -z).split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency("securecompare", "~> 1.0")
+
+  spec.add_development_dependency("debug") if "#{RbConfig::CONFIG["MAJOR"]}.#{RbConfig::CONFIG["MINOR"]}".to_f >= 3.1
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: token_checksum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Garen J. Torikian
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: securecompare
+  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: debug
+  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'
+description:
+email:
+- gjtorikian@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/token_checksum.rb
+- lib/token_checksum/base_62.rb
+- lib/token_checksum/version.rb
+- sig/token_checksum.rbs
+- token_checksum.gemspec
+homepage: https://github.com/gjtorikian/token_checksum
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gjtorikian/token_checksum
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.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 token generator with an identifiable prefix and a 32-bit checksum suffix.
+test_files: []