auth-armor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ad0ba2c4186c59ee35abaa9965a6868ad8badfe92fb8708a64fe61ebdfafc66
+  data.tar.gz: 2e6a1ccee5e81db6ebe5287f6c87e6278be2ab7046335007db8394715d9d8ea2
+SHA512:
+  metadata.gz: e5cdd93b3c614394d2e2857ad4b8190478e85f20c3a6424cdffaf95f6da12b175ce19be66cfdeb5f98e94e3d39c52e8b34d5ab003e571cd02b9bd2c59016308f
+  data.tar.gz: 60c12909801f4952f00b5395fd638926f4e184075381e48c4df09ed604e126db3eb790d16fb658a8eb4f7eb2ad1f8fff3afdca90f4ea90f9dd02198535109623

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

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 hannahmasila@gmail.com. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in auth-armor.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "pry", '~> 0.12.2'

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    auth-armor (0.1.0)
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    method_source (0.9.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    netrc (0.11.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.3.3)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  auth-armor!
+  bundler (~> 2.1.4)
+  pry (~> 0.12.2)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Hannah Masila
+
+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,139 @@
+# AuthArmor
+
+AuthArmor is Password-less login and 2FA using biometrics secured by hardware and PKI.
+
+This library provides convenient access to the AuthArmor API from applications written in the Ruby language. It includes a pre-defined set of methods for API resources that initialize themselves dynamically from API responses.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'auth-armor'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install auth-armor
+
+## Usage
+
+The library needs to be instantiated with your client_id and client_secret. This returns a client object that is authenticated with Oauth2.
+
+```ruby
+require "auth-armor"
+AuthArmor::Client.new(client_id: "CLIENT_ID", client_secret: "CLIENT_SECRET")
+
+```
+
+
+## Auth Request
+
+To send an Auth request to the a mobile device or security key, call the `auth_request` method with the following arguments
+
+```ruby
+AuthArmor::Client.auth_request(
+  auth_profile_id: "AUTH_PROFILE_ID",
+  action_name: "Login",
+  short_msg: "This is a test message",
+)
+```
+
+### Auth Request for Mobile Device
+
+```ruby
+AuthArmor::Client.auth_request(
+  auth_profile_id: "AUTH_PROFILE_ID",
+  action_name: "Login",
+  short_msg: "This is a test message",
+  accepted_auth_methods: "mobiledevice"
+)
+```
+
+### Auth Request for Mobile Device when Biometrics are enforced
+
+```ruby
+AuthArmor::Client.auth_request(
+  auth_profile_id: "AUTH_PROFILE_ID",
+  action_name: "Login",
+  short_msg: "This is a test message",
+  accepted_auth_methods: "mobiledevice",
+  forcebiometric: true
+)
+```
+
+### Auth Request for Security Key
+
+```ruby
+AuthArmor::Client.auth_request(
+  auth_profile_id: "AUTH_PROFILE_ID",
+  action_name: "Login",
+  short_msg: "This is a test message",
+  accepted_auth_methods: "securitykey"
+)
+```
+
+### Optional arguments
+
+
+- `forcebiometric` - this is false by default. It is only applicable if one of the `accepted_auth_methods` is `mobiledevice`
+
+- `accepted_auth_methods` - this can either be `mobiledevice` or `securitykey`. If neither is provided, both auth methods are acceptable.
+
+- `timeout_in_seconds` - this is the amount of time you want to allow the auth to be valid before it expires. The min is 15, and max is 300. If not provided, the default time for the project is used.
+
+
+## Invite Request
+
+To generate an invite, call the `invite_request` method with a `nickname`
+
+```ruby
+AuthArmor::Client.invite_request(
+  nickname: "NICKNAME"
+)
+```
+
+### Optional arguments
+
+`reference_id` - This is an optional value that you can set to further cross reference your records.
+
+### Consuming an invite using QR code
+
+Once an invite request is created, calling the `generate_qr_code` method returns a JSON that you can generate a QR code.
+
+```ruby
+AuthArmor::Client.generate_qr_code
+
+```
+
+### Consuming an invite using link
+
+Once an invite request is created, calling the `get_invite_link` method returns a link that can be shared.
+
+
+```ruby
+AuthArmor::Client.get_invite_link
+```
+
+## 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/hmasila/auth-armor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hmasila/auth-armor/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Auth::Armor project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hmasila/auth-armor/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/auth-armor.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/auth/armor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "auth-armor"
+  spec.version       = AuthArmor::VERSION
+  spec.authors       = ["Hannah Masila"]
+  spec.email         = ["hannahmasila@gmail.com"]
+
+  spec.summary       = %q{Write a short summary, because RubyGems requires one.}
+  spec.description   = %q{Write a longer description or delete this line.}
+  spec.homepage      = "https://rubygems.org/gems/auth-armor"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/hmasila/auth-armor"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency "bundler", "~> 2.1.4"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_dependency "rest-client"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "auth_armor"
+
+# 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/auth/armor/version.rb

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

data/lib/auth_armor.rb

@@ -0,0 +1,139 @@
+require "auth/armor/version"
+require 'rest-client'
+require 'json'
+
+module AuthArmor
+
+	API_URL = "https://api.autharmor.com/v1"
+	INVITE_URL = "https://invite.autharmor.com"
+	ACCEPTED_SCOPES = [
+		"aarmor.api.generate_invite_code aarmor.api.request_auth",
+		"aarmor.api.generate_invite_code",
+		"aarmor.api.request_auth"
+	]
+
+  class Error < StandardError; end
+
+  class Client
+	  attr_accessor :access_token, :invite_code
+
+	  def initialize(scope: "aarmor.api.generate_invite_code aarmor.api.request_auth", client_id: , client_secret:)
+	  	fail "Scope not allowed." unless ACCEPTED_SCOPES.include? scope
+
+	    payload = {
+	      client_id: client_id,
+	      client_secret: client_secret,
+	      grant_type: "client_credentials",
+	      scope: scope
+	  	}
+
+	    response = RestClient.post("https://login.autharmor.com/connect/token", payload)
+
+	    if response.code == 200
+	    	@access_token = JSON.parse(response)["access_token"]
+	    else
+	    	fail "Invalid response #{response.to_str} received."
+	    end
+	  end
+
+	  def connect(payload: {}, method:, endpoint:)
+	  	RestClient.post("#{API_URL}/#{endpoint}",
+			  payload.to_json,
+			  {
+			  	content_type: 'application/json',
+			  	Authorization: "Bearer #{@access_token}"
+			  }) do |response, request, result|
+			  case response.code
+			  when 400
+			    { code: :error, response: JSON.parse(response.to_str) }
+			  when 200
+			   	{ "code" => :success, "response" => JSON.parse(response.to_str) }
+			  else
+			    fail "Invalid response #{response.to_str} received."
+			  end
+			end
+
+		rescue RestClient::Unauthorized, RestClient::Forbidden => err
+		  JSON.parse(err.response.to_str)
+	  end
+
+	  def auth_request(timeout_in_seconds: nil, forcebiometric: false, accepted_auth_methods: nil, auth_profile_id:, action_name:, short_msg:)
+	  	payload = {
+			  auth_profile_id: auth_profile_id,
+			  action_name: action_name,
+			  short_msg: short_msg,
+			  timeout_in_seconds: timeout_in_seconds,
+			  accepted_auth_methods: auth_methods(accepted_auth_methods, forcebiometric)
+			}
+
+	  	connect(payload: payload, method: :post, endpoint: "auth/request")
+	  end
+
+	  def invite_request(reference_id: nil, nickname:)
+	  	payload = {
+	  		nickname: nickname,
+	  		reference_id: reference_id
+	  	}
+
+	  	response = connect(payload: payload, method: :post, endpoint: "invite/request")
+
+	  	if response["code"] == :success
+	  		@invite_code = response["response"]
+	  	else
+	  		@invite_code = nil
+	  	end
+
+	  	response
+	  end
+
+	  def generate_qr_code
+	  	fail "QR code could not be generated. Use the invite_request method to get an invite code" if @invite_code.nil?
+	  	
+	  	aa_sig = @invite_code["aa_sig"]
+	  	invite_code = @invite_code["invite_code"]
+
+			{
+			  "type": "profile_invite",
+			  "version": 1,
+			  "format_id": 1,
+			  "payload": {
+			    "aa_sig": aa_sig,
+			    "invite_code": invite_code
+			  }
+			}
+
+	  end
+
+	  def get_invite_link
+	  	fail "Invite link could not be generated. Use the invite_request method to get an invite code" if @invite_code.nil?
+
+	  	aa_sig = @invite_code["aa_sig"]
+	  	invite_code = @invite_code["invite_code"]
+	  	
+	  	"#{INVITE_URL}/?i=#{invite_code}&aa_sig=#{aa_sig}"
+	  end
+
+	  private
+
+	  def auth_methods(accepted_auth_methods, forcebiometric)
+	  	mobile_device = {
+        name: "mobiledevice",      
+        rules: [
+          {
+            name: "forcebiometric",
+            value: forcebiometric
+          }
+        ]
+      }
+			security_key = { name: "securitykey" }
+
+			if accepted_auth_methods == "securitykey"
+				[security_key]
+			elsif accepted_auth_methods == "mobiledevice"
+				[mobile_device]
+			else
+				[mobile_device, security_key]
+	  	end
+	  end
+	end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: auth-armor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hannah Masila
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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'
+description: Write a longer description or delete this line.
+email:
+- hannahmasila@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- auth-armor.gemspec
+- bin/console
+- bin/setup
+- lib/auth/armor/version.rb
+- lib/auth_armor.rb
+homepage: https://rubygems.org/gems/auth-armor
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/auth-armor
+  source_code_uri: https://github.com/hmasila/auth-armor
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []