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.

Sign up for GitHub

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

Jump to bottom

feat: add SAML specific external URL config #1599

Merged
merged 1 commit into from
May 31, 2024
Merged

feat: add SAML specific external URL config #1599

merged 1 commit into from
May 31, 2024

Conversation

hf
Copy link
Contributor

@hf hf commented May 30, 2024

Adds a SAML-specific external URL config, which allows the advertised SAML metadata to be different than the one defined with the API external URL.

This is useful in projects that use proxies or custom domains which can be very disruptive with SAML as a new connection with the IDP needs to be established. By configuring GOTRUE_SAML_EXTERNAL_URL to the URL before the custom domain was set up, Auth will advertise the correct metadata.

@hf hf requested a review from a team as a code owner May 30, 2024 10:31
@coveralls
Copy link

Pull Request Test Coverage Report for Build 9301082594

Details

  • 8 of 19 (42.11%) changed or added relevant lines in 2 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.03%) to 65.695%
Changes Missing Coverage Covered Lines Changed/Added Lines %
internal/conf/saml.go 1 5 20.0%
internal/api/saml.go 7 14 50.0%
Totals Coverage Status
Change from base Build 9299647492: -0.03%
Covered Lines: 8409
Relevant Lines: 12800
💛 - Coveralls

kangmingtay
kangmingtay approved these changes May 31, 2024
View reviewed changes
Copy link
Member

@kangmingtay kangmingtay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i guess the validation will need to be done externally to check if the SAML external url is a valid url that can reach the auth server? (i.e a valid custom domain / project url)

@hf
Copy link
Contributor Author

hf commented May 31, 2024

i guess the validation will need to be done externally to check if the SAML external url is a valid url that can reach the auth server? (i.e a valid custom domain / project url)

Yup, that's a value that can't be derived by the Auth server -- it's up to whoever is deploying this to know what URL the thing can be reached at.

@hf hf merged commit b352719 into master May 31, 2024
3 checks passed
@hf hf deleted the hf/saml-specific-external-url branch May 31, 2024 12:41
@github-actions github-actions bot mentioned this pull request May 31, 2024
Merged
kangmingtay pushed a commit that referenced this pull request Jun 6, 2024
@github-actions
chore(master): release 2.153.0 (#1596)
dd16b95 
🤖 I have created a release *beep* *boop*
---


##
[2.153.0](v2.152.0...v2.153.0)
(2024-06-04)


### Features

* add SAML specific external URL config
([#1599](#1599))
([b352719](b352719))
* add support for verifying argon2i and argon2id passwords
([#1597](#1597))
([55409f7](55409f7))
* make the email client explicity set the format to be HTML
([#1149](#1149))
([53e223a](53e223a))


### Bug Fixes

* call write header in write if not written
([#1598](#1598))
([0ef7eb3](0ef7eb3))
* deadlock issue with timeout middleware write
([#1595](#1595))
([6c9fbd4](6c9fbd4))
* improve token OIDC logging
([#1606](#1606))
([5262683](5262683))
* update contributing to use v1.22
([#1609](#1609))
([5894d9e](5894d9e))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@kangmingtay kangmingtay mentioned this pull request Jun 11, 2024
Open
uxodb pushed a commit to uxodb/auth that referenced this pull request Nov 13, 2024
@hf
feat: add SAML specific external URL config (supabase#1599)
6db58a3 
Adds a SAML-specific external URL config, which allows the advertised
SAML metadata to be different than the one defined with the API external
URL.

This is useful in projects that use proxies or custom domains which can
be very disruptive with SAML as a new connection with the IDP needs to
be established. By configuring `GOTRUE_SAML_EXTERNAL_URL` to the URL
before the custom domain was set up, Auth will advertise the correct
metadata.
uxodb pushed a commit to uxodb/auth that referenced this pull request Nov 13, 2024
@github-actions
chore(master): release 2.153.0 (supabase#1596)
bf00d92 
🤖 I have created a release *beep* *boop*
---


##
[2.153.0](supabase/auth@v2.152.0...v2.153.0)
(2024-06-04)


### Features

* add SAML specific external URL config
([supabase#1599](supabase#1599))
([b352719](supabase@b352719))
* add support for verifying argon2i and argon2id passwords
([supabase#1597](supabase#1597))
([55409f7](supabase@55409f7))
* make the email client explicity set the format to be HTML
([supabase#1149](supabase#1149))
([53e223a](supabase@53e223a))


### Bug Fixes

* call write header in write if not written
([supabase#1598](supabase#1598))
([0ef7eb3](supabase@0ef7eb3))
* deadlock issue with timeout middleware write
([supabase#1595](supabase#1595))
([6c9fbd4](supabase@6c9fbd4))
* improve token OIDC logging
([supabase#1606](supabase#1606))
([5262683](supabase@5262683))
* update contributing to use v1.22
([supabase#1609](supabase#1609))
([5894d9e](supabase@5894d9e))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
LashaJini pushed a commit to LashaJini/auth that referenced this pull request Nov 13, 2024
@hf @LashaJini
feat: add SAML specific external URL config (supabase#1599)
8351b43 
Adds a SAML-specific external URL config, which allows the advertised
SAML metadata to be different than the one defined with the API external
URL.

This is useful in projects that use proxies or custom domains which can
be very disruptive with SAML as a new connection with the IDP needs to
be established. By configuring `GOTRUE_SAML_EXTERNAL_URL` to the URL
before the custom domain was set up, Auth will advertise the correct
metadata.
LashaJini pushed a commit to LashaJini/auth that referenced this pull request Nov 13, 2024
@github-actions @LashaJini
chore(master): release 2.153.0 (supabase#1596)
569e3ac 
🤖 I have created a release *beep* *boop*
---


##
[2.153.0](supabase/auth@v2.152.0...v2.153.0)
(2024-06-04)


### Features

* add SAML specific external URL config
([supabase#1599](supabase#1599))
([b352719](supabase@b352719))
* add support for verifying argon2i and argon2id passwords
([supabase#1597](supabase#1597))
([55409f7](supabase@55409f7))
* make the email client explicity set the format to be HTML
([supabase#1149](supabase#1149))
([53e223a](supabase@53e223a))


### Bug Fixes

* call write header in write if not written
([supabase#1598](supabase#1598))
([0ef7eb3](supabase@0ef7eb3))
* deadlock issue with timeout middleware write
([supabase#1595](supabase#1595))
([6c9fbd4](supabase@6c9fbd4))
* improve token OIDC logging
([supabase#1606](supabase#1606))
([5262683](supabase@5262683))
* update contributing to use v1.22
([supabase#1609](supabase#1609))
([5894d9e](supabase@5894d9e))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
LashaJini pushed a commit to LashaJini/auth that referenced this pull request Nov 15, 2024
@hf @LashaJini
feat: add SAML specific external URL config (supabase#1599)
416bb40 
Adds a SAML-specific external URL config, which allows the advertised
SAML metadata to be different than the one defined with the API external
URL.

This is useful in projects that use proxies or custom domains which can
be very disruptive with SAML as a new connection with the IDP needs to
be established. By configuring `GOTRUE_SAML_EXTERNAL_URL` to the URL
before the custom domain was set up, Auth will advertise the correct
metadata.
LashaJini pushed a commit to LashaJini/auth that referenced this pull request Nov 15, 2024
@github-actions @LashaJini
chore(master): release 2.153.0 (supabase#1596)
299c61b 
🤖 I have created a release *beep* *boop*
---


##
[2.153.0](supabase/auth@v2.152.0...v2.153.0)
(2024-06-04)


### Features

* add SAML specific external URL config
([supabase#1599](supabase#1599))
([b352719](supabase@b352719))
* add support for verifying argon2i and argon2id passwords
([supabase#1597](supabase#1597))
([55409f7](supabase@55409f7))
* make the email client explicity set the format to be HTML
([supabase#1149](supabase#1149))
([53e223a](supabase@53e223a))


### Bug Fixes

* call write header in write if not written
([supabase#1598](supabase#1598))
([0ef7eb3](supabase@0ef7eb3))
* deadlock issue with timeout middleware write
([supabase#1595](supabase#1595))
([6c9fbd4](supabase@6c9fbd4))
* improve token OIDC logging
([supabase#1606](supabase#1606))
([5262683](supabase@5262683))
* update contributing to use v1.22
([supabase#1609](supabase#1609))
([5894d9e](supabase@5894d9e))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kangmingtay kangmingtay kangmingtay approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@hf @coveralls @kangmingtay