cow_auth 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bfaaf0d5f8c6e90a6f6cef610a1e22ae253e9583
+  data.tar.gz: c5817e97f60e5dae55dd9ea28df6c821ac47bc4f
+SHA512:
+  metadata.gz: b71afdd4e265c535ddfa8dfda4963c4df1a5db672085487448bee259995910e1b8a5fc1b995e41c225a97da81a7eb596cccf2e2d0ff0019e9a1db02e8694036f
+  data.tar.gz: 952dfd528ae4264b8f7dad71f33c709403bd72cf92fc7e1e3681ce7e320a6318435b4979effe3d81d9115114b9fc4e1146598749e6f2616a82cab6eb3a9dba59

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at mickey@vt.edu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Mickey Cowden
+
+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,73 @@
+# CowAuth
+
+WARNING: This gem is in early development, which means you probably shouldn't use it yet for critical applications.
+
+The main goal of this gem is to provide API authentication for Rails (or Rails-like) web applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cow_auth'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cow_auth
+
+## Usage
+
+TODO: Write usage instructions here
+
+Example Rails model generator command:
+
+    $ bundle exec rails generate model user email:string sid:string encrypted_password:string first_name:string last_name:string sign_in_count:integer
+
+    # Modified migration; includes indexes.
+    class CreateUsers < ActiveRecord::Migration[5.0]
+      def change
+        create_table :users do |t|
+          t.string :email, null: false
+          t.string :sid, null: false
+          t.string :encrypted_password
+          t.string :first_name
+          t.string :last_name
+          t.integer :sign_in_count
+          t.timestamps
+        end
+        add_index :users, :email, unique: true
+        add_index :users, :sid, unique: true
+      end
+    end
+
+### Controllers
+
+Add the following lines in the controller(s) that you want to enforce authenticatication for.
+
+    include CowAuth::Authentication
+    before_action :authenticate_user
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+    bundle exec gem build cow_auth.gemspec
+    bundle exec gem install cow_auth-0.1.0.gem
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mickey13/cow_auth. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cow_auth"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cow_auth.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cow_auth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cow_auth'
+  spec.version       = CowAuth::VERSION
+  spec.authors       = ['Mickey Cowden']
+  spec.email         = ['mickey@vt.edu']
+
+  spec.summary       = 'Summary'
+  spec.description   = 'Description'
+  spec.homepage      = 'https://github.com/mickey13/cow_auth'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  # spec.add_runtime_dependency 'activesupport', '5.0.0.beta3'
+  spec.add_runtime_dependency 'scrypt', '~> 2.1'
+  # spec.add_runtime_dependency 'redis', '~> 3.2'
+end

data/lib/cow_auth/authentication.rb

