duo_universal 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0ddc25daa62e34539d8d7b5da2b8fe454eb2fc7c848b72bf7098b2e3e1a0c8b7
+  data.tar.gz: a9859887f7b7e396c0d7a175fb3c49aea51407216d9228b67c0c6368f8054c25
+SHA512:
+  metadata.gz: 3daa95110c9d941dfbf79a64401661013643023234595fb2b0fa9d0c27d9dcc1fdfb3e93544b8eb8d9430d9b39a3d3c766e52019fe389998bcf9fe4bf1ae3232
+  data.tar.gz: f1d95e2b5916a2a382d42208693269db122a1ebdeaa751d94fe0d1498fc4e3f2cbfea1406ce6c8326e00ed7f26220eb86dbb169c419ad420b7ac96652992eb5b

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-08-19
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in duo.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    duo_universal (0.1.0.pre)
+      httparty
+      jwt
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    diff-lcs (1.5.0)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    jwt (2.4.1)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    multi_xml (0.6.0)
+    parallel (1.21.0)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.25.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  byebug
+  duo_universal!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.20

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Andrew Walter
+
+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,32 @@
+# Duo
+_A port of Duo's Universal Python SDK client to Ruby._
+
+Python SDK: https://github.com/duosecurity/duo_universal_python
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add duo_universal
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install duo_universal
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 the created tag, 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/[USERNAME]/duo.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/duo_universal/client.rb

