Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Authentication redirect loop #5794

Closed
RubyLangdon opened this issue May 27, 2020 · 12 comments
Closed

Authentication redirect loop #5794

RubyLangdon opened this issue May 27, 2020 · 12 comments

Comments

@RubyLangdon
Copy link

Issue Summary:

We are suddenly in a redirect loop with gitlab auth.

Cloud Provider(s):

AWS

Environment:

Spinnaker v1.18.12
Halyard v1.31.1
Oauth provider is Gitlab
Authz provider type is FILE

Feature Area:

Authentication / authorization

Description:

We suddenly notice that we cannot log in to the spinnaker UI. The browser has a too many redirects error. We've changed nothing, it was working one day and not the next.

If we upgrade to 1.19.10 or 1.20.3 it works fine. (We'd prefer not to upgrade at the moment due to #5701).
When we downgrade back to 1.18.12 it's broken again. The issue also occurred when we tested versions 1.15.5, 1.16.7, and 1.17.10.

We tried flushing the redis cache which didn't help.
We can't see any error logs in any spinnaker pods. Gate debug logs are attached.
gatelogs.txt

Steps to Reproduce:

Contents of gate-local.yaml

security:
  oauth2:
    client:
      clientId: xxxxxx
      clientSecret: xxxxxx
      userAuthorizationUri: https://gitlab.com/oauth/authorize
      accessTokenUri: https://gitlab.com/oauth/token
      scope: read_user openid
      preEstablishedRedirectUri: <our-gate-base-url>/login
    resource:
      userInfoUri: https://gitlab.com/api/v4/user          
    userInfoMapping:        
      email: email
      firstName: ''
      lastName: name
      username: username

Additional Details:

@bcornils
Copy link

Hello @RubyLangdon Thanks for filing the issue. Unfortunately, no one is available to work on this at the moment, but we welcome contributions from our community. We strongly encourage you to discuss your plans here or on the SIG's slack channel before you start working on the issue. Additionally, I encourage you to leverage our community in slack. Use the search functionality to find users who have a similar experience, or post a message in #general or another related channel. If no one is able to assist please let us know here. Thank you.

@bcornils
Copy link

Hi @RubyLangdon just wanted to check in to see if you found folks to assist in troubleshooting this and/or finding more information regarding root cause.

@RubyLangdon
Copy link
Author

Hi @bcornils, so far we haven't made any progress and I haven't managed to find anyone with a similar issue.

@bcornils
Copy link

Hi @RubyLangdon I'll bring this to the Security SIG this thursday, please feel free to join us to discuss further.

@alchen99
Copy link

@RubyLangdon your scope read_user, userInfoUri, and userInfoMapping is not correct. This will cause an endless redirect loop. Also some tomcat overrides are usually needed. Please try the following in gate-local.yml

server:
  tomcat:
    httpsServerPort: X-Forwarded-Port
    internalProxies: .*
    protocolHeader: X-Forwarded-Proto
    remoteIpHeader: X-Forwarded-For

security:
  oauth2:
    enabled: true
    client:
      clientId: xxxxx
      clientSecret: xxxxx
      accessTokenUri: https://gitlab.com/oauth/token
      userAuthorizationUri: https://gitlab.com/oauth/authorize
      scope: openid,email
    resource:
      userInfoUri: https://gitlab.com/oauth/userinfo
    userInfoMapping:
      email: email
      firstName: name
      lastName: ''      
      username: nickname

@RubyLangdon
Copy link
Author

RubyLangdon commented Jul 26, 2020

Hi @alchen99, when I try that config I get a gitlab error The redirect URI included is not valid.

In gate-local.yml I also have preEstablishedRedirectUri: https://<my-gate-url>/login and in the gitlab application I have the callback URL set to http://<my-gate-url>/login which works in version 1.19 and 1.20.

@alchen99
Copy link

@RubyLangdon unless you have a typo shouldn't your callback URL be https:///login? Is security.apiSecurity.overrideBaseUrl in the ~/.hal/config the same as https:// ? While you are in the redirect loop go to https:///auth/user in the same session. It should return a JSON with some info in it. Check to make sure username is populated.

@RubyLangdon
Copy link
Author

That wasn't a typo, we have always had the gitlab application callback URL set to http, and it's https in the hal config overrideBaseUrl.

However if I change the callback URL to https and set everything up as in your example we are back in the same situation of endless redirects.

At the user endpoint https://gitlab.com/api/v4/user I can see that username is populated. At https://gitlab.com/oauth/userinfo I get a 401. I'm actually not sure what the difference is between those two and when they should be used.

@alchen99
Copy link

Hmm normally the callback URL should be https if using OAuth/OIDC. I'm actually surprised it allowed you to use http for anything other than localhost as the callback.

Seems like we might have different implementations of the GitLab Applications/Oauth since https://gitlab.com/api/v4/user returns a 401 for me. If https://gitlab.com/api/v4/user returns something for you then you should be fine using it. Just make sure the username is mapped to a field that will never be null.

So it looks like the setup I gave you does not work in 1.18 but does work in 1.19 and onwards. Given that you and I have to use a different userInfoUri and that you said that it just suddenly stopped working I'm guessing that something changed on the GitLab side.

I think you will need to upgrade if you want OAuth to work.

@spinnakerbot
Copy link

This issue hasn't been updated in 45 days, so we are tagging it as 'stale'. If you want to remove this label, comment:

@spinnakerbot remove-label stale

@spinnakerbot
Copy link

This issue is tagged as 'stale' and hasn't been updated in 45 days, so we are tagging it as 'to-be-closed'. It will be closed in 45 days unless updates are made. If you want to remove this label, comment:

@spinnakerbot remove-label to-be-closed

@spinnakerbot
Copy link

This issue is tagged as 'to-be-closed' and hasn't been updated in 45 days, so we are closing it. You can always reopen this issue if needed.

chris-h-phillips added a commit to chris-h-phillips/gate that referenced this issue Feb 13, 2022
During setup of spinnaker authentication with oauth2 a common hurdle is a redirect loop.

For example:

spinnaker/spinnaker#5794
spinnaker/spinnaker#1630

Also, many threads in Slack discuss these problems. In fact this appears to be a common
pitfall for the spring-security-oauth2-autoconfigure library in general. A light refresher
on the ouath2 flow in play here seems worthwhile. The user is redirected from `/login` in gate
to the external auth provider (google, github, etc.) and after successfully authenticating
they are redirected back to the gate `/login` endpoint but this time with a code parameter
that is to be used to request an access token.

This request can fail for a variety of reasons, and if it does, the underlying spring library
triggers a redirect to the `/error` endpoint. What causes the redirect loop for gate in particular
(and for other users of the library in a similar fashion) is that the WebSecurityConfigurerAdapter
in play is treating `/error` as an authenticated path and so instead of just returning with a 401,
it re-redirects to `/login` and the redirect loop continues.

My thought is that instead of a redirect loop, simply allowing the 401 to be returned will be a stronger
more helpful signal as to what is going on. Hopefully it will save future first-time installers headaches.

Spinnaker docs have included several troubleshooting hints and tips for how where you terminate SSL
affects configuration etc. Even after following all of these and lots of spelunking through spinnaker
github issues and combing over threads in slack, I found myself still experiencing a redirect loop even
though I had applied all the combined wisdom that was applicable to my setup.

As it turns out, I had a bad copy/paste of my client secret in my configuration. So the request
to turn the code from google into an access token from google was failing with a 401. After much
debugging and deep diving into the spring security code I found that had I turned on DEBUG in gate
for these classes in gate-local.yml:

```
logging:
  level:
    org.springframework.security.web.authentication.SimpleUrlAuthenticationFailureHandler: DEBUG
    org.springframework.security.oauth2.client.filter.OAuth2ClientAuthenticationProcessingFilter: DEBUG
```

Then I would have seen in the logs that a 401 response was returned from google and perhaps it would have
caused me to look closer at my botched client secret configuration. I think perhaps we don't want to require
that all operators of spinnaker become spring-security-oauth2 experts. So I'm proposing adding `/error` to
the list of paths in gate that aren't treated as authenticated. Thus short-circuiting the redirect loop and
bringing to light helpful troubleshooting info that was previously more or less swallowed.
mergify bot pushed a commit to spinnaker/gate that referenced this issue Feb 15, 2022
During setup of spinnaker authentication with oauth2 a common hurdle is a redirect loop.

For example:

spinnaker/spinnaker#5794
spinnaker/spinnaker#1630

Also, many threads in Slack discuss these problems. In fact this appears to be a common
pitfall for the spring-security-oauth2-autoconfigure library in general. A light refresher
on the ouath2 flow in play here seems worthwhile. The user is redirected from `/login` in gate
to the external auth provider (google, github, etc.) and after successfully authenticating
they are redirected back to the gate `/login` endpoint but this time with a code parameter
that is to be used to request an access token.

This request can fail for a variety of reasons, and if it does, the underlying spring library
triggers a redirect to the `/error` endpoint. What causes the redirect loop for gate in particular
(and for other users of the library in a similar fashion) is that the WebSecurityConfigurerAdapter
in play is treating `/error` as an authenticated path and so instead of just returning with a 401,
it re-redirects to `/login` and the redirect loop continues.

My thought is that instead of a redirect loop, simply allowing the 401 to be returned will be a stronger
more helpful signal as to what is going on. Hopefully it will save future first-time installers headaches.

Spinnaker docs have included several troubleshooting hints and tips for how where you terminate SSL
affects configuration etc. Even after following all of these and lots of spelunking through spinnaker
github issues and combing over threads in slack, I found myself still experiencing a redirect loop even
though I had applied all the combined wisdom that was applicable to my setup.

As it turns out, I had a bad copy/paste of my client secret in my configuration. So the request
to turn the code from google into an access token from google was failing with a 401. After much
debugging and deep diving into the spring security code I found that had I turned on DEBUG in gate
for these classes in gate-local.yml:

```
logging:
  level:
    org.springframework.security.web.authentication.SimpleUrlAuthenticationFailureHandler: DEBUG
    org.springframework.security.oauth2.client.filter.OAuth2ClientAuthenticationProcessingFilter: DEBUG
```

Then I would have seen in the logs that a 401 response was returned from google and perhaps it would have
caused me to look closer at my botched client secret configuration. I think perhaps we don't want to require
that all operators of spinnaker become spring-security-oauth2 experts. So I'm proposing adding `/error` to
the list of paths in gate that aren't treated as authenticated. Thus short-circuiting the redirect loop and
bringing to light helpful troubleshooting info that was previously more or less swallowed.
rsh09 pushed a commit to OpsMx/gate that referenced this issue Mar 31, 2022
* fix(oauth): remove circular dependency on ExternalAuthTokenFilter bean in OAuth2SsoConfig when oauth2 is enabled (spinnaker#1492)

Previously in spring 2.2.5, if oauth2 is enabled there is no circular
dependency on ExternalAuthTokenFilter bean in OAuth2SsoConfig.

In spring 2.2.13, if oauth2 is enabled there is a circular dependency
error on ExternalAuthTokenFilter bean. This circular dependency results
in an error when the gate application tries to start up. The application
fails with error:

BeanCurrentlyInCreationException: Error creating bean with name
'OAuth2SsoConfig': Bean with name 'OAuth2SsoConfig' has been injected
into other beans [externalAuthTokenFilter] in its raw version as part
of a circular reference, but has eventually been wrapped.

To fix this error, add the Component annotation to
ExternalAuthTokenFilter and remove the ExternalAuthTokenFilter bean
from OAuth2SsoConfig.

Co-authored-by: David Byron <dbyron@salesforce.com>

* fix(web): disable keel by default as it is an optional service (spinnaker#1453)

Co-authored-by: Justin Field <justin.field@armory.io>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

* fix(api): fix movie quotes to match movie script (spinnaker#1423)

Co-authored-by: Justin Field <justin.field@armory.io>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

* chore(build): gradle 6.8.1 (spinnaker#1413)

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

* chore(dependencies): Autobump korkVersion (spinnaker#1493)

Co-authored-by: root <root@265713e22300>

* chore(dependencies): Autobump korkVersion (spinnaker#1495)

Co-authored-by: root <root@ca7e6659c3b3>

* chore(dependencies): Autobump korkVersion (spinnaker#1496)

Co-authored-by: root <root@7e927306ac3d>

* fix(vulnerability): avoid expose gate endpoints (spinnaker#1497)

* chore(dependencies): Autobump korkVersion (spinnaker#1501)

Co-authored-by: root <root@01b270ba5f94>

* chore(dependencies): Autobump fiatVersion (spinnaker#1504)

Co-authored-by: root <root@73790eeb50df>

* chore(dependencies): Autobump korkVersion (spinnaker#1502)

Co-authored-by: root <root@a229fbda21b3>
Co-authored-by: Matt <6519811+mattgogerly@users.noreply.github.com>

* feat(web): Expose experimental account storage API (spinnaker#1494)

* feat(web): Expose experimental account storage API

This adds some of the REST APIs introduced in the experimental account
storage API in Clouddriver to Gate. Initially, these APIs are only
available for admins.

* Combine account and credentials endpoints

* Add docs on AccountDefinition

* Add alpha annotations

* chore(build): update mergify config (spinnaker#1506)

Co-authored-by: Cameron Motevasselani <cameron@armory.io>

* fix(gate): Typos in Account Management API (spinnaker#1510)

* fix(gate/web): Fix typo in PreAuthorize annotation

It appears that some variables were renamed while I worked on the PR
and didn't update the annotations to match.

* fix(gate/core): Fix retrofit signature error

* fix(gate/web): Add explicit name property to AccountDefinition (spinnaker#1514)

This fixes an authorization check error where Jackson knows how to
handle the `name` property of an account definition, but SpEL does
not see the property. Now the PostFilter annotation should work
equivalently to the same filter check in Clouddriver.

* chore(dependencies): Autobump korkVersion (spinnaker#1515)

Co-authored-by: root <root@d38215f0a8da>

* fix(authn/oauth2): prevent oauth2 redirect loops (spinnaker#1517)

During setup of spinnaker authentication with oauth2 a common hurdle is a redirect loop.

For example:

spinnaker/spinnaker#5794
spinnaker/spinnaker#1630

Also, many threads in Slack discuss these problems. In fact this appears to be a common
pitfall for the spring-security-oauth2-autoconfigure library in general. A light refresher
on the ouath2 flow in play here seems worthwhile. The user is redirected from `/login` in gate
to the external auth provider (google, github, etc.) and after successfully authenticating
they are redirected back to the gate `/login` endpoint but this time with a code parameter
that is to be used to request an access token.

This request can fail for a variety of reasons, and if it does, the underlying spring library
triggers a redirect to the `/error` endpoint. What causes the redirect loop for gate in particular
(and for other users of the library in a similar fashion) is that the WebSecurityConfigurerAdapter
in play is treating `/error` as an authenticated path and so instead of just returning with a 401,
it re-redirects to `/login` and the redirect loop continues.

My thought is that instead of a redirect loop, simply allowing the 401 to be returned will be a stronger
more helpful signal as to what is going on. Hopefully it will save future first-time installers headaches.

Spinnaker docs have included several troubleshooting hints and tips for how where you terminate SSL
affects configuration etc. Even after following all of these and lots of spelunking through spinnaker
github issues and combing over threads in slack, I found myself still experiencing a redirect loop even
though I had applied all the combined wisdom that was applicable to my setup.

As it turns out, I had a bad copy/paste of my client secret in my configuration. So the request
to turn the code from google into an access token from google was failing with a 401. After much
debugging and deep diving into the spring security code I found that had I turned on DEBUG in gate
for these classes in gate-local.yml:

```
logging:
  level:
    org.springframework.security.web.authentication.SimpleUrlAuthenticationFailureHandler: DEBUG
    org.springframework.security.oauth2.client.filter.OAuth2ClientAuthenticationProcessingFilter: DEBUG
```

Then I would have seen in the logs that a 401 response was returned from google and perhaps it would have
caused me to look closer at my botched client secret configuration. I think perhaps we don't want to require
that all operators of spinnaker become spring-security-oauth2 experts. So I'm proposing adding `/error` to
the list of paths in gate that aren't treated as authenticated. Thus short-circuiting the redirect loop and
bringing to light helpful troubleshooting info that was previously more or less swallowed.

* chore(ci): update setup-java GHA to v2 (spinnaker#1518)

closes: spinnaker/spinnaker#6611

* fix(dependency): Issue with jackson-bom and kotlin-bom version conflict resolution while upgrading the spring-boot 2.3.x (spinnaker#1505)

* fix(dependency): Introducing spring dependency management gradle plugin

Spring boot has moved to gradle based dependency management from v2.3.x. This change has brought issue of conflict resolution failure of the Jackson-bom version and kotlin-bom version with gate service when it consumes the maven-bom generated by kork. The issue details are available in given link.
https://docs.google.com/document/d/1Ck4KeoB1ER0aQUTnf3e-x-M3i2Ur0It7YaaxEMiMXls/edit

To resolve this issue while upgrading gate service with spring v2.3.x, we must require the spring dependency management gradle plugin.

* Revert "fix(dependency): Introducing spring dependency management gradle plugin"

This reverts commit b3b2c9e.

* fix(dependency): Issue with jackson-bom and kotlin-bom version conflict resolution while upgrading the spring-boot 2.3.x.

The root cause of this issue is uncontrolled conflict resolution of jackson-bom and kotlin-bom dependency version imported from external maven BOM provided by kork-bom, as per the gradle documentation https://docs.gradle.org/6.9.1/userguide/platforms.html#sub:bom_import, we can use gradle enforcedPlatform closure as part of the implementation to strictly adhere the versions of direct and transitive dependencies imported BOM.

implementation(enforcedPlatform("io.spinnaker.kork:kork-bom:$korkVersion"))

* chore(dependencies): Autobump spinnakerGradleVersion (spinnaker#1519)

Co-authored-by: root <root@92ccf252161e>

* chore(dependencies): Autobump spinnakerGradleVersion (spinnaker#1520)

Co-authored-by: root <root@8e952337838c>

* chore(dependencies): Autobump spinnakerGradleVersion (spinnaker#1521)

Co-authored-by: root <root@e15a7ff336aa>

* chore(dependencies): Autobump spinnakerGradleVersion (spinnaker#1522)

Co-authored-by: root <root@00e70a80e3dd>

* chore(dependencies): Autobump spinnakerGradleVersion (spinnaker#1523)

Co-authored-by: root <root@4cdab225ba98>

* chore(dependencies): Autobump spinnakerGradleVersion (spinnaker#1524)

Co-authored-by: root <root@2bf6cb9b4370>

* chore(dependencies): Autobump fiatVersion (spinnaker#1528)

Co-authored-by: root <root@69a0efe35201>

* chore(ci): GHA - container image and apt package build & push (spinnaker#1529)

to Google Artifact Registry

see: spinnaker/rosco#841

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

* chore(ci): GHA - simplify build versioning (spinnaker#1530)

- collapse version info gathering steps into single `build_variables` step
- collapse version info parts into single string and use everywhere.
- use short git sha: `(git rev-parse --short HEAD)`

Note `build.yml` versioning is not compatible with Debian package
building as gradle plugin enforces `^[0-9]+`.
We don't publish master branch or release-* branches to GAR apt
repository though.
Prefixing the version with `<tag>-dev-` or something and publishing Debian
packages is possible but may pollute `apt-cache policy spinnaker-rosco` output
and overall be unnecessary with regular releases.

* fix(plugins-test): try harder for the version of versionNotSupportedPlugin to actually not be supported (spinnaker#1532)

Before this, a gate version >= 2.0.0 would cause versionNotSupportedPlugin to get used,
causing tests to fail, and making it impossible to e.g. release gate.

* chore(cit): GHA - plugin builds require SemVer (spinnaker#1531)

I wanted to avoid confusion between a git tag `X` building version `X` and a
master or release branch building version `X-dev-*` but it seems unavoidable.
SemVer is required by plugins.
See constraint: https://github.com/spinnaker/kork/blob/5dc6bb98615667f1b4f3e18445c1651d773c9f6b/kork-plugins/src/main/kotlin/com/netflix/spinnaker/kork/plugins/SpinnakerServiceVersionManager.kt#L47

changes:
- fetch full git repository so that we can access previous tag in branch.
  Convert `release.yml` to this method instead of `run: git.. --unshallow`.
- use previous git tag as start of version string. Cut the 'v' prefix from the
  tag, 'v1.2.3' -> '1.2.3' as required for Plugins (and Debians fwiw):
  `Caused by: Unexpected character 'LETTER(v)' at position '0', expecting '[DIGIT]'`
- append `-dev-<branch_name|'pr'>` to designate that it is not an
  official version. The short git SHA and date time are NOT present on
  release versions (eg: 1.2.3) so that also differs.
- do this version setting in `pr.yml` as well so we might pick up version
  issues in PR's and not just at merge.

* chore(dependencies): Autobump korkVersion (spinnaker#1536)

Co-authored-by: root <root@3f84b148af75>

* chore(dependencies): Autobump spinnakerGradleVersion (spinnaker#1537)

Co-authored-by: root <root@87e31b5c1a0c>

* feat(credentials): Update account type discriminator (spinnaker#1533)

This normalizes the type discriminator in account definitions to match that of account credentials instances (i.e., the type of CredentialsDefinition instance and Credentials instance are both specified through the "type" property).

This also removes redundant authorization annotations that are better enforced by AccountDefinitionService in Clouddriver.

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

* resolved  AuthConfig file conflict.

Co-authored-by: Calvin Tse <sam.calvin.tse@gmail.com>
Co-authored-by: David Byron <dbyron@salesforce.com>
Co-authored-by: Emmanouil Katefidis <e.katefidis@outlook.com>
Co-authored-by: Justin Field <justin.field@armory.io>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: Thomas Swanson <tomswanson4444@gmail.com>
Co-authored-by: Cameron Fieber <cfieber@netflix.com>
Co-authored-by: spinnakerbot <spinbot@spinnaker.io>
Co-authored-by: root <root@265713e22300>
Co-authored-by: root <root@ca7e6659c3b3>
Co-authored-by: root <root@7e927306ac3d>
Co-authored-by: Cristhian Castaneda <ccastanedarivera@gmail.com>
Co-authored-by: root <root@01b270ba5f94>
Co-authored-by: root <root@73790eeb50df>
Co-authored-by: root <root@a229fbda21b3>
Co-authored-by: Matt <6519811+mattgogerly@users.noreply.github.com>
Co-authored-by: Matt Sicker <boards@gmail.com>
Co-authored-by: Cameron Motevasselani <cmotevasselani@gmail.com>
Co-authored-by: Cameron Motevasselani <cameron@armory.io>
Co-authored-by: Matt Sicker <msicker@apple.com>
Co-authored-by: root <root@d38215f0a8da>
Co-authored-by: Chris Phillips <4722632+chris-h-phillips@users.noreply.github.com>
Co-authored-by: kskewes-sf <96093759+kskewes-sf@users.noreply.github.com>
Co-authored-by: Sandesh <sandeshjainhyd@gmail.com>
Co-authored-by: root <root@92ccf252161e>
Co-authored-by: root <root@8e952337838c>
Co-authored-by: root <root@e15a7ff336aa>
Co-authored-by: root <root@00e70a80e3dd>
Co-authored-by: root <root@4cdab225ba98>
Co-authored-by: root <root@2bf6cb9b4370>
Co-authored-by: root <root@69a0efe35201>
Co-authored-by: David Byron <82477955+dbyron-sf@users.noreply.github.com>
Co-authored-by: root <root@3f84b148af75>
Co-authored-by: root <root@87e31b5c1a0c>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants