Skip to content

🎧 Your Personal Streaming Service

feat(server): add ExtAuth logout URL configuration (#5074)

Deluan Quintão2bb13e5ff1b6
diff --git a/conf/configuration.go b/conf/configuration.go
index 000bffb58..555d8f587 100644
--- a/conf/configuration.go
+++ b/conf/configuration.go
@@ -250,6 +250,7 @@ type pluginsOptions struct {
type extAuthOptions struct {
TrustedSources string
UserHeader string
+ LogoutURL string
}
type searchOptions struct {
@@ -345,6 +346,7 @@ func Load(noConfigDump bool) {
validateBackupSchedule,
validatePlaylistsPath,
validatePurgeMissingOption,
+ validateURL("ExtAuth.LogoutURL", Server.ExtAuth.LogoutURL),
)
if err != nil {
os.Exit(1)
@@ -548,6 +550,33 @@ func validateSchedule(schedule, field string) (string, error) {
return schedule, err
}
+// validateURL checks if the provided URL is valid and has either http or https scheme.
+// It returns a function that can be used as a hook to validate URLs in the config.
+func validateURL(optionName, optionURL string) func() error {
+ return func() error {
+ if optionURL == "" {
+ return nil
+ }
+ u, err := url.Parse(optionURL)
+ if err != nil {
+ log.Error(fmt.Sprintf("Invalid %s: it could not be parsed", optionName), "url", optionURL, "err", err)
+ return err
+ }
+ if u.Scheme != "http" && u.Scheme != "https" {
+ err := fmt.Errorf("invalid scheme for %s: '%s'. Only 'http' and 'https' are allowed", optionName, u.Scheme)
+ log.Error(err.Error())
+ return err
+ }
+ // Require an absolute URL with a non-empty host and no opaque component.
+ if u.Host == "" || u.Opaque != "" {
+ err := fmt.Errorf("invalid %s: '%s'. A full http(s) URL with a non-empty host is required", optionName, optionURL)
+ log.Error(err.Error())
+ return err
+ }
+ return nil
+ }
+}
+
func normalizeSearchBackend(value string) string {
v := strings.ToLower(strings.TrimSpace(value))
switch v {
@@ -641,6 +670,7 @@ func setViperDefaults() {
viper.SetDefault("passwordencryptionkey", "")
viper.SetDefault("extauth.userheader", "Remote-User")
viper.SetDefault("extauth.trustedsources", "")
+ viper.SetDefault("extauth.logouturl", "")
viper.SetDefault("prometheus.enabled", false)
viper.SetDefault("prometheus.metricspath", consts.PrometheusDefaultPath)
viper.SetDefault("prometheus.password", "")
diff --git a/conf/configuration_test.go b/conf/configuration_test.go
index b4ed6ca2d..73fec4196 100644
--- a/conf/configuration_test.go
+++ b/conf/configuration_test.go
@@ -52,6 +52,48 @@ var _ = Describe("Configuration", func() {
})
})
+ Describe("ValidateURL", func() {
+ It("accepts a valid http URL", func() {
+ fn := conf.ValidateURL("TestOption", "http://example.com/path")
+ Expect(fn()).To(Succeed())
+ })
+
+ It("accepts a valid https URL", func() {
+ fn := conf.ValidateURL("TestOption", "https://example.com/path")
+ Expect(fn()).To(Succeed())
+ })
+
+ It("rejects a URL with no scheme", func() {
+ fn := conf.ValidateURL("TestOption", "example.com/path")
+ Expect(fn()).To(MatchError(ContainSubstring("invalid scheme")))
+ })
+
+ It("rejects a URL with an unsupported scheme", func() {
+ fn := conf.ValidateURL("TestOption", "javascript://example.com/path")
+ Expect(fn()).To(MatchError(ContainSubstring("invalid scheme")))
+ })
+
+ It("accepts an empty URL (optional config)", func() {
+ fn := conf.ValidateURL("TestOption", "")
+ Expect(fn()).To(Succeed())
+ })
+
+ It("includes the option name in the error message", func() {
+ fn := conf.ValidateURL("MyOption", "ftp://example.com")
+ Expect(fn()).To(MatchError(ContainSubstring("MyOption")))
+ })
+
+ It("rejects a URL that cannot be parsed", func() {
+ fn := conf.ValidateURL("TestOption", "://invalid")
+ Expect(fn()).To(HaveOccurred())
+ })
+
+ It("rejects a URL without a host", func() {
+ fn := conf.ValidateURL("TestOption", "http:///path")
+ Expect(fn()).To(MatchError(ContainSubstring("non-empty host is required")))
+ })
+ })
+
DescribeTable("NormalizeSearchBackend",
func(input, expected string) {
Expect(conf.NormalizeSearchBackend(input)).To(Equal(expected))
diff --git a/conf/export_test.go b/conf/export_test.go
index 7344dc4ca..d1d1bb3a9 100644
--- a/conf/export_test.go
+++ b/conf/export_test.go
@@ -8,4 +8,6 @@ var SetViperDefaults = setViperDefaults
var ParseLanguages = parseLanguages
+var ValidateURL = validateURL
+
var NormalizeSearchBackend = normalizeSearchBackend
diff --git a/server/serve_index.go b/server/serve_index.go
index b5b364267..92ef47e23 100644
--- a/server/serve_index.go
+++ b/server/serve_index.go
@@ -76,6 +76,7 @@ func serveIndex(ds model.DataStore, fs fs.FS, shareInfo *model.Share) http.Handl
"separator": string(os.PathSeparator),
"enableInspect": conf.Server.Inspect.Enabled,
"pluginsEnabled": conf.Server.Plugins.Enabled,
+ "extAuthLogoutURL": conf.Server.ExtAuth.LogoutURL,
}
if strings.HasPrefix(conf.Server.UILoginBackgroundURL, "/") {
appConfig["loginBackgroundURL"] = path.Join(conf.Server.BasePath, conf.Server.UILoginBackgroundURL)
diff --git a/server/serve_index_test.go b/server/serve_index_test.go
index 9d6f480ff..e08a42643 100644
--- a/server/serve_index_test.go
+++ b/server/serve_index_test.go
@@ -104,6 +104,7 @@ var _ = Describe("serveIndex", func() {
Entry("enableUserEditing", func() { conf.Server.EnableUserEditing = false }, "enableUserEditing", false),
Entry("enableSharing", func() { conf.Server.EnableSharing = true }, "enableSharing", true),
Entry("devNewEventStream", func() { conf.Server.DevNewEventStream = true }, "devNewEventStream", true),
+ Entry("extAuthLogoutURL", func() { conf.Server.ExtAuth.LogoutURL = "https://auth.example.com/logout" }, "extAuthLogoutURL", "https://auth.example.com/logout"),
)
DescribeTable("sets other UI configuration values",
diff --git a/ui/src/authProvider.js b/ui/src/authProvider.js
index 4ae238eec..813a4f5b4 100644
--- a/ui/src/authProvider.js
+++ b/ui/src/authProvider.js
@@ -66,6 +66,10 @@ const authProvider = {
logout: () => {
removeItems()
+ if (config.extAuthLogoutURL) {
+ window.location.href = config.extAuthLogoutURL
+ return Promise.resolve(false)
+ }
return Promise.resolve()
},
diff --git a/ui/src/layout/UserMenu.jsx b/ui/src/layout/UserMenu.jsx
index a5757a73c..e33185578 100644
--- a/ui/src/layout/UserMenu.jsx
+++ b/ui/src/layout/UserMenu.jsx
@@ -122,7 +122,7 @@ const UserMenu = (props) => {
})
: null,
)}
- {!config.auth && logout}
+ {(!config.auth || !!config.extAuthLogoutURL) && logout}
</MenuList>
</Popover>
</div>