docs(OAuth2):added guide for aws cognito by joetancy · Pull Request #2017 · spinnaker/spinnaker.github.io

joetancy · 2020-08-31T09:00:31Z

Add a guide for AWS Cognito user pools to be used for OAuth2 authentication

dorbin

@joetancy , thanks for the doc! I've made some editing suggestions. I'll tag someone for a technical review.

dorbin · 2020-08-31T13:57:23Z

setup/security/authentication/oauth/cognito/index.md

+
+## Setting up an AWS Cognito App Client
+
+1. Navigate to [https://aws.amazon.com/](https://aws.amazon.com/) and log in with your AWS credentials.


Can we link directly to the Cognito page?

dorbin · 2020-08-31T13:57:43Z

setup/security/authentication/oauth/cognito/index.md

+1. Navigate to [https://aws.amazon.com/](https://aws.amazon.com/) and log in with your AWS credentials.
+2. Search for Cognito in the search bar.
+3. Select the user pools you want Spinnaker to use.
+4. At the side bar under "General settings", select "App clients", add a client


Suggested change

4. At the side bar under "General settings", select "App clients", add a client

4. At the side bar under "General settings", select "App clients", add a client.

dorbin · 2020-08-31T13:59:52Z

setup/security/authentication/oauth/cognito/index.md

+2. Search for Cognito in the search bar.
+3. Select the user pools you want Spinnaker to use.
+4. At the side bar under "General settings", select "App clients", add a client
+  - Make sure you select "Generate client secret"


Suggested change

- Make sure you select "Generate client secret"

- Make sure you select "Generate client secret."

dorbin · 2020-08-31T14:00:06Z

setup/security/authentication/oauth/cognito/index.md

+3. Select the user pools you want Spinnaker to use.
+4. At the side bar under "General settings", select "App clients", add a client
+  - Make sure you select "Generate client secret"
+5. After that go to "App integration", then to "App client settings"


Suggested change

5. After that go to "App integration", then to "App client settings"

5. After that go to "App integration," then to "App client settings."

dorbin · 2020-08-31T14:01:09Z

setup/security/authentication/oauth/cognito/index.md

+4. At the side bar under "General settings", select "App clients", add a client
+  - Make sure you select "Generate client secret"
+5. After that go to "App integration", then to "App client settings"
+  - Select "Cognito User Pool" as one of the "Enabled Identity Providers"


Suggested change

- Select "Cognito User Pool" as one of the "Enabled Identity Providers"

- Select "Cognito User Pool" as one of the "Enabled Identity Providers."

dorbin · 2020-08-31T14:04:48Z

setup/security/authentication/oauth/cognito/index.md

+  - Make sure you select "Generate client secret"
+5. After that go to "App integration", then to "App client settings"
+  - Select "Cognito User Pool" as one of the "Enabled Identity Providers"
+  - Input your callback url


Suggested change

- Input your callback url

- Input your callback URL.

Periods for all these that are complete sentences.

dorbin · 2020-08-31T14:05:22Z

setup/security/authentication/oauth/cognito/index.md

+    - email, openid
+  - Also make sure you already have a domain name for your hosted UI
+
+You should have these credentials ready before moving on to the next step


Suggested change

You should have these credentials ready before moving on to the next step

Have these credentials ready before moving on to the next step

dorbin · 2020-08-31T14:06:48Z

setup/security/authentication/oauth/cognito/index.md

+
+## Configure Halyard
+
+You may configure Halyard either with the CLI or by manually editing the hal config.


Suggested change

You may configure Halyard either with the CLI or by manually editing the hal config.

You can configure Halyard either with the [CLI](/reference/halyard/commands/) or by manually editing the hal config.

dorbin · 2020-08-31T14:07:19Z

setup/security/authentication/oauth/cognito/index.md

+
+### CLI
+
+Set up OAuth 2.0 with AWS Cognito:


Suggested change

Set up OAuth 2.0 with AWS Cognito:

1. Set up OAuth 2.0 with AWS Cognito:

dorbin · 2020-08-31T14:07:32Z

setup/security/authentication/oauth/cognito/index.md

+
+`hal config security authn oauth2 edit --provider OTHER --client-id (client ID from above)  --client-secret (client secret from above) --access-token-uri (your domain name)/oauth2/token --user-authorization-uri (your domain name)/oauth2/authorize --user-info-uri (your domain name)/oauth2/userInfo`
+
+Now enable OAuth 2.0 using hal:


Suggested change

Now enable OAuth 2.0 using hal:

Enable OAuth 2.0:

dorbin · 2020-08-31T14:10:03Z

@clareliguori

clareliguori · 2020-09-02T03:08:54Z

@dorbin I don't have much knowledge about Cognito, so this LGTM

joetancy · 2020-09-15T02:30:44Z

Thank you for the suggested changes @dorbin, all changes have been committed!

dorbin · 2020-09-15T14:46:41Z

@spinnaker/sig-aws
Hoping anyone in the SIG knows anything about Cognito. :) If so, can you review?

dorbin · 2020-09-15T14:56:21Z

setup/security/authentication/oauth/cognito/index.md

+4. At the side bar under "General settings", select "App clients", add a client.
+  - Make sure you select "Generate client secret."
+5. After that go to "App integration", then to "App client settings."
+  a) Select "Cognito User Pool" as one of the "Enabled Identity Providers."


