extid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: faeb5eea6b6861a39118d9d05b72f047811ed29c4cc7200bd695fe2f8bccdf87
+  data.tar.gz: 5dfe631e43b5921395e462cf5e37c4037452d4db522f815c3b30e2d4d71cf33d
+SHA512:
+  metadata.gz: 25269a9b265b689afee7642347f289af9440bb2eaac12543ce0f942d00cad2b6ea6186b391ec88ea64e3216943a1e0f89fb746238124478ba30a71e8629f1c99
+  data.tar.gz: 8cc5212c3b1bdcd0a3c9a2c2974caa60743e34e6132fdefcbb6ed444829623cb7056d430fb38971e438b87f8800123a95da09781567fb74b3aeb3ef12ce6ead2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    extid (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.16.3)
+    rake (13.0.6)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  extid!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.3.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Jack Christensen
+
+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,38 @@
+# ExtID
+
+It can be valuable to internally use a serial integer as an ID without revealing that ID to the outside world. extid
+uses AES-128 to convert to and from an external ID that cannot feasibly be decoded without the secret key.
+
+This prevents outsiders from quantifying the usage of your application by observing the rate of increase of IDs as well
+as provides protection against brute force crawling of all resources.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```
+$ bundle add extid
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```
+$ gem install extid
+```
+
+## Usage
+
+```ruby
+require 'extid'
+
+prefix = "user"
+key = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15].pack('C*')
+type = ExtID::Type.new prefix, key
+type.encode(1) # => "user_13189a6ae4ab07ae70a3aabd30be99de"
+type.decode("user_13189a6ae4ab07ae70a3aabd30be99de") # => 1
+```
+
+## Other Implementations
+
+* [Go](https://github.com/jackc/go-extid)
+* [PostgreSQL](https://github.com/jackc/pg-extid)

data/Rakefile

@@ -0,0 +1,12 @@
+# 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
+
+task default: :test

data/extid.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/extid/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "extid"
+  spec.version = ExtID::VERSION
+  spec.authors = ["Jack Christensen"]
+  spec.email = ["jack@jackchristensen.com"]
+
+  spec.summary = "Convert integers to and from opaque external IDs"
+  spec.description = "It can be valuable to internally use a serial integer as an ID without revealing that ID to the outside world. extid uses AES-128 to convert to and from an external ID that cannot feasibly be decoded without the secret key."
+  spec.homepage = "https://github.com/jackc/ruby-extid"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.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
+    `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"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/extid/version.rb

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

data/lib/extid.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'openssl'
+require_relative "extid/version"
+
+module ExtID
+  MinInt64 = -9223372036854775808
+  MaxInt64 = 9223372036854775807
+
+  class Type
+    def initialize(prefix, key)
+      raise ArgumentError, "key must be exactly 16 bytes" unless key.bytesize == 16
+
+      @prefix = prefix + "_"
+      @key = key
+    end
+
+    def encode(n)
+      raise ArgumentError, "n is too small" unless n >= MinInt64
+      raise ArgumentError, "n is too big" unless n <= MaxInt64
+
+      binary_number = [n].pack("q>")
+      raise ArgumentError, "n could not be encoded into 64-bit binary" unless binary_number.bytesize == 8
+      plaintext = binary_number + "\x0\x0\x0\x0\x0\x0\x0\x0"
+
+      cipher = OpenSSL::Cipher.new('AES-128-ECB')
+      cipher.encrypt
+      cipher.key = @key
+      cipher.padding = 0
+
+      ciphertext = cipher.update(plaintext) + cipher.final
+      @prefix + ciphertext.unpack("H*").first
+    end
+
+    def decode(s)
+      raise ArgumentError, "invalid prefix" unless s.start_with?(@prefix)
+      hex_ciphertext = s[@prefix.size..]
+      ciphertext = [hex_ciphertext].pack("H*")
+
+      cipher = OpenSSL::Cipher.new('AES-128-ECB')
+      cipher.decrypt
+      cipher.key = @key
+      cipher.padding = 0
+
+      plaintext = cipher.update(ciphertext) + cipher.final
+      plaintext[0, 8].unpack("q>").first
+    end
+  end
+end

data/sig/extid.rbs

@@ -0,0 +1,10 @@
+module ExtID
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  def initialize: (String prefix, String key) -> void
+
+  def encode: (Integer n) -> String
+
+  def decode: (String s) -> Integer
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: extid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jack Christensen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-26 00:00:00.000000000 Z
+dependencies: []
+description: It can be valuable to internally use a serial integer as an ID without
+  revealing that ID to the outside world. extid uses AES-128 to convert to and from
+  an external ID that cannot feasibly be decoded without the secret key.
+email:
+- jack@jackchristensen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- extid.gemspec
+- lib/extid.rb
+- lib/extid/version.rb
+- sig/extid.rbs
+homepage: https://github.com/jackc/ruby-extid
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jackc/ruby-extid
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.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: Convert integers to and from opaque external IDs
+test_files: []