Merge pull request #1022 from DerDummePunkt/github_991_ux_improvments_configurable_oidc_login_button_text

#991 ux improvements: OIDC Login Label

Author: jmattheis

config/config.go

@@ -68,6 +68,7 @@ type OIDC struct {
 	AutoRegister   bool
 	LinkByUsername bool
 	Scopes         []string
+	IDPName        string
 }
 
 type Configuration struct {
@@ -117,6 +118,7 @@ func Get() (*Configuration, []FutureLog) {
 			UsernameClaim: "preferred_username",
 			AutoRegister:  true,
 			Scopes:        []string{"openid", "profile", "email"},
+			IDPName:       "OIDC",
 		},
 	}
 
@@ -180,6 +182,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

@@ -22,6 +22,7 @@ func TestConfigEnv(t *testing.T) {
 	t.Setenv("GOTIFY_SERVER_CORS_ALLOWMETHODS", "GET,POST")
 	t.Setenv("GOTIFY_SERVER_CORS_ALLOWHEADERS", "Authorization,content-type")
 	t.Setenv("GOTIFY_SERVER_STREAM_ALLOWEDORIGINS", ".+.example.com,otherdomain.com")
+	t.Setenv("GOTIFY_OIDC_IDP_NAME", "Company XYZ SSO")
 
 	conf, _ := Get()
 	assert.Equal(t, 80, conf.Server.Port, "should use defaults")
@@ -33,6 +34,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 TestLocalAuthDisabled(t *testing.T) {

config/keys.go

@@ -42,5 +42,6 @@ const (
 	EnvOIDCLinkByUsername               = "GOTIFY_OIDC_LINK_BY_USERNAME"
 	EnvLocalAuthEnabled                 = "GOTIFY_LOCALAUTH_ENABLED"
 	EnvOIDCScopes                       = "GOTIFY_OIDC_SCOPES"
+	EnvOIDCIDPName                      = "GOTIFY_OIDC_IDP_NAME"
 	EnvNoColor                          = "NOCOLOR"
 )

docs/spec.json

@@ -2947,7 +2947,8 @@
         "version",
         "register",
         "localAuth",
-        "oidc"
+        "oidc",
+        "oidcIdpName"
       ],
       "properties": {
         "localAuth": {
@@ -2962,6 +2963,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

@@ -228,6 +228,11 @@
 # Type: boolean
 # GOTIFY_LOCALAUTH_ENABLED=true
 
+# Name of the OIDC identity provider displayed in UI.
+# Type: text
+# Example: Authelia
+# 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

@@ -24,4 +24,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

@@ -120,7 +120,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.LocalAuthEnabled, conf.OIDC.Enabled)
+	ui.Register(g, *vInfo, conf.Registration, conf.LocalAuthEnabled, conf.OIDC.Enabled, conf.OIDC.IDPName)
 
 	if conf.OIDC.Enabled {
 		oidcHandler := api.NewOIDC(conf, db, userChangeNotifier)
@@ -191,7 +191,13 @@ 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, LocalAuth: conf.LocalAuthEnabled})
+		ctx.JSON(200, &model.GotifyInfo{
+			Version:     vInfo.Version,
+			Oidc:        conf.OIDC.Enabled,
+			Register:    conf.Registration,
+			LocalAuth:   conf.LocalAuthEnabled,
+			OIDCIDPName: conf.OIDC.IDPName,
+		})
 	})
 
 	g.Group("/").Use(authentication.RequireApplicationOrClient).POST("/message", messageHandler.CreateMessage)

router/router_test.go

@@ -42,7 +42,11 @@ func (s *IntegrationSuite) BeforeTest(string, string) {
 	g, closable := Create(
 		s.db.GormDatabase,
 		&model.VersionInfo{Version: "1.0.0", BuildDate: "2018-02-20-17:30:47", Commit: "asdasds"},
-		&config.Configuration{PassStrength: 5, LocalAuthEnabled: true},
+		&config.Configuration{
+			PassStrength:     5,
+			LocalAuthEnabled: true,
+			OIDC:             config.OIDC{IDPName: "Company XYZ SSO"},
+		},
 	)
 	s.closable = closable
 	s.server = httptest.NewServer(g)
@@ -60,6 +64,12 @@ func (s *IntegrationSuite) TestVersionInfo() {
 	doRequestAndExpect(s.T(), req, 200, `{"version":"1.0.0", "commit":"asdasds", "buildDate":"2018-02-20-17:30:47"}`)
 }
 
+func (s *IntegrationSuite) TestGotifyInfo() {
+	req := s.newRequest("GET", "gotifyinfo", "")
+
+	doRequestAndExpect(s.T(), req, 200, `{"version":"1.0.0", "oidc":false, "register":false, "localAuth":true, "oidcIdpName":"Company XYZ SSO"}`)
+}
+
 func (s *IntegrationSuite) TestHeaderInProd() {
 	mode.Set(mode.Prod)
 	req := s.newRequest("GET", "version", "")

ui/serve.go

@@ -16,19 +16,28 @@ import (
 var box embed.FS
 
 type uiConfig struct {
-	Register  bool              `json:"register"`
-	Version   model.VersionInfo `json:"version"`
-	LocalAuth bool              `json:"localAuth"`
-	OIDC      bool              `json:"oidc"`
+	Register    bool              `json:"register"`
+	Version     model.VersionInfo `json:"version"`
+	LocalAuth   bool              `json:"localAuth"`
+	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, localAuthEnabled, oidcEnabled bool) {
+func Register(
+	r *gin.Engine,
+	version model.VersionInfo,
+	register bool,
+	localAuthEnabled bool,
+	oidcEnabled bool,
+	oidcIDPName string,
+) {
 	uiConfigBytes, err := json.Marshal(uiConfig{
-		Version:   version,
-		Register:  register,
-		LocalAuth: localAuthEnabled,
-		OIDC:      oidcEnabled,
+		Version:     version,
+		Register:    register,
+		LocalAuth:   localAuthEnabled,
+		OIDC:        oidcEnabled,
+		OIDCIDPName: oidcIDPName,
 	})
 	if err != nil {
 		panic(err)

ui/src/ElevateStore.ts

@@ -82,7 +82,7 @@ export class ElevateStore {
         }
 
         if (!this.elevated) {
-            this.snack('OIDC elevation was not completed.');
+            this.snack(`${config.get('oidcIdpName')} elevation was not completed.`);
         }
         this.cleanupOidcElevate();
     };