Resolution to GB Authentication issue (#128)

* first draft integtration

* Add translation for refresh token

* fix restart issue

* Add Firefox JWT capture example image

* Add configuration details for GB 

For GB a JWT token is needed

README.md

@@ -58,12 +58,13 @@ A media player component for Home Assistant that controls each LG Horizon Settop
 
 ### Parameters
 
-| Parameter  | Required              | Description                         |
-| ---------- | --------------------- | ----------------------------------- |
-| Username   | yes                   | Your provider username              |
-| Password   | yes                   | Your provider password              |
-| Provider   | yes (default 'Ziggo') | Your Provider                       |
-| Identifier | no (only for Telenet) | Your account identifier (see below) |
+| Parameter     | Required              | Description                         |
+| ------------  | --------------------- | ----------------------------------- |
+| Username      | yes                   | Your provider username              |
+| Password      | yes                   | Your provider password              |
+| Provider      | yes (default 'Ziggo') | Your Provider                       |
+| Identifier    | no (only for Telenet) | Your account identifier (see below) |
+| Refresh Token | no (only for GB)      | A JWT Token (see below)             |
 
 ## Configuration Telenet multiple accounts
 
@@ -78,6 +79,27 @@ After entering your credentials an account selection screen will popup:
   ![Identifier code](/images/Telenet%20code.png)
 - Use that code in the config of your telenet account in HA
 
+## Configuration for Virgin GB
+For the Virgin GB integration the Password is not used, instead, you need JWT token.   
+To get the JWT token you need to download a plugin and then login to your Virgin Box from a web browser as follows.
+
+1.  Download a Plug to get access to the tokens:
+
+- For Firefox use [JWT Debugger](https://addons.mozilla.org/en-GB/firefox/addon/jwtio-debugger/)
+- For Chrome use [JWT Inspector](https://chromewebstore.google.com/detail/jwt-inspector/jgjihoodklabhdoeffdjofnknfijolgk?hl=en&pli=1)
+- For Edge use [JwtToken](https://microsoftedge.microsoft.com/addons/detail/jwttoken/hbppejkakghldbgjeblinppeindhpeoh?hl=en-us)
+
+2. Login to your Virgin box using the web browser 
+[https://virgintvgo.virginmedia.com/](https://virgintvgo.virginmedia.com/)
+
+3. Open the JWT extension and copy the JWT token.
+Firefox example:
+![account selection](/images/GB%20Firefox%20JWT.png)
+(you need the bit starting `eyJ0...` - make sure you get all of it - its quite long.
+_NOTE: Keep this token secure/treat as a password - it gives full access to your virgin box._
+
+4.  Paste the JWT token into the Refresh Token parameter
+
 ## Service to change channel
 
 ```yaml

custom_components/lghorizon/__init__.py

@@ -10,6 +10,7 @@
 from .const import (
     DOMAIN,
     CONF_COUNTRY_CODE,
+    CONF_REFRESH_TOKEN,
     API,
     COUNTRY_CODES,
     CONF_IDENTIFIER
@@ -27,7 +28,8 @@
                 vol.Optional(CONF_COUNTRY_CODE, default="nl"): cv.string,
                 vol.Required(CONF_USERNAME): cv.string,
                 vol.Required(CONF_PASSWORD): cv.string,
-                vol.Optional(CONF_IDENTIFIER):cv.string
+                vol.Optional(CONF_IDENTIFIER):cv.string,
+                vol.Optional(CONF_REFRESH_TOKEN):cv.string
             }
         )
     },
@@ -40,12 +42,17 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     telenet_identifier = None
     if CONF_IDENTIFIER in entry.data:
         telenet_identifier = entry.data[CONF_IDENTIFIER]
+
+    refresh_token = None
+    if CONF_REFRESH_TOKEN in entry.data:
+       refresh_token = entry.data[CONF_REFRESH_TOKEN]
 
     api = LGHorizonApi(
         entry.data[CONF_USERNAME],
         entry.data[CONF_PASSWORD],
         COUNTRY_CODES[entry.data[CONF_COUNTRY_CODE]],
-        telenet_identifier
+        telenet_identifier,
+        refresh_token,
     )
     await hass.async_add_executor_job(api.connect)
     hass.data.setdefault(DOMAIN, {})
@@ -55,6 +62,12 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     }
     await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
 
+    if CONF_REFRESH_TOKEN in entry.data:
+        _LOGGER.info("New JWT stored: %s", api.refresh_token)
+        new_data = {**entry.data}
+        new_data[CONF_REFRESH_TOKEN] = api.refresh_token
+        hass.config_entries.async_update_entry(entry, data=new_data)
+
     return True
 
 

custom_components/lghorizon/config_flow.py

@@ -13,7 +13,7 @@
 from homeassistant.const import CONF_USERNAME, CONF_PASSWORD
 import homeassistant.helpers.config_validation as cv
 
-from .const import DOMAIN, CONF_COUNTRY_CODE, COUNTRY_CODES, CONF_IDENTIFIER
+from .const import DOMAIN, CONF_COUNTRY_CODE, CONF_REFRESH_TOKEN, COUNTRY_CODES, CONF_IDENTIFIER
 from lghorizon import (
     LGHorizonApi,
     LGHorizonApiUnauthorizedError,
@@ -29,8 +29,8 @@
         ),
         vol.Required(CONF_USERNAME): cv.string,
         vol.Required(CONF_PASSWORD): cv.string,
-        vol.Optional(CONF_IDENTIFIER):cv.string
-
+        vol.Optional(CONF_IDENTIFIER):cv.string,
+        vol.Optional(CONF_REFRESH_TOKEN):cv.string
     }
 )
 
@@ -42,11 +42,17 @@ async def validate_input(hass: HomeAssistant, data: dict[str, Any]) -> dict[str,
         telenet_identifier = None
         if CONF_IDENTIFIER in data:
             telenet_identifier = data[CONF_IDENTIFIER]
+
+        refresh_token = None
+        if CONF_REFRESH_TOKEN in data:
+            refresh_token = data[CONF_REFRESH_TOKEN]
+
         api = LGHorizonApi(
             data[CONF_USERNAME],
             data[CONF_PASSWORD],
             COUNTRY_CODES[data[CONF_COUNTRY_CODE]],
             telenet_identifier,
+            refresh_token,
         )
         await hass.async_add_executor_job(api.connect)
         await hass.async_add_executor_job(api.disconnect)

custom_components/lghorizon/const.py

@@ -3,6 +3,7 @@
 DOMAIN = "lghorizon"
 API = "lghorizon_api"
 CONF_COUNTRY_CODE = "country_code"
+CONF_REFRESH_TOKEN = "refresh_token"
 CONF_REMOTE_KEY = "remote_key"
 CONF_IDENTIFIER = "identifier"
 

custom_components/lghorizon/translations/en.json

@@ -9,7 +9,8 @@
           "username": "Username",
           "password": "Password",
           "country_code": "Provider",
-          "identifier": "DTV identifier"
+          "identifier": "DTV identifier",
+          "refresh_token": "Refresh Token (GB)"
         }
       }
     },
@@ -68,4 +69,4 @@
       }
     }
   }
-}
+}

custom_components/lghorizon/translations/nl.json

@@ -9,7 +9,8 @@
           "username": "Gebruikersnaam",
           "password": "Wachtwoord",
           "country_code": "Provider",
-          "identifier": "DTV identifier"
+          "identifier": "DTV identifier",
+          "refresh_token": "Refresh Token (GB)"
         }
       }
     },