When following a link that prompts sign in through SAML or Multi-Auth the destination page is not lost #1557

cwperks · 2023-08-17T18:51:39Z

Description

Fixes a bug with nextUrl and SAML when multiauth is enabled. The SAML login button was not correctly carrying the nextUrl from the URL after logging in and instead routing the user to the home page.

Now the user will be routed to where they previously were before their session timed out or if they log off.

Issues Resolved

Resolves [BUG] SAML nextUrl is empty when clicking on the Button Log in with single sign-on #1434

Check List

New functionality includes testing
New functionality has been documented
Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Craig Perkins <[email protected]>

codecov · 2023-08-17T19:02:27Z

Codecov Report

Merging #1557 (1a994d4) into main (c10031f) will increase coverage by 0.11%.
The diff coverage is 91.66%.

@@            Coverage Diff             @@
##             main    #1557      +/-   ##
==========================================
+ Coverage   66.06%   66.18%   +0.11%     
==========================================
  Files          93       93              
  Lines        2328     2339      +11     
  Branches      310      312       +2     
==========================================
+ Hits         1538     1548      +10     
  Misses        722      722              
- Partials       68       69       +1

Files Changed	Coverage Δ
public/apps/login/login-page.tsx	`75.78% <91.66%> (+1.97%)`	⬆️

peternied

Good find - encoding issues are something else.

peternied · 2023-08-18T00:22:51Z

public/apps/login/login-page.tsx

-            renderLoginButton(AuthType.SAML, SAML_AUTH_LOGIN_WITH_FRAGMENT, samlConfig)
-          );
+          const urlParams = new URLSearchParams(window.location.search);
+          let nextUrl = urlParams.get('nextUrl');


Confusing to see this variable assigned values multiple times.

The function should be simpler now. I reduced the amount of usages of nextUrl

peternied · 2023-08-18T00:23:26Z

public/apps/login/login-page.tsx

-          formBodyOp.push(
-            renderLoginButton(AuthType.SAML, SAML_AUTH_LOGIN_WITH_FRAGMENT, samlConfig)
-          );
+          const urlParams = new URLSearchParams(window.location.search);


Could this new logic be broken out into a function, I think that could help clarify while this block is doing and keep its logic isolated

I abstracted this out into a function in login-utils

Signed-off-by: Craig Perkins <[email protected]>

stephen-crawford

Other than Peter's comment about extracting the code block into the function this looks good to me. Nice job with the tests.

Signed-off-by: Craig Perkins <[email protected]>

common/index.ts

public/utils/login-utils.tsx

test/jest_integration/saml_multiauth.test.ts

Signed-off-by: Craig Perkins <[email protected]>

DarshitChanpura · 2023-08-18T18:47:29Z

Unit tests CI fails due to linter errors. Once those are fixed via #1558, I'll add my approval.

Signed-off-by: Craig Perkins <[email protected]>

…erks/security-dashboards-plugin into fix-multi-auth-saml-next-url

Signed-off-by: Craig Perkins <[email protected]>

cwperks · 2023-08-23T13:06:11Z

@DarshitChanpura @peternied @scrawfor99 This is ready for review again after the PR to remove hardcoded colors was merged.

DarshitChanpura

LGTM. Thanks @cwperks !

.github/workflows/integration-test.yml

public/apps/login/login-page.tsx

RyanL1997

Hi @cwperks, thanks for putting them together. I apologize for the late review. I just left some questions/comments.

test/jest_integration/saml_multiauth.test.ts

.github/workflows/integration-test.yml

Signed-off-by: Craig Perkins <[email protected]>

cwperks · 2023-08-24T16:29:18Z

@RyanL1997 We still have the saml_auth tests they are just skipped on windows because of the issue bringing up the node-based IdP on the Github Windows runner.

RyanL1997 · 2023-08-24T16:30:29Z

@RyanL1997 We still have the saml_auth tests they are just skipped on windows because of the issue bringing up the node-based IdP on the Github Windows runner.

Yes, I know that. I was just confusing for a second when I see that line change haha. But I get it now. Thanks

RyanL1997

@cwperks Thanks for adding the unit test. This is looking good to me.

#1557) * Fix bug with nextUrl using SAML and multiauth enabled Signed-off-by: Craig Perkins <[email protected]> (cherry picked from commit f655ccf)

#1557) (#1561) * Fix bug with nextUrl using SAML and multiauth enabled Signed-off-by: Craig Perkins <[email protected]> (cherry picked from commit f655ccf) Co-authored-by: Craig Perkins <[email protected]>

cwperks added 4 commits August 17, 2023 08:54

Fix bug with nextUrl using SAML and multiauth enabled

5800345

Signed-off-by: Craig Perkins <[email protected]>

Add saml multiauth tests

ee02908

Signed-off-by: Craig Perkins <[email protected]>

uncomment

1e6f826

Signed-off-by: Craig Perkins <[email protected]>

Headless

a864b90

Signed-off-by: Craig Perkins <[email protected]>

cwperks requested review from cliu123, DarshitChanpura, davidlago, peternied, RyanL1997 and stephen-crawford as code owners August 17, 2023 18:51

cwperks added the backport 2.x backport to 2.x branch label Aug 17, 2023

peternied reviewed Aug 18, 2023

View reviewed changes

Create a function and add another test where nextUrl is empty

1c3f3d9

Signed-off-by: Craig Perkins <[email protected]>

stephen-crawford previously approved these changes Aug 18, 2023

View reviewed changes

app/home

5e7fb59

Signed-off-by: Craig Perkins <[email protected]>

cwperks dismissed stephen-crawford’s stale review via 5e7fb59 August 18, 2023 14:08

