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:

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.

require "auth-armor"
client = 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

client.auth_request(
  nickname: "NICKNAME",
  action_name: "Login",
  short_msg: "This is a test message",
)

Auth Request for Mobile Device

client.auth_request(
  nickname: "NICKNAME",
  action_name: "Login",
  short_msg: "This is a test message",
  accepted_auth_methods: "mobiledevice"
)

Auth Request for Mobile Device when Biometrics are enforced

client.auth_request(
  nickname: "NICKNAME",
  action_name: "Login",
  short_msg: "This is a test message",
  accepted_auth_methods: "mobiledevice",
  forcebiometric: true
)

Auth Request for Security Key

client.auth_request(
  nickname: "NICKNAME",
  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.

• nonce - An optional value that is signed and returned in the request. This helps validate the response was from your request and no one has done a man-in-the-middle attack.

• 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.

• latitude - this is the latitude where the request originated from.

• langitude - this is the longitude where the request originated from. If provided, location details will show in the push message about the origin of the request.

Invite Request

To generate an invite, call the invite_request method with a nickname

client.invite_request(
  nickname: "NICKNAME"
)

Optional arguments

reference_id - This is an optional value that you can set to further cross reference your records.

reset_and_reinvite - If you need to reset the current user and reinvite, set this flag to true. This will remove all mobile devices and/or active pending invites and create a new invite. Use caution when using this - it will reset any existing user with this nickname

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.

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.

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.

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.

License

The gem is available as open source under the terms of the MIT License.

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.