duo-auth 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 197075825fc8cad240329986e5dfc0fc1b99eec2
+  data.tar.gz: 9971f8e9c251e8b6071daf03b9e0a131a57a68fa
+SHA512:
+  metadata.gz: b86471b1b9abe9e9aa1e427ce24adf009b7e80367ec3660ac0e4512e27539a48acc7ded786cf2b7af7d899b9a00bb142b2bbb714abfb267645a33407958dcd2f
+  data.tar.gz: ef721a90532f9d740fd185dbee9e83f8fae7b1cea115ccbaf6898b28145683a82675c46f28799e392831530e859b4327174603a81aa68d5619aa702efa98097d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Christopher Ostrowski
+
+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,65 @@
+![](http://techjeeper.com/wp-content/uploads/2013/08/Wordmark-Duo.png)
+
+# DUO Auth 
+
+This gem provides the ability to create HMAC login verification requests with the DUO 2-factor server.
+The code is taken from https://github.com/duosecurity/duo_ruby with some minor refactorings and gemification.
+
+## Compatibilty
+This gem is up-to-date with `bb77567c838d77bce4f501b475d28dade300edcd` from https://github.com/duosecurity/duo_ruby.
+This covers `DUO-PSA-2015-001`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'duo-auth'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install duo-auth
+
+## Usage
+
+### Create a Signed Request
+
+To create a signed request to be passed to the DUO servers use the follow singleton method:
+```ruby
+  Duo::Auth.sign_request(ENV[:duo_ikey], ENV[:duo_skey], Rails::Application.config.secret_token, @user.id)
+```
+
+The sign request method takes 4 arguments:
+
+1. Your DUO Integration Key.
+2. Your DUO Secret Key.
+3. An application secret token. Any secret token with a minimum of 40 characters will do, but if you're using rails, the default secret token will work great.
+4. Your user identifier. This is whatever you are using on DUO to track your users. This is also returned from the verify request step.
+
+### Verify a DUO Response
+
+To verify the returned DUO response after 2-factor has been verified use the following singleton:
+```ruby
+  Duo::Auth.verify_response(ENV[:duo_ikey], ENV[:duo_skey], Rails::Application.config.secret_token, params[:sig_response])
+```
+The verify response method takes 4 arguments:
+
+1. Your DUO Integration Key.
+2. Your DUO Secret Key.
+3. An application secret token..
+4. The response from DUO. This is typically posted back to your application after authentication is complete.
+
+The `verify_response` method will return the user identifier that was passed to the `sign_request` method if the verification was successful.
+
+## Contributing
+
+1. Fork it ( https://github.com/TheKidCoder/duo-auth/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/duo-auth.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'duo/auth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "duo-auth"
+  spec.version       = Duo::Auth::VERSION
+  spec.authors       = ["Christopher Ostrowski"]
+  spec.email         = ["chris@madebyfunction.com"]
+  spec.summary       = %q{Sign & Verify 2-factor auth requests using DUO Security.}
+  spec.description   = %q{This is a minimal gem that will provide the ability to sign & verify a duo request. Doesn't include any view layer.}
+  spec.homepage      = "http://github.com/thekidcoder/duo-auth"
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/duo/auth.rb

@@ -0,0 +1,98 @@
+require 'base64'
+require 'openssl'
+require "duo/auth/version"
+
+module Duo
+  DUO_PREFIX  = 'TX'
+  APP_PREFIX  = 'APP'
+  AUTH_PREFIX = 'AUTH'
+
+  DUO_EXPIRE = 300
+  APP_EXPIRE = 3600
+
+  IKEY_LEN = 20
+  SKEY_LEN = 40
+  AKEY_LEN = 40
+
+  ERR_USER = 'ERR|The username passed to sign_request() is invalid.'
+  ERR_IKEY = 'ERR|The Duo integration key passed to sign_request() is invalid.'
+  ERR_SKEY = 'ERR|The Duo secret key passed to sign_request() is invalid.'
+  ERR_AKEY = "ERR|The application secret key passed to sign_request() must be at least #{Duo::AKEY_LEN} characters."
+
+  module Auth
+    class << self
+      # Sign a Duo request with the ikey, skey, akey, and username
+      def sign_request(ikey, skey, akey, username)
+        return Duo::ERR_USER if not username or username.to_s.length == 0
+        return Duo::ERR_USER if username.include? '|'
+        return Duo::ERR_IKEY if not ikey or ikey.to_s.length != Duo::IKEY_LEN
+        return Duo::ERR_SKEY if not skey or skey.to_s.length != Duo::SKEY_LEN
+        return Duo::ERR_AKEY if not akey or akey.to_s.length < Duo::AKEY_LEN
+
+        vals = [username, ikey]
+
+        duo_sig = sign_vals(skey, vals, Duo::DUO_PREFIX, Duo::DUO_EXPIRE)
+        app_sig = sign_vals(akey, vals, Duo::APP_PREFIX, Duo::APP_EXPIRE)
+
+        return [duo_sig, app_sig].join(':')
+      end
+
+      # Verify a response from Duo with the skey and akey.
+      def verify_response(ikey, skey, akey, sig_response)
+        begin
+          auth_sig, app_sig = sig_response.to_s.split(':')
+          auth_user = parse_vals(skey, auth_sig, Duo::AUTH_PREFIX, ikey)
+          app_user = parse_vals(akey, app_sig, Duo::APP_PREFIX, ikey)
+        rescue
+          return nil
+        end
+
+        return nil if auth_user != app_user
+
+        return auth_user
+      end
+      
+      private
+      def hmac_sha1(key, data)
+        OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), key, data.to_s)
+      end
+
+      def sign_vals(key, vals, prefix, expire)
+        exp = Time.now.to_i + expire
+
+        val_list = vals + [exp]
+        val = val_list.join('|')
+
+        b64 = Base64.encode64(val).gsub(/\n/,'')
+        cookie = prefix + '|' + b64
+
+        sig = hmac_sha1(key, cookie)
+        return [cookie, sig].join('|')
+      end
+
+      def parse_vals(key, val, prefix, ikey)
+        ts = Time.now.to_i
+
+        parts = val.to_s.split('|')
+        return nil if parts.length !=3
+        u_prefix, u_b64, u_sig = parts
+
+        sig = hmac_sha1(key, [u_prefix, u_b64].join('|'))
+
+        return nil if hmac_sha1(key, sig) != hmac_sha1(key, u_sig)
+
+        return nil if u_prefix != prefix
+
+        cookie_parts = Base64.decode64(u_b64).to_s.split('|')
+        return nil if cookie_parts.length != 3
+        user, u_ikey, exp = cookie_parts
+
+        return nil if u_ikey != ikey
+
+        return nil if ts >= exp.to_i
+
+        return user
+      end
+    end
+  end
+end

data/lib/duo/auth/version.rb

@@ -0,0 +1,5 @@
+module Duo
+  module Auth
+    VERSION = "0.0.1"
+  end
+end

data/spec/auth_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Duo::Auth do
+  context 'signing request' do
+    subject {Duo::Auth}
+    it 'creates a proper response with valid arguments' do
+      expect(subject.sign_request(IKEY, SKEY, AKEY, USER)).not_to be_nil
+    end
+
+    it 'expects a user ID' do
+      expect(subject.sign_request(IKEY, SKEY, AKEY, '')).to be(Duo::ERR_USER)
+    end
+
+    it 'cannot have a pipe character in the user key' do
+      expect(subject.sign_request(IKEY, SKEY, AKEY, 'in|valid')).to be(Duo::ERR_USER)
+    end
+
+    it 'expects a valid integration key' do
+      expect(subject.sign_request('invalid', SKEY, AKEY, USER)).to be(Duo::ERR_IKEY)
+    end
+
+    it 'expects a valid secret key' do
+      expect(subject.sign_request(IKEY, 'invalid', AKEY, USER)).to be(Duo::ERR_SKEY)
+    end
+
+    it 'expects a valid application key' do
+      expect(subject.sign_request(IKEY, SKEY, 'invalid', USER)).to be(Duo::ERR_AKEY)
+    end
+  end
+
+  context 'verifying a response' do
+    let(:request_sig) {Duo::Auth.sign_request(IKEY, SKEY, AKEY, USER)}
+    let(:valid_app_sig) {request_sig.to_s.split(':').last}
+
+    let(:invalid_request_sig) {Duo::Auth.sign_request(IKEY, SKEY, 'invalid' * 6, USER)}
+    let(:invalid_app_sig) {invalid_request_sig.to_s.split(':').last}
+
+    it 'rejects an invalid user' do
+      expect(Duo::Auth.verify_response(IKEY, SKEY, AKEY, INVALID_RESPONSE + ':' + valid_app_sig)).to be_nil
+    end
+
+    it 'rejects expired responses' do
+      expect(Duo::Auth.verify_response(IKEY, SKEY, AKEY, EXPIRED_RESPONSE + ':' + valid_app_sig)).to be_nil
+    end
+
+    it 'rejects responses with invalid app sig' do
+      expect(Duo::Auth.verify_response(IKEY, SKEY, AKEY, FUTURE_RESPONSE + ':' + invalid_app_sig)).to be_nil
+    end
+
+    it 'allows responses with valid app sig' do
+      expect(Duo::Auth.verify_response(IKEY, SKEY, AKEY, FUTURE_RESPONSE + ':' + valid_app_sig)).to eq(USER)
+    end
+
+    it 'rejects wrong params' do
+      expect(Duo::Auth.verify_response(IKEY, SKEY, AKEY, FUTURE_RESPONSE + ':' + WRONG_PARAMS_APP)).to be_nil
+    end
+
+    it 'rejects wrong params from response' do
+      expect(Duo::Auth.verify_response(IKEY, SKEY, AKEY, WRONG_PARAMS_RESPONSE + ':' + valid_app_sig)).to be_nil
+    end
+
+    it 'will not verify with wrong integration key' do
+      expect(Duo::Auth.verify_response(WRONG_IKEY, SKEY, AKEY, FUTURE_RESPONSE + ':' + valid_app_sig)).to be_nil
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require_relative '../lib/duo/auth'
+
+IKEY = "DIXXXXXXXXXXXXXXXXXX"
+WRONG_IKEY = "DIXXXXXXXXXXXXXXXXXY"
+SKEY = "deadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
+AKEY = "useacustomerprovidedapplicationsecretkey"
+
+USER = "testuser"
+
+INVALID_RESPONSE = "AUTH|INVALID|SIG"
+EXPIRED_RESPONSE = "AUTH|dGVzdHVzZXJ8RElYWFhYWFhYWFhYWFhYWFhYWFh8MTMwMDE1Nzg3NA==|cb8f4d60ec7c261394cd5ee5a17e46ca7440d702"
+FUTURE_RESPONSE = "AUTH|dGVzdHVzZXJ8RElYWFhYWFhYWFhYWFhYWFhYWFh8MTYxNTcyNzI0Mw==|d20ad0d1e62d84b00a3e74ec201a5917e77b6aef"
+WRONG_PARAMS_RESPONSE = "AUTH|dGVzdHVzZXJ8RElYWFhYWFhYWFhYWFhYWFhYWFh8MTYxNTcyNzI0M3xpbnZhbGlkZXh0cmFkYXRh|6cdbec0fbfa0d3f335c76b0786a4a18eac6cdca7"
+WRONG_PARAMS_APP = "APP|dGVzdHVzZXJ8RElYWFhYWFhYWFhYWFhYWFhYWFh8MTYxNTcyNzI0M3xpbnZhbGlkZXh0cmFkYXRh|7c2065ea122d028b03ef0295a4b4c5521823b9b5"

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: duo-auth
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christopher Ostrowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is a minimal gem that will provide the ability to sign & verify
+  a duo request. Doesn't include any view layer.
+email:
+- chris@madebyfunction.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- duo-auth.gemspec
+- lib/duo/auth.rb
+- lib/duo/auth/version.rb
+- spec/auth_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/thekidcoder/duo-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.4.5
+signing_key: 
+specification_version: 4
+summary: Sign & Verify 2-factor auth requests using DUO Security.
+test_files:
+- spec/auth_spec.rb
+- spec/spec_helper.rb