@joetancy I don't know if you've set yourself up to preview your changes, but these substeps might not resolve the way you want them to. If you are previewing, and this looks ok, then ignore this comment.

But Markdown usually wants sub steps to start with 1. , just like the first-level steps. And the indentation causes Markdown to give them letters instead of numbers.

apologies, fixed in the next commit!

dorbin

A few more comments, Joe.

Still would like someone to do a technical review. @robzienert , you? Or do you know who might know? Thanks.

dorbin · 2020-10-15T15:20:33Z

setup/security/authentication/oauth/cognito/index.md

+1. Navigate to [https://aws.amazon.com/cognito/](https://aws.amazon.com/cognito/) and log in with your AWS credentials.
+2. Search for Cognito in the search bar.
+3. Select the user pools you want Spinnaker to use.
+4. At the side bar under "General settings", select "App clients", add a client.


Suggested change

4. At the side bar under "General settings", select "App clients", add a client.

4. At the side bar under **General settings**, select **App clients**, add a client.

Sorry, @joetancy, I should have done this the last time I looked at this. Can you change all UI elements to be in boldface instead of double-quotes? Thanks!

https://developers.google.com/style/ui-elements

dorbin · 2020-10-15T15:23:34Z

setup/security/authentication/oauth/cognito/index.md

+5. After that go to "App integration", then to "App client settings."
+    - Select "Cognito User Pool" as one of the "Enabled Identity Providers."
+    - Input your callback URL.
+    - Check the following


Suggested change

- Check the following

- Check the following:

dorbin · 2020-10-15T15:23:47Z

setup/security/authentication/oauth/cognito/index.md

+    - Check the following
+       - Authorization code grant, Implicit grant
+       - email, openid
+    - Also make sure you already have a domain name for your hosted UI


Suggested change

- Also make sure you already have a domain name for your hosted UI

- Also make sure you already have a domain name for your hosted UI.

dorbin · 2020-10-15T15:23:58Z

setup/security/authentication/oauth/cognito/index.md

+       - email, openid
+    - Also make sure you already have a domain name for your hosted UI
+
+Have these credentials ready before moving on to the next step


Suggested change

Have these credentials ready before moving on to the next step

Have these credentials ready before moving on to the next step:

added guide for aws cognito

c37f033

dorbin suggested changes Aug 31, 2020

View reviewed changes

joetancy added 2 commits September 15, 2020 10:22

Merge branch 'master' into patch-1

f053aea

Edited the doc based on comments in PR spinnaker#2017

bbdd7c0

joetancy requested a review from dorbin September 15, 2020 02:30

dorbin reviewed Sep 15, 2020

View reviewed changes

joetancy added 4 commits September 16, 2020 11:55

better bullet formatting

7e978a2

Merge branch 'master' into patch-1

ee84cca

Merge branch 'master' into patch-1

e5c856c

Merge branch 'master' into patch-1

20a12b9

joetancy requested a review from dorbin October 15, 2020 09:03

dorbin reviewed Oct 15, 2020

View reviewed changes


		## Setting up an AWS Cognito App Client

		1. Navigate to [https://aws.amazon.com/](https://aws.amazon.com/) and log in with your AWS credentials.

	4. At the side bar under "General settings", select "App clients", add a client
	4. At the side bar under "General settings", select "App clients", add a client.

	- Make sure you select "Generate client secret"
	- Make sure you select "Generate client secret."

	5. After that go to "App integration", then to "App client settings"
	5. After that go to "App integration," then to "App client settings."

	- Select "Cognito User Pool" as one of the "Enabled Identity Providers"
	- Select "Cognito User Pool" as one of the "Enabled Identity Providers."

	You should have these credentials ready before moving on to the next step
	Have these credentials ready before moving on to the next step


		## Configure Halyard

		You may configure Halyard either with the CLI or by manually editing the hal config.

	You may configure Halyard either with the CLI or by manually editing the hal config.
	You can configure Halyard either with the [CLI](/reference/halyard/commands/) or by manually editing the hal config.

	Set up OAuth 2.0 with AWS Cognito:
	1. Set up OAuth 2.0 with AWS Cognito:


		`hal config security authn oauth2 edit --provider OTHER --client-id (client ID from above) --client-secret (client secret from above) --access-token-uri (your domain name)/oauth2/token --user-authorization-uri (your domain name)/oauth2/authorize --user-info-uri (your domain name)/oauth2/userInfo`

		Now enable OAuth 2.0 using hal:

	4. At the side bar under "General settings", select "App clients", add a client.
	4. At the side bar under General settings, select App clients, add a client.

	- Also make sure you already have a domain name for your hosted UI
	- Also make sure you already have a domain name for your hosted UI.

Conversation

joetancy commented Aug 31, 2020

Uh oh!

dorbin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dorbin commented Aug 31, 2020

Uh oh!

clareliguori commented Sep 2, 2020

Uh oh!

joetancy commented Sep 15, 2020

Uh oh!

dorbin commented Sep 15, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dorbin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants