Skip to content

High performance, self-hosted, newsletter and mailing list manager with a modern dashboard. Single binary app.

Make OIDC provider name display on login button configurable. Closes #2211

Kailash Nadh12bc79866f1a
diff --git a/cmd/auth.go b/cmd/auth.go
index ed9c872f..c202a56b 100644
--- a/cmd/auth.go
+++ b/cmd/auth.go
@@ -187,25 +187,30 @@ func (a *App) renderLoginPage(c echo.Context, loginErr error) error {
}
var (
- oidcProvider = ""
- oidcLogo = ""
+ oidcProviderName = a.cfg.Security.OIDC.ProviderName
+ oidcLogo = ""
)
if a.cfg.Security.OIDC.Enabled {
oidcLogo = "oidc.png"
- u, err := url.Parse(a.cfg.Security.OIDC.Provider)
+ u, err := url.Parse(a.cfg.Security.OIDC.ProviderURL)
if err == nil {
h := strings.Split(u.Hostname(), ".")
// Get the last two h for the root domain
+ prov := ""
if len(h) >= 2 {
- oidcProvider = h[len(h)-2] + "." + h[len(h)-1]
+ prov = h[len(h)-2] + "." + h[len(h)-1]
} else {
- oidcProvider = u.Hostname()
+ prov = u.Hostname()
+ }
+
+ if oidcProviderName == "" {
+ oidcProviderName = prov
}
// Lookup the logo in the known providers map.
- if _, ok := oidcProviders[oidcProvider]; ok {
- oidcLogo = oidcProvider + ".png"
+ if _, ok := oidcProviders[prov]; ok {
+ oidcLogo = prov + ".png"
}
}
}
@@ -213,7 +218,7 @@ func (a *App) renderLoginPage(c echo.Context, loginErr error) error {
out := loginTpl{
Title: a.i18n.T("users.login"),
PasswordEnabled: true,
- OIDCProvider: oidcProvider,
+ OIDCProvider: oidcProviderName,
OIDCProviderLogo: oidcLogo,
NextURI: next,
}
diff --git a/cmd/init.go b/cmd/init.go
index 0ddc1b6b..9c7bd974 100644
--- a/cmd/init.go
+++ b/cmd/init.go
@@ -97,7 +97,8 @@ type Config struct {
Security struct {
OIDC struct {
Enabled bool `koanf:"enabled"`
- Provider string `koanf:"provider_url"`
+ ProviderURL string `koanf:"provider_url"`
+ ProviderName string `koanf:"provider_name"`
ClientID string `koanf:"client_id"`
ClientSecret string `koanf:"client_secret"`
} `koanf:"oidc"`
diff --git a/frontend/src/views/settings/security.vue b/frontend/src/views/settings/security.vue
index 08a49b46..725879ff 100644
--- a/frontend/src/views/settings/security.vue
+++ b/frontend/src/views/settings/security.vue
@@ -1,25 +1,35 @@
<template>
<div class="items">
<div class="columns">
- <div class="column is-4">
+ <div class="column is-3">
<b-field :label="$t('settings.security.enableOIDC')" :message="$t('settings.security.OIDCHelp')">
<b-switch v-model="data['security.oidc']['enabled']" name="security.oidc" />
</b-field>
</div>
- <div class="column is-8">
- <b-field :label="$t('settings.security.OIDCURL')" label-position="on-border">
- <div>
- <b-input v-model="data['security.oidc']['provider_url']" name="oidc.provider_url"
- placeholder="https://login.yoursite.com" :disabled="!data['security.oidc']['enabled']" :maxlength="300"
- required type="url" pattern="https?://.*" />
-
- <div class="spaced-links is-size-7 mt-2" :class="{ 'disabled': !data['security.oidc']['enabled'] }">
- <a href="#" @click.prevent="() => setProvider(n, 'google')">Google</a>
- <a href="#" @click.prevent="() => setProvider(n, 'microsoft')">Microsoft</a>
- <a href="#" @click.prevent="() => setProvider(n, 'apple')">Apple</a>
- </div>
+ <div class="column is-9">
+ <div class="columns">
+ <div class="column is-7">
+ <b-field :label="$t('settings.security.OIDCURL')" label-position="on-border">
+ <div>
+ <b-input v-model="data['security.oidc']['provider_url']" name="oidc.provider_url"
+ placeholder="https://login.yoursite.com" :disabled="!data['security.oidc']['enabled']"
+ :maxlength="300" required type="url" pattern="https?://.*" />
+
+ <div class="spaced-links is-size-7 mt-2" :class="{ 'disabled': !data['security.oidc']['enabled'] }">
+ <a href="#" @click.prevent="() => setProvider('google')">Google</a>
+ <a href="#" @click.prevent="() => setProvider('microsoft')">Microsoft</a>
+ <a href="#" @click.prevent="() => setProvider('apple')">Apple</a>
+ </div>
+ </div>
+ </b-field>
</div>
- </b-field>
+ <div class="column is-5">
+ <b-field :label="$t('settings.security.OIDCName')" label-position="on-border">
+ <b-input v-model="data['security.oidc']['provider_name']" name="oidc.provider_name" ref="provider_name"
+ :disabled="!data['security.oidc']['enabled']" :maxlength="200" />
+ </b-field>
+ </div>
+ </div>
<b-field :label="$t('settings.security.OIDCClientID')" label-position="on-border">
<b-input v-model="data['security.oidc']['client_id']" name="oidc.client_id" ref="client_id"
@@ -43,12 +53,12 @@
<hr />
<div class="columns">
- <div class="column is-4">
+ <div class="column is-3">
<b-field :label="$t('settings.security.enableCaptcha')" :message="$t('settings.security.enableCaptchaHelp')">
<b-switch v-model="data['security.enable_captcha']" name="security.captcha" />
</b-field>
</div>
- <div class="column is-8">
+ <div class="column is-9">
<b-field :label="$t('settings.security.captchaKey')" label-position="on-border"
:message="$t('settings.security.captchaKeyHelp')">
<b-input v-model="data['security.captcha_key']" name="captcha_key"
@@ -108,8 +118,9 @@ export default Vue.extend({
},
methods: {
- setProvider(n, provider) {
+ setProvider(provider) {
this.$set(this.data['security.oidc'], 'provider_url', OIDC_PROVIDERS[provider]);
+ this.$set(this.data['security.oidc'], 'provider_name', provider.charAt(0).toUpperCase() + provider.slice(1));
this.$nextTick(() => {
this.$refs.client_id.focus();
diff --git a/i18n/en.json b/i18n/en.json
index cc0080fa..f619a7eb 100644
--- a/i18n/en.json
+++ b/i18n/en.json
@@ -529,6 +529,7 @@
"settings.security.OIDCRedirectURL": "Redirect URL for oAuth provider",
"settings.security.OIDCRedirectWarning": "This does not seem to be a production URL. Change the Root URL in 'General' settings.",
"settings.security.OIDCURL": "Provider URL",
+ "settings.security.OIDCName": "Provider name",
"settings.security.OIDCWarning": "When OIDC is enabled, default password login is disabled. Invalid config can lock you out.",
"settings.security.captchaKey": "hCaptcha.com SiteKey",
"settings.security.captchaKeyHelp": "Visit www.hcaptcha.com to obtain the key and secret.",
diff --git a/internal/migrations/v5.0.0.go b/internal/migrations/v5.0.0.go
index 0f79ee75..22b7907a 100644
--- a/internal/migrations/v5.0.0.go
+++ b/internal/migrations/v5.0.0.go
@@ -40,7 +40,10 @@ func V5_0_0_rc1(db *sqlx.DB, fs stuffbin.FileSystem, ko *koanf.Koanf, lo *log.Lo
// Insert new preference settings.
if _, err := db.Exec(`
- INSERT INTO settings (key, value) VALUES('privacy.domain_allowlist', '[]') ON CONFLICT DO NOTHING;
+ INSERT INTO settings (key, value) VALUES
+ ('privacy.domain_allowlist', '[]'),
+ ('security.oidc.provider_name', '""')
+ ON CONFLICT DO NOTHING;
`); err != nil {
return err
}
diff --git a/models/settings.go b/models/settings.go
index d0cb8a36..2137b418 100644
--- a/models/settings.go
+++ b/models/settings.go
@@ -44,6 +44,7 @@ type Settings struct {
OIDC struct {
Enabled bool `json:"enabled"`
ProviderURL string `json:"provider_url"`
+ ProviderName string `json:"provider_name"`
ClientID string `json:"client_id"`
ClientSecret string `json:"client_secret"`
} `json:"security.oidc"`
diff --git a/schema.sql b/schema.sql
index b5c6c9fc..0236e30d 100644
--- a/schema.sql
+++ b/schema.sql
@@ -256,7 +256,7 @@ INSERT INTO settings (key, value) VALUES
('security.enable_captcha', 'false'),
('security.captcha_key', '""'),
('security.captcha_secret', '""'),
- ('security.oidc', '{"enabled": false, "provider_url": "", "client_id": "", "client_secret": ""}'),
+ ('security.oidc', '{"enabled": false, "provider_url": "", "provider_name": "", "client_id": "", "client_secret": ""}'),
('upload.provider', '"filesystem"'),
('upload.max_file_size', '5000'),
('upload.extensions', '["jpg","jpeg","png","gif","svg","*"]'),