Add optional URL to branding

With this change, the branding configuration can optionally define an URL. The URL is available in the branding response and is used by the web client to add a clickable link to the logo of the login form.

Author: dragonchaser

bootstrap/backends/ldap/ldap.go

@@ -143,10 +143,11 @@ func NewIdentityManager(bs bootstrap.Bootstrap) (identity.Manager, error) {
 		AuthorizationEndpointURI: fullAuthorizationEndpointURL,
 		SignedOutEndpointURI:     fullSignedOutEndpointURL,
 
-		DefaultBannerLogo:       config.IdentifierDefaultBannerLogo,
-		DefaultSignInPageText:   config.IdentifierDefaultSignInPageText,
-		DefaultUsernameHintText: config.IdentifierDefaultUsernameHintText,
-		UILocales:               config.IdentifierUILocales,
+		DefaultBannerLogo:        config.IdentifierDefaultBannerLogo,
+		DefaultSignInPageText:    config.IdentifierDefaultSignInPageText,
+		DefaultSignInPageLogoURI: config.IdentifierDefaultLogoTargetURI,
+		DefaultUsernameHintText:  config.IdentifierDefaultUsernameHintText,
+		UILocales:                config.IdentifierUILocales,
 
 		Backend: identifierBackend,
 	})

bootstrap/backends/libregraph/libregraph.go

@@ -126,10 +126,11 @@ func NewIdentityManager(bs bootstrap.Bootstrap) (identity.Manager, error) {
 		AuthorizationEndpointURI: fullAuthorizationEndpointURL,
 		SignedOutEndpointURI:     fullSignedOutEndpointURL,
 
-		DefaultBannerLogo:       config.IdentifierDefaultBannerLogo,
-		DefaultSignInPageText:   config.IdentifierDefaultSignInPageText,
-		DefaultUsernameHintText: config.IdentifierDefaultUsernameHintText,
-		UILocales:               config.IdentifierUILocales,
+		DefaultBannerLogo:        config.IdentifierDefaultBannerLogo,
+		DefaultSignInPageText:    config.IdentifierDefaultSignInPageText,
+		DefaultSignInPageLogoURI: config.IdentifierDefaultLogoTargetURI,
+		DefaultUsernameHintText:  config.IdentifierDefaultUsernameHintText,
+		UILocales:                config.IdentifierUILocales,
 
 		Backend: identifierBackend,
 	})

bootstrap/bootstrap.go

