touth 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 897c36cb2334dae65ce580c4a3b952045b1b5d43
+  data.tar.gz: 6bd3f571f4c5cf62bae2a7164b0174623e03e8c5
+SHA512:
+  metadata.gz: e5190b10304a511c916cb90a921c343ce46510c2386268cd49b0de5ef162aac3c6fdb723deeee385918ea1aec37950b73a4dfef073cb58fbf15ca972e34a4a6b
+  data.tar.gz: 1bf88d5b71449557118e117c4bfdf1cd09969aeebf601b15ff9ab3c8ece3b67fae66902ee23def5766409752338da0ae0eee8034094df97b2a4e238fbb6410c9

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in touth.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yuki Iwanaga
+
+MIT License
+
+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,111 @@
+Touth
+=====
+
+Secure and simple token based authentication for Rails.
+
+No dependencies. No migration necessary. Session-less.
+
+
+Getting started
+---------------
+
+Touth works with Rails 3.x and 4.x. Add this line to Gemfile:
+
+```rub
+gem 'touth'
+```
+
+### Model
+
+```ruby
+class UserAccount < ActiveRecord::Base
+
+  acts_as_token_authenticatable
+
+end
+```
+
+### Controller
+
+```ruby
+class ApplicationController < ActionController::Base
+
+  token_authentication_for :user_account
+
+end
+```
+
+### Helper methods
+
+Checking if a user is signed in, and getting the current signed-in user, the following Devise-like helpers is available:
+
+- `user_account_signed_in?`
+- `current_user_account`
+
+### Hooks
+
+- `authenticate_entity_from_token!`
+
+### Fallbacks
+
+- `token_authentication_error!(type)`
+
+
+Usage
+-----
+
+### Access token generation
+
+```ruby
+user_account = UserAccount.first
+
+user_account.access_token
+```
+
+### Authentication by request headers
+
+```
+X-Auth-ID: 1
+X-Auth-Token: 9619feb4b8d54352ae07588d011da48385c8c4f072ab889d3996d127ad2142fc6213d553
+```
+
+
+Configuation
+------------
+
+Touth can be customized with an initializer in `config/initializers/touth.rb`.
+
+```ruby
+Touth.setup do |config|
+  config.access_token_lifetime = 60.days
+  config.client_secret_key     = ''  # use SecureRandom.hex(64) to generate one
+  config.password_field        = :encrypted_password  # works nice with devise
+end
+```
+
+
+Contributing
+------------
+
+Contributions are always welcome!
+
+### Bug reports
+
+1. Ensure the bug can be reproduced on the latest master.
+2. Check it's not a duplicate.
+3. Raise an issue.
+
+
+### Pull requests
+
+1. Fork the repository.
+2. Create a branch.
+6. Create a new pull request.
+
+
+License
+-------
+
+This project is copyright by [Creasty](http://www.creasty.com), released under the MIT lisence.  
+See `LICENSE` file for details.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/touth.rb

@@ -0,0 +1,69 @@
+require 'active_support'
+
+require_relative 'touth/engine' if defined? Rails
+
+
+#  Touth
+#-----------------------------------------------
+module Touth
+
+  extend ActiveSupport::Autoload
+
+  autoload :ActsAsTokenAuthenticatable
+  autoload :ActiveRecordSupport
+  autoload :ActionControllerSupport
+  autoload :VERSION
+
+  class Configuration
+
+    attr_accessor :access_token_lifetime,
+      :client_secret_key,
+      :password_field
+
+    def initialize
+      @access_token_lifetime = 60 * (24 * 60 * 60)  # 60 days
+      @client_secret_key     = ''  # use SecureRandom.hex(64) to generate one
+      @password_field        = :encrypted_password
+    end
+
+  end
+
+  class << self
+
+    def setup
+      @configuration ||= Configuration.new
+      yield @configuration if block_given?
+    end
+
+    def method_missing(method_name, *args, &block)
+      if @configuration.respond_to? method_name
+        @configuration.send method_name, *args, &block
+      else
+        super
+      end
+    end
+
+    def respond_to?(method_name, include_private = false)
+      @configuration.respond_to? method_name
+    end
+
+  end
+
+end
+
+
+#  Setup
+#-----------------------------------------------
+Touth.setup
+
+
+#  Include
+#-----------------------------------------------
+ActiveSupport.on_load(:active_record) do
+  extend Touth::ActiveRecordSupport::ClassMethods
+end
+ActiveSupport.on_load(:action_controller) do
+  extend Touth::ActionControllerSupport::ClassMethods
+  include Touth::ActionControllerSupport::InstanceMethods
+end
+

data/lib/touth/action_controller_support.rb

@@ -0,0 +1,65 @@
+module Touth
+  module ActionControllerSupport
+
+    module ClassMethods
+
+      mattr_accessor :token_authentication_on
+
+      def token_authentication_for(scope)
+        name = scope.to_s
+
+        self.token_authentication_on = {
+          model_class: name.camelize.constantize,
+          current:     nil,
+        }
+
+        before_action :authenticate_entity_from_token!
+
+        define_method "#{name}_signed_in?" do
+          !!self.class.token_authentication_on[:current]
+        end
+
+        define_method "current_#{name}" do
+          self.class.token_authentication_on[:current]
+        end
+      end
+
+    end
+
+    module InstanceMethods
+
+    protected
+
+      def token_authentication_header
+        @token_authentication_header ||= {
+          id:    request.headers['X-Auth-ID'],
+          token: request.headers['X-Auth-Token'],
+        }
+      end
+
+      def authenticate_entity_from_token!
+        id = token_authentication_header[:id]
+
+        model = id.present? \
+          && self.class.token_authentication_on[:model_class].find(id)
+
+        unless model
+          return token_authentication_error! :no_entity
+        end
+
+        unless model.valid_access_token? token_authentication_header[:token]
+          return token_authentication_error! :invalid_token
+        end
+
+        self.class.token_authentication_on[:current] = model
+      end
+
+      def token_authentication_error!(type)
+        render nothing: true, status: :unauthorized
+        false
+      end
+
+    end
+
+  end
+end

data/lib/touth/active_record_support.rb

@@ -0,0 +1,13 @@
+module Touth
+  module ActiveRecordSupport
+
+    module ClassMethods
+
+      def acts_as_token_authenticatable
+        include Touth::ActsAsTokenAuthenticatable
+      end
+
+    end
+
+  end
+end

data/lib/touth/acts_as_token_authenticatable.rb

@@ -0,0 +1,37 @@
+module Touth
+  module ActsAsTokenAuthenticatable
+
+    def access_token(lifetime = Touth.access_token_lifetime)
+      expires_at = Time.now.to_i + lifetime
+
+      "#{access_token_id(expires_at)}#{[expires_at].pack('V')}".unpack('H*')[0]
+    end
+
+    def valid_access_token?(token)
+      begin
+        data = [token].pack 'H*'
+        token_id, timestamp = data[0..0x1f], data[0x20..-1]
+        expires_at = timestamp.unpack('V')[0]
+
+        access_token_id(expires_at) == token_id && Time.now.to_i < expires_at
+      rescue
+        false
+      end
+    end
+
+  private
+
+    def access_token_id(expires_at)
+      raw = [
+        expires_at,
+        self.class.name,
+        self.id,
+        self.send(Touth.password_field),
+      ].join ':'
+
+      digest = OpenSSL::Digest.new 'sha256'
+      OpenSSL::HMAC.digest digest, Touth.client_secret_key, raw
+    end
+
+  end
+end

data/lib/touth/engine.rb

@@ -0,0 +1,6 @@
+require 'rails/engine'
+
+module ActsAsTaggableOn
+  class Engine < Rails::Engine
+  end
+end

data/lib/touth/version.rb

@@ -0,0 +1,3 @@
+module Touth
+  VERSION = '0.0.1'
+end

data/touth.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'touth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'touth'
+  spec.version       = Touth::VERSION
+  spec.authors       = ['Yuki Iwanaga']
+  spec.email         = ['yuki@creasty.com']
+  spec.summary       = 'Token based authentication'
+  spec.description   = 'Secure and simple token based authentication for Rails 4'
+  spec.homepage      = 'https://github.com/creasty/touth'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '~> 4.1', '>= 3.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.3'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: touth
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yuki Iwanaga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+description: Secure and simple token based authentication for Rails 4
+email:
+- yuki@creasty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/touth.rb
+- lib/touth/action_controller_support.rb
+- lib/touth/active_record_support.rb
+- lib/touth/acts_as_token_authenticatable.rb
+- lib/touth/engine.rb
+- lib/touth/version.rb
+- touth.gemspec
+homepage: https://github.com/creasty/touth
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Token based authentication
+test_files: []