Aws::CognitoSrp for Ruby

An unofficial Ruby library implementing AWS Cognito's SRP authentication flow.

Originally translated from Python's Warrant by Jonathan Viney, packaged into this gem by Pedro Carbajal.

Installation

In your Gemfile:

gem 'aws-cognito-srp'

Usage

require "aws-cognito-srp"

aws_srp = Aws::CognitoSrp.new(
  username:   "username",
  password:   "password",
  pool_id:    "pool-id",
  client_id:  "client-id",
  aws_client: Aws::CognitoIdentityProvider::Client.new(region: "aws-region")
)

resp = aws_srp.authenticate

# Read tokens
resp.id_token
resp.access_token
resp.refresh_token

# A few hours later ... ⌛️

new_tokens = aws_srp.refresh_tokens(resp.refresh_token)

Supported rubies

This gem is tested against and supports Ruby 2.3, 2.4, 2.5, 2.6, 2.7 and 3.0.

Development

After checking out the repo, run bin/setup to install dependencies. 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/beezwax/aws-cognito-srp-ruby

Disclaimer

This project is not sponsored by or otherwise affiliated with Amazon Web Services, Inc., an Amazon.com, Inc. subsidiary. AWS and Amazon Cognito are trademarks of Amazon.com, Inc., or its affiliates in the United States and/or other countries.