l402_middleware 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 70f9855a816d04309f2ec16eb94b5f0385a17c8a4ca6588716f4a136ee29bbc5
+  data.tar.gz: f8185f1bb22374bbf2f5f541569fec57b508d2761082b8d070b9dcd97d555f5f
+SHA512:
+  metadata.gz: a2e01af0cac5c6db1ad99f1cff29bfcacd13ec99ee9f96e3f00ac51f066a9f0a4021cabfb4cf50f5be2dfcd1092b3f719d3c92227bd95dd5c391b946a8e2bbab
+  data.tar.gz: c91b2f77ea8ac6322d7236039c15a90e73dd9848a64f1212e054102b1bac806d0a5eb4d636ca3677b25c806a541579cd30ba4b652c7d235dc73b859998ee523d

data/lib/l402_middleware.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'l402'
+require 'l402_logger'
+require 'l402_config'
+require 'utils'
+require 'constants'
+
+module L402Middleware
+  class << self
+    attr_accessor :configuration
+  end
+
+  class Middleware
+    def initialize(app, config = nil)
+      @app = app
+      @config = L402Middleware::Configuration.new(config || default_config)
+
+      @config.validate!
+
+      verify_connect
+    end
+
+    def call(env)
+      token = extract_auth_token(env)
+      is_valid_l402_token, err = valid_l402_token?(token)
+
+      if free?(env['REQUEST_PATH'].to_s) || (is_valid_l402_token.to_s == "true" && err.nil?)
+        return allow_request(env)
+      end
+
+      invoke_payment(env[L402_AUTHORIZATION_HEADER].present?)
+    end
+
+    private
+
+    def default_config
+      if defined?(Rails)
+        config = Rails.configuration.try(:l402_middleware)
+        unless config
+          raise 'Rails configuration for L402Middleware is missing. Please pass config along with the L402Middleware'
+        end
+
+        config
+      else
+        unless L402Middleware.configuration
+          raise 'Configuration required for standalone mode. Use L402Middleware.configuration to set it.'
+        end
+
+        L402Middleware.configuration
+      end
+    end
+
+    def extract_auth_token(env)
+      auth_header = env[L402_AUTHORIZATION_HEADER]
+      auth_header&.strip
+    end
+
+    # Example token: L402 AGIAJEemVQUTEyNCR0exk7ek90Cg==:1234abcd1234abcd1234abcd
+    def valid_l402_token?(token)
+      return [false, 'missing L02 header'] unless token.to_s.downcase.start_with?("#{L402_HEADER} ")
+
+      token = token.sub(sub_l402_header_regex, "")
+
+      macaroon_part, preimage = token.split(':', 2)
+
+      return [false, 'missing macaroon or primage'] if macaroon_part.blank? || preimage.blank?
+
+      macaroons = macaroon_part.split(',').map(&:strip)
+
+      macaroons.each  do |macaroon|
+        decoded_macaroon = Base64.strict_decode64(macaroon)
+        result, err = L402.verify_l402(decoded_macaroon, preimage, @config)
+
+        return [true, nil] if result.to_s == "true" && err.nil?
+      rescue StandardError => e
+        L402Logger.error("Error verifying macaroon: #{e.message}")
+        return [false, "error verifying macaroon: #{e.message}"] 
+      end
+
+      return [false, 'unauthorized']
+    end
+
+    def allow_request(env)
+      @status, @headers, @response = @app.call(env)
+      [@status, @headers, @response]
+    end
+
+    def invoke_payment(is_unauthorized = false)
+      macaroon, invoice = L402.get_payment_request_details(@config)
+
+      status = 402
+      header = {
+        'Content-Type' => 'application/json',
+        L402_CHALLENGE_HEADER => get_payment_header(macaroon, invoice)
+      }
+      response = is_unauthorized ? unauthorized_response : request_payment_response(macaroon, invoice)
+
+      [status, header, [response]]
+    end
+
+    def verify_connect
+      case @config.network_type
+      when :lnd
+        connect_to_lnd
+      when :lnurl
+        connect_to_lnurl
+      else
+        raise "Unsupported network type: #{@config.network_type}"
+      end
+    end
+
+    def connect_to_lnd
+      lnd_config = @config.lnd
+
+      begin
+        Lighstorm.connect!(
+          address: lnd_config[:address],
+          certificate_path: lnd_config[:tls_certificate_path],
+          macaroon_path: lnd_config[:macaroon_path]
+        )
+        L402Logger.info('Successfully connected to LND network')
+      rescue StandardError => e
+        L402Logger.error("Failed to connect to LND: #{e.message}\n#{e.backtrace.join("\n")}")
+        raise "Unable to establish connection with Lightning network: #{e.message}"
+      end
+    end
+
+    # Placeholder method
+    def connect_to_lnurl
+      @config.lnurl
+      raise 'integration with lnurl is WIP'
+    end
+
+    def free?(request)
+      @config.endpoints.each do |endpoint|
+        L402Logger.info("ENDPOINT: #{endpoint}, request :#{request}, regex: #{@config.endpoints}")
+        return false unless Regexp.new(endpoint).match(request).nil?
+      end
+
+      true
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: l402_middleware
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ritik Jain
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.25.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.25.4
+- !ruby/object:Gem::Dependency
+  name: lighstorm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: macaroons
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: A Ruby middleware implementation for the L402 protocol, leveraging macaroons
+  and the Lightning Network for secure authentication and payments.
+email: ritikjain1272@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/l402_middleware.rb
+homepage: https://rubygems.org/gems/l402_middleware
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/rits1272/l402_middleware
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: L402 middleware for authentication and payment handling
+test_files: []