@@ -260,6 +260,9 @@ func (bs *bootstrap) initialize(settings *Settings) error {
 	if settings.IdentifierDefaultSignInPageText != "" {
 		bs.config.IdentifierDefaultSignInPageText = &settings.IdentifierDefaultSignInPageText
 	}
+	if settings.IdentifierDefaultLogoTargetURI != "" {
+		bs.config.IdentifierDefaultLogoTargetURI = &settings.IdentifierDefaultLogoTargetURI
+	}
 	if settings.IdentifierDefaultUsernameHintText != "" {
 		bs.config.IdentifierDefaultUsernameHintText = &settings.IdentifierDefaultUsernameHintText
 	}

bootstrap/config.go

@@ -51,6 +51,7 @@ type Config struct {
 	IdentifierScopesConf              string
 	IdentifierDefaultBannerLogo       []byte
 	IdentifierDefaultSignInPageText   *string
+	IdentifierDefaultLogoTargetURI    *string
 	IdentifierDefaultUsernameHintText *string
 	IdentifierUILocales               []string
 

bootstrap/settings.go

@@ -44,6 +44,7 @@ type Settings struct {
 	IdentifierScopesConf              string
 	IdentifierDefaultBannerLogo       string
 	IdentifierDefaultSignInPageText   string
+	IdentifierDefaultLogoTargetURI    string
 	IdentifierDefaultUsernameHintText string
 	IdentifierUILocales               []string
 	SigningKid                        string

cmd/licod/serve.go

@@ -94,6 +94,7 @@ func commandServe() *cobra.Command {
 	serveCmd.Flags().StringVar(&cfg.IdentifierScopesConf, "identifier-scopes-conf", "", "Path to a scopes.yaml configuration file")
 	serveCmd.Flags().StringVar(&cfg.IdentifierDefaultBannerLogo, "identifier-default-banner-logo", "", "Path to a default banner logo that appears on sign-in page.")
 	serveCmd.Flags().StringVar(&cfg.IdentifierDefaultSignInPageText, "identifier-default-sign-in-page-text", "", "Default text that appears at the bottom of the sign-in box.")
+	serveCmd.Flags().StringVar(&cfg.IdentifierDefaultLogoTargetURI, "identifier-default-logo-target-url", "", "Default URL for the logo of the login page.")
 	serveCmd.Flags().StringVar(&cfg.IdentifierDefaultUsernameHintText, "identifier-default-username-hint-text", "", "Default string that shows as the hint in the username textbox on the sign-in screen.")
 	serveCmd.Flags().StringArrayVar(&cfg.IdentifierUILocales, "identifier-ui-locale", nil, "Enabled user interface locales (can be used multiple times, if not set all supported locales are enabled)")
 	serveCmd.Flags().BoolVar(&cfg.Insecure, "insecure", false, "Disable TLS certificate and hostname validation")

identifier/api.go

@@ -47,10 +47,11 @@ func (i Identifier) writeHelloResponse(rw http.ResponseWriter, req *http.Request
 	response := &HelloResponse{
 		State: r.State,
 		Branding: &meta.Branding{
-			BannerLogo:       i.defaultBannerLogo,
-			UsernameHintText: i.Config.DefaultUsernameHintText,
-			SignInPageText:   i.Config.DefaultSignInPageText,
-			Locales:          i.Config.UILocales,
+			BannerLogo:        i.defaultBannerLogo,
+			UsernameHintText:  i.Config.DefaultUsernameHintText,
+			SignInPageText:    i.Config.DefaultSignInPageText,
+			SignInPageLogoURI: i.Config.DefaultSignInPageLogoURI,
+			Locales:           i.Config.UILocales,
 		},
 	}
 

identifier/config.go

@@ -46,10 +46,11 @@ type Config struct {
 	AuthorizationEndpointURI *url.URL
 	SignedOutEndpointURI     *url.URL
 
-	DefaultBannerLogo       []byte
-	DefaultSignInPageText   *string
-	DefaultUsernameHintText *string
-	UILocales               []string
+	DefaultBannerLogo        []byte
+	DefaultSignInPageText    *string
+	DefaultSignInPageLogoURI *string
+	DefaultUsernameHintText  *string
+	UILocales                []string
 
 	Backend backends.Backend
 }

identifier/meta/branding.go

@@ -19,8 +19,9 @@ package meta
 
 // Branding is a container to hold identifier branding meta data.
 type Branding struct {
-	BannerLogo       *string  `json:"bannerLogo,omitempty"`
-	SignInPageText   *string  `json:"signinPageText,omitempty"`
-	UsernameHintText *string  `json:"usernameHintText,omitempty"`
-	Locales          []string `json:"locales,omitempty"`
+	BannerLogo        *string  `json:"bannerLogo,omitempty"`
+	SignInPageText    *string  `json:"signinPageText,omitempty"`
+	UsernameHintText  *string  `json:"usernameHintText,omitempty"`
+	SignInPageLogoURI *string  `json:"signinPageLogoURI,omitempty"`
+	Locales           []string `json:"locales,omitempty"`
 }

identifier/src/components/ResponsiveScreen.jsx

@@ -71,7 +71,17 @@ const ResponsiveScreen = (props) => {
         }}
       >
         <div className={classes.content}>
-          {logo}
+          {branding?.signinPageLogoURI ? (
+            <a
+              href={branding.signinPageLogoURI}
+              target="_blank"
+              rel="noopener noreferrer"
+            >
+              {logo}
+            </a>
+          ) : (
+            logo
+          )}
           {content}
         </div>
         {!loading && <DialogActions className={classes.actions} disableSpacing><LocaleSelect disableUnderline locales={branding?.locales}/></DialogActions>}