├── doc └── .gitkeep ├── .rspec ├── lib ├── jwt_authentication │ ├── version.rb │ ├── exceptions.rb │ ├── adapter.rb │ ├── devise.rb │ ├── token_generator.rb │ ├── entities_manager.rb │ ├── adapters │ │ ├── mongoid_adapter.rb │ │ ├── rails_adapter.rb │ │ ├── active_record_adapter.rb │ │ └── rails_api_adapter.rb │ ├── acts_as_jwt_authentication_handler.rb │ ├── engine.rb │ ├── sign_in_handler.rb │ ├── configuration.rb │ ├── acts_as_jwt_authenticatable.rb │ ├── entity.rb │ └── jwt_authentication_handler.rb ├── generators │ ├── active_record │ │ ├── templates │ │ │ └── migration.rb │ │ └── jwt_authentication_generator.rb │ ├── jwt_authentication │ │ ├── setup_generator.rb │ │ ├── jwt_authentication_generator.rb │ │ ├── initialize_generator.rb │ │ └── orm_helpers.rb │ └── templates │ │ └── jwt_authentication.rb └── jwt_authentication.rb ├── .gitignore ├── Gemfile ├── app └── controllers │ └── jwt_authentication │ ├── confirmations_controller.rb │ ├── passwords_controller.rb │ ├── sessions_controller.rb │ ├── concerns │ └── jwt_controller_helpers.rb │ └── registrations_controller.rb ├── jwt_authentication.gemspec ├── Rakefile ├── Gemfile.lock ├── README.md └── LICENSE /doc/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.rspec: -------------------------------------------------------------------------------- 1 | --color 2 | --format documentation 3 | --order rand 4 | -------------------------------------------------------------------------------- /lib/jwt_authentication/version.rb: -------------------------------------------------------------------------------- 1 | module JwtAuthentication 2 | VERSION = '0.0.7' 3 | end 4 | -------------------------------------------------------------------------------- /lib/jwt_authentication/exceptions.rb: -------------------------------------------------------------------------------- 1 | module JwtAuthentication 2 | class NotAuthenticated < StandardError 3 | end 4 | end 5 | -------------------------------------------------------------------------------- /lib/jwt_authentication/adapter.rb: -------------------------------------------------------------------------------- 1 | module JwtAuthentication 2 | module Adapter 3 | def base_class 4 | raise NotImplementedError 5 | end 6 | end 7 | end 8 | -------------------------------------------------------------------------------- /lib/jwt_authentication/devise.rb: -------------------------------------------------------------------------------- 1 | require 'devise/models/authenticatable' 2 | 3 | Devise::Models::Authenticatable::BLACKLIST_FOR_SERIALIZATION << :authentication_token 4 | -------------------------------------------------------------------------------- /lib/generators/active_record/templates/migration.rb: -------------------------------------------------------------------------------- 1 | class AddAuthenticationTokenTo<%= table_name.camelize %> < ActiveRecord::Migration 2 | def change 3 | <%= migration_data -%> 4 | end 5 | end 6 | -------------------------------------------------------------------------------- /lib/jwt_authentication/token_generator.rb: -------------------------------------------------------------------------------- 1 | require 'devise' 2 | 3 | module JwtAuthentication 4 | class TokenGenerator 5 | def generate_token 6 | Devise.friendly_token 7 | end 8 | end 9 | end 10 | -------------------------------------------------------------------------------- /lib/jwt_authentication/entities_manager.rb: -------------------------------------------------------------------------------- 1 | require 'jwt_authentication/entity' 2 | 3 | module JwtAuthentication 4 | class EntitiesManager 5 | def find_or_create_entity(model) 6 | @entities ||= {} 7 | @entities[model] ||= Entity.new(model.to_s.classify.constantize) 8 | end 9 | end 10 | end 11 | -------------------------------------------------------------------------------- /lib/generators/jwt_authentication/setup_generator.rb: -------------------------------------------------------------------------------- 1 | module JwtAuthentication 2 | module Generators 3 | class SetupGenerator < Rails::Generators::Base 4 | def all 5 | generate 'jwt_authentication:initialize' 6 | generate 'jwt_authentication User' 7 | end 8 | end 9 | end 10 | end 11 | -------------------------------------------------------------------------------- /lib/generators/jwt_authentication/jwt_authentication_generator.rb: -------------------------------------------------------------------------------- 1 | require 'rails/generators/named_base' 2 | 3 | module JwtAuthentication 4 | module Generators 5 | class JwtAuthenticationGenerator < Rails::Generators::NamedBase 6 | include Rails::Generators::ResourceHelpers 7 | hook_for :orm 8 | end 9 | end 10 | end 11 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .bundle/ 2 | log/*.log 3 | pkg/ 4 | test/dummy/db/*.sqlite3 5 | test/dummy/db/*.sqlite3-journal 6 | test/dummy/log/*.log 7 | test/dummy/tmp/ 8 | test/dummy/.sass-cache 9 | 10 | # Rubygems 11 | *.gem 12 | 13 | # RVM 14 | .ruby-version 15 | .ruby-gemset 16 | 17 | # Editors 18 | *.sublime-project 19 | *.sublime-workspace 20 | 21 | /.idea 22 | -------------------------------------------------------------------------------- /lib/jwt_authentication/adapters/mongoid_adapter.rb: -------------------------------------------------------------------------------- 1 | require 'mongoid' 2 | require 'jwt_authentication/adapter' 3 | 4 | module JwtAuthentication 5 | module Adapters 6 | class MongoidAdapter 7 | extend JwtAuthentication::Adapter 8 | 9 | def self.base_class 10 | ::Mongoid::Document 11 | end 12 | end 13 | end 14 | end 15 | -------------------------------------------------------------------------------- /lib/jwt_authentication/adapters/rails_adapter.rb: -------------------------------------------------------------------------------- 1 | require 'action_controller' 2 | require 'jwt_authentication/adapter' 3 | 4 | module JwtAuthentication 5 | module Adapters 6 | class RailsAdapter 7 | extend JwtAuthentication::Adapter 8 | 9 | def self.base_class 10 | ::ActionController::Base 11 | end 12 | end 13 | end 14 | end 15 | -------------------------------------------------------------------------------- /lib/jwt_authentication/adapters/active_record_adapter.rb: -------------------------------------------------------------------------------- 1 | require 'active_record' 2 | require 'jwt_authentication/adapter' 3 | 4 | module JwtAuthentication 5 | module Adapters 6 | class ActiveRecordAdapter 7 | extend JwtAuthentication::Adapter 8 | 9 | def self.base_class 10 | ::ActiveRecord::Base 11 | end 12 | end 13 | end 14 | end 15 | -------------------------------------------------------------------------------- /lib/jwt_authentication/acts_as_jwt_authentication_handler.rb: -------------------------------------------------------------------------------- 1 | require 'active_support/deprecation' 2 | require 'jwt_authentication/jwt_authentication_handler' 3 | 4 | module JwtAuthentication 5 | module ActsAsJwtAuthenticationHandler 6 | def acts_as_jwt_authentication_handler(options = {}) 7 | include JwtAuthentication::JwtAuthenticationHandler 8 | handle_jwt_authentication(options) 9 | end 10 | end 11 | end 12 | -------------------------------------------------------------------------------- /lib/jwt_authentication/adapters/rails_api_adapter.rb: -------------------------------------------------------------------------------- 1 | require 'action_controller' 2 | require 'jwt_authentication/adapter' 3 | 4 | module JwtAuthentication 5 | module Adapters 6 | class RailsAPIAdapter 7 | extend JwtAuthentication::Adapter 8 | 9 | def self.base_class 10 | ::ActionController::API 11 | end 12 | end 13 | 14 | # make the adpater available even if the 'API' acronym is not defined 15 | RailsApiAdapter = RailsAPIAdapter 16 | end 17 | end 18 | 19 | -------------------------------------------------------------------------------- /lib/jwt_authentication/engine.rb: -------------------------------------------------------------------------------- 1 | module JwtAuthentication 2 | class Engine < ::Rails::Engine 3 | initializer 'jwt-autentication' do |app| 4 | cookies_required = JwtAuthentication.models.any? { |key, value| value.is_a?(Hash) && value.has_key?(:cookie_name) } 5 | 6 | if cookies_required 7 | app.middleware.use ::ActionDispatch::Cookies 8 | 9 | JwtAuthentication::JwtAuthenticationHandler.module_exec do 10 | include ::ActionController::Cookies 11 | end 12 | end 13 | end 14 | end 15 | end 16 | -------------------------------------------------------------------------------- /lib/generators/jwt_authentication/initialize_generator.rb: -------------------------------------------------------------------------------- 1 | require 'rails/generators/base' 2 | require 'securerandom' 3 | 4 | module JwtAuthentication 5 | module Generators 6 | class InitializeGenerator < Rails::Generators::Base 7 | source_root File.expand_path("../../templates", __FILE__) 8 | 9 | desc "Creates a JwtAuthentication initializer in your application." 10 | 11 | def copy_initializer 12 | template "jwt_authentication.rb", "config/initializers/jwt_authentication.rb" 13 | end 14 | 15 | end 16 | end 17 | end 18 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source "https://rubygems.org" 2 | 3 | # Declare your gem's dependencies in simple_token_authentication.gemspec. 4 | # Bundler will treat runtime dependencies like base dependencies, and 5 | # development dependencies will be added by default to the :development group. 6 | gemspec 7 | 8 | # Declare any dependencies that are still in development here instead of in 9 | # your gemspec. These might include edge Rails or gems from your path or 10 | # Git. Remember to move these dependencies to your gemspec before releasing 11 | # your gem to rubygems.org. 12 | 13 | # To use debugger 14 | # gem 'debugger' 15 | 16 | gem 'devise' 17 | gem 'jwt' 18 | -------------------------------------------------------------------------------- /lib/jwt_authentication/sign_in_handler.rb: -------------------------------------------------------------------------------- 1 | module JwtAuthentication 2 | class SignInHandler 3 | # Devise sign in is performed through a controller 4 | # which includes Devise::Controllers::SignInOut 5 | def sign_in(controller, record, *args) 6 | integrate_with_devise_trackable!(controller) 7 | 8 | controller.send(:sign_in, record, *args) 9 | end 10 | 11 | private 12 | 13 | def integrate_with_devise_trackable!(controller) 14 | # Sign in using token should not be tracked by Devise trackable 15 | # See https://github.com/plataformatec/devise/issues/953 16 | controller.env["devise.skip_trackable"] = true 17 | end 18 | end 19 | end 20 | -------------------------------------------------------------------------------- /lib/generators/jwt_authentication/orm_helpers.rb: -------------------------------------------------------------------------------- 1 | module JwtAuthentication 2 | module Generators 3 | module OrmHelpers 4 | def model_contents 5 | " acts_as_jwt_authenticatable\n" 6 | end 7 | 8 | private 9 | 10 | def model_exists? 11 | File.exists?(File.join(destination_root, model_path)) 12 | end 13 | 14 | # check if devise migration exist 15 | def migration_exists?(table_name) 16 | Dir.glob("#{File.join(destination_root, migration_path)}/[0-9]*_*.rb").grep(/\d+_devise_\w+_#{table_name}.rb$/).first 17 | end 18 | 19 | def migration_path 20 | @migration_path ||= File.join("db", "migrate") 21 | end 22 | 23 | def model_path 24 | @model_path ||= File.join("app", "models", "#{file_path}.rb") 25 | end 26 | end 27 | end 28 | end 29 | -------------------------------------------------------------------------------- /app/controllers/jwt_authentication/confirmations_controller.rb: -------------------------------------------------------------------------------- 1 | class JwtAuthentication::ConfirmationsController < Devise::ConfirmationsController 2 | include JwtAuthentication::Concerns::JwtControllerHelpers 3 | 4 | def create 5 | self.resource = resource_class.send_confirmation_instructions(resource_params) 6 | yield resource if block_given? 7 | render nothing: true, status: json_status(true) 8 | end 9 | 10 | def show 11 | self.resource = resource_class.confirm_by_token(params[:confirmation_token]) 12 | yield resource if block_given? 13 | if resource.errors.empty? 14 | token, expires = resource.jwt_token_and_expires 15 | send(:"set_jwt_cookie_for_#{resource_name}", token, expires) 16 | render json: { auth_token: token } 17 | else 18 | render_errors resource.errors 19 | end 20 | end 21 | end 22 | -------------------------------------------------------------------------------- /app/controllers/jwt_authentication/passwords_controller.rb: -------------------------------------------------------------------------------- 1 | class JwtAuthentication::PasswordsController < Devise::PasswordsController 2 | include JwtAuthentication::Concerns::JwtControllerHelpers 3 | 4 | def create 5 | self.resource = resource_class.send_reset_password_instructions(resource_params) 6 | yield resource if block_given? 7 | if resource.errors.empty? 8 | render nothing: true, status: json_status(true) 9 | else 10 | render_errors resource.errors 11 | end 12 | end 13 | 14 | def update 15 | self.resource = resource_class.reset_password_by_token(resource_params) 16 | yield resource if block_given? 17 | if resource.errors.empty? 18 | resource.unlock_access! if unlockable?(resource) 19 | sign_in(resource_name, resource) 20 | token, expires = resource.jwt_token_and_expires 21 | send(:"set_jwt_cookie_for_#{resource_name}", token, expires) 22 | render json: { auth_token: token, resource: resource } 23 | else 24 | render_errors resource.errors 25 | end 26 | end 27 | end 28 | -------------------------------------------------------------------------------- /app/controllers/jwt_authentication/sessions_controller.rb: -------------------------------------------------------------------------------- 1 | class JwtAuthentication::SessionsController < Devise::SessionsController 2 | include JwtAuthentication::Concerns::JwtControllerHelpers 3 | 4 | def create 5 | self.resource = warden.authenticate!({ scope: resource_name, recall: "#{controller_path}#new", store: false }) 6 | sign_in(resource_name, resource) 7 | yield resource if block_given? 8 | 9 | token, expires = resource.jwt_token_and_expires(sign_in_params[:remember_me]) 10 | send(:"set_jwt_cookie_for_#{resource_name}", token, expires) 11 | render json: { auth_token: token, resource: resource } 12 | end 13 | 14 | def destroy 15 | unless all_signed_out? 16 | Devise.sign_out_all_scopes ? sign_out : sign_out(resource_name) 17 | yield if block_given? 18 | end 19 | send(:"destroy_jwt_cookie_for_#{resource_name}") 20 | 21 | render nothing: true, status: json_status(true) 22 | end 23 | 24 | def destroy_all 25 | current_entity = send(:"current_#{resource_name}") 26 | current_entity.regenerate_authentication_token! if current_entity 27 | end 28 | end 29 | -------------------------------------------------------------------------------- /jwt_authentication.gemspec: -------------------------------------------------------------------------------- 1 | $:.push File.expand_path("../lib", __FILE__) 2 | 3 | # Maintain your gem's version: 4 | require "jwt_authentication/version" 5 | 6 | # Describe your gem and declare its dependencies: 7 | Gem::Specification.new do |s| 8 | s.name = "jwt_authentication" 9 | s.version = JwtAuthentication::VERSION 10 | s.authors = ["author"] 11 | s.email = ["auther@mail.com"] 12 | s.homepage = "https://github.com/" 13 | s.summary = "Jwt authentication for Rails apps or API with Devise." 14 | s.license = "GPLv3" 15 | 16 | s.files = Dir["{app,config,doc,lib}/**/*", "LICENSE", "Rakefile", "README.md"] 17 | s.test_files = Dir["spec/**/*"] 18 | 19 | s.add_dependency "actionmailer", ">= 3.2.6", "< 5" 20 | s.add_dependency "actionpack", ">= 3.2.6", "< 5" 21 | s.add_dependency "devise", "~> 3.2" 22 | s.add_dependency "jwt", "~> 1.2.1" 23 | 24 | s.add_development_dependency "rspec", "~> 3.0" 25 | s.add_development_dependency "inch", "~> 0.4" 26 | s.add_development_dependency "activerecord", ">= 3.2.6", "< 5" 27 | s.add_development_dependency 'mongoid', '>= 3.1.0', '< 5' 28 | 29 | end 30 | -------------------------------------------------------------------------------- /app/controllers/jwt_authentication/concerns/jwt_controller_helpers.rb: -------------------------------------------------------------------------------- 1 | module JwtAuthentication 2 | module Concerns 3 | module JwtControllerHelpers 4 | extend ActiveSupport::Concern 5 | 6 | included do 7 | skip_before_filter :verify_authenticity_token # to avoid Devise check anti forgery token 8 | skip_before_filter :verify_signed_out_user # we do it by ourselves 9 | before_filter :allow_params_authentication! 10 | before_filter :set_request_format! 11 | end 12 | 13 | def render_resource_or_errors(resource, options = {}) 14 | if resource.errors.empty? 15 | render options.merge({ json: { resource: resource } }) 16 | else 17 | render_errors resource.errors 18 | end 19 | end 20 | 21 | def json_status(bool) 22 | bool ? :ok : :unprocessable_entity 23 | end 24 | 25 | def require_no_authentication 26 | end 27 | 28 | def set_request_format! 29 | request.format = :json 30 | end 31 | 32 | def render_errors(errors) 33 | status = json_status !JwtAuthentication.status_error_in_response 34 | render json: { errors: errors }, status: status 35 | end 36 | end 37 | end 38 | end 39 | -------------------------------------------------------------------------------- /lib/generators/active_record/jwt_authentication_generator.rb: -------------------------------------------------------------------------------- 1 | require 'rails/generators/active_record' 2 | require 'generators/jwt_authentication/orm_helpers' 3 | 4 | module ActiveRecord 5 | module Generators 6 | class JwtAuthenticationGenerator < ActiveRecord::Generators::Base 7 | include JwtAuthentication::Generators::OrmHelpers 8 | class_option :skipmigrations, :aliases => "-m", :desc => 'Do not create migrations' 9 | 10 | source_root File.expand_path("../templates", __FILE__) 11 | 12 | def inject_devise_content 13 | raise 'Devise migrations was not found' unless (model_exists?) 14 | content = model_contents 15 | 16 | class_path = if namespaced? 17 | class_name.to_s.split("::") 18 | else 19 | [class_name] 20 | end 21 | 22 | inject_into_class(model_path, class_path.last, content) 23 | end 24 | 25 | def copy_migration 26 | return if options[:skipmigrations].present? 27 | raise 'Devise migrations was not found' unless migration_exists?(table_name) 28 | migration_template "migration.rb", "db/migrate/add_authentication_token_to_#{table_name}.rb" 29 | end 30 | 31 | def migration_data 32 | < resource 16 | } 17 | return 18 | else 19 | expire_data_after_sign_in! 20 | end 21 | end 22 | render_resource_or_errors(resource) 23 | end 24 | 25 | def update 26 | self.resource = resource_class.to_adapter.get!(send(:"current_#{resource_name}").to_key) 27 | resource_updated = update_resource(resource, account_update_params) 28 | yield resource if block_given? 29 | if resource_updated 30 | sign_in resource_name, resource, bypass: true 31 | end 32 | render_resource_or_errors(resource) 33 | end 34 | 35 | def destroy 36 | resource.destroy 37 | Devise.sign_out_all_scopes ? sign_out : sign_out(resource_name) 38 | yield resource if block_given? 39 | render nothing: true, status: json_status(resource.destroyed?) 40 | end 41 | end 42 | -------------------------------------------------------------------------------- /lib/jwt_authentication/configuration.rb: -------------------------------------------------------------------------------- 1 | module JwtAuthentication 2 | module Configuration 3 | 4 | mattr_accessor :models 5 | mattr_accessor :controller_adapters 6 | mattr_accessor :model_adapters 7 | mattr_accessor :adapters_dependencies 8 | mattr_accessor :jwt_timeout_verify 9 | mattr_accessor :jwt_timeout_leeway 10 | mattr_accessor :jwt_timeout 11 | mattr_accessor :jwt_timeout_remember_me 12 | mattr_accessor :key_fields 13 | mattr_accessor :status_error_in_response 14 | 15 | @@controller_adapters = ['rails', 'rails_api'] 16 | @@model_adapters = ['active_record', 'mongoid'] 17 | @@adapters_dependencies = { 'active_record' => 'ActiveRecord::Base', 18 | 'mongoid' => 'Mongoid::Document', 19 | 'rails' => 'ActionController::Base', 20 | 'rails_api' => 'ActionController::API' } 21 | @@jwt_timeout_verify = true 22 | @@jwt_timeout_leeway = 60 23 | @@jwt_timeout = 20.minutes 24 | @@jwt_timeout_remember_me = 1.month 25 | @@models = {user: {header_name: 'X-User-Token', 26 | param_name: 'user_token', 27 | sign_in: :devise}} 28 | @@key_fields = [:email] 29 | @@status_error_in_response = false 30 | 31 | def configure 32 | yield self if block_given? 33 | end 34 | 35 | def parse_options(options) 36 | options[:models] ||= @@models 37 | options 38 | end 39 | end 40 | end 41 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | begin 2 | require 'bundler/setup' 3 | rescue LoadError 4 | puts 'You must `gem install bundler` and `bundle install` to run rake tasks' 5 | end 6 | 7 | require 'rdoc/task' 8 | 9 | RDoc::Task.new(:rdoc) do |rdoc| 10 | rdoc.rdoc_dir = 'rdoc' 11 | rdoc.title = 'SimpleTokenAuthentication' 12 | rdoc.options << '--line-numbers' 13 | rdoc.rdoc_files.include('README.rdoc') 14 | rdoc.rdoc_files.include('lib/**/*.rb') 15 | end 16 | 17 | 18 | Bundler::GemHelper.install_tasks 19 | 20 | 21 | begin 22 | require 'inch/rake' 23 | 24 | Inch::Rake::Suggest.new(:inch) do |suggest| 25 | suggest.args << "--private" 26 | suggest.args << "--pedantic" 27 | end 28 | rescue LoadError 29 | desc 'Inch rake task not available' 30 | task :inch do 31 | abort 'Inch rake task is not available. Be sure to install inch as a gem or plugin' 32 | end 33 | end 34 | 35 | begin 36 | require 'rspec/core/rake_task' 37 | 38 | desc 'Provide private interfaces documentation' 39 | RSpec::Core::RakeTask.new(:spec) 40 | 41 | namespace :spec do 42 | desc 'Provide public interfaces documentation' 43 | RSpec::Core::RakeTask.new(:public) do |t| 44 | t.rspec_opts = "--tag public" 45 | end 46 | end 47 | 48 | namespace :spec do 49 | desc 'Provide private interfaces documentation for development purpose' 50 | RSpec::Core::RakeTask.new(:development) do |t| 51 | t.rspec_opts = "--tag protected --tag private" 52 | end 53 | end 54 | rescue LoadError 55 | desc 'RSpec rake task not available' 56 | task :spec do 57 | abort 'RSpec rake task is not available. Be sure to install rspec-core as a gem or plugin' 58 | end 59 | end 60 | 61 | task default: ['spec:public', 'spec:development', :inch] 62 | -------------------------------------------------------------------------------- /lib/jwt_authentication.rb: -------------------------------------------------------------------------------- 1 | require 'jwt_authentication/acts_as_jwt_authenticatable' 2 | require 'jwt_authentication/acts_as_jwt_authentication_handler' 3 | require 'jwt_authentication/configuration' 4 | require 'jwt_authentication/engine' 5 | require 'jwt_authentication/devise' 6 | require 'jwt' 7 | 8 | module JwtAuthentication 9 | extend Configuration 10 | 11 | NoAdapterAvailableError = Class.new(LoadError) 12 | 13 | private 14 | 15 | def self.ensure_models_can_act_as_jwt_authenticatables model_adapters 16 | model_adapters.each do |model_adapter| 17 | model_adapter.base_class.send :include, JwtAuthentication::ActsAsJwtAuthenticatable 18 | end 19 | end 20 | 21 | def self.ensure_controllers_can_act_as_jwt_authentication_handlers controller_adapters 22 | controller_adapters.each do |controller_adapter| 23 | controller_adapter.base_class.send :extend, JwtAuthentication::ActsAsJwtAuthenticationHandler 24 | end 25 | end 26 | 27 | def self.load_available_adapters adapters_short_names 28 | available_adapters = adapters_short_names.collect do |short_name| 29 | adapter_name = "jwt_authentication/adapters/#{short_name}_adapter" 30 | if adapter_dependency_fulfilled?(short_name) && require(adapter_name) 31 | adapter_name.camelize.constantize 32 | end 33 | end 34 | available_adapters.compact! 35 | 36 | raise JwtAuthentication::NoAdapterAvailableError if available_adapters.empty? 37 | 38 | available_adapters 39 | end 40 | 41 | def self.adapter_dependency_fulfilled? adapter_short_name 42 | qualified_const_defined?(JwtAuthentication.adapters_dependencies[adapter_short_name]) 43 | end 44 | 45 | available_model_adapters = load_available_adapters JwtAuthentication.model_adapters 46 | ensure_models_can_act_as_jwt_authenticatables available_model_adapters 47 | 48 | available_controller_adapters = load_available_adapters JwtAuthentication.controller_adapters 49 | ensure_controllers_can_act_as_jwt_authentication_handlers available_controller_adapters 50 | 51 | end 52 | -------------------------------------------------------------------------------- /lib/generators/templates/jwt_authentication.rb: -------------------------------------------------------------------------------- 1 | JwtAuthentication.configure do |config| 2 | # 3 | # # Configure models, that will be default for `acts_as_jwt_authentication_handler` calling. 4 | # # Note: specified model should have `authentication_token` attribute (Model should "act as jwt authenticatable") 5 | # # header_name - name of header to search auth_token in request 6 | # # param_name - name of parameters to search auth_token in request 7 | # # cookie_name - name of cookie to search auth_token in request 8 | # # sign_in - method to be executed if authentication success, possible values: :devise, :simplified 9 | # # if :devise selected, devises method sign_in() will be called at success authentication, 10 | # # if :simplified selected, instance variable with name of resource will be set (@user or @terminal) 11 | # config.models = {user: {header_name: 'X-User-Token', 12 | # param_name: 'user_token', 13 | # # cookie_name: 'user_token', 14 | # sign_in: :devise}} 15 | # 16 | # # Configure mark of jwt timeout verification 17 | # config.jwt_timeout_verify = true 18 | # 19 | # # Configure jwt timeout leeway (value in seconds) 20 | # config.jwt_timeout_leeway = 60 21 | # 22 | # # Configure jwt timeout for simple login (without "remember me) 23 | # # Devise SessionsController generates jwt according to this parameter 24 | # # * This parameter may be overridden in each model: 25 | # # acts_as_jwt_authenticatable jwt_timeout: 10.minutes 26 | # config.jwt_timeout = 20.minutes 27 | # 28 | # # Configure jwt timeout for session login (with "remember me) 29 | # # Devise SessionsController generates jwt according to this parameter 30 | # # * This parameter may be overridden in each model: 31 | # # acts_as_jwt_authenticatable jwt_timeout_remember_me: 1.week 32 | # config.jwt_timeout_remember_me = 1.month 33 | # 34 | # # Configure list of model keys, to be stored in jwt payload. 35 | # # Also, record we be searched by this fields at authentication. 36 | # # * This parameter may be overridden in each model: 37 | # # acts_as_jwt_authenticatable key_fields: [:email, :id] 38 | # config.key_fields = [:email] 39 | # 40 | # # Configure response http-status at fail. If true - status at error will be 422, if false - 200 41 | # config.status_error_in_response = false 42 | # 43 | 44 | end 45 | -------------------------------------------------------------------------------- /lib/jwt_authentication/acts_as_jwt_authenticatable.rb: -------------------------------------------------------------------------------- 1 | require 'active_support/concern' 2 | require 'jwt_authentication/token_generator' 3 | 4 | module JwtAuthentication 5 | module ActsAsJwtAuthenticatable 6 | extend ::ActiveSupport::Concern 7 | 8 | included do 9 | private :generate_authentication_token 10 | private :token_suitable? 11 | private :token_generator 12 | private :token_expires_and_data 13 | end 14 | 15 | def ensure_authentication_token 16 | if authentication_token.blank? 17 | self.authentication_token = generate_authentication_token(token_generator) 18 | end 19 | end 20 | 21 | def generate_authentication_token(token_generator) 22 | loop do 23 | token = token_generator.generate_token 24 | break token if token_suitable?(token) 25 | end 26 | end 27 | 28 | def regenerate_authentication_token! 29 | self.update_column :authentication_token, generate_authentication_token(token_generator) 30 | end 31 | 32 | def token_suitable?(token) 33 | self.class.where(authentication_token: token).count == 0 34 | end 35 | 36 | def token_generator 37 | @token_generator ||= TokenGenerator.new 38 | end 39 | 40 | def token_expires_and_data(remember = false) 41 | data = self.class.jwt_key_fields.inject({}) { |hash, field| hash[field] = self.send field; hash } 42 | 43 | [Time.now + jwt_session_duration(remember), data] 44 | end 45 | 46 | def jwt_token_and_expires(remember = false) 47 | expires, data = token_expires_and_data(remember) 48 | payload = {exp: expires.to_i, self.class.name.underscore => data} 49 | 50 | [JWT.encode(payload, self.authentication_token), expires] 51 | end 52 | 53 | def jwt_token(remember = false) 54 | jwt_token_and_expires(remember).first 55 | end 56 | 57 | def jwt_session_duration(remember = false) 58 | remember ? self.class.jwt_timeout_remember_me : self.class.jwt_timeout 59 | end 60 | 61 | module ClassMethods 62 | def acts_as_jwt_authenticatable(options = {}) 63 | before_save :ensure_authentication_token 64 | @jwt_timeout_remember_me = options[:timeout_remember_me] || JwtAuthentication.jwt_timeout_remember_me 65 | @jwt_timeout = options[:timeout] || JwtAuthentication.jwt_timeout 66 | @jwt_key_fields = options[:key_fields] || JwtAuthentication.key_fields 67 | end 68 | 69 | def jwt_timeout 70 | self.instance_variable_get("@jwt_timeout") 71 | end 72 | 73 | def jwt_timeout_remember_me 74 | self.instance_variable_get("@jwt_timeout_remember_me") 75 | end 76 | 77 | def jwt_key_fields 78 | self.instance_variable_get("@jwt_key_fields") 79 | end 80 | end 81 | end 82 | end 83 | -------------------------------------------------------------------------------- /lib/jwt_authentication/entity.rb: -------------------------------------------------------------------------------- 1 | module JwtAuthentication 2 | class Entity 3 | def initialize(model) 4 | @model = model 5 | @name = model.name 6 | end 7 | 8 | def model 9 | @model 10 | end 11 | 12 | def name 13 | @name 14 | end 15 | 16 | def name_underscore 17 | name.underscore 18 | end 19 | 20 | def token_header_name(controller) 21 | controller.jwt_models[name_underscore.to_sym][:header_name] || "X-#{name}-Token" 22 | end 23 | 24 | def token_param_name(controller) 25 | controller.jwt_models[name_underscore.to_sym][:param_name] || "#{name_underscore}_token" 26 | end 27 | 28 | def token_cookie_name(controller) 29 | controller.jwt_models[name_underscore.to_sym][:cookie_name] 30 | end 31 | 32 | def cookie_enabled?(controller) 33 | token_cookie_name(controller).present? 34 | end 35 | 36 | def get_token_from_cookie(controller) 37 | cookie_enabled?(controller) ? controller.send(:cookies)[token_cookie_name(controller)] : nil 38 | end 39 | 40 | def get_token(controller) 41 | (get_token_from_cookie(controller) || controller.request.headers[token_header_name(controller)] || controller.params[token_param_name(controller)]).to_s 42 | end 43 | 44 | def get_entity(controller) 45 | token = get_token controller 46 | if token.present? 47 | payload = JWT.decode(token, nil, false)[0] # get payload; decode can raise: JWT::DecodeError 48 | keys = model.jwt_key_fields.inject({}) do |hash, field| 49 | hash[field] = payload[name_underscore][field.to_s] 50 | hash 51 | end 52 | keys[:email] = integrate_with_devise_case_insensitive_keys(keys[:email]) if keys[:email].present? 53 | record = find_entity_by_keys(keys) 54 | JWT.decode(token, record.authentication_token, true, verify_expiration: JwtAuthentication.jwt_timeout_verify, leeway: JwtAuthentication.jwt_timeout_leeway) 55 | record 56 | end 57 | rescue 58 | controller.send(:response).headers["x-remove-#{name_underscore}-token"] = 'yes' 59 | controller.send(:cookies).delete(token_cookie_name(controller)) if cookie_enabled?(controller) 60 | nil 61 | end 62 | 63 | def find_entity_by_keys(keys) 64 | model.find_by keys 65 | end 66 | 67 | # Private: Take benefit from Devise case-insensitive keys 68 | # 69 | # See https://github.com/plataformatec/devise/blob/v3.4.1/lib/generators/templates/devise.rb#L45-L48 70 | # 71 | # email - the original email String 72 | # 73 | # Returns an email String which case follows the Devise case-insensitive keys policy 74 | def integrate_with_devise_case_insensitive_keys(email) 75 | email.downcase! if email && Devise.case_insensitive_keys.include?(:email) 76 | email 77 | end 78 | end 79 | end 80 | -------------------------------------------------------------------------------- /Gemfile.lock: -------------------------------------------------------------------------------- 1 | PATH 2 | remote: . 3 | specs: 4 | jwt_authentication (0.0.4) 5 | actionmailer (>= 3.2.6, < 5) 6 | actionpack (>= 3.2.6, < 5) 7 | devise (~> 3.2) 8 | jwt (~> 1.2.1) 9 | 10 | GEM 11 | remote: https://rubygems.org/ 12 | specs: 13 | actionmailer (4.1.8) 14 | actionpack (= 4.1.8) 15 | actionview (= 4.1.8) 16 | mail (~> 2.5, >= 2.5.4) 17 | actionpack (4.1.8) 18 | actionview (= 4.1.8) 19 | activesupport (= 4.1.8) 20 | rack (~> 1.5.2) 21 | rack-test (~> 0.6.2) 22 | actionview (4.1.8) 23 | activesupport (= 4.1.8) 24 | builder (~> 3.1) 25 | erubis (~> 2.7.0) 26 | activemodel (4.1.8) 27 | activesupport (= 4.1.8) 28 | builder (~> 3.1) 29 | activerecord (4.1.8) 30 | activemodel (= 4.1.8) 31 | activesupport (= 4.1.8) 32 | arel (~> 5.0.0) 33 | activesupport (4.1.8) 34 | i18n (~> 0.6, >= 0.6.9) 35 | json (~> 1.7, >= 1.7.7) 36 | minitest (~> 5.1) 37 | thread_safe (~> 0.1) 38 | tzinfo (~> 1.1) 39 | arel (5.0.1.20140414130214) 40 | bcrypt (3.1.9) 41 | bson (2.3.0) 42 | builder (3.2.2) 43 | coderay (1.1.0) 44 | connection_pool (2.0.0) 45 | devise (3.4.1) 46 | bcrypt (~> 3.0) 47 | orm_adapter (~> 0.1) 48 | railties (>= 3.2.6, < 5) 49 | responders 50 | thread_safe (~> 0.1) 51 | warden (~> 1.2.3) 52 | diff-lcs (1.2.5) 53 | erubis (2.7.0) 54 | i18n (0.6.11) 55 | inch (0.5.7) 56 | pry 57 | sparkr (>= 0.2.0) 58 | term-ansicolor 59 | yard (~> 0.8.7.5) 60 | json (1.8.1) 61 | jwt (1.2.1) 62 | mail (2.6.3) 63 | mime-types (>= 1.16, < 3) 64 | method_source (0.8.2) 65 | mime-types (2.4.3) 66 | minitest (5.4.3) 67 | mongoid (4.0.0) 68 | activemodel (~> 4.0) 69 | moped (~> 2.0.0) 70 | origin (~> 2.1) 71 | tzinfo (>= 0.3.37) 72 | moped (2.0.0) 73 | bson (~> 2.2) 74 | connection_pool (~> 2.0) 75 | optionable (~> 0.2.0) 76 | optionable (0.2.0) 77 | origin (2.1.1) 78 | orm_adapter (0.5.0) 79 | pry (0.10.1) 80 | coderay (~> 1.1.0) 81 | method_source (~> 0.8.1) 82 | slop (~> 3.4) 83 | rack (1.5.2) 84 | rack-test (0.6.3) 85 | rack (>= 1.0) 86 | railties (4.1.8) 87 | actionpack (= 4.1.8) 88 | activesupport (= 4.1.8) 89 | rake (>= 0.8.7) 90 | thor (>= 0.18.1, < 2.0) 91 | rake (10.4.2) 92 | responders (1.1.2) 93 | railties (>= 3.2, < 4.2) 94 | rspec (3.1.0) 95 | rspec-core (~> 3.1.0) 96 | rspec-expectations (~> 3.1.0) 97 | rspec-mocks (~> 3.1.0) 98 | rspec-core (3.1.7) 99 | rspec-support (~> 3.1.0) 100 | rspec-expectations (3.1.2) 101 | diff-lcs (>= 1.2.0, < 2.0) 102 | rspec-support (~> 3.1.0) 103 | rspec-mocks (3.1.3) 104 | rspec-support (~> 3.1.0) 105 | rspec-support (3.1.2) 106 | slop (3.6.0) 107 | sparkr (0.4.1) 108 | term-ansicolor (1.3.0) 109 | tins (~> 1.0) 110 | thor (0.19.1) 111 | thread_safe (0.3.4) 112 | tins (1.3.3) 113 | tzinfo (1.2.2) 114 | thread_safe (~> 0.1) 115 | warden (1.2.3) 116 | rack (>= 1.0) 117 | yard (0.8.7.6) 118 | 119 | PLATFORMS 120 | ruby 121 | 122 | DEPENDENCIES 123 | activerecord (>= 3.2.6, < 5) 124 | devise 125 | inch (~> 0.4) 126 | jwt 127 | jwt_authentication! 128 | mongoid (>= 3.1.0, < 5) 129 | rspec (~> 3.0) 130 | -------------------------------------------------------------------------------- /lib/jwt_authentication/jwt_authentication_handler.rb: -------------------------------------------------------------------------------- 1 | require 'active_support/concern' 2 | 3 | require 'jwt_authentication/entities_manager' 4 | require 'jwt_authentication/sign_in_handler' 5 | require 'jwt_authentication/exceptions' 6 | 7 | module JwtAuthentication 8 | module JwtAuthenticationHandler 9 | extend ::ActiveSupport::Concern 10 | 11 | included do 12 | private_class_method :define_jwt_authentication_helpers_for 13 | private_class_method :entities_manager 14 | 15 | private :authenticate_entity_by_jwt! 16 | private :sign_in_handler 17 | private :raise_error! 18 | private :set_jwt_to_cookie 19 | 20 | end 21 | 22 | def authenticate_entity_by_jwt!(entity) 23 | return true unless valid_entity_name?(entity) 24 | record = entity.get_entity(self) 25 | return false unless record.present? 26 | perform_sign_in!(record, sign_in_handler, self) 27 | true 28 | end 29 | 30 | def sign_in_handler 31 | @@sign_in_handler ||= SignInHandler.new 32 | end 33 | 34 | def raise_error! 35 | raise JwtAuthentication::NotAuthenticated.new('Not authenticated') 36 | end 37 | 38 | def set_jwt_to_cookie(entity, token, expires) 39 | return unless entity.cookie_enabled? self 40 | 41 | cookie_name = entity.token_cookie_name(self) 42 | if JwtAuthentication.jwt_timeout_verify 43 | cookies[cookie_name] = {value: token, expires: expires} 44 | else 45 | cookies.permanent[cookie_name] = token 46 | end 47 | end 48 | 49 | def destroy_jwt_cookie(entity) 50 | return unless entity.cookie_enabled? self 51 | 52 | cookie_name = entity.token_cookie_name(self) 53 | cookies[cookie_name] = nil 54 | end 55 | 56 | def valid_entity_name?(entity) 57 | jwt_models.has_key? entity.name_underscore.to_sym 58 | end 59 | 60 | module ClassMethods 61 | def handle_jwt_authentication(options = {}) 62 | options = JwtAuthentication.parse_options(options) 63 | (options[:models] || JwtAuthentication.models).each do |model, params| 64 | entity = entities_manager.find_or_create_entity(model) 65 | define_jwt_authentication_helpers_for(entity) 66 | sign_in_method = params[:sign_in] || :devise 67 | define_sign_in_method(entity, sign_in_method) 68 | end 69 | define_common_helpers(options) 70 | end 71 | 72 | def entities_manager 73 | if class_variable_defined?(:@@entities_manager) 74 | class_variable_get(:@@entities_manager) 75 | else 76 | class_variable_set(:@@entities_manager, EntitiesManager.new) 77 | end 78 | end 79 | 80 | def define_sign_in_method(entity, method = :devise) 81 | case method # :devise, :simplified 82 | when :devise 83 | sign_in_method = lambda { |record, sign_in_handler, controller| sign_in_handler.sign_in controller, record, store: false } 84 | else 85 | sign_in_method = lambda { |record, sign_in_handler, controller| controller.instance_variable_set("@#{entity.name.underscore}", record) } 86 | end 87 | 88 | class_eval do 89 | define_method :perform_sign_in! do |record, sign_in_handler, controller| 90 | sign_in_method.call(record, sign_in_handler, controller) 91 | end 92 | private :perform_sign_in! 93 | end 94 | end 95 | 96 | def define_common_helpers(options) 97 | class_eval do 98 | define_method :jwt_models do 99 | lambda do |models| 100 | return models 101 | end.call(options[:models]) 102 | end 103 | end 104 | end 105 | 106 | def define_jwt_authentication_helpers_for(entity) 107 | class_eval do 108 | define_method "jwt_authenticate_#{entity.name_underscore}".to_sym do 109 | lambda do |_entity| 110 | authenticate_entity_by_jwt!(_entity) 111 | end.call(entity) 112 | end 113 | 114 | define_method "jwt_authenticate_#{entity.name_underscore}!".to_sym do 115 | lambda do |_entity| 116 | raise_error! unless authenticate_entity_by_jwt!(_entity) 117 | end.call(entity) 118 | end 119 | 120 | define_method "set_jwt_cookie_for_#{entity.name_underscore}".to_sym do |token, expires| 121 | lambda do |_entity| 122 | set_jwt_to_cookie(_entity, token, expires) 123 | end.call(entity) 124 | end 125 | 126 | define_method "destroy_jwt_cookie_for_#{entity.name_underscore}".to_sym do 127 | lambda do |_entity| 128 | destroy_jwt_cookie(_entity) 129 | end.call(entity) 130 | end 131 | end 132 | end 133 | end 134 | end 135 | end 136 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | JWT Authentication 2 | =========================== 3 | 4 | [devise]: https://github.com/plataformatec/devise 5 | [jwt-gem]: https://github.com/progrium/ruby-jwt 6 | [sta-gem]: https://github.com/gonzalo-bulnes/simple_token_authentication 7 | 8 | This is a mix of [Simple Token Authentication][sta-gem] and [JWT][jwt-gem], based on [Devise][devise]. 9 | 10 | 11 | 12 | * [Installation](#installation) 13 | * [Using](#using) 14 | * [Configuring](#configuring) 15 | * [Authentication](#authentication) 16 | * [Devise](#devise) 17 | 18 | Installation 19 | ----- 20 | 21 | Add the gem to your `Gemfile`: 22 | 23 | ```ruby 24 | # Gemfile 25 | 26 | gem 'jwt_authentication', github: 'Rezonans/jwt_authentication' 27 | ``` 28 | 29 | Using 30 | ----- 31 | 32 | ### Models 33 | 34 | Make the models token authenticatable 35 | 36 | #### ActiveRecord 37 | 38 | First define which model or models will be token authenticatable (typ. `User`): 39 | 40 | ```ruby 41 | # app/models/user.rb 42 | 43 | class User < ActiveRecord::Base 44 | acts_as_jwt_authenticatable 45 | 46 | # Note: you can include any module you want. If available, 47 | # token authentication will be performed before any other 48 | # Devise authentication method. 49 | # 50 | # Include default devise modules. Others available are: 51 | # :confirmable, :lockable, :timeoutable and :omniauthable 52 | devise :invitable, :database_authenticatable, 53 | :recoverable, :rememberable, :trackable, :validatable, 54 | :lockable 55 | 56 | # ... 57 | end 58 | ``` 59 | 60 | Method `acts_as_jwt_authenticatable` extends Model with several methods: `:jwt_token`, `:generate_authentication_token!` 61 | and some others. Obviously, `:jwt_token` returns token for current record and `:generate_authentication_token!` updates record with new authentication_token. 62 | 63 | If the model or models that you have chosen does not contain `:authentication_token` column, then add the new column onto it (with index): 64 | 65 | ```bash 66 | rails g jwt_authentication MODEL 67 | ``` 68 | This will add 'acts_as_jwt_authenticatable' to specified MODEL. Also, this will generate migration for adding 'authentication_token' to MODEL. 69 | To skip generating migration add '-m' parameter: rails g jwt_authentication User -m. 70 | Migration looks like: 71 | ```ruby 72 | def change 73 | add_column :users, :authentication_token, :string 74 | add_index :users, :authentication_token 75 | end 76 | ``` 77 | 78 | 79 | ### Allow controllers to handle jwt authentication 80 | 81 | Define controllers, which will handle jwt authentication (typ. `HomeController`) for which _jwt authenticatable_ models: 82 | 83 | ```ruby 84 | # app/controllers/home_controller.rb 85 | 86 | class HomeController < ActionController::Base # or ActionController::API 87 | # ... 88 | 89 | acts_as_jwt_authentication_handler 90 | # Note: you can specify several parameters for handling authentication for this controller: 91 | # :models (which "acts as jwt authenticatable") for authenticating, hash, that specifies models 92 | # and those authentication parameters :header_name, :param_name, :sign_in 93 | # 94 | # example: 95 | # acts_as_jwt_authentication_handler models: {terminal: {header_name: 'terminal_auth_token', 96 | # param_name: 'X-Auth-Terminal-Token', 97 | # sign_in: :simplified} 98 | # 99 | # ... 100 | end 101 | ``` 102 | 103 | Method `acts_as_jwt_authentication_handler` extends controller with methods: `:jwt_authenticate_user`, `:jwt_authenticate_user!` and with another ones. 104 | Instead of _user_ there will be specified model names, pair of methods for each model. 105 | 106 | See detailed parameters and methods description in [Authentication](#authentication) 107 | 108 | Atfer controller was extended with jwt_authentication helpers, you may authenticate entity in _actions_ or in _before filter_: 109 | 110 | ```ruby 111 | class TerminalsController < ActionController 112 | acts_as_jwt_authentication_handler models: {terminal: {sign_in: :simlified}} 113 | before_filter :jwt_authenticate_terminal! 114 | 115 | def show 116 | @terminal 117 | end 118 | 119 | end 120 | 121 | ``` 122 | 123 | ### Routing 124 | 125 | Define devise routes for creating devise mapping. 126 | 127 | ```ruby 128 | # config/routes.rb 129 | 130 | ... 131 | devise_for :users, module: :jwt_authentication 132 | ... 133 | 134 | ``` 135 | Devise routing is necessary, because it creates devise mappings. 136 | 137 | Configuring 138 | ------ 139 | 140 | Some aspects of the behavior of _Jwt Authentication_ can be customized with an initializer. 141 | Below is an example with reasonable defaults: 142 | 143 | ```ruby 144 | # config/initializers/jwt_authentication.rb 145 | 146 | JwtAuthentication.configure do |config| 147 | # 148 | # # Configure models, that will be default for `acts_as_jwt_authentication_handler` calling. 149 | # # Note: specified model should have `authentication_token` attribute (Model should "act as jwt authenticatable") 150 | # # header_name - name of header to search auth_token within request 151 | # # param_name - name of parameters to search auth_token within request 152 | # # sign_in - method to be executed if authentication success, possible values: :devise, :simplified 153 | # # if :devise selected, devises method sign_in() will be called at success authentication, 154 | # # if :simplified selected, instance variable with name of resource will be set (@user or @terminal) 155 | # config.models = {user: {header_name: 'X-User-Token', 156 | # param_name: 'user_token', 157 | # sign_in: :devise}} 158 | # 159 | # # Configure mark of jwt timeout verification 160 | # config.jwt_timeout_verify = true 161 | # 162 | # # Configure jwt timeout leeway (value in seconds) 163 | # config.jwt_timeout_leeway = 60 164 | # 165 | # # Configure jwt timeout for simple login (without "remember me") 166 | # # Devise SessionsController generates jwt according to this parameter 167 | # # * This parameter may be overridden in each model: 168 | # # acts_as_jwt_authenticatable jwt_timeout: 10.minutes 169 | # config.jwt_timeout = 20.minutes 170 | # 171 | # # Configure jwt timeout for session login (with "remember me") 172 | # # Devise SessionsController generates jwt according to this parameter 173 | # # * This parameter may be overridden in each model: 174 | # # acts_as_jwt_authenticatable jwt_timeout_remember_me: 1.week 175 | # config.jwt_timeout_remember_me = 1.month 176 | # 177 | # # Configure list of model keys to be stored in jwt payload. 178 | # # Also, record will be searched by this fields at authentication. 179 | # # * This parameter may be overridden in each model: 180 | # # acts_as_jwt_authenticatable key_fields: [:email, :id] 181 | # config.key_fields = [:email] 182 | # 183 | 184 | end 185 | ``` 186 | 187 | Authentication 188 | ----- 189 | 190 | As there was mentioned in [Using](#using), method `acts_as_jwt_authentication_handler` adds to controller two methods: 191 | `:jwt_authenticate_user` and `:jwt_authenticate_user!`. Method with bang raises error, if authentication falls, 192 | method without bang do nothing if authentication falls. 193 | Authentication process is pretty simple: 194 | * Analize request - try to find token either in params or header. If token is not found, authentication falls. 195 | * Read payload from jwt 196 | * Search for entity by field, that payload contains. If entity is not found, authentication falls. 197 | * Decode jwt with entities `authentication_token` (private key, that is stored as entities field). 198 | If `jwt_timeout_verify` specified, timeout verification will take place also. 199 | * If token successfully verified - _sign_in handler_ will be called, otherwise authentication falls. 200 | 201 | `sign_in_handler`. You may specify, what to do at success authentication in `sign_in` parameter in model: 202 | ```ruby 203 | # config/initializers/jwt_authentication.rb 204 | ... 205 | config.models = {user: {sign_in: :devise}} 206 | ... 207 | ``` 208 | There are 2 variants: 209 | * `:devise` (default) - `:sign_in` (devise controller method) will be called 210 | * `:simplified` - create instance variable with resource name (@user, @terminal, etc). 211 | 212 | Devise 213 | ----- 214 | 215 | JwtAuthentication inherits devise controllers: Registrations, Confirmations, Sessions, Passwords. 216 | So, you can extend this functionality with inheritance or override of some of them. 217 | Note, that you need to specify routes to this inherited controllers, like here: 218 | ```ruby 219 | # config/routes.rb 220 | ... 221 | devise_for :users, module: :jwt_authentication 222 | ... 223 | 224 | ``` 225 | _Note: request format will be set to `:json` by before filter `:set_request_format!`, that is plugged to each inherited devise controller. 226 | It is necessary for process action if `warder.authenticate!` falls. It will render view for sessions creating by default, 227 | but in our case we need json response :unauthorized_ 228 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------