feat: add option to configure button text on login screen

Author: cavefire

README.md

@@ -36,6 +36,7 @@ Note the client id and client secret as you will need it setting up this integra
      username_field: "preferred_username"  # Adjust based on your IdP's user info response
      scope: "openid profile email"
      block_login: false
+     openid_text: "Login with OpenID / OAuth2"  # Text to display on the login page
    ```
 2. Replace the placeholders (`YOUR_CLIENT_ID`, `YOUR_CLIENT_SECRET`, etc.) with the details provided by your Identity Provider.
 3. Restart Home Assistant.

custom_components/openid/__init__.py

@@ -22,6 +22,7 @@
     CONF_BLOCK_LOGIN,
     CONF_CONFIGURE_URL,
     CONF_CREATE_USER,
+    CONF_OPENID_TEXT,
     CONF_SCOPE,
     CONF_TOKEN_URL,
     CONF_USER_INFO_URL,
@@ -49,6 +50,9 @@
                 ): cv.string,
                 vol.Optional(CONF_CREATE_USER, default=False): cv.boolean,
                 vol.Optional(CONF_BLOCK_LOGIN, default=False): cv.boolean,
+                vol.Optional(
+                    CONF_OPENID_TEXT, default="OpenID / OAuth2 Authentication"
+                ): cv.string,
             }
         )
     },
@@ -101,8 +105,8 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
     # Patch /auth/authorize to inject our JS file.
     override_authorize_route(hass)
 
-    if hass.data[DOMAIN].get(CONF_BLOCK_LOGIN, False):
-        override_authorize_login_flow(hass)
+    # Patch the login flow to include additional OpenID data.
+    override_authorize_login_flow(hass)
 
     return True
 

custom_components/openid/authorize.js

@@ -19,13 +19,15 @@ window.fetch = async (...args) => {
     return response;
   }
 
+  const openIdText = responseBody.openid_text;
+
   const authFlow = document.getElementsByClassName('card-content')[0];
 
   const listNode = document.createElement('ha-list');
   const listItemNode = document.createElement('ha-list-item');
   listItemNode.setAttribute('hasmeta', '');
   listItemNode.setAttribute('mwc-list-item', '');
-  listItemNode.innerHTML = 'OpenID / OAuth2 Authentication <ha-icon-next slot="meta"></ha-icon-next>';
+  listItemNode.innerHTML = `${openIdText} <ha-icon-next slot="meta"></ha-icon-next>`;
   listItemNode.onclick = redirect_openid_login;
 
   listNode.appendChild(listItemNode);

custom_components/openid/const.py

@@ -15,3 +15,4 @@
 CONF_CREATE_USER = "create_user"
 CONF_BLOCK_LOGIN = "block_login"
 CONF_USE_HEADER_AUTH = "use_header_auth"
+CONF_OPENID_TEXT = "openid_text"

custom_components/openid/http_helper.py

@@ -8,27 +8,36 @@
 
 from homeassistant.core import HomeAssistant
 
-from .const import CONF_BLOCK_LOGIN, DOMAIN
+from .const import CONF_BLOCK_LOGIN, CONF_OPENID_TEXT, DOMAIN
 
 _LOGGER = logging.getLogger(__name__)
 
 
 def override_authorize_login_flow(hass: HomeAssistant) -> None:
     """Patch the build-in /auth/login_flow page to not return any actual login data."""
 
-    async def get(request: Request) -> Response:
-        content = {
-            "type": "form",
-            "flow_id": None,
-            "handler": [None],
-            "data_schema": [],
-            "errors": {},
-            "description_placeholders": None,
-            "last_step": None,
-            "preview": None,
-            "step_id": "init",
-            "block_login": hass.data[DOMAIN].get(CONF_BLOCK_LOGIN, False),
-        }
+    _original_post_function = None
+
+    async def post(request: Request) -> Response:
+        if not hass.data[DOMAIN].get(CONF_BLOCK_LOGIN, False):
+            content = json.loads((await _original_post_function(request)).text)
+        else:
+            content = {
+                "type": "form",
+                "flow_id": None,
+                "handler": [None],
+                "data_schema": [],
+                "errors": {},
+                "description_placeholders": None,
+                "last_step": None,
+                "preview": None,
+                "step_id": "init",
+            }
+
+        content[CONF_BLOCK_LOGIN] = hass.data[DOMAIN].get(CONF_BLOCK_LOGIN, False)
+        content[CONF_OPENID_TEXT] = hass.data[DOMAIN].get(
+            CONF_OPENID_TEXT, "OpenID / OAuth2 Authentication"
+        )
 
         return Response(
             status=HTTPStatus.OK,
@@ -39,11 +48,12 @@ async def get(request: Request) -> Response:
     # Swap out the existing GET handler on /auth/authorize
     for resource in hass.http.app.router._resources:  # noqa: SLF001
         if getattr(resource, "canonical", None) == "/auth/login_flow":
-            get_handler = resource._routes.get("GET")  # noqa: SLF001
+            post_handler = resource._routes.get("POST")  # noqa: SLF001
             # Replace the underlying coroutine fn.
-            get_handler._handler = get  # noqa: SLF001
+            _original_post_function = post_handler._handler  # noqa: SLF001
+            post_handler._handler = post  # noqa: SLF001
             # Reset the routes map to ensure only our GET exists.
-            resource._routes = {"GET": get_handler, "POST": get_handler}  # noqa: SLF001
+            resource._routes = {"POST": post_handler}  # noqa: SLF001
             _LOGGER.debug("Overrode /auth/login_flow route")
             break