@@ -0,0 +1,175 @@
+require 'jwt'
+require 'securerandom'
+require 'httparty'
+
+require 'byebug'
+
+module Duo
+  class Client
+    STATE_LENGTH = 36
+    JTI_LENGTH = 36
+    MINIMUM_STATE_LENGTH = 22
+    MAXIMUM_STATE_LENGTH = 1024
+    CLIENT_ID_LENGTH = 20
+    CLIENT_SECRET_LENGTH = 40
+    CLIENT_ASSERTION_TYPE = 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer'
+    JWT_LEEWAY = 60
+
+    attr_reader :client_id, :client_secret, :host, :redirect_uri, :use_duo_code_attribute
+
+    def initialize(client_id, client_secret, host, redirect_uri, optional_args = {})
+      raise Duo::ClientIDLengthError unless client_id && client_id.length == CLIENT_ID_LENGTH
+      raise Duo::ClientSecretLengthError unless client_secret && client_secret.length == CLIENT_SECRET_LENGTH
+      raise Duo::ApiHostRequiredError unless host
+      raise Duo::RedirectUriRequiredError unless redirect_uri
+
+      @client_id = client_id
+      @client_secret = client_secret
+      @host = host
+      @redirect_uri = redirect_uri
+      @use_duo_code_attribute = optional_args.fetch(:use_duo_code_attribute) { true }
+    end
+
+    def api_host_uri
+      "https://#{host}"
+    end
+
+    def authorize_endpoint_uri
+      "https://#{host}/oauth/v1/authorize"
+    end
+
+    def health_check_endpoint_uri
+      "https://#{host}/oauth/v1/health_check"
+    end
+
+    def token_endpoint_uri
+      "https://#{host}/oauth/v1/token"
+    end
+
+    def create_auth_url(username, state)
+      raise Duo::StateLengthError unless state && state.length >= MINIMUM_STATE_LENGTH && state.length <= MAXIMUM_STATE_LENGTH
+      raise Duo::UsernameRequiredError unless username && username.gsub(/\s*/, '').length > 0
+
+      jwt_args = {
+        scope: 'openid',
+        redirect_uri: redirect_uri,
+        client_id: client_id,
+        iss: client_id,
+        aud: api_host_uri,
+        exp: (Time.now + (5*60)).to_i,
+        state: state,
+        response_type: 'code',
+        duo_uname: username,
+        use_duo_code_attribute: use_duo_code_attribute,
+      }
+
+      req_jwt = JWT.encode(jwt_args, client_secret, 'HS512')
+
+      all_args = {
+        response_type: 'code',
+        client_id: client_id,
+        request: req_jwt
+      }
+
+      query_string = URI.encode_www_form all_args
+
+      "#{authorize_endpoint_uri}?#{query_string}"
+    end
+
+    def generate_state
+      SecureRandom.alphanumeric(STATE_LENGTH)
+    end
+
+    # Checks whether Duo is available.
+    # Returns:
+    #  {'response': {'timestamp': <int:unix timestamp>}, 'stat': 'OK'}
+    # Raises:
+    # 
+    def health_check
+      req_payload = {
+        client_assertion: JWT.encode(jwt_args_for(health_check_endpoint_uri), client_secret, 'HS512'),
+        client_id: client_id
+      }
+
+      # ToDo: Add Support for verifying SSL certificates
+      begin
+        res = HTTParty.post(health_check_endpoint_uri, body: req_payload)
+
+        json_resp = JSON.parse res.body
+
+        raise Duo::Error.new(json_resp) unless json_resp['stat'] == 'OK'
+
+        json_resp
+      rescue => e
+        raise e
+      end
+    end
+
+    # Exchanges the duo_code for a token with Duo to determine
+    # if the auth was successful.
+    #	Argument:
+    #		duo_code      -- Authentication session transaction id
+    #										 returned by Duo
+    #		username      -- Name of the user authenticating with Duo
+    # 	nonce         -- Random 36B string used to associate
+    #										 a session with an ID token
+    #	Returns:
+    #		A token with meta-data about the auth
+    #	Raises:
+    #		Duo::Error on error for invalid duo_codes, invalid credentials,
+    #		or problems connecting to Duo
+    def exchange_authorization_code_for_2fa_result(duo_code, username, nonce = nil)
+      raise Duo::DuoCodeRequiredError unless duo_code
+
+      jwt_args = jwt_args_for(token_endpoint_uri)
+
+      all_args = {
+        grant_type: 'authorization_code',
+        code: duo_code,
+        redirect_uri: redirect_uri,
+        client_id: client_id,
+        client_assertion_type: CLIENT_ASSERTION_TYPE,
+        client_assertion: JWT.encode(jwt_args, client_secret, 'HS512')
+      }
+
+      begin
+        user_agent = "duo_universal_ruby/#{Duo::VERSION} ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL} #{RUBY_PLATFORM}"
+
+        resp = HTTParty.post(token_endpoint_uri, body: all_args, headers: { user_agent: user_agent })
+
+        json_response_body = JSON.parse(resp.body)
+
+        raise Duo::Error.new(json_response_body) unless resp.code == 200
+
+        decoded_token = JWT.decode(json_response_body['id_token'], client_secret, true, { 
+          algorithm: 'HS512', 
+          iss: token_endpoint_uri, 
+          verify_iss: true,  
+          aud: client_id,
+          verify_aud: true,
+          exp_leeway: JWT_LEEWAY,
+          required_claims: ['exp', 'iat'],
+          verify_iat: false
+        })
+
+        # ToDo: finalise validation
+
+        decoded_token
+      rescue => e
+        raise Duo::Error.new(e.message)
+      end
+    end
+
+    private
+
+    def jwt_args_for(endpoint_uri)
+      {
+        iss: client_id,
+        sub: client_id,
+        aud: endpoint_uri,
+        exp: (Time.now + (5*60)).to_i,
+        jti: SecureRandom.alphanumeric(JTI_LENGTH)
+      }
+    end
+  end
+end

data/lib/duo_universal/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Duo
+  VERSION = "0.1.0.pre"
+end

data/lib/duo_universal.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "duo_universal/version"
+require_relative "duo_universal/client"
+
+module Duo
+  class Error < StandardError; end
+  class StateLengthError < StandardError; end
+  class UsernameRequiredError < StandardError; end
+  class ClientIDLengthError < StandardError; end
+  class ClientSecretLengthError < StandardError; end
+  class ApiHostRequiredError < StandardError; end
+  class RedirectUriRequiredError < StandardError; end
+  class DuoCodeRequiredError < StandardError; end
+end

data/sig/duo.rbs

@@ -0,0 +1,4 @@
+module Duo
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: duo_universal
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Andrew Walter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: 
+email:
+- andrew.walter@burnet.edu.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/duo_universal.rb
+- lib/duo_universal/client.rb
+- lib/duo_universal/version.rb
+- sig/duo.rbs
+homepage: https://www.github.com/xtrasimplicity/duo_universal_ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.github.com/xtrasimplicity/duo_universal_ruby
+  source_code_uri: https://www.github.com/xtrasimplicity/duo_universal_ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Duo Universal Ruby SDK
+test_files: []