token_secret_auth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4eb919fd271312c8f4bc8eb9ad88f9df541e067f
+  data.tar.gz: b6baf874507a1c6f3660606a59514a5112839ab8
+SHA512:
+  metadata.gz: f841553378bbf8e844dc24f0c047b5142c42f3a959b7c10f3d89569ca64c7e67db5e488a1de2b39ab2632cfbbab0a6a328ba678eec385851da9ea7912d4aa6e2
+  data.tar.gz: d97252337e1a6211273013af52c55856f3c79aff3b99698bf7fd5f5bc07cfdcf1671d09fe8d63c70534f626330ccd1b6026728662a33486d91e8289632bcce23

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.3
+before_install: gem install bundler -v 1.15.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tgaff@alumni.nd.edu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in token_secret_auth.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 tgaff
+
+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,188 @@
+# TokenSecretAuth
+
+TokenSecretAuth aims to be a simple implementation of token+secret authentication.
+
+Clients using this can send a token + secret that looks like: `{ token: "koV3Zel321fe", secret: "fffixk5ptz2puaf1sk3wo5szpkrpjnhp" }`
+
+* **token** is a hashed form of the model **id**
+
+* **secret** is randomly assigned and can be **encrypted** using `has_secure_password` or a similar implementation.
+
+## Why should I use this?
+
+
+> OR Why did you release this?
+
+Many APIs use a token or a token+secret to authenticate API clients.  If that token+secret grants similar power as a login+password it **should be protected just like a password**
+
+However, while looking for a gem to handle mobile API authentication I found that many solutions fit into one of two categories:
+
+1. They required Devise
+1. They did not encrypt the token (or secret) properly
+
+
+### Other benefits
+
+* It's plain-old ruby - any model that responds to `.find(id)` and works with or in a manner similar to `has_secure_password` will work. (model instance should respond to `model_instance#password=`)
+*  Flexible: you can send token+secret in the URL or in the header or any other way you can interpret in a controller method.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'token_secret_auth'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install token_secret_auth
+
+In your model file add:
+
+    include TokenSecretAuth
+
+This grants your model instances the following methods: 
+
+    #token, #decode_token, #generate_secret
+
+Also add to the model:
+
+    has_secure_password
+
+Create and run a migration to add the `password_digest` field to your model.  
+For example on rails: 
+
+    $ rails generate migration AddPasswordDigestToApiClients password_digest:string
+    
+Note: you do not need a 'token' field on your model.  `#token` is a virtual attribute derived from the model ID.  `password` is your secret.
+
+## Usage
+
+#### Generating a token
+
+Tokens are generated from the model ID.
+
+```ruby
+SomeModel.find(1000).token # => o9WM01OR1jgD
+```
+
+#### Generating a secret
+
+Secrets are randomly generated by `Model.generate_secret` or `#generate_secret`.
+Store the secret using `#password=` or similar encrypted functionality.
+
+```ruby
+client = ApiClient.find_by_token('afuoisjdjl')
+client.password = client.generate_secret
+client.save # bcrypt/has_secure_password will handle encryption
+```
+
+On Rails you may want to simply generate the password using active record callbacks:
+
+```ruby
+  before_validation :set_secret, on: [ :new, :create ]
+
+  def set_secret
+    self.password = generate_secret
+  end
+```
+
+
+#### Passing token+secret to client
+
+If your API allows a client to login and then receive a new API token+secret the responding controller method may look something like this.
+
+```ruby
+ def try_login
+    @email = login_params[:email]
+    @pass  = login_params[:password]
+    @user = User.find_by(email: @email).try(:authenticate, @pass)
+    if @user
+      api_client = @user.api_clients.create
+      # IMPORTANT - this is the only time you can see the secret decrypted
+      render json: { token: api_client.token, secret: api_client.secret }
+    else
+      render json: {password: ["Invalid account or password"]}, status: :unauthorized
+    end
+  end
+```
+
+To perform authentication with the token + secret, for example as a `before_action` in an `ApplicationController`:
+
+```ruby
+def current_user
+  if params[:credentials]
+    token = credentials_params[:token]
+    secret = credentials_params[:secret]
+  begin
+    api_client = ApiClient.authenticate_by_credentials(token, secret)
+  rescue ActiveRecord::RecordNotFound
+  # if someone sends a decodable token but the record doesn't exist
+  end
+end
+
+  if api_client
+    @current_user = api_client.user
+  else
+    render json: {errors: ['Unauthorized token or secret']}, status: :unauthorized }
+  end
+end
+```
+
+Headers are an even better way to pass authentication tokens.  **TODO:**
+
+```ruby
+
+```
+
+
+#### salt
+
+If you'd like to change the salt used for hashing **IDs** to generate `token`s you can add an initializer:
+
+```ruby
+# config/initializers/token_secret_auth.rb
+
+TokenSecretAuth.configure do |config|
+    config.id_salt = 'some appropriately salty bytes'
+end
+```
+
+> Note: the salt used for hashing the secret (password) is controlled by your BCrypt config.
+
+## FAQ
+
+### Why not devise?
+
+Devise is a great solution and I often recommend it.  However, it is sometimes more complexity than needed for something this simple.  TokenSecretAuth does not require devise.
+
+### Why do I need to encrypt my API token?
+
+If your token or token+secret grants a user similar power as a login+password then it should be encrypted with one-way encryption **just like a password**.
+
+### How do I get the secret?
+
+The secret is the password field on the model.  It's only available when the instance is first created after that you can't retrieve it - - that's the whole point of one-way encryption.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tgaff/token_secret_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).
+
+## Code of Conduct
+
+Everyone interacting in the TokenSecretAuth project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/token_secret_auth/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "token_secret_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(__FILE__)

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/lib/token_secret_auth.rb

