Added a new auth_token property to AuthSession class (#350)

broHeryk · web-flow · commit 9a621bd66daa · 2025-01-17T19:41:18.000+01:00
* add auth session property

added tests

fixed names

remove formating noise

remove formating from test

* update packages

* bump python version to 3.9

* adjust versions

* fix plugin for poetry
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -11,7 +11,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: [ '3.8', '3.10' ]
+        python-version: [ '3.9', '3.10' ]
         os: [ ubuntu-latest, macos-latest, windows-latest ]
         include:
           - os: ubuntu-latest
diff --git a/.github/workflows/cve-scanning-python.yml b/.github/workflows/cve-scanning-python.yml
@@ -23,7 +23,7 @@ jobs:
           python-version: "3.10"
       - uses: abatilo/actions-poetry@192395c0d10c082a7c62294ab5d9a9de40e48974
         with:
-          poetry-version: "1.2.2"
+          poetry-version: "2.0.0"
       - name: Install safety
         run: pip3 install safety
       - name: Build app
diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml
@@ -24,11 +24,11 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Set up Python 3.8
+      - name: Set up Python 3.9
         id: setup-python
         uses: actions/setup-python@v4
         with:
-          python-version: 3.8
+          python-version: 3.9
 
       - name: Copy main branch into gh-pages
         run: |
diff --git a/.github/workflows/pylint.yaml b/.github/workflows/pylint.yaml
@@ -15,11 +15,11 @@ jobs:
       - name: Checkout Code
         uses: actions/checkout@v4
 
-      - name: Set up Python 3.8
+      - name: Set up Python 3.9
         id: setup-python
         uses: actions/setup-python@v4
         with:
-          python-version: 3.8
+          python-version: 3.9
 
       - name: Get pip cache dir
         id: pip-cache
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -13,10 +13,10 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Python 3.8
+      - name: Set up Python 3.9
         uses: actions/setup-python@v4
         with:
-          python-version: 3.8
+          python-version: 3.9
 
       - name: Install Poetry
         run: pip install poetry
diff --git a/.github/workflows/security.yml b/.github/workflows/security.yml
@@ -15,11 +15,11 @@ jobs:
       - name: Checkout Code
         uses: actions/checkout@v4
 
-      - name: Set up Python 3.8
+      - name: Set up Python 3.9
         id: setup-python
         uses: actions/setup-python@v4
         with:
-          python-version: 3.8
+          python-version: 3.9
 
       - name: Get pip cache dir
         id: pip-cache
diff --git a/examples/authentication/auth.py b/examples/authentication/auth.py
@@ -12,6 +12,7 @@ async def run():
         auth_session = bdk.bot_session()
         logging.info(await auth_session.key_manager_token)
         logging.info(await auth_session.session_token)
+        logging.info(await auth_session.auth_token)
         logging.info("Obo example:")
         obo_auth_session = bdk.obo(username="username")
         logging.info(await obo_auth_session.session_token)
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -12,13 +12,13 @@ packages = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.8"
+python = "^3.9"
 nulltype = "^2.3.1"
 python-dateutil = "^2.8.2"
 urllib3 = "^1.26.19"
 aiohttp = "^3.10.2"
 pyyaml = "^6.0"
-PyJWT = "^2.3.0"
+PyJWT = "^2.10.0"
 cryptography = "^43.0.1"
 tenacity = "^8.0.1"
 defusedxml = "^0.7.1"
@@ -37,6 +37,9 @@ safety = "^2.2.0"
 liccheck = "^0.6.2"
 coverage = {version = "^6.0b1", extras = ["toml"]}
 
+[tool.poetry.requires-plugins]
+poetry-plugin-export = ">=1.8"
+
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
diff --git a/symphony/bdk/core/auth/auth_session.py b/symphony/bdk/core/auth/auth_session.py
@@ -1,12 +1,15 @@
 """Module containing session handle classes.
 
 """
+from datetime import datetime, timezone
 import logging
 
 from symphony.bdk.core.auth.exception import AuthInitializationError
 
 logger = logging.getLogger(__name__)
 
+EXPIRATION_SAFETY_BUFFER_SECONDS = 5
+
 
 class AuthSession:
     """RSA Authentication session handle to get session and key manager tokens from.
@@ -21,7 +24,9 @@ def __init__(self, authenticator):
         """
         self._session_token = None
         self._key_manager_token = None
+        self._auth_token = None
         self._authenticator = authenticator
+        self._expire_at = -1
 
     async def refresh(self):
         """Trigger re-authentication to refresh the tokens.
@@ -40,6 +45,26 @@ async def session_token(self):
             self._session_token = await self._authenticator.retrieve_session_token()
         return self._session_token
 
+    @property
+    async def auth_token(self):
+        """Auth token request calls the same endpoint that session token.
+        Therefore, session token is updated unintentionally,
+         since there's no explicit way to update authorization token exclusively
+         : return: (str) authorization_token like Bearer eyJh...
+        """
+
+        if (
+            self._auth_token
+            and self._expire_at
+            > datetime.now(timezone.utc).timestamp() + EXPIRATION_SAFETY_BUFFER_SECONDS
+        ):
+            return self._auth_token
+        token, expire_at = await self._authenticator.retrieve_session_token_object()
+        self._expire_at = expire_at
+        self._auth_token = token.authorization_token
+        self._session_token = token.token
+        return self._auth_token
+
     @property
     async def key_manager_token(self):
         """
diff --git a/symphony/bdk/core/auth/bot_authenticator.py b/symphony/bdk/core/auth/bot_authenticator.py
@@ -1,8 +1,9 @@
 """Module containing BotAuthenticator classes.
 """
+from typing import Optional, Tuple
 from abc import ABC, abstractmethod
 
-from symphony.bdk.core.auth.jwt_helper import create_signed_jwt
+from symphony.bdk.core.auth.jwt_helper import create_signed_jwt, generate_expiration_time
 from symphony.bdk.core.config.model.bdk_bot_config import BdkBotConfig
 from symphony.bdk.core.config.model.bdk_retry_config import BdkRetryConfig
 from symphony.bdk.core.retry import retry
@@ -11,6 +12,7 @@
 from symphony.bdk.gen.auth_api.certificate_authentication_api import CertificateAuthenticationApi
 from symphony.bdk.gen.login_api.authentication_api import AuthenticationApi
 from symphony.bdk.gen.login_model.authenticate_request import AuthenticateRequest
+from symphony.bdk.gen.login_model.token import Token
 
 
 class BotAuthenticator(ABC):
@@ -30,6 +32,17 @@ async def retrieve_session_token(self) -> str:
         """
         return await self._authenticate_and_get_token(self._session_auth_client)
 
+    async def retrieve_session_token_object(self) -> Tuple[Token, int]:
+        """Authenticates and retrieves a new auth token.
+
+        :return: retrieved token object + expiration date.
+        """
+        expire_at = generate_expiration_time()
+        token = await self._authenticate_and_get_token_object(
+            self._session_auth_client, expire_at
+        )
+        return token, expire_at
+
     async def retrieve_key_manager_token(self) -> str:
         """Authenticated and retrieved a new key manager session.
 
@@ -58,11 +71,21 @@ def __init__(self, bot_config: BdkBotConfig, login_api_client: ApiClient, relay_
 
     @retry(retry=authentication_retry)
     async def _authenticate_and_get_token(self, api_client: ApiClient) -> str:
-        jwt = create_signed_jwt(self._bot_config.private_key, self._bot_config.username)
-        req = AuthenticateRequest(token=jwt)
+        token_object = await self._authenticate_and_get_token_object(api_client)
+        return token_object.token
 
-        token = await AuthenticationApi(api_client).pubkey_authenticate_post(req)
-        return token.token
+    @retry(retry=authentication_retry)
+    async def _authenticate_and_get_token_object(
+        self, api_client: ApiClient, expire_at: Optional[int] = None
+    ) -> Token:
+        """Calls pubkey auth endpoint with signed jwt token.
+        :return: token object which might contain a few tokens inside
+        """
+        jwt = create_signed_jwt(
+            self._bot_config.private_key, self._bot_config.username, expire_at
+        )
+        req = AuthenticateRequest(token=jwt)
+        return await AuthenticationApi(api_client).pubkey_authenticate_post(req)
 
 
 class BotAuthenticatorCert(BotAuthenticator):
diff --git a/symphony/bdk/core/auth/jwt_helper.py b/symphony/bdk/core/auth/jwt_helper.py
@@ -61,6 +61,16 @@ def validate_jwt(jwt_token: str, certificate: str, allowed_audience: str) -> dic
         raise AuthInitializationError("Unable to validate the jwt") from exc
 
 
+def generate_expiration_time() -> int:
+    """Generates integer timestamp value for jwt token
+    :return: timestamp value
+    """
+    return int(
+        datetime.datetime.now(datetime.timezone.utc).timestamp()
+        + DEFAULT_EXPIRATION_SECONDS
+    )
+
+
 def _parse_public_key_from_x509_cert(certificate: str) -> str:
     """Returns the public key in PEM format given a X509 certificate content in PEM format
 
diff --git a/tests/core/auth/auth_session_test.py b/tests/core/auth/auth_session_test.py
@@ -1,9 +1,12 @@
+from datetime import datetime, timezone
+
 from unittest.mock import AsyncMock
 
 import pytest
 
 from symphony.bdk.core.auth.auth_session import AuthSession, OboAuthSession, AppAuthSession
 from symphony.bdk.core.auth.exception import AuthInitializationError
+from symphony.bdk.gen.login_model.token import Token
 from symphony.bdk.gen.login_model.extension_app_tokens import ExtensionAppTokens
 
 
@@ -19,6 +22,38 @@ async def test_refresh():
     assert await auth_session.key_manager_token == "km_token"
 
 
+@pytest.mark.asyncio
+async def test_auth_token():
+    mock_bot_authenticator = AsyncMock()
+    expired_ts, fresh_ts, = (
+        datetime.now(timezone.utc).timestamp(),
+        datetime.now(timezone.utc).timestamp() + 500,
+    )
+    mock_bot_authenticator.retrieve_session_token_object.side_effect = [
+        (
+            Token(
+                authorization_token="initial_token",
+                token="session_tokeт",
+                name="sessionToken",
+            ),
+            expired_ts,
+        ),
+        (
+            Token(
+                authorization_token="updated_token",
+                token="session_token",
+                name="sessionToken",
+            ),
+            fresh_ts,
+        ),
+    ]
+    auth_session = AuthSession(mock_bot_authenticator)
+    assert await auth_session.auth_token == "initial_token"
+    assert await auth_session.auth_token == "updated_token"
+    assert await auth_session.auth_token == "updated_token"
+    assert mock_bot_authenticator.retrieve_session_token_object.call_count == 2
+
+
 @pytest.mark.asyncio
 async def test_refresh_obo():
     mock_obo_authenticator = AsyncMock()
diff --git a/tests/core/auth/bot_authenticator_rsa_test.py b/tests/core/auth/bot_authenticator_rsa_test.py
@@ -36,19 +36,21 @@ def fixture_config():
 
 @pytest.mark.asyncio
 async def test_bot_session_rsa(config, mocked_api_client):
-    with patch("symphony.bdk.core.auth.bot_authenticator.create_signed_jwt", return_value="privateKey"):
+    with patch("symphony.bdk.core.auth.bot_authenticator.create_signed_jwt", return_value="privateKey"), patch("symphony.bdk.core.auth.bot_authenticator.generate_expiration_time", return_value=100):
         login_api_client = mocked_api_client()
         relay_api_client = mocked_api_client()
 
-        login_api_client.call_api.return_value = Token(token="session_token")
+        login_api_client.call_api.return_value = Token(authorization_token="auth_token", token="session_token", name="sessionToken")
         relay_api_client.call_api.return_value = Token(token="km_token")
 
         bot_authenticator = BotAuthenticatorRsa(config, login_api_client, relay_api_client, minimal_retry_config())
         session_token = await bot_authenticator.retrieve_session_token()
         km_token = await bot_authenticator.retrieve_key_manager_token()
-
+        auth_token, expire_at = await bot_authenticator.retrieve_session_token_object()
         assert session_token == "session_token"
         assert km_token == "km_token"
+        assert auth_token == Token(authorization_token="auth_token", token="session_token", name="sessionToken")
+        assert expire_at == 100
 
 
 @pytest.mark.asyncio
