omniauth-cognito-idp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d7fe53d2b9bd12affe018276c0b14ff17a6d6217
+  data.tar.gz: 02cae7892d5c1cd0eee4bd6fee0c85fd069972ba
+SHA512:
+  metadata.gz: 47058783e9ad210f31a4ebbd31a7dc25c4164818aefe276287d257eed8a2165ccc423b36962fbf3ceeb6fd5f4b6eb77a24a7e5aa2a7d7c3807cfbd40159f2013
+  data.tar.gz: 6b2f7c55f432184d826cacf0809eda76dd826c85d0aad4dbc21b0f81e3064c9816a3d4fc192ab415e7ad50ba0dc1adcde8fdb8c9b8750c48e8b2b97027fbb5ed

data/LICENSE.md

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2018 The Sage Group Plc
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,79 @@
+# omniauth-cognito-idp
+
+[![Build Status](https://travis-ci.org/Sage/omniauth-cognito-idp.svg?branch=master)](https://travis-ci.org/Sage/omniauth-cognito-idp)
+[![Maintainability](https://api.codeclimate.com/v1/badges/fc91c64f9d7b63724714/maintainability)](https://codeclimate.com/github/Sage/omniauth-cognito-idp/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/fc91c64f9d7b63724714/test_coverage)](https://codeclimate.com/github/Sage/omniauth-cognito-idp/test_coverage)
+[![Gem Version](https://badge.fury.io/rb/omniauth-cognito-idp.svg)](https://badge.fury.io/rb/omniauth-cognito-idp)
+
+This is an [OmniAuth](https://github.com/omniauth/omniauth) strategy based on
+[omniauth-oauth2](https://github.com/omniauth/omniauth-oauth2) for authenticating against the
+[Amazon Cognito IdP](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-userpools-server-contract-reference.html).
+
+## Setup
+
+### Cognito User Pool
+
+The User Pool needs to have a domain assigned. You also have to create a client application for the User Pool. The
+client application should have a secret.
+
+### Ruby Application
+
+Add the gem to your bundle as usual. Then, OmniAuth is used as Rack middleware:
+
+```ruby
+# for instance, in config.ru
+require 'omniauth-cognito-idp'
+
+use Rack::Session::Cookie # OmniAuth requires session support
+
+use OmniAuth::Strategies::CognitoIdP,
+  ENV['CLIENT_ID'],
+  ENV['CLIENT_SECRET'],
+  client_options: {
+    site: ENV['COGNITO_USER_POOL_SITE']
+  },
+  scope: 'email openid aws.cognito.signin.user.admin profile',
+  user_pool_id: ENV['COGNITO_USER_POOL_ID'],
+  aws_region: ENV['AWS_REGION']
+
+run MyApplication
+```
+
+The following configuration options are available:
+
+1. `client_options` (required)
+
+   This is a Hash that is used to configure the OAuth2 client. You have to include the `site` key and specify the domain
+   you assigned to the Cognito User Pool.
+2. `scope` (required)
+
+   A space separated list of scopes you want to request. Make sure to include `openid` and some openid attributes if you
+   want to get an ID token (which gives you information about the user without additional request). When you include
+   `aws.cognito.signin.user.admin`, you can use the access token to get or update the user's attributes in the
+   User Pool.
+   
+   See https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html
+3. `user_pool_id` (optional)
+
+   When specified together with `aws_region`, the ID token returned by Cognito will be verified to really belong to the
+   User Pool you expect.
+4. `aws_region` (optional)
+   When specified together with `user_pool_id`, the ID token returned by Cognito will be verified to really belong to
+   the given AWS region.
+5. `jwt_leeway` (optional)
+
+   Each JWT has it's own expiration and do not use before dates. As the issuer's clock might be off a bit from your's,
+   you can allow some leeway for the JWT validation. Must be a positive integer. Default is 60 seconds. 
+
+## Development
+
+The repository contains a small Sinatra application that can be used to test the strategy. Just run `rackup` with the
+following ENV variables set:
+
+* `COGNITO_CLIENT_ID`: The id of the client application
+* `COGNITO_CLIENT_SECRET`: The client application's secret
+* `COGNITO_POOL_SITE`: The domain attached to the user pool.
+
+The application will start at `http://localhost:8678`. You will have to add a callback URL
+`http://localhost:8678/auth/cognito-idp/callback` to the client application in the AWS Console. The test app stores the
+tokens in memory, so you will need to sign in again after restarting the server.

data/RELEASE_NOTES.md

@@ -0,0 +1,3 @@
+# v0.1.0 (to be released)
+
+Initial Release with basic features.

data/lib/omniauth-cognito-idp.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'omniauth-cognito-idp/version'
+require 'omniauth/strategies/cognito_idp'

data/lib/omniauth-cognito-idp/version.rb

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

data/lib/omniauth/strategies/cognito_idp.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# Copyright 2018 The Sage Group Plc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+#
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'omniauth-oauth2'
+require 'jwt'
+
+module OmniAuth
+  module Strategies
+    # OmniAuth strategy that authenticates against an Amazon Cognito User Pool
+    class CognitoIdP < OmniAuth::Strategies::OAuth2
+      option :name, 'cognito-idp'
+      option :client_options,
+        {
+          authorize_url: '/oauth2/authorize',
+          token_url: '/oauth2/token',
+          auth_scheme: :basic_auth
+        }
+      option :jwt_leeway, 60
+      option :user_pool_id, nil
+      option :aws_region, nil
+
+      uid do
+        parsed_id_token['sub'] if parsed_id_token
+      end
+
+      info do
+        if parsed_id_token
+          {
+            name: parsed_id_token['name'],
+            email: parsed_id_token['email'],
+            phone: parsed_id_token['phone_number']
+          }
+        end
+      end
+
+      credentials do
+        { token: access_token.token }.tap do |hash|
+          hash[:refresh_token] = access_token.refresh_token if access_token.expires? && access_token.refresh_token
+          hash[:expires_at] = access_token.expires_at if access_token.expires?
+          hash[:expires] = access_token.expires?
+          hash[:id_token] = id_token if id_token
+        end
+      end
+
+      extra do
+        { raw_info: parsed_id_token.reject { |key| %w[iss aud exp iat token_use nbf].include?(key) } }
+      end
+
+      private
+
+      # Override this method to remove the query string from the callback_url because Cognito
+      # requires an exact match
+      def build_access_token
+        client.auth_code.get_token(
+          request.params['code'],
+          { redirect_uri: callback_url.split('?').first }.merge(token_params.to_hash(symbolize_keys: true)),
+          deep_symbolize(options.auth_token_params)
+        )
+      end
+
+      def id_token
+        access_token['id_token']
+      end
+
+      def parsed_id_token
+        return nil unless id_token
+
+        @parsed_id_token ||= JWT.decode(
+          id_token,
+          nil,
+          false,
+          verify_iss: options[:aws_region] && options[:user_pool_id],
+          iss: "https://cognito-idp.#{options[:aws_region]}.amazonaws.com/#{options[:user_pool_id]}",
+          verify_aud: true,
+          aud: options[:client_id],
+          verify_sub: true,
+          verify_expiration: true,
+          verify_not_before: true,
+          verify_iat: true,
+          verify_jti: false,
+          leeway: options[:jwt_leeway]).first
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'cognito_idp', 'CognitoIdP'

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-cognito-idp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sage Business Cloud Accounting API Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-17 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: omniauth-oauth2
+  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: aws-sdk-cognitoidentityprovider
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: Use the Amazon Cognito IdP with OmniAuth
+email: sageoneapi@sage.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- RELEASE_NOTES.md
+- lib/omniauth-cognito-idp.rb
+- lib/omniauth-cognito-idp/version.rb
+- lib/omniauth/strategies/cognito_idp.rb
+homepage: http://github.com/Sage/omniauth-cognito-idp
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: OmniAuth Strategy for Amazon Cognito
+test_files: []