adds env var GOTIFY_OIDC_IDP_NAME with default "OIDC"

variable is used in the UI for button labels at login and elevation
forms

Author: DerDummePunkt

config/config.go

@@ -68,6 +68,7 @@ type OIDC struct {
 	AutoRegister   bool
 	LinkByUsername bool
 	Scopes         []string
+	IDPName        string
 }
 
 type Configuration struct {
@@ -115,6 +116,7 @@ func Get() (*Configuration, []FutureLog) {
 			UsernameClaim: "preferred_username",
 			AutoRegister:  true,
 			Scopes:        []string{"openid", "profile", "email"},
+			IDPName:       "OIDC",
 		},
 	}
 
@@ -177,6 +179,7 @@ func Get() (*Configuration, []FutureLog) {
 	add(parseBool(&c.OIDC.AutoRegister, EnvOIDCAutoRegister))
 	add(parseBool(&c.OIDC.LinkByUsername, EnvOIDCLinkByUsername))
 	add(parseList(&c.OIDC.Scopes, EnvOIDCScopes))
+	add(parseString(&c.OIDC.IDPName, EnvOIDCIDPName))
 
 	add(parseString(&c.NoColor, EnvNoColor))
 

config/config_test.go

@@ -20,6 +20,7 @@ func TestConfigEnv(t *testing.T) {
 	os.Setenv("GOTIFY_SERVER_CORS_ALLOWMETHODS", "GET,POST")
 	os.Setenv("GOTIFY_SERVER_CORS_ALLOWHEADERS", "Authorization,content-type")
 	os.Setenv("GOTIFY_SERVER_STREAM_ALLOWEDORIGINS", ".+.example.com,otherdomain.com")
+	os.Setenv("GOTIFY_OIDC_IDP_NAME", "Company XYZ SSO")
 
 	defer func() {
 		os.Unsetenv("GOTIFY_DEFAULTUSER_NAME")
@@ -29,6 +30,7 @@ func TestConfigEnv(t *testing.T) {
 		os.Unsetenv("GOTIFY_SERVER_CORS_ALLOWMETHODS")
 		os.Unsetenv("GOTIFY_SERVER_CORS_ALLOWHEADERS")
 		os.Unsetenv("GOTIFY_SERVER_STREAM_ALLOWEDORIGINS")
+		os.Unsetenv("GOTIFY_OIDC_IDP_NAME")
 	}()
 
 	conf, _ := Get()
@@ -41,6 +43,7 @@ func TestConfigEnv(t *testing.T) {
 	assert.Equal(t, []string{"GET", "POST"}, conf.Server.Cors.AllowMethods)
 	assert.Equal(t, []string{"Authorization", "content-type"}, conf.Server.Cors.AllowHeaders)
 	assert.Equal(t, []string{".+.example.com", "otherdomain.com"}, conf.Server.Stream.AllowedOrigins)
+	assert.Equal(t, "Company XYZ SSO", conf.OIDC.IDPName)
 }
 
 func TestFile(t *testing.T) {

config/keys.go

@@ -41,5 +41,6 @@ const (
 	EnvOIDCAutoRegister                 = "GOTIFY_OIDC_AUTOREGISTER"
 	EnvOIDCLinkByUsername               = "GOTIFY_OIDC_LINK_BY_USERNAME"
 	EnvOIDCScopes                       = "GOTIFY_OIDC_SCOPES"
+	EnvOIDCIDPName                      = "GOTIFY_OIDC_IDP_NAME"
 	EnvNoColor                          = "NOCOLOR"
 )

docs/spec.json

@@ -2940,7 +2940,8 @@
       "required": [
         "version",
         "register",
-        "oidc"
+        "oidc",
+        "oidcIdpName"
       ],
       "properties": {
         "oidc": {
@@ -2949,6 +2950,12 @@
           "x-go-name": "Oidc",
           "example": true
         },
+        "oidcIdpName": {
+          "description": "Name of the OIDC identity provider.",
+          "type": "string",
+          "x-go-name": "OIDCIDPName",
+          "example": "OIDC"
+        },
         "register": {
           "description": "If registration is enabled.",
           "type": "boolean",

gotify-server.env.example

@@ -224,6 +224,13 @@
 # Type: text-list
 # GOTIFY_OIDC_SCOPES=openid,profile,email
 
+# Name of the OIDC identity provider displayed in the login and elevation UI.
+# Only used if GOTIFY_OIDC_ENABLED is true. Defaults to OIDC.
+#
+# Type: text
+# Example: Company XYZ SSO
+# GOTIFY_OIDC_IDP_NAME=OIDC
+
 # Database driver to use. For mysql and postgres the target database must
 # already exist and the configured user must have sufficient permissions.
 #

model/gotifyinfo.go

@@ -19,4 +19,9 @@ type GotifyInfo struct {
 	// required: true
 	// example: true
 	Oidc bool `json:"oidc"`
+	// Name of the OIDC identity provider.
+	//
+	// required: true
+	// example: OIDC
+	OIDCIDPName string `json:"oidcIdpName"`
 }

router/router.go

@@ -118,7 +118,7 @@ func Create(db *database.GormDatabase, vInfo *model.VersionInfo, conf *config.Co
 	userChangeNotifier.OnUserDeleted(pluginManager.RemoveUser)
 	userChangeNotifier.OnUserAdded(pluginManager.InitializeForUserID)
 
-	ui.Register(g, *vInfo, conf.Registration, conf.OIDC.Enabled)
+	ui.Register(g, *vInfo, conf.Registration, conf.OIDC.Enabled, conf.OIDC.IDPName)
 
 	if conf.OIDC.Enabled {
 		oidcHandler := api.NewOIDC(conf, db, userChangeNotifier)
@@ -189,7 +189,12 @@ func Create(db *database.GormDatabase, vInfo *model.VersionInfo, conf *config.Co
 	//     schema:
 	//         $ref: "#/definitions/GotifyInfo"
 	g.GET("gotifyinfo", func(ctx *gin.Context) {
-		ctx.JSON(200, &model.GotifyInfo{Version: vInfo.Version, Oidc: conf.OIDC.Enabled, Register: conf.Registration})
+		ctx.JSON(200, &model.GotifyInfo{
+			Version:     vInfo.Version,
+			Oidc:        conf.OIDC.Enabled,
+			Register:    conf.Registration,
+			OIDCIDPName: conf.OIDC.IDPName,
+		})
 	})
 
 	g.Group("/").Use(authentication.RequireApplicationOrClient).POST("/message", messageHandler.CreateMessage)

ui/serve.go

@@ -16,14 +16,20 @@ import (
 var box embed.FS
 
 type uiConfig struct {
-	Register bool              `json:"register"`
-	Version  model.VersionInfo `json:"version"`
-	OIDC     bool              `json:"oidc"`
+	Register    bool              `json:"register"`
+	Version     model.VersionInfo `json:"version"`
+	OIDC        bool              `json:"oidc"`
+	OIDCIDPName string            `json:"oidcIdpName"`
 }
 
 // Register registers the ui on the root path.
-func Register(r *gin.Engine, version model.VersionInfo, register, oidcEnabled bool) {
-	uiConfigBytes, err := json.Marshal(uiConfig{Version: version, Register: register, OIDC: oidcEnabled})
+func Register(r *gin.Engine, version model.VersionInfo, register, oidcEnabled bool, oidcIDPName string) {
+	uiConfigBytes, err := json.Marshal(uiConfig{
+		Version:     version,
+		Register:    register,
+		OIDC:        oidcEnabled,
+		OIDCIDPName: oidcIDPName,
+	})
 	if err != nil {
 		panic(err)
 	}

ui/src/common/ElevationForm.tsx

@@ -17,6 +17,7 @@ const ElevationForm = observer(() => {
 
     const oidcEnabled = config.get('oidc');
     const oidcPending = elevateStore.oidcElevatePending;
+    const oidcIdpName = config.get('oidcIdpName');
 
     const handleLocalElevate = async () => {
         try {
@@ -88,7 +89,7 @@ const ElevationForm = observer(() => {
                         color="primary"
                         fullWidth
                         onClick={() => elevateStore.oidcElevate(ElevateDuration)}>
-                        Elevate via OIDC
+                        {`Elevate via ${oidcIdpName}`}
                     </Button>
                 </>
             )}

ui/src/config.ts

@@ -5,6 +5,7 @@ export interface IConfig {
     register: boolean;
     version: IVersion;
     oidc: boolean;
+    oidcIdpName: string;
 }
 
 declare global {
@@ -18,6 +19,7 @@ const config: IConfig = {
     register: false,
     version: {commit: 'unknown', buildDate: 'unknown', version: 'unknown'},
     oidc: false,
+    oidcIdpName: 'OIDC',
     ...window.config,
 };