jwt-rest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6229e085830cca4899bfa9ef248f02d8ad7fca11
+  data.tar.gz: ef6d83d44c95ae05d62ff1a766761a3ac1e8fe8c
+SHA512:
+  metadata.gz: c1a9043a63577267151a44f191249b12945ffde205baddd09c4fffa4773b1a40bbcd693beb08b11e759dda3170ec67efe8b0d07a69d7a7bd3ab60d66156b120f
+  data.tar.gz: '0900893019db66dbf674673896d4115b64d6c0ec9ce6765f967c872f1738d25b9cf19492b908c5ca19131740aa36c0b0623be5fb126e5b321c09b1a735fa54dd'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 mariowise
+
+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,72 @@
+# jwt-rest
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jwt-rest'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Usage
+
+First you will need to provide a way to find if the ApiKey is valid or not, and a way to retrieve the RSA private key to sign JWT tokens. For this, lets create a initializer `config/initializers/jwt_rest.rb`.
+
+```
+require "jwt_rest"
+
+module JwtRest
+  module Secrets
+    def self.rsa_private_key
+      # return he Base64 encoded of your RSA private key
+    end
+
+    def self.valid_api_key?(api_key)
+      # return true if the api_key is valid
+    end
+  end
+end
+```
+
+Then in your API's base controller do this
+
+```
+class ApiController < ActionController::API
+  include JwtRest::Authenticable
+
+  before_action :demand_application_json
+  before_action :demand_api_key
+
+  def handle_user_identity(jwt_payload)
+    return false unless @current_user = User.find_by(email: jwt_payload.dig("email"))
+    true
+  end
+end
+```
+
+This will ensure that every call to your API i
+s made with a valid api key. You could use the method `demand_current_user` for those endpoins where you need to authenticate the user with the JWT token.
+
+```
+class UsersController < ApiController
+  before_action :demand_current_user, only: [:profile]
+
+  def profile
+    # here we have the @current_user variable
+  end
+end
+```
+
+## Contributing
+Contribution directions go here.
+
+### TODO
+
+* Multiple RSA algorithm types for the JWT token
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Jwt::Rest'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/jwt_rest/auth_header.rb

@@ -0,0 +1,25 @@
+module JwtRest
+  class AuthHeader
+    def initialize(chunk = "")
+      @type, @value = chunk.split(" ")
+      @type = @type&.downcase
+    end
+
+    def is_basic?
+      type == "basic"
+    end
+
+    def is_token?
+      type == "bearer"
+    end
+
+    def token
+      return JwtRest::Tokens::Basic.new(token: value).load_token if is_basic?
+      return JwtRest::Tokens::Jwt.new(token: value).load_token if is_token?
+    end
+
+    private
+
+    attr_accessor :type, :value
+  end
+end

data/lib/jwt_rest/authenticable.rb

@@ -0,0 +1,30 @@
+module JwtRest
+  module Authenticable
+    def demand_application_json
+      unless request.format.symbol == :json
+        render status: :not_acceptable, json: { error: "only application/json Content-Tyle is allowed" }
+      end
+    end
+
+    def demand_api_key
+      api_key = request.headers["HTTP_X_API_KEY"]
+      unless JwtRest::Secrets.valid_api_key?(api_key)
+        render status: :unauthorized, json: { error: "invalid api key" }
+      end
+    end
+
+    def demand_current_user
+      header = JwtRest::AuthHeader.new(request.headers["HTTP_AUTHORIZATION"])
+      unless header.is_token? && header.token && handle_user_identity(header.token.payload)
+        render status: :unauthorized, json: { error: "invalid authorization token" }
+      end
+    end
+
+    # To be defined by the developer
+    # def handle_user_identity(jwt_payload)
+    #   true if the users is valid
+    # end
+
+    attr_reader :current_user
+  end
+end

data/lib/jwt_rest/secrets.rb

@@ -0,0 +1,21 @@
+module JwtRest
+  module Secrets
+    def self.rsa_private_key
+      raise "You should override this method and provide the Base64 encoded of your RSA private key"
+    end
+
+    def self.valid_api_key?(api_key)
+      raise "You should override this method and provide a way to verify your API_KEYs"
+    end
+
+    def self.rsa_private
+      pkey = rsa_private_key
+      begin
+        decoded = Base64.decode64(pkey)
+        OpenSSL::PKey::RSA.new(decoded)
+      rescue
+        raise "Unable to decode your private key. Be sure to provide a valid RSA private key and then apply the Base64 encoding"
+      end
+    end
+  end
+end

data/lib/jwt_rest/tokens/basic.rb

@@ -0,0 +1,31 @@
+module JwtRest
+  module Tokens
+    class Basic
+      attr_reader :username, :password, :token
+
+      def initialize(username: nil, password: nil, token: nil)
+        @username = username
+        @password = password
+        @token = token
+      end
+
+      def load_token
+        @username, @password = decoder(@token).split(":")
+        self
+      end
+
+      def load_credentials
+        @token = encoder("#{username}:#{password}")
+        self
+      end
+
+      def encoder(target)
+        Base64.encode64(target).gsub("\n", "")
+      end
+
+      def decoder(target)
+        Base64.decode64(target)
+      end
+    end
+  end
+end

data/lib/jwt_rest/tokens/jwt.rb

@@ -0,0 +1,34 @@
+module JwtRest
+  module Tokens
+    class JwtRest::Tokens::Jwt
+      attr_reader :payload, :token
+
+      def initialize(payload: nil, token: nil)
+        @payload = payload || {}
+        @token = token
+      end
+
+      def load_payload
+        @payload[:exp] = default_exp unless @payload[:exp]
+        @token = JWT.encode(payload, key, 'RS384')
+        self
+      end
+
+      def load_token
+        parts = JWT.decode(token, key.public_key, true, { algorithm: 'RS384' })
+        @payload = parts.reduce({}, :merge)
+        self
+      end
+
+      private
+
+      def key
+        JwtRest::Secrets.rsa_private
+      end
+
+      def default_exp
+        (Time.now + 24 * 3600).to_i
+      end
+    end
+  end
+end

data/lib/jwt_rest/version.rb

@@ -0,0 +1,3 @@
+module JwtRest
+  VERSION = "0.1.0"
+end

data/lib/jwt_rest.rb

@@ -0,0 +1,10 @@
+require "jwt"
+require "jwt_rest/version"
+require "jwt_rest/secrets"
+require "jwt_rest/tokens/basic"
+require "jwt_rest/tokens/jwt"
+require "jwt_rest/auth_header"
+require "jwt_rest/authenticable"
+
+module JwtRest
+end

data/lib/tasks/jwt/rest_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :jwt_rest do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: jwt-rest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mariowise
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !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 security layer for any API REST in Rails with JWT tokens.
+email:
+- mariolopezlandes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/jwt_rest.rb
+- lib/jwt_rest/auth_header.rb
+- lib/jwt_rest/authenticable.rb
+- lib/jwt_rest/secrets.rb
+- lib/jwt_rest/tokens/basic.rb
+- lib/jwt_rest/tokens/jwt.rb
+- lib/jwt_rest/version.rb
+- lib/tasks/jwt/rest_tasks.rake
+homepage: https://github.com/mariowise/jwt-rest
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A security layer for any API REST in Rails with JWT tokens.
+test_files: []