stephen-crawford previously approved these changes Aug 18, 2023

View reviewed changes

Use comma separated list

c9409a8

Signed-off-by: Craig Perkins <[email protected]>

cwperks dismissed stephen-crawford’s stale review via c9409a8 August 18, 2023 15:10

DarshitChanpura reviewed Aug 18, 2023

View reviewed changes

common/index.ts Show resolved Hide resolved

public/utils/login-utils.tsx Outdated Show resolved Hide resolved

test/jest_integration/saml_multiauth.test.ts Show resolved Hide resolved

cwperks added 3 commits August 18, 2023 12:10

Pass option multiple times

351cba7

Signed-off-by: Craig Perkins <[email protected]>

Add to DEVELOPER_GUIDE

4d2c1b0

Signed-off-by: Craig Perkins <[email protected]>

Merge branch 'main' into fix-multi-auth-saml-next-url

4ea4f36

cwperks added 5 commits August 22, 2023 13:13

Merge branch 'main' into fix-multi-auth-saml-next-url

57aa442

Remove unused param

07facc3

Signed-off-by: Craig Perkins <[email protected]>

Merge branch 'fix-multi-auth-saml-next-url' of https://github.com/cwp…

37be795

…erks/security-dashboards-plugin into fix-multi-auth-saml-next-url

Remove unused

e5479f3

Signed-off-by: Craig Perkins <[email protected]>

Move function to login-page

19368da

Signed-off-by: Craig Perkins <[email protected]>

DarshitChanpura previously approved these changes Aug 23, 2023

View reviewed changes

derek-ho reviewed Aug 24, 2023

View reviewed changes

.github/workflows/integration-test.yml Show resolved Hide resolved

peternied requested changes Aug 24, 2023

View reviewed changes

.github/workflows/integration-test.yml Show resolved Hide resolved

public/apps/login/login-page.tsx Show resolved Hide resolved

stephen-crawford previously approved these changes Aug 24, 2023

View reviewed changes

stephen-crawford requested review from DarshitChanpura and stephen-crawford August 24, 2023 15:41

RyanL1997 reviewed Aug 24, 2023

View reviewed changes

test/jest_integration/saml_multiauth.test.ts Show resolved Hide resolved

test/jest_integration/saml_multiauth.test.ts Show resolved Hide resolved

.github/workflows/integration-test.yml Show resolved Hide resolved

Add unit tests for extractNextUrlFromWindowLocation

1a994d4

Signed-off-by: Craig Perkins <[email protected]>

cwperks dismissed stale reviews from stephen-crawford and DarshitChanpura via 1a994d4 August 24, 2023 16:20

RyanL1997 approved these changes Aug 24, 2023

View reviewed changes

peternied approved these changes Aug 24, 2023

View reviewed changes

cwperks merged commit f655ccf into opensearch-project:main Aug 24, 2023
13 checks passed

opensearch-trigger-bot bot mentioned this pull request Aug 24, 2023

[Backport 2.x] Use value from nextUrl when logging in with SAML and multiauth enabled #1561

Merged

peternied changed the title ~~Use value from nextUrl when logging in with SAML and multiauth enabled~~ When following a link that prompts sign in through SAML or Multi-Auth the destination page is not lost Aug 31, 2023

cwperks mentioned this pull request Dec 1, 2023

Implement nextUrl for OpenID Authentication #1563

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

When following a link that prompts sign in through SAML or Multi-Auth the destination page is not lost #1557

When following a link that prompts sign in through SAML or Multi-Auth the destination page is not lost #1557

cwperks commented Aug 17, 2023 •

edited by peternied

Loading

codecov bot commented Aug 17, 2023 •

edited

Loading

peternied left a comment

peternied Aug 18, 2023

cwperks Aug 18, 2023

peternied Aug 18, 2023

cwperks Aug 18, 2023

stephen-crawford left a comment

DarshitChanpura commented Aug 18, 2023 •

edited

Loading

cwperks commented Aug 23, 2023 •

edited

Loading

DarshitChanpura left a comment

RyanL1997 left a comment

cwperks commented Aug 24, 2023

RyanL1997 commented Aug 24, 2023

RyanL1997 left a comment

When following a link that prompts sign in through SAML or Multi-Auth the destination page is not lost #1557

When following a link that prompts sign in through SAML or Multi-Auth the destination page is not lost #1557

Conversation

cwperks commented Aug 17, 2023 • edited by peternied Loading

Description

Category

Issues Resolved

Check List

codecov bot commented Aug 17, 2023 • edited Loading

Codecov Report

peternied left a comment

Choose a reason for hiding this comment

peternied Aug 18, 2023

Choose a reason for hiding this comment

cwperks Aug 18, 2023

Choose a reason for hiding this comment

peternied Aug 18, 2023

Choose a reason for hiding this comment

cwperks Aug 18, 2023

Choose a reason for hiding this comment

stephen-crawford left a comment

Choose a reason for hiding this comment

DarshitChanpura commented Aug 18, 2023 • edited Loading

cwperks commented Aug 23, 2023 • edited Loading

DarshitChanpura left a comment

Choose a reason for hiding this comment

RyanL1997 left a comment

Choose a reason for hiding this comment

cwperks commented Aug 24, 2023

RyanL1997 commented Aug 24, 2023

RyanL1997 left a comment

Choose a reason for hiding this comment

cwperks commented Aug 17, 2023 •

edited by peternied

Loading

codecov bot commented Aug 17, 2023 •

edited

Loading

DarshitChanpura commented Aug 18, 2023 •

edited

Loading

cwperks commented Aug 23, 2023 •

edited

Loading