aws-srp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bc27e086070a47ca1d6035d3c058ac7865e72bc527c748e584f6edf3f2e65a77
+  data.tar.gz: f939b7bd528cd2d1aad17e5651eabf88581e9ed28c70ba4d01d1574c344a7c15
+SHA512:
+  metadata.gz: 0e641bdbb5e55d8e9694f952a14cc16d2f6783e7f43787bb2ce7ce37f767d69a40c1c1aeeb135e072ab13273afc8b87bc6cd324ae4d1c41a97e7bbe1bbd9e624
+  data.tar.gz: f57c6d80d0fc372b2d70a329c60a78f928aa570e798b6272e806dc72fc83a34efd4b9f404a08e2b21f5ea4544b1b2ba2e09615f3d1763fcc4231de97d3c2a174

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.6
+before_install: gem install bundler -v 2.1.4

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    aws-srp (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aws-srp!
+  pry
+  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 Tim Masliuchenko
+
+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,60 @@
+# aws-srp [![Build Status](https://travis-ci.org/timsly/aws-srp.svg?branch=master)](https://travis-ci.org/timsly/aws-srp)
+
+AWS Cognito SRP Utility
+
+This is a ruby implementation of [the AWS Cognito flow helpers](https://github.com/aws-amplify/amplify-js/blob/main/packages/amazon-cognito-identity-js/src/AuthenticationHelper.js)
+using some ideas from [the SIRP gem](https://github.com/grempe/sirp)
+
+By design the `AwsSRP::Flow` only processes params but doesn't trigger any requests.
+Requests should be handled on the client side.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aws-srp'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install aws-srp
+
+## Usage
+
+```ruby
+flow = AwsSRP::Flow.new
+init_params = flow.init_auth
+
+# Do the init AWS Congnito request by sending `init_params`
+# Parse the JSON response and pass it to the `AwsSRP::Flow#verify_password`
+
+challange_request_params = flow.verify_password(challange_response_body)
+
+# Send the `challange_request_params` and parse the response.
+# The session token should be there
+```
+
+## TODO
+
+- Test coverage for `AwsSRP::SRP` and `AwsSRP::Flow` classes
+- Handle more AWS Cognito features(2FA, etc)
+
+## 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/timsly/aws-srp.
+
+
+## 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/aws-srp.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'lib/aws_srp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aws-srp'
+  spec.version       = AwsSRP::VERSION
+  spec.authors       = ['Tim Masliuchenko']
+  spec.email         = ['insside@gmail.com']
+
+  spec.summary       = %q{AWS Cognito SRP Utility}
+  spec.description   = %q{AWS Cognito SRP Utility}
+  spec.homepage      = 'https://github.com/timsly/aws-srp'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/timsly/aws-srp'
+
+  # 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']
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'aws-srp'
+
+require 'pry'
+Pry.start

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/aws-srp.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'aws_srp'

data/lib/aws_srp.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'openssl'
+require 'base64'
+require 'securerandom'
+
+require 'aws_srp/version'
+require 'aws_srp/hasher'
+require 'aws_srp/hex'
+require 'aws_srp/srp'
+require 'aws_srp/flow'
+require 'aws_srp/flow/password_verifier_response'

data/lib/aws_srp/flow.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module AwsSRP
+  # AWS Cognito flow
+  class Flow
+    attr_reader :pool_id, :username, :password, :srp
+
+    def initialize(pool_id, username, password)
+      @pool_id = pool_id
+      @username = username
+      @password = password
+
+      @srp = SRP.new
+    end
+
+    def now
+      @now ||= Time.now.utc.strftime('%a %b %-e %H:%M:%S UTC %Y')
+    end
+
+    def init_auth
+      {
+        AuthParameters: {
+          USERNAME: username,
+          SRP_A: srp.aa.str
+        }
+      }
+    end
+
+    def verify_password(response)
+      response = PasswordVerifierResponse.new(response)
+
+      srp.username = [pool_id, response.user_id].join
+      srp.password = password
+      srp.salt = response.salt
+      srp.bb = response.bb
+
+      hmac = Hasher.new(srp.hkdf)
+        .update(pool_id)
+        .update(response.user_id)
+        .update(response.secret_block, base64: true)
+        .update(now)
+
+      {
+        ChallengeName: response.challenge_name,
+        ChallengeResponses: {
+          USERNAME: response.user_id,
+          PASSWORD_CLAIM_SECRET_BLOCK: response.secret_block,
+          TIMESTAMP: now,
+          PASSWORD_CLAIM_SIGNATURE: hmac.digest64
+        }
+      }
+    end
+  end
+end

data/lib/aws_srp/flow/password_verifier_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module AwsSRP
+  class Flow
+    # Password Verifier Challange response wrapper
+    class PasswordVerifierResponse
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+      end
+
+      def challenge_name
+        dig!('ChallengeName')
+      end
+
+      def salt
+        dig!('ChallengeParameters', 'SALT')
+      end
+
+      def secret_block
+        dig!('ChallengeParameters', 'SECRET_BLOCK')
+      end
+
+      def bb
+        dig!('ChallengeParameters', 'SRP_B')
+      end
+
+      def user_id
+        dig!('ChallengeParameters', 'USER_ID_FOR_SRP')
+      end
+
+      private
+
+      def dig!(*path)
+        response.dig(*path) ||
+          raise(ArgumentError, "#{path.join('/')} not found in the response")
+      end
+    end
+  end
+end

data/lib/aws_srp/hasher.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module AwsSRP
+  # Depends on the `msg` presence acts as a digest or a hmac
+  class Hasher
+    ALGORITHM = 'sha256'
+
+    def self.digest(key, msg = nil)
+      new(key, msg).digest
+    end
+
+    def self.hexdigest(key, msg = nil)
+      new(key, msg).hexdigest
+    end
+
+    def initialize(key, msg = nil)
+      @key = key
+      @digest = OpenSSL::Digest.new(ALGORITHM)
+
+      update(msg) if msg
+    end
+
+    def update(msg, base64: false)
+      msg = Base64.strict_decode64(msg) if base64
+      hmac.update(msg)
+
+      self
+    end
+
+    def digest
+      perform :digest
+    end
+
+    def hexdigest
+      perform :hexdigest
+    end
+
+    def digest64
+      Base64.strict_encode64(digest)
+    end
+
+    private
+
+    def hmac
+      @hmac ||= OpenSSL::HMAC.new(@key, @digest)
+    end
+
+    def perform(method)
+      @hmac ? hmac.public_send(method) : @digest.public_send(method, @key)
+    end
+  end
+end

data/lib/aws_srp/hex.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module AwsSRP
+  # Hexadecimal number represntation.
+  class Hex
+    HEX_STRING_PATTERN = /^[a-fA-F0-9]+$/.freeze
+    DOUBLE_ZERO_PADDING_PATTERN = /^[a-fA-F89]/.freeze
+    ARITHMETIC_OPERATORS = %i[+ - * / %].freeze
+
+    # Return a hex string (e.g. \x9F)
+    def self.str(str)
+      [str].pack('H*')
+    end
+
+    attr_reader :str
+
+    def initialize(val)
+      @str, @int = if val.is_a?(Integer)
+        [val.to_s(16), val]
+      else
+        validate_str!(val.to_s)
+      end
+
+      @str = @str.downcase
+    end
+
+    def int
+      @int ||= str.hex
+    end
+    alias to_i int
+
+    def padding
+      if str.length.odd?
+        '0'
+      elsif str =~ DOUBLE_ZERO_PADDING_PATTERN
+        '00'
+      end
+    end
+
+    def to_s
+      "#{padding}#{str}"
+    end
+
+    # to hex string (e.g. \x9F)
+    def to_hs
+      self.class.str(to_s)
+    end
+
+    def concat(other)
+      to_s + other.to_s
+    end
+
+    ARITHMETIC_OPERATORS.each do |method|
+      class_eval <<-CODE, __FILE__, __LINE__ + 1
+        def #{method}(other)
+          self.class.new(to_i.#{method}(other.to_i))
+        end
+      CODE
+    end
+
+    def zero?
+      to_i.zero?
+    end
+
+    def mod_exp(b, m)
+      self.class.new(_mod_exp(to_i, b.to_i, m.to_i))
+    end
+
+    private
+
+    def validate_str!(val)
+      return val if val =~ HEX_STRING_PATTERN
+
+      raise ArgumentError, "'#{val}' must be a hex string"
+    end
+
+    # Modular Exponentiation
+    # https://en.wikipedia.org/wiki/Modular_exponentiation
+    # http://rosettacode.org/wiki/Modular_exponentiation#Ruby
+    if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.5')
+      class_eval <<-CODE, __FILE__, __LINE__ + 1
+        def _mod_exp(a, b, m)
+          a.to_bn.mod_exp(b, m).to_i
+        end
+      CODE
+    else
+      class_eval <<-CODE, __FILE__, __LINE__ + 1
+        def _mod_exp(a, b, m)
+          a.pow(b, m)
+        end
+      CODE
+    end
+  end
+end

data/lib/aws_srp/srp.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module AwsSRP
+  # SRP related logic
+  # Titleized methods are not common in ruby so `A` becomes `aa`
+  class SRP
+    N = %w[
+      FFFFFFFF FFFFFFFF C90FDAA2 2168C234 C4C6628B 80DC1CD1 29024E08
+      8A67CC74 020BBEA6 3B139B22 514A0879 8E3404DD EF9519B3 CD3A431B
+      302B0A6D F25F1437 4FE1356D 6D51C245 E485B576 625E7EC6 F44C42E9
+      A637ED6B 0BFF5CB6 F406B7ED EE386BFB 5A899FA5 AE9F2411 7C4B1FE6
+      49286651 ECE45B3D C2007CB8 A163BF05 98DA4836 1C55D39A 69163FA8
+      FD24CF5F 83655D23 DCA3AD96 1C62F356 208552BB 9ED52907 7096966D
+      670C354E 4ABC9804 F1746C08 CA18217C 32905E46 2E36CE3B E39E772C
+      180E8603 9B2783A2 EC07A28F B5C55DF0 6F4C52C9 DE2BCBF6 95581718
+      3995497C EA956AE5 15D22618 98FA0510 15728E5A 8AAAC42D AD33170D
+      04507A33 A85521AB DF1CBA64 ECFB8504 58DBEF0A 8AEA7157 5D060C7D
+      B3970F85 A6E1E4C7 ABF5AE8C DB0933D7 1E8C94E0 4A25619D CEE3D226
+      1AD2EE6B F12FFA06 D98A0864 D8760273 3EC86A64 521F2B18 177B200C
+      BBE11757 7A615D6C 770988C0 BAD946E2 08E24FA0 74E5AB31 43DB5BFC
+      E0FD108E 4B82D120 A93AD2CA FFFFFFFF FFFFFFFF
+    ].freeze
+    INFO_BITS = "Caldera Derived Key\u0001"
+
+    attr_reader :nn, :g, :a, :username, :password, :salt, :bb
+
+    def initialize
+      @nn = Hex.new(N.join)
+      @g = Hex.new(2)
+      @a = Hex.new(SecureRandom.hex(128))
+    end
+
+    # A = g^a (mod N)
+    def aa
+      @aa ||= g.mod_exp(a, nn)
+    end
+
+    # Multiplier parameter
+    # k = H(N, g) (in SRP-6a)
+    def k
+      @k ||= hash(nn.concat(g), hex: true)
+    end
+
+    # u = H(A, B)
+    def u
+      srp_6a_safety_check! do
+        hash(aa.concat(bb), hex: true)
+      end
+    end
+
+    def credentials_hash
+      hash([username, password].join(':'))
+    end
+
+    # Private key (derived from username, raw password and salt)
+    # x = H(salt || H(username || ':' || password))
+    def x
+      @x ||= hash(salt.concat(credentials_hash), hex: true)
+    end
+
+    # Client secret
+    # S = (B - (k * g^x)) ^ (a + (u * x)) % N
+    def ss
+      ((bb - k * g.mod_exp(x, nn)) % nn).mod_exp(a + x * u, nn)
+    end
+
+    def username=(val)
+      reset
+      @username = val
+    end
+
+    def password=(val)
+      reset
+      @password = val
+    end
+
+    def salt=(val)
+      reset
+      @salt = Hex.new(val)
+    end
+
+    def bb=(val)
+      bb = Hex.new(val)
+      srp_6a_safety_check!(bb % nn)
+
+      reset
+      @bb = bb
+    end
+
+    def hkdf
+      prk = Hasher.digest(u.to_hs, ss.to_hs)
+      Hasher.digest(prk, INFO_BITS)[0, 16]
+    end
+
+    def reset
+      @x = nil
+
+      self
+    end
+
+    private
+
+    def hash(str, hex: false)
+      str = Hex.str(str) if hex
+      hexdigest = Hasher.hexdigest(str)
+
+      hex ? Hex.new(hexdigest) : hexdigest
+    end
+
+    def srp_6a_safety_check!(val = nil)
+      val ||= yield
+
+      raise ArgumentError, 'SRP-6a safety check failed' if val.zero?
+
+      val
+    end
+  end
+end

data/lib/aws_srp/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AwsSRP
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: aws-srp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Masliuchenko
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-08 00:00:00.000000000 Z
+dependencies: []
+description: AWS Cognito SRP Utility
+email:
+- insside@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- aws-srp.gemspec
+- bin/console
+- bin/setup
+- lib/aws-srp.rb
+- lib/aws_srp.rb
+- lib/aws_srp/flow.rb
+- lib/aws_srp/flow/password_verifier_response.rb
+- lib/aws_srp/hasher.rb
+- lib/aws_srp/hex.rb
+- lib/aws_srp/srp.rb
+- lib/aws_srp/version.rb
+homepage: https://github.com/timsly/aws-srp
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/timsly/aws-srp
+  source_code_uri: https://github.com/timsly/aws-srp
+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.0.3
+signing_key:
+specification_version: 4
+summary: AWS Cognito SRP Utility
+test_files: []