@@ -0,0 +1,3 @@
+require 'token_secret_auth/version'
+require 'token_secret_auth/base'
+

data/lib/token_secret_auth/base.rb

@@ -0,0 +1,105 @@
+module TokenSecretAuth
+  class << self
+    require 'hashids'
+    # salt for the id ONLY,
+    # optional config - even if user doesn't change this
+    #   the only possible leak is the id
+    DEFAULT_SALT = 'NaCl NaHCO3 NH4ClO3 NaBr MgCl2'
+
+    # TokenSecretAuth.hash_id
+    # returns the stored instance of Hashids
+    #   used for generating any Token
+    def hash_id
+      @hid
+    end
+
+    # recommended configuration:
+    # TokenSecretAuth.configure do |config|
+    #   config.id_salt = 'some appropriate saltiness'
+    # end
+    def configure
+      yield self
+      @id_salt = DEFAULT_SALT if @id_salt.nil?
+      set_hash_id_instance(@id_salt)
+    end
+
+    # set salt for hashing IDs
+    def id_salt=(salt)
+      @id_salt = salt
+    end
+    protected
+    # TokenSecretAuth.set_hash_id_instance
+    # call only once
+    def set_hash_id_instance(salt)
+      @hid = Hashids.new(salt, 12)
+    end
+  end
+
+
+  module ClassMethods
+    def decode_token(token)
+      decoded = TokenSecretAuth.hash_id.decode(token).first
+    end
+
+    # .find_with_token
+    # Use on model files to find a particular instance based on the token (hashed ID)
+    def find_with_token(token)
+      begin
+        find(decode_token(token))
+      rescue Hashids::InputError
+        # controller should handle not found when we can't decode bad token
+        return find(nil)
+      end
+    end
+
+    # .authenticate_by_credentials
+    # finds correct instance by its token and then authenticates the password for that instance
+    def authenticate_by_credentials(token, secret=nil)
+      account = find_with_token(token)
+      # note BCrypt's authenticate will return false or the object when matched
+      if account
+        account.authenticate(secret)
+      end
+    end
+
+    # create a new randomly generated secret
+    def generate_secret
+      rand(36**secret_length).to_s(36)
+    end
+
+    # the default length for a secret
+    def secret_length
+      @secret_length ||= 32
+    end
+
+    private
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  # Returns the object's ID attribute encoded as a token
+  def token
+    return nil if !id
+    encode(id)
+  end
+
+  # the model can call this method to generate a new password for the user
+  # it should then encrypt this password for storage in db
+  def generate_secret
+    self.password = self.class.generate_secret
+  end
+
+
+  private
+  def secret_length
+    @secret_length ||= 32
+  end
+
+  def encode(value)
+    TokenSecretAuth.hash_id.encode(value)
+  end
+
+  self.configure {} # Necessary to perform default setup
+end

data/lib/token_secret_auth/version.rb

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

data/token_secret_auth.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "token_secret_auth/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "token_secret_auth"
+  spec.version       = TokenSecretAuth::VERSION
+  spec.authors       = ["tgaff"]
+  spec.email         = ["tgaff@alumni.nd.edu"]
+
+  spec.summary       = %q{Simple token+secret authentication gem.}
+  spec.description   = %q{Simple token + secret authentication gem with encrypted secrets.}
+  spec.homepage      = "https://github.com/tgaff/token_secret_auth"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  # spec.bindir        = "exe"
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  spec.add_runtime_dependency "hashids", "~>1.0"
+  spec.add_development_dependency "bundler", "~> 1"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.11"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: token_secret_auth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tgaff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashids
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Simple token + secret authentication gem with encrypted secrets.
+email:
+- tgaff@alumni.nd.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/token_secret_auth.rb
+- lib/token_secret_auth/base.rb
+- lib/token_secret_auth/version.rb
+- token_secret_auth.gemspec
+homepage: https://github.com/tgaff/token_secret_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.5.1
+signing_key: 
+specification_version: 4
+summary: Simple token+secret authentication gem.
+test_files: []