feat(web): custom reset password link #2854

you1996 · 2022-02-07T11:13:42Z

feat(authentication): custom reset password URL

Administrators can now redirect users to their custom password reset portal and configure authelia to do so by disabling the internal password reset procedure and enabling the option to use an external portal in the case of some businesses who employ one.

Fixes #1934.

authelia · 2022-02-07T11:13:45Z

Thanks for choosing to contribute @you1996. We lint all PR's with golangci-lint and eslint, I may add a review to your PR with some suggestions.

You are free to apply the changes if you're comfortable, alternatively you are welcome to ask a team member for advice.

Artifacts

These changes once approved by a team member will be published for testing on Buildkite, DockerHub and GitHub Container Registry.

Docker Container

docker pull authelia/authelia:PR2854
docker pull ghcr.io/authelia/authelia:PR2854

internal/server/template.go

james-d-elliott

So all looks fine to me. Just one suggestion around simplifying the configuration and something that will allow us to group other related options. I'll merge master into this branch and provide an example of how to utilize a URL struct in the config.

Edit: Seems I don't have permission to merge master into this. Please do so and you'll be able to use url.URL as in the configuration struct.

config.template.yml

docs/configuration/authentication/index.md

internal/configuration/config.template.yml

internal/configuration/validator/authentication.go

internal/server/template.go

web/index.html

web/.env.production

web/.env.development

web/src/utils/Configuration.ts

internal/configuration/schema/authentication.go

autheliabot · 2022-03-16T11:08:38Z

internal/configuration/validator/authentication.go

@@ -33,6 +33,17 @@
 			validator.Push(fmt.Errorf(errFmtAuthBackendRefreshInterval, config.RefreshInterval, err))
 		}
 	}
+
+	if configuration.EnableExternalResetPassword && !configuration.DisableResetPassword {


🚫 [golangci] _{reported by reviewdog 🐶}
undeclared name: configuration (typecheck)

autheliabot · 2022-03-16T11:08:40Z

internal/configuration/validator/authentication.go

@@ -33,6 +33,17 @@
 			validator.Push(fmt.Errorf(errFmtAuthBackendRefreshInterval, config.RefreshInterval, err))
 		}
 	}
+
+	if configuration.EnableExternalResetPassword && !configuration.DisableResetPassword {
+		validator.Push(errors.New("You cannot enable both `internal reset password` and `external reset password` processes in `authentication_backend`"))


🚫 [golangci] _{reported by reviewdog 🐶}
undeclared name: errors (typecheck)

autheliabot · 2022-03-16T11:08:40Z

internal/configuration/validator/authentication.go

+		validator.Push(errors.New("You cannot enable both `internal reset password` and `external reset password` processes in `authentication_backend`"))
+	}
+
+	if configuration.EnableExternalResetPassword {


🚫 [golangci] _{reported by reviewdog 🐶}
undeclared name: configuration (typecheck)

autheliabot · 2022-03-16T11:08:40Z

internal/configuration/validator/authentication.go

+	}
+
+	if configuration.EnableExternalResetPassword {
+		err := utils.IsStringAbsURL(configuration.ExternalResetPasswordURL)


🚫 [golangci] _{reported by reviewdog 🐶}
undeclared name: configuration (typecheck)

autheliabot · 2022-03-16T11:08:41Z

internal/configuration/validator/authentication_test.go

@@ -230,6 +230,19 @@
 	suite.Assert().False(suite.validator.HasErrors())
 }

+func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenResetURLIsInvalid() {
+	suite.configuration.EnableExternalResetPassword = true


🚫 [golangci] _{reported by reviewdog 🐶}
suite.configuration undefined (type *FileBasedAuthenticationBackend has no field or method configuration) (typecheck)

autheliabot · 2022-03-16T11:08:41Z

internal/configuration/validator/authentication_test.go

@@ -230,6 +230,19 @@
 	suite.Assert().False(suite.validator.HasErrors())
 }

+func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenResetURLIsInvalid() {
+	suite.configuration.EnableExternalResetPassword = true
+	suite.configuration.DisableResetPassword = true


🚫 [golangci] _{reported by reviewdog 🐶}
suite.configuration undefined (type *FileBasedAuthenticationBackend has no field or method configuration) (typecheck)

autheliabot · 2022-03-16T11:08:41Z

internal/configuration/validator/authentication_test.go

+func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenResetURLIsInvalid() {
+	suite.configuration.EnableExternalResetPassword = true
+	suite.configuration.DisableResetPassword = true
+	suite.configuration.ExternalResetPasswordURL = "example.com" //nolint:goconst


🚫 [golangci] _{reported by reviewdog 🐶}
suite.configuration undefined (type *FileBasedAuthenticationBackend has no field or method configuration) (typecheck)

autheliabot · 2022-03-16T11:08:41Z

internal/configuration/validator/authentication_test.go

+	suite.configuration.DisableResetPassword = true
+	suite.configuration.ExternalResetPasswordURL = "example.com" //nolint:goconst
+
+	ValidateAuthenticationBackend(&suite.configuration, suite.validator)


🚫 [golangci] _{reported by reviewdog 🐶}
suite.configuration undefined (type *FileBasedAuthenticationBackend has no field or method configuration) (typecheck)

you1996 · 2022-03-16T11:11:01Z

So all looks fine to me. Just one suggestion around simplifying the configuration and something that will allow us to group other related options. I'll merge master into this branch and provide an example of how to utilize a URL struct in the config.

Edit: Seems I don't have permission to merge master into this. Please do so and you'll be able to use url.URL as in the configuration struct.

Hello james, thank you for the review, merge done.

james-d-elliott · 2022-03-16T11:25:25Z

So all looks fine to me. Just one suggestion around simplifying the configuration and something that will allow us to group other related options. I'll merge master into this branch and provide an example of how to utilize a URL struct in the config.
Edit: Seems I don't have permission to merge master into this. Please do so and you'll be able to use url.URL as in the configuration struct.

Hello james, thank you for the review, merge done.

Nice one! You'll have to change the references in the validator from configuration to config. We shortened it since the additional uration was superfluous.

james-d-elliott · 2022-03-30T22:21:06Z

Did you get around to those fixes? Once I merge all the other 4.35.0 images I am hoping this is ready or I'll have to fix it up myself.

I'd appreciate if I can push to this branch if you don't have time to fix this up, though I can manually takeover this PR worst case scenario, you can enable this by clicking this checkbox:

This allows providing a custom URL for password resets. If provided the disable_reset_password option is ignored, the password reset API is disabled, and the button provided in the UI to reset the password redirects users to the configured endpoint. Closes #1934, Closes #2854 Co-authored-by: you1996 <youssri@flyweight.tech>

autheliabot reviewed Feb 7, 2022

View reviewed changes

internal/server/template.go Outdated Show resolved Hide resolved

you1996 added 2 commits February 7, 2022 13:09

feat(authentication): custom reset password link

d61bcab

fix typo

3e1677f

james-d-elliott requested changes Mar 16, 2022

View reviewed changes

internal/configuration/schema/authentication.go Show resolved Hide resolved

james-d-elliott changed the title ~~feat(authentication): custom reset password link~~ feat(web): custom reset password link Mar 16, 2022

Merge branch 'authelia:master' into custom-reset-password

0387e74

autheliabot reviewed Mar 16, 2022

View reviewed changes

james-d-elliott added the status/needs-review Pull requests that need to be reviewed label Mar 30, 2022

james-d-elliott removed the status/needs-review Pull requests that need to be reviewed label Mar 30, 2022

james-d-elliott mentioned this pull request Apr 4, 2022

feat(web): password reset custom url #3111

Merged

james-d-elliott closed this in #3111 Apr 4, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(web): custom reset password link #2854

feat(web): custom reset password link #2854

you1996 commented Feb 7, 2022

authelia bot commented Feb 7, 2022

james-d-elliott left a comment •

edited

autheliabot Mar 16, 2022

autheliabot Mar 16, 2022

autheliabot Mar 16, 2022

autheliabot Mar 16, 2022

autheliabot Mar 16, 2022

autheliabot Mar 16, 2022

autheliabot Mar 16, 2022

autheliabot Mar 16, 2022

you1996 commented Mar 16, 2022

james-d-elliott commented Mar 16, 2022

james-d-elliott commented Mar 30, 2022

feat(web): custom reset password link #2854

feat(web): custom reset password link #2854

Conversation

you1996 commented Feb 7, 2022

authelia bot commented Feb 7, 2022

Artifacts

Docker Container

james-d-elliott left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

you1996 commented Mar 16, 2022

james-d-elliott commented Mar 16, 2022

james-d-elliott commented Mar 30, 2022

james-d-elliott left a comment •

edited