Add HMAC capabilities (#152)

This adds HMAC capabilities by allowing to provide a signature secret.
Additionally removes the old way of adding the API key to the metadata.

Author: florian-wagner-frequenz

RELEASE_NOTES.md

@@ -8,6 +8,7 @@
 
 - Updated to `v0.8.0` of the Electricity Trading API.
 - Updated to `v0.11.0` of the base client library.
+- Added HMAC capabilities
 
 ## Bug Fixes
 

src/frequenz/client/electricity_trading/_client.py

@@ -161,10 +161,14 @@ def dt_to_pb_timestamp_utc(dt: datetime) -> Timestamp:
 class Client(BaseApiClient[ElectricityTradingServiceStub]):
     """Electricity trading client."""
 
-    _instances: dict[tuple[str, str | None], "Client"] = {}
+    _instances: dict[tuple[str, str | None, str | None], "Client"] = {}
 
     def __new__(
-        cls, server_url: str, connect: bool = True, auth_key: str | None = None
+        cls,
+        server_url: str,
+        connect: bool = True,
+        auth_key: str | None = None,
+        sign_secret: str | None = None,
     ) -> "Client":
         """
         Create a new instance of the client or return an existing one if it already exists.
@@ -173,11 +177,12 @@ def __new__(
             server_url: The URL of the Electricity Trading service.
             connect: Whether to connect to the server immediately.
             auth_key: The API key for the authorization.
+            sign_secret: The cryptographic secret to use for HMAC generation.
 
         Returns:
             The client instance.
         """
-        key = (server_url, auth_key)
+        key = (server_url, auth_key, sign_secret)
 
         # Check if an instance already exists for this key
         if key not in cls._instances:
@@ -188,14 +193,19 @@ def __new__(
         return cls._instances[key]
 
     def __init__(
-        self, server_url: str, connect: bool = True, auth_key: str | None = None
+        self,
+        server_url: str,
+        connect: bool = True,
+        auth_key: str | None = None,
+        sign_secret: str | None = None,
     ) -> None:
         """Initialize the client.
 
         Args:
             server_url: The URL of the Electricity Trading service.
             connect: Whether to connect to the server immediately.
             auth_key: The API key for the authorization.
+            sign_secret: The cryptographic secret to use for HMAC generation.
         """
         if not hasattr(
             self, "_initialized"
@@ -204,6 +214,8 @@ def __init__(
                 server_url,
                 connect=connect,
                 create_stub=ElectricityTradingServiceStub,
+                auth_key=auth_key,
+                sign_secret=sign_secret,
             )
             self._initialized = True
 
@@ -236,8 +248,6 @@ def __init__(
             ],
         ] = {}
 
-        self._metadata = (("key", auth_key),) if auth_key else ()
-
     @property
     def stub(self) -> electricity_trading_pb2_grpc.ElectricityTradingServiceAsyncStub:
         """
@@ -311,7 +321,6 @@ def gridpool_orders_stream(
                             gridpool_id=gridpool_id,
                             filter=gridpool_order_filter.to_pb(),
                         ),
-                        metadata=self._metadata,
                     ),
                     lambda response: OrderDetail.from_pb(response.order_detail),
                 )
@@ -376,7 +385,6 @@ def gridpool_trades_stream(
                             gridpool_id=gridpool_id,
                             filter=gridpool_trade_filter.to_pb(),
                         ),
-                        metadata=self._metadata,
                     ),
                     lambda response: Trade.from_pb(response.trade),
                 )
@@ -549,7 +557,6 @@ async def create_gridpool_order(
                     electricity_trading_pb2.CreateGridpoolOrderRequest(
                         gridpool_id=gridpool_id, order=order.to_pb()
                     ),
-                    metadata=self._metadata,
                     timeout=timeout,
                 ),
             )
@@ -666,7 +673,6 @@ async def update_gridpool_order(
                         update_order_fields=update_order_fields.to_pb(),
                         update_mask=update_mask,
                     ),
-                    metadata=self._metadata,
                     timeout=timeout,
                 ),
             )
@@ -705,7 +711,6 @@ async def cancel_gridpool_order(
                     electricity_trading_pb2.CancelGridpoolOrderRequest(
                         gridpool_id=gridpool_id, order_id=order_id
                     ),
-                    metadata=self._metadata,
                     timeout=timeout,
                 ),
             )
@@ -741,7 +746,6 @@ async def cancel_all_gridpool_orders(
                     electricity_trading_pb2.CancelAllGridpoolOrdersRequest(
                         gridpool_id=gridpool_id
                     ),
-                    metadata=self._metadata,
                     timeout=timeout,
                 ),
             )
@@ -782,7 +786,6 @@ async def get_gridpool_order(
                     electricity_trading_pb2.GetGridpoolOrderRequest(
                         gridpool_id=gridpool_id, order_id=order_id
                     ),
-                    metadata=self._metadata,
                     timeout=timeout,
                 ),
             )
@@ -848,7 +851,6 @@ async def list_gridpool_orders(
                     grpc_call_with_timeout(
                         self.stub.ListGridpoolOrders,
                         request,
-                        metadata=self._metadata,
                         timeout=timeout,
                     ),
                 )
@@ -926,7 +928,6 @@ async def list_gridpool_trades(
                     grpc_call_with_timeout(
                         self.stub.ListGridpoolTrades,
                         request,
-                        metadata=self._metadata,
                         timeout=timeout,
                     ),
                 )
@@ -1010,7 +1011,6 @@ def dt_to_pb_timestamp(dt: datetime) -> Timestamp:
                                     dt_to_pb_timestamp(end_time) if end_time else None
                                 ),
                             ),
-                            metadata=self._metadata,
                         ),
                         lambda response: PublicTrade.from_pb(response.public_trade),
                     )
@@ -1071,7 +1071,6 @@ def receive_public_order_book(
                                 start_time=start_time_utc,
                                 end_time=end_time_utc,
                             ),
-                            metadata=self._metadata,
                         ),
                         lambda response: [
                             PublicOrder.from_pb(public_order)

src/frequenz/client/electricity_trading/cli/__main__.py

@@ -46,59 +46,100 @@ def cli() -> None:
 
 @cli.command()
 @click.option("--url", required=True, type=str)
-@click.option("--key", required=True, type=str)
+@click.option("--auth_key", required=True, type=str)
 @click.option("--delivery-start", default=None, type=iso)
 @click.option("--start", default=None, type=iso)
 @click.option("--end", default=None, type=iso)
-def receive_public_trades(
-    url: str, key: str, *, start: datetime, end: datetime, delivery_start: datetime
+@click.option("--sign_secret", default=None, type=str)
+def receive_public_trades(  # pylint: disable=too-many-arguments
+    url: str,
+    auth_key: str,
+    *,
+    start: datetime,
+    end: datetime,
+    delivery_start: datetime,
+    sign_secret: str | None = None,
 ) -> None:
     """List and/or stream public trades."""
     asyncio.run(
         run_receive_public_trades(
-            url=url, key=key, delivery_start=delivery_start, start=start, end=end
+            url=url,
+            auth_key=auth_key,
+            delivery_start=delivery_start,
+            start=start,
+            end=end,
+            sign_secret=sign_secret,
         )
     )
 
 
 @cli.command()
 @click.option("--url", required=True, type=str)
-@click.option("--key", required=True, type=str)
+@click.option("--auth_key", required=True, type=str)
 @click.option("--gid", required=True, type=int)
 @click.option("--start", default=None, type=iso)
-def receive_gridpool_trades(url: str, key: str, gid: int, *, start: datetime) -> None:
+@click.option("--sign_secret", default=None, type=str)
+def receive_gridpool_trades(
+    url: str,
+    auth_key: str,
+    gid: int,
+    *,
+    start: datetime,
+    sign_secret: str | None = None,
+) -> None:
     """List and/or stream gridpool trades."""
     asyncio.run(
-        run_list_gridpool_trades(url=url, key=key, gid=gid, delivery_start=start)
+        run_list_gridpool_trades(
+            url=url,
+            auth_key=auth_key,
+            gid=gid,
+            delivery_start=start,
+            sign_secret=sign_secret,
+        )
     )
 
 
 @cli.command()
 @click.option("--url", required=True, type=str)
-@click.option("--key", required=True, type=str)
+@click.option("--auth_key", required=True, type=str)
 @click.option("--start", default=None, type=iso)
 @click.option("--gid", required=True, type=int)
-def receive_gridpool_orders(url: str, key: str, *, start: datetime, gid: int) -> None:
+@click.option("--sign_secret", default=None, type=str)
+def receive_gridpool_orders(
+    url: str,
+    auth_key: str,
+    *,
+    start: datetime,
+    gid: int,
+    sign_secret: str | None = None,
+) -> None:
     """List and/or stream gridpool orders."""
     asyncio.run(
-        run_list_gridpool_orders(url=url, key=key, delivery_start=start, gid=gid)
+        run_list_gridpool_orders(
+            url=url,
+            auth_key=auth_key,
+            delivery_start=start,
+            gid=gid,
+            sign_secret=sign_secret,
+        )
     )
 
 
 @cli.command()
 @click.option("--url", required=True, type=str)
-@click.option("--key", required=True, type=str)
+@click.option("--auth_key", required=True, type=str)
 @click.option("--start", required=True, type=iso)
 @click.option("--gid", required=True, type=int)
 @click.option("--quantity", required=True, type=str)
 @click.option("--price", required=True, type=str)
 @click.option("--area", required=True, type=str)
 @click.option("--currency", default="EUR", type=str)
 @click.option("--duration", default=900, type=int)
+@click.option("--sign_secret", default=None, type=str)
 def create_order(
     # pylint: disable=too-many-arguments
     url: str,
-    key: str,
+    auth_key: str,
     *,
     start: datetime,
     gid: int,
@@ -107,6 +148,7 @@ def create_order(
     area: str,
     currency: str,
     duration: int,
+    sign_secret: str | None = None,
 ) -> None:
     """Create an order.
 
@@ -118,35 +160,58 @@ def create_order(
     asyncio.run(
         run_create_order(
             url=url,
-            key=key,
+            auth_key=auth_key,
             delivery_start=start,
             gid=gid,
             quantity_mw=quantity,
             price=price,
             delivery_area=area,
             currency=currency,
             duration=timedelta(seconds=duration),
+            sign_secret=sign_secret,
         )
     )
 
 
 @cli.command()
 @click.option("--url", required=True, type=str)
-@click.option("--key", required=True, type=str)
+@click.option("--auth_key", required=True, type=str)
 @click.option("--gid", required=True, type=int)
 @click.option("--order", required=True, type=int)
-def cancel_order(url: str, key: str, gid: int, order: int) -> None:
+@click.option("--sign_secret", default=None, type=str)
+def cancel_order(
+    url: str, auth_key: str, gid: int, order: int, sign_secret: str | None = None
+) -> None:
     """Cancel an order."""
-    asyncio.run(run_cancel_order(url=url, key=key, gridpool_id=gid, order_id=order))
+    asyncio.run(
+        run_cancel_order(
+            url=url,
+            auth_key=auth_key,
+            gridpool_id=gid,
+            order_id=order,
+            sign_secret=sign_secret,
+        )
+    )
 
 
 @cli.command()
 @click.option("--url", required=True, type=str)
-@click.option("--key", required=True, type=str)
+@click.option("--auth_key", required=True, type=str)
 @click.option("--gid", required=True, type=int)
-def cancel_all_orders(url: str, key: str, gid: int) -> None:
+@click.option("--sign_secret", default=None, type=str)
+def cancel_all_orders(
+    url: str, auth_key: str, gid: int, sign_secret: str | None = None
+) -> None:
     """Cancel all orders for a gridpool ID."""
-    asyncio.run(run_cancel_order(url=url, key=key, gridpool_id=gid, order_id=None))
+    asyncio.run(
+        run_cancel_order(
+            url=url,
+            auth_key=auth_key,
+            gridpool_id=gid,
+            order_id=None,
+            sign_secret=sign_secret,
+        )
+    )
 
 
 @cli.command()