enigma-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f691900c9f844780a09317e57903bd139526e8150b576c7c698f35b13eec0e80
+  data.tar.gz: 598aed28768abee375e5684102b7891c73a6c3540188f70490503259525b1f7f
+SHA512:
+  metadata.gz: b033557d0da1ecfffcbf0c9565b24b9b0ff384b78e339ed77fa4ccc92bd3586c1261cf6afc47ac9ae77bf59259661d69f82039db51ff2389e6c6ba9631728c53
+  data.tar.gz: e9e96d6d20fc1cefde3d27fe4b41204906073f4bd6e3b06d7c0ea60386828a8dd4b78eddff3c9625cae4c96a7b0fc0c49ebd9b4802fb30c1adb7a774cac34132

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-11-11
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Yavor Dashev
+
+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,108 @@
+# Enigma
+
+
+Enigma: Firebase-Compatible Password Verifier for Ruby
+Enigma is a lightweight Ruby gem designed to verify passwords hashed using Firebase's custom scrypt-based algorithm, making it ideal for seamless integrations and migrations involving Firebase authentication systems. It provides a secure, efficient way to compare a user-provided password against a stored hash without exposing sensitive details, ensuring constant-time comparisons to mitigate timing attacks.
+Key Features
+
+Firebase Compatibility: Implements the exact password verification logic used by Firebase Authentication, including scrypt hashing combined with AES-256-CTR encryption for signing.
+Configurable Parameters: Easily customize scrypt parameters (rounds, memory cost), signer keys, and salt separators via a simple configuration block or per-instance overrides.
+Secure Practices: Utilizes OpenSSL's fixed-length secure comparison (when available) to prevent side-channel vulnerabilities.
+Logging Support: Integrates with any Ruby logger (defaults to STDERR) for error tracking, with Rails compatibility out of the box.
+Minimal Dependencies: Relies only on the scrypt gem for hashing, with Base64 and OpenSSL from Ruby's standard library.
+
+Use Case: Migrating Firebase Users to Devise
+One common application of Enigma is during user migrations from Firebase to other authentication systems, such as Devise in a Ruby on Rails application. For instance, when importing users from Firebase, you often need to verify their existing passwords without rehashing them prematurely. Enigma shines here by allowing you to:
+
+Extract Firebase Data: Pull the user's salt (base64-encoded), stored hash (base64-encoded), and other parameters from Firebase exports.
+Verify Input Password: During login or migration, use Enigma to check if the password the user enters matches the Firebase-stored hash.
+Seamless Transition to Devise: If the verification succeeds, you can safely set the raw password value in Devise (e.g., via user.update(password: raw_password)) to generate a new, Devise-compatible hash. This avoids forcing password resets and provides a smooth user experience.
+
+In a real-world migration script, this might look like:
+
+## Installation
+
+ Replace `enigma` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add enigma
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install enigma
+```
+
+## Usage
+
+# In a Rails app, configure once (e.g., in an initializer)
+Enigma.configure do |config|
+  config.base64_signer_key = Rails.application.credentials.dig(:firebase, :base64_signer_key)
+  config.base64_salt_separator = Rails.application.credentials.dig(:firebase, :base64_salt_separator)
+  config.logger = Rails.logger  # Optional: use Rails logger
+end
+
+Then verify
+verifier = Enigma::Verifier.new(
+  password_to_check: "user_password",
+  user_salt_base64: "some_base64_salt",
+  stored_hash_base64: "stored_base64_hash"
+)
+verifier.verify  # => true or false
+
+# Assuming you have Firebase user data
+
+firebase_user = { salt_base64: '...', hash_base64: '...', password_input: user_provided_password }
+
+Enigma.configure do |config|
+  config.base64_signer_key = 'your_firebase_signer_key_base64'
+  config.base64_salt_separator = 'your_firebase_salt_separator_base64'
+end
+
+verifier = Enigma::Verifier.new(
+  password_to_check: firebase_user[:password_input],
+  target_salt_base64: firebase_user[:salt_base64],
+  stored_hash_base64: firebase_user[:hash_base64]
+)
+
+if verifier.verify
+  # Password matches! Migrate to Devise
+  new_user = User.new(email: firebase_user[:email])
+  new_user.password = firebase_user[:password_input]  # Set raw password to let Devise hash it
+  new_user.save
+  puts "User migrated successfully!"
+else
+  puts "Password verification failed. Prompt for reset."
+end
+
+
+
+## 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).
+
+Potential Improvements
+
+If this is specifically for Firebase password verification, name the gem something like firebase-scrypt-verifier to make its purpose clear (check rubygems.org for conflicts).
+Add error handling for invalid base64 inputs or scrypt failures.
+If you want to support hashing (not just verification), extend the class with a hash_password method.
+Check for existing gems: A quick search shows gems like firebase-auth-ruby or scrypt, but if this matches Firebase's exact algo (scrypt with AES signing), your custom implementation could fill a niche.
+
+If you run into issues during setup or need help with a specific part (e.g., testing), provide more details!
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/y-dashev/enigma. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/y-dashev/enigma/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Enigma project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/y-dashev/enigma/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/enigma/verifier.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require "scrypt"
+require "base64"
+require "openssl"
+require "logger"
+
+module Enigma
+  # Verifies the password by comparing it with the stored hash.
+  class Verifier
+    # @!attribute [r] password_to_check
+    #   @return [String] The password to be checked.
+    # @!attribute [r] target_salt_base64
+    #   @return [String] The base64-encoded user salt.
+    # @!attribute [r] stored_hash_base64
+    #   @return [String] The base64-encoded stored hash.
+    # @!attribute [r] base64_signer_key
+    #   @return [String] The base64-encoded signer key.
+    # @!attribute [r] base64_salt_separator
+    #   @return [String] The base64-encoded salt separator.
+    # @!attribute [r] rounds
+    #   @return [Integer] The number of rounds used for password hashing.
+    # @!attribute [r] mem_cost
+    #   @return [Integer] The memory cost used for password hashing.
+    def initialize(password_to_check:, target_salt_base64:, stored_hash_base64:)
+      check_args(password_to_check, target_salt_base64, stored_hash_base64, Enigma.base64_signer_key,
+                 Enigma.base64_salt_separator,
+                 Enigma.rounds, Enigma.mem_cost)
+
+      @password_to_check = password_to_check
+      @target_salt_base64 = target_salt_base64
+      @stored_hash_base64 = stored_hash_base64
+      @base64_signer_key = Enigma.base64_signer_key
+      @base64_salt_separator = Enigma.base64_salt_separator
+      @rounds = Enigma.rounds
+      @mem_cost = Enigma.mem_cost
+    end
+
+    def verify
+      verify_password
+    end
+
+    private
+
+    def check_args(*args)
+      args.each do |arg|
+        if arg.nil?
+          Enigma.logger.error "Argument is nil or missing!"
+          raise EnigmaError, "Missing required argument"
+        end
+      end
+    end
+
+    def verify_password
+      user_salt = decoded_user_salt
+      salt_separator = decoded_salt_separator
+      signer_key = decoded_signer_key
+      stored_hash = decoded_stored_hash
+      scrypt_salt = user_salt + salt_separator
+      scrypt_hash = compute_scrypt_hash(scrypt_salt)
+      computed_hash = encrypt_signer_key(scrypt_hash, signer_key)
+
+      return false if computed_hash.bytesize != stored_hash.bytesize
+
+      secure_compare(computed_hash, stored_hash)
+    end
+
+    def decoded_user_salt
+      Base64.decode64(@target_salt_base64)
+    end
+
+    def decoded_salt_separator
+      Base64.decode64(@base64_salt_separator)
+    end
+
+    def decoded_signer_key
+      Base64.decode64(@base64_signer_key)
+    end
+
+    def decoded_stored_hash
+      Base64.decode64(@stored_hash_base64)
+    end
+
+    def compute_scrypt_hash(scrypt_salt)
+      n = 1 << @mem_cost
+      r = @rounds
+      p = 1
+      dk_len = 32
+      SCrypt::Engine.scrypt(@password_to_check, scrypt_salt, n, r, p, dk_len)
+    end
+
+    def encrypt_signer_key(scrypt_hash, signer_key)
+      iv = "\0" * 16
+      cipher = OpenSSL::Cipher.new("aes-256-ctr")
+      cipher.encrypt
+      cipher.iv = iv
+      cipher.key = scrypt_hash
+      cipher.update(signer_key) + cipher.final
+    end
+
+    def secure_compare(computed_hash, stored_hash)
+      return false unless OpenSSL.respond_to?(:fixed_length_secure_compare)
+
+      OpenSSL.fixed_length_secure_compare(computed_hash, stored_hash)
+    rescue EnigmaError => e
+      Enigma.logger.error "Verification failed: #{e.message}. Returning false."
+      false
+    end
+  end
+end

data/lib/enigma/version.rb

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

data/lib/enigma.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "enigma/version"
+require_relative "enigma/verifier"
+
+# Enigma module provides functionality for encrypting and verifying passwords from scrypt to bcrypt.
+module Enigma
+  class << self
+    attr_accessor :base64_signer_key, :base64_salt_separator, :rounds, :mem_cost, :logger
+
+    def configure
+      yield self if block_given?
+    end
+  end
+
+  self.rounds = 8
+  self.mem_cost = 14
+  self.logger = Logger.new(STDERR)
+
+  class EnigmaError < ArgumentError; end
+end

data/sig/enigma.rbs

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

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: enigma-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yavor Dashev
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: scrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |
+  Enigma is a lightweight Ruby gem designed to verify passwords hashed using Firebase's custom scrypt-based algorithm, making it ideal for seamless integrations and migrations involving Firebase authentication systems. It provides a secure, efficient way to compare a user-provided password against a stored hash without exposing sensitive details, ensuring constant-time comparisons to mitigate timing attacks.
+
+  Key features include:
+  - Full compatibility with Firebase Authentication's password hashing logic, combining scrypt with AES-256-CTR encryption for signing.
+  - Configurable parameters for scrypt (rounds, memory cost), signer keys, and salt separators.
+  - Secure practices using OpenSSL's fixed-length comparisons.
+  - Support for custom logging, with easy integration into Rails or other frameworks.
+  - Minimal dependencies, relying on the 'scrypt' gem alongside Ruby's standard library.
+
+  A common use case is migrating users from Firebase to systems like Devise in Ruby on Rails. During migration, extract the user's base64-encoded salt and stored hash from Firebase, then use Enigma to verify the input password. If it matches, set the raw password in Devise to generate a new hash, avoiding forced resets and ensuring a smooth transition.
+
+  Whether for custom auth systems, password audits, or hybrid setups, Enigma simplifies secure verification while prioritizing ease of use.
+email:
+- 58559918+y-dashev@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/enigma.rb
+- lib/enigma/verifier.rb
+- lib/enigma/version.rb
+- sig/enigma.rbs
+homepage: https://github.com/y-dashev/enigma
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/y-dashev/enigma
+  source_code_uri: https://github.com/y-dashev/enigma
+  changelog_uri: https://github.com/y-dashev/enigma/blob/master/CHANGELOG.md
+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.5.16
+signing_key:
+specification_version: 4
+summary: A Ruby gem for verifying passwords hashed with Firebase's scrypt-based algorithm.
+test_files: []