@@ -0,0 +1,21 @@
+module CowAuth
+  module Authentication
+    extend ActiveSupport::Concern
+    include ActionController::HttpAuthentication::Token::ControllerMethods
+
+  private
+
+    def authenticate_user
+      authenticate_or_request_with_http_token do |api_key, options|
+        sid, auth_token = api_key.match(/sid=([[:alnum:]]*)&auth_token=([[:alnum:]]*)/).try(:captures)
+        @current_user = User.authenticate_from_token(sid, auth_token)
+      end
+    end
+
+    def request_http_token_authentication(realm = 'Application', message = nil)
+      message ||= 'HTTP Token: Access denied.'
+      self.headers['WWW-Authenticate'] = %(Token realm="#{realm.tr('"'.freeze, ''.freeze)}")
+      self.__send__ :render, json: { error: message }, status: :unauthorized
+    end
+  end
+end

data/lib/cow_auth/session.rb

@@ -0,0 +1,23 @@
+module CowAuth
+  module Session
+    extend ActiveSupport::Concern
+
+    def create
+      user = User.find_by(email: params[:email])
+      if user.try(:authenticate, params[:password])
+        user.api_sign_in
+        render json: user
+      else
+        render json: { error: 'Invalid user credentials.' }, status: :unauthorized
+      end
+    end
+
+    def destroy
+      if @current_user.try(:api_sign_out)
+        head :ok
+      else
+        render json: { error: 'Could not sign user out.' }, status: :unauthorized
+      end
+    end
+  end
+end

data/lib/cow_auth/user.rb

@@ -0,0 +1,91 @@
+require 'scrypt'
+
+module CowAuth
+  class User < ActiveRecord::Base
+
+    after_initialize :generate_sid_if_necessary
+
+    validates :email, presence: true
+    validates :email, uniqueness: true
+    validates :encrypted_password, presence: true
+    validates :sid, presence: true
+    validates :sid, uniqueness: true
+    validates :sid, format: { with: /\AC[a-z0-9]{32}\z/ }
+
+    def password=(new_password)
+      return false if new_password.blank?
+      salt = SCrypt::Engine.generate_salt
+      self.encrypted_password = SCrypt::Engine.hash_secret(new_password, salt)
+      return true
+    end
+
+    def authenticate(password)
+      return false if self.encrypted_password.blank?
+      if SCrypt::Password.new(self.encrypted_password) == password
+        self.update(sign_in_count: self.sign_in_count + 1)
+        return true
+      end
+      return false
+    end
+
+    def api_sign_in
+      $redis.set(self.redis_key, {
+        auth_token: User.generate_random_hex_string,
+        expires_at: User.generate_token_expires_at
+      }.to_json)
+    end
+
+    def api_sign_out
+      $redis.del(self.redis_key)
+    end
+
+    def self.authenticate_from_token(sid, auth_token)
+      api_key = User.fetch_api_key_from_redis(sid)
+      if api_key.present? && api_key.key?(:auth_token) && api_key.key?(:expires_at) && api_key[:auth_token] == auth_token && api_key[:expires_at] > Time.zone.now
+        return User.find_by(sid: sid)
+      end
+      return nil
+    end
+
+    def as_json(options = nil)
+      return {
+        uuid: self.uuid,
+        email: self.email,
+        sid: self.sid,
+        auth_token: User.fetch_api_key_from_redis(self.sid).try(:[], :auth_token),
+        first_name: self.first_name,
+        last_name: self.last_name,
+        sign_in_count: self.sign_in_count,
+        is_approved: self.is_approved,
+        created_at: self.created_at,
+        updated_at: self.updated_at
+      }
+    end
+
+  protected
+
+    def redis_key
+      return "user_#{self.sid}"
+    end
+
+  private
+
+    def generate_sid_if_necessary
+      self.sid ||= "C#{SecureRandom.hex(16)}"
+      return true
+    end
+
+    def self.generate_random_hex_string
+      return SecureRandom.hex(16)
+    end
+
+    def self.generate_token_expires_at
+      return 1.month.from_now
+    end
+
+    def self.fetch_api_key_from_redis(sid)
+      api_key = $redis.get("user_#{sid}")
+      return api_key.present? ? JSON.parse(api_key).try(:symbolize_keys) : nil
+    end
+  end
+end

data/lib/cow_auth/version.rb

@@ -0,0 +1,3 @@
+module CowAuth
+  VERSION = '0.1.1'
+end

data/lib/cow_auth.rb

@@ -0,0 +1,12 @@
+require 'cow_auth/version'
+require 'cow_auth/user'
+require 'cow_auth/session'
+require 'cow_auth/authentication'
+
+module CowAuth
+  def self.hi
+    user = CowAuth::User.new
+    puts user
+    return user
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: cow_auth
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Mickey Cowden
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: scrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Description
+email:
+- mickey@vt.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cow_auth.gemspec
+- lib/cow_auth.rb
+- lib/cow_auth/authentication.rb
+- lib/cow_auth/session.rb
+- lib/cow_auth/user.rb
+- lib/cow_auth/version.rb
+homepage: https://github.com/mickey13/cow_auth
+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.6.2
+signing_key: 
+specification_version: 4
+summary: Summary
+test_files: []