minimal_jwt 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad7bf5f55dbee50ee2fc6bfbaee9523f104f7dcb6818a859e50c4115959dbc16
+  data.tar.gz: 0d8a43623d0bd41129b47a684bc0ccca83cef08c5c288a561b6fdd70990745c1
+SHA512:
+  metadata.gz: 24981349845797583c7bfc8da38b912ac8d0a718804d5c8de23dad41edeab1667b123c97f10859a7f6da0ebfd4cd468806889981f34a28409bd70acd246b3a90
+  data.tar.gz: 87239f370252348588a367f67acab7e15b2c17f373fa8763f9e46b4aea5463b931df014239c9548825261e778a2f230a9f03d7972744dba793598020be5b0ad6

data/README.md

@@ -0,0 +1,3 @@
+# minimal_jwt
+
+A lightweight library for encoding & decoding JSON Web Tokens (JWTs).

data/lib/minimal_jwt/algorithm.rb

@@ -0,0 +1,7 @@
+module MinimalJwt
+  class Algorithm
+    HS256 = :HS256
+    RS256 = :RS256
+    ES256 = :ES256
+  end
+end

data/lib/minimal_jwt/errors/invalid_jwt_error.rb

@@ -0,0 +1,10 @@
+module MinimalJwt
+  class InvalidJwtError < StandardError
+    attr_reader :message
+
+    def initialize(message = '')
+      super
+      @message = message
+    end
+  end
+end

data/lib/minimal_jwt/errors/invalid_payload_error.rb

@@ -0,0 +1,10 @@
+module MinimalJwt
+  class InvalidPayloadError < StandardError
+    attr_reader :message
+
+    def initialize(message = '')
+      super
+      @message = message
+    end
+  end
+end

data/lib/minimal_jwt/errors/unsupported_signing_algorithm_error.rb

@@ -0,0 +1,10 @@
+module MinimalJwt
+  class UnsupportedSigningAlgorithmError < StandardError
+    attr_reader :message
+
+    def initialize(message = '')
+      super
+      @message = message
+    end
+  end
+end

data/lib/minimal_jwt/jwt.rb

@@ -0,0 +1,102 @@
+require 'base64'
+require 'json'
+require 'openssl'
+
+module MinimalJwt
+  class JWT
+    attr_accessor :token
+
+    def initialize(token:)
+      @token = token
+      header, payload, signature = @token.split('.')
+      @header = header
+      @payload = payload
+      @signature = signature
+    end
+
+    def valid?
+      return false if @token.nil?
+      return false if @header.nil? || @payload.nil? || @signature.nil?
+
+      begin
+        base64_decode(@header)
+        base64_decode(@payload)
+        base64_decode(@signature)
+        true
+      rescue StandardError
+        false
+      end
+    end
+
+    def header
+      raise InvalidJwtError unless valid?
+
+      JSON.parse(base64_decode(@header))
+    end
+
+    def payload
+      raise InvalidJwtError unless valid?
+
+      JSON.parse(base64_decode(@payload))
+    end
+
+    def signature_verified?
+      return false unless valid?
+
+      data_to_verify = "#{@header}.#{@payload}"
+      calculated_encoded_signature = base64_encode(signature(Algorithm::HS256, secret, data_to_verify))
+      calculated_encoded_signature == @signature
+    end
+
+    def self.encode(algorithm: Algorithm::HS256, payload:)
+      raise InvalidPayloadError.new('Payload should be a hash') unless payload.is_a?(Hash)
+
+      header = {
+        alg: algorithm,
+        typ: :JWT
+      }
+      encoded_header = base64_encode(header.to_json)
+      encoded_payload = base64_encode(payload.to_json)
+      data_to_sign = "#{encoded_header}.#{encoded_payload}"
+
+      encoded_signature = base64_encode(signature(algorithm, secret, data_to_sign))
+
+      JWT.new(token: "#{data_to_sign}.#{encoded_signature}")
+    end
+
+    private
+
+    def self.signature(algorithm, secret, data_to_sign)
+      case algorithm
+      when Algorithm::HS256
+        OpenSSL::HMAC.digest('sha256', secret, data_to_sign)
+      else
+        raise UnsupportedSigningAlgorithmError.new("Sorry! Signing with #{algorithm.to_s} is not supported yet")
+      end
+    end
+
+    def self.base64_encode(content)
+      Base64.urlsafe_encode64(content).tr('=', '')
+    end
+
+    def self.secret
+      ENV['MINIMAL_JWT_SIGNATURE_SECRET'] || ''
+    end
+
+    def signature(algorithm, secret, data_to_sign)
+      self.class.signature(algorithm, secret, data_to_sign)
+    end
+
+    def base64_encode(content)
+      self.class.base64_encode(content)
+    end
+
+    def secret
+      self.class.secret
+    end
+
+    def base64_decode(content)
+      Base64.urlsafe_decode64(content).tr('=', '')
+    end
+  end
+end

data/lib/minimal_jwt/version.rb

@@ -0,0 +1,3 @@
+module MinimalJwt
+  VERSION = "1.0.1"
+end

data/lib/minimal_jwt.rb

@@ -0,0 +1,7 @@
+require 'minimal_jwt/jwt'
+require 'minimal_jwt/algorithm'
+require 'minimal_jwt/errors/invalid_jwt_error'
+require 'minimal_jwt/errors/invalid_payload_error'
+require 'minimal_jwt/errors/unsupported_signing_algorithm_error'
+
+include MinimalJwt

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: minimal_jwt
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Nikshep A V
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-29 00:00:00.000000000 Z
+dependencies: []
+description: A minimal lightweight JWT library
+email: nikshep.av@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/minimal_jwt.rb
+- lib/minimal_jwt/algorithm.rb
+- lib/minimal_jwt/errors/invalid_jwt_error.rb
+- lib/minimal_jwt/errors/invalid_payload_error.rb
+- lib/minimal_jwt/errors/unsupported_signing_algorithm_error.rb
+- lib/minimal_jwt/jwt.rb
+- lib/minimal_jwt/version.rb
+homepage:
+licenses: []
+metadata:
+  source_code_uri: https://github.com/navrikk/minimal_jwt
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.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: Minimal JWT
+test_files: []