rack_jwt_aegis 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2d574fb0978ebcc27c003f09163d7485e04ff9af359fbfacaaae62bb04ed484
+  data.tar.gz: d9569601beeb497265025ab704860aaa9bb35f88e94d929ad2561ffc0a5f225a
+SHA512:
+  metadata.gz: 876bbe061f88ba9258b0d7c766984a71e09bd4043352b00b57f760d7910e1cbc8786898346a37d3eba7d0e9ba2bfbc0c3e5d3b0a4b129c4bcfb404eb25c06c57
+  data.tar.gz: 94717f98a46ca598112b76084568ae1cf10c17518ef2305d611a45e672cb5f413bff70254b65411d5dfdcbfc81e0251ba36a85f390d6173b17d24d8e1fcd902f

data/.rubocop.yml

@@ -0,0 +1,160 @@
+plugins:
+  - rubocop-performance
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'adrs/**/*'
+    - 'coverage/**/*'
+    - '.github/**/*'
+    - '.vscode/**/*'
+    - '.history/**/*'
+
+# Layout and Formatting
+Layout/LineLength:
+  Max: 120
+  AllowedPatterns: ['\A\s*#.*\z'] # Allow long comments
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+# Style Guidelines
+Style/Documentation:
+  Enabled: false # Disable for now during development
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+  ConsistentQuotesInMultiline: true
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/ClassAndModuleChildren:
+  Enabled: false # Allow both compact and nested styles
+
+Style/NumericLiterals:
+  MinDigits: 6
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+# Naming Conventions
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+Naming/PredicatePrefix:
+  ForbiddenPrefixes:
+    - is_
+
+# Metrics and Complexity
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/tasks/**/*'
+    - 'config/**/*'
+
+Metrics/ModuleLength:
+  Max: 200
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+Metrics/ClassLength:
+  Max: 150
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+Metrics/MethodLength:
+  Max: 20
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+Metrics/AbcSize:
+  Max: 20
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+Metrics/PerceivedComplexity:
+  Max: 8
+
+# Performance Rules
+Performance/CollectionLiteralInLoop:
+  Enabled: true
+
+Performance/StringReplacement:
+  Enabled: true
+
+Performance/UnfreezeString:
+  Enabled: true
+
+# Security Rules
+Security/Open:
+  Enabled: true
+
+Security/YAMLLoad:
+  Enabled: true
+
+Security/JSONLoad:
+  Enabled: true
+
+# Lint Rules
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'test/**/*'
+
+Lint/SuppressedException:
+  AllowComments: true
+
+# Minitest-specific Rules
+Minitest/MultipleAssertions:
+  Enabled: false # Allow multiple assertions in tests
+
+Minitest/AssertTruthy:
+  Enabled: true
+
+Minitest/AssertWithExpectedArgument:
+  Enabled: true
+
+Minitest/RefuteFalse:
+  Enabled: true
+
+Minitest/RefuteNil:
+  Enabled: true

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 Ken C. Demanawa
+
+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,215 @@
+# Rack JWT Aegis
+
+JWT authentication middleware for hierarchical multi-tenant Rack applications with 2-level tenant support.
+
+**Note: This is version 0.0.0 - a placeholder release to reserve the gem name. Implementation is in progress.**
+
+## Features
+
+- JWT token validation with configurable algorithms
+- 2-level multi-tenant support (Company-Group → Company, Organization → Department, etc.)
+- Subdomain-based tenant isolation for top-level tenants
+- Company slug access control for sub-level tenants
+- Configurable path exclusions for public endpoints
+- Custom payload validation
+- Debug mode for development
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack_jwt_aegis'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install rack_jwt_aegis
+```
+
+## Quick Start
+
+### Rails Application
+
+```ruby
+# config/application.rb
+config.middleware.insert_before 0, RackJwtAegis::Middleware, {
+  jwt_secret: ENV['JWT_SECRET'],
+  company_header_name: 'X-Company-Group-Id',
+  skip_paths: ['/api/v1/login', '/api/v1/refresh', '/health']
+}
+```
+
+### Sinatra Application
+
+```ruby
+require 'rack_jwt_aegis'
+
+use RackJwtAegis::Middleware, {
+  jwt_secret: ENV['JWT_SECRET'],
+  company_header_name: 'X-Company-Group-Id',
+  skip_paths: ['/login', '/health']
+}
+```
+
+### Pure Rack Application
+
+```ruby
+require 'rack_jwt_aegis'
+
+app = Rack::Builder.new do
+  use RackJwtAegis::Middleware, {
+    jwt_secret: ENV['JWT_SECRET'],
+    validate_subdomain: true,
+    validate_company_slug: true
+  }
+
+  run YourApp.new
+end
+```
+
+## Configuration Options
+
+### Basic Configuration
+
+```ruby
+RackJwtAegis::Middleware.new(app, {
+  # JWT Settings (Required)
+  jwt_secret: ENV['JWT_SECRET'],
+  jwt_algorithm: 'HS256',  # Default: 'HS256'
+
+  # Multi-Tenant Settings
+  company_header_name: 'X-Company-Group-Id',  # Default: 'X-Company-Group-Id'
+  validate_subdomain: true,     # Default: false
+  validate_company_slug: true,  # Default: false
+
+  # Path Configuration
+  skip_paths: ['/health', '/api/v1/login', '/api/v1/refresh'],
+  company_slug_pattern: /^\/api\/v1\/([^\/]+)\//,  # Default pattern
+
+  # Response Customization
+  unauthorized_response: { error: 'Authentication required' },
+  forbidden_response: { error: 'Access denied' },
+
+  # Debugging
+  debug_mode: Rails.env.development?  # Default: false
+})
+```
+
+### Advanced Configuration
+
+```ruby
+RackJwtAegis::Middleware.new(app, {
+  jwt_secret: ENV['JWT_SECRET'],
+
+  # Custom Payload Validation
+  custom_payload_validator: ->(payload, request) {
+    # Return true if valid, false if invalid
+    payload['role'] == 'admin' || payload['permissions'].include?('read')
+  },
+
+  # Flexible Payload Mapping
+  payload_mapping: {
+    user_id: :sub,                    # Map 'sub' claim to user_id
+    company_group_id: :company_id,    # Map 'company_id' claim
+    company_group_domain: :domain,    # Map 'domain' claim
+    company_slugs: :accessible_companies  # Map array of accessible companies
+  },
+
+  # Custom Tenant Extraction
+  tenant_strategy: :custom,
+  tenant_extractor: ->(request) {
+    # Extract tenant from custom header or logic
+    request.get_header('HTTP_X_TENANT_ID')
+  }
+})
+```
+
+## Multi-Tenant Support
+
+Rack JWT Aegis provides multiple strategies for multi-tenant authentication:
+
+### Subdomain Validation
+
+```ruby
+# Validates that the JWT's domain matches the request subdomain
+config.validate_subdomain = true
+```
+
+### Company Slug Validation
+
+```ruby
+# Validates that the requested company slug is accessible to the user
+config.validate_company_slug = true
+config.company_slug_pattern = /^\/api\/v1\/([^\/]+)\//
+```
+
+### Header-Based Validation
+
+```ruby
+# Validates the X-Company-Group-Id header against JWT payload
+config.company_header_name = 'X-Company-Group-Id'
+```
+
+## JWT Payload Structure
+
+The middleware expects JWT payloads with the following structure:
+
+```json
+{
+  "user_id": 12345,
+  "company_group_id": 67890,
+  "company_group_domain": "acme.example.com",
+  "company_slugs": ["acme", "acme-corp"],
+  "roles": ["admin", "user"],
+  "exp": 1640995200,
+  "iat": 1640991600
+}
+```
+
+You can customize the payload mapping using the `payload_mapping` configuration option.
+
+## Security Features
+
+- JWT signature verification
+- Token expiration validation
+- Company/tenant access control
+- Subdomain validation
+- Request path filtering for public endpoints
+
+## Performance
+
+- Skip paths are checked before JWT processing
+- Low memory footprint
+
+## Error Handling
+
+The middleware returns appropriate HTTP status codes:
+
+- **401 Unauthorized** - Missing, invalid, or expired JWT
+- **403 Forbidden** - Valid JWT but insufficient permissions/access
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](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 Rack JWT Aegis project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).

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/examples/basic_usage.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/rack_jwt_aegis'
+require 'jwt'
+require 'json'
+require 'rack'
+
+# Example: Basic JWT authentication middleware usage
+
+# 1. Create a simple Rack app
+class SimpleApp
+  def call(env)
+    # Access authenticated user data
+    if RackJwtAegis::RequestContext.authenticated?(env)
+      user_id = RackJwtAegis::RequestContext.user_id(env)
+      company_slugs = RackJwtAegis::RequestContext.company_slugs(env)
+
+      response = {
+        message: 'Hello authenticated user!',
+        user_id: user_id,
+        company_access: company_slugs,
+      }
+
+      [200, { 'Content-Type' => 'application/json' }, [JSON.generate(response)]]
+    else
+      [401, {}, ['Unauthorized']]
+    end
+  end
+end
+
+# 2. Configure the middleware
+Rack::Builder.new do
+  use RackJwtAegis::Middleware, {
+    jwt_secret: 'demo-secret-key',
+
+    # Multi-tenant features
+    validate_subdomain: true,
+    validate_company_slug: true,
+
+    # Skip authentication for health check
+    skip_paths: ['/health'],
+
+    # Debug mode for demonstration
+    debug_mode: true,
+  }
+
+  run SimpleApp.new
+end
+
+# 3. Generate a demo JWT token
+payload = {
+  'user_id' => 123,
+  'company_group_id' => 456,
+  'company_group_domain' => 'acme-corp.example.com',
+  'company_slugs' => ['widgets-division', 'services-division'],
+  'exp' => Time.now.to_i + 3600, # 1 hour from now
+}
+
+token = JWT.encode(payload, 'demo-secret-key', 'HS256')
+
+puts "\n🛡️  Rack JWT Aegis Demo"
+puts '=' * 50
+puts "\n📋 Configuration:"
+puts '- JWT Secret: demo-secret-key'
+puts '- Multi-tenant: Subdomain + Company Slug validation'
+puts '- Skip paths: /health'
+puts '- Debug mode: enabled'
+
+puts "\n🎫 Generated JWT Token:"
+puts "#{token[0..50]}..." if token.length > 50
+
+puts "\n📊 JWT Payload:"
+puts JSON.pretty_generate(payload)
+
+puts "\n✅ Middleware initialized successfully!"
+puts "\n💡 To test this middleware:"
+puts '1. Start a Rack server with this configuration'
+puts '2. Send requests with Authorization: Bearer <token>'
+puts '3. Try different subdomains and company slugs'
+puts '4. Check /health endpoint (should work without auth)'
+
+puts "\n📝 Example curl commands:"
+puts "curl -H 'Authorization: Bearer #{token}' -H 'Host: acme-corp.example.com' http://localhost:3000/api/v1/widgets-division/data"
+puts 'curl http://localhost:3000/health'