flwr 1.18.0__py3-none-any.whl → 1.20.0__py3-none-any.whl

flwr/client/grpc_rere_client/grpc_adapter.py

@@ -38,8 +38,6 @@ from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
     CreateNodeResponse,
     DeleteNodeRequest,
     DeleteNodeResponse,
-    PingRequest,
-    PingResponse,
     PullMessagesRequest,
     PullMessagesResponse,
     PushMessagesRequest,
@@ -47,6 +45,18 @@ from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
 )
 from flwr.proto.grpcadapter_pb2 import MessageContainer  # pylint: disable=E0611
 from flwr.proto.grpcadapter_pb2_grpc import GrpcAdapterStub
+from flwr.proto.heartbeat_pb2 import (  # pylint: disable=E0611
+    SendNodeHeartbeatRequest,
+    SendNodeHeartbeatResponse,
+)
+from flwr.proto.message_pb2 import (  # pylint: disable=E0611
+    ConfirmMessageReceivedRequest,
+    ConfirmMessageReceivedResponse,
+    PullObjectRequest,
+    PullObjectResponse,
+    PushObjectRequest,
+    PushObjectResponse,
+)
 from flwr.proto.run_pb2 import GetRunRequest, GetRunResponse  # pylint: disable=E0611
 
 T = TypeVar("T", bound=GrpcMessage)
@@ -120,11 +130,11 @@ class GrpcAdapter:
         """."""
         return self._send_and_receive(request, DeleteNodeResponse, **kwargs)
 
-    def Ping(  # pylint: disable=C0103
-        self, request: PingRequest, **kwargs: Any
-    ) -> PingResponse:
+    def SendNodeHeartbeat(  # pylint: disable=C0103
+        self, request: SendNodeHeartbeatRequest, **kwargs: Any
+    ) -> SendNodeHeartbeatResponse:
         """."""
-        return self._send_and_receive(request, PingResponse, **kwargs)
+        return self._send_and_receive(request, SendNodeHeartbeatResponse, **kwargs)
 
     def PullMessages(  # pylint: disable=C0103
         self, request: PullMessagesRequest, **kwargs: Any
@@ -149,3 +159,21 @@ class GrpcAdapter:
     ) -> GetFabResponse:
         """."""
         return self._send_and_receive(request, GetFabResponse, **kwargs)
+
+    def PushObject(  # pylint: disable=C0103
+        self, request: PushObjectRequest, **kwargs: Any
+    ) -> PushObjectResponse:
+        """."""
+        return self._send_and_receive(request, PushObjectResponse, **kwargs)
+
+    def PullObject(  # pylint: disable=C0103
+        self, request: PullObjectRequest, **kwargs: Any
+    ) -> PullObjectResponse:
+        """."""
+        return self._send_and_receive(request, PullObjectResponse, **kwargs)
+
+    def ConfirmMessageReceived(  # pylint: disable=C0103
+        self, request: ConfirmMessageReceivedRequest, **kwargs: Any
+    ) -> ConfirmMessageReceivedResponse:
+        """."""
+        return self._send_and_receive(request, ConfirmMessageReceivedResponse, **kwargs)

flwr/client/message_handler/message_handler.py

@@ -164,7 +164,7 @@ def validate_out_message(out_message: Message, in_message_metadata: Metadata) ->
     in_meta = in_message_metadata
     if (  # pylint: disable-next=too-many-boolean-expressions
         out_meta.run_id == in_meta.run_id
-        and out_meta.message_id == ""  # This will be generated by the server
+        and out_meta.message_id == out_message.object_id  # Should match the object id
         and out_meta.src_node_id == in_meta.dst_node_id
         and out_meta.dst_node_id == in_meta.src_node_id
         and out_meta.reply_to_message_id == in_meta.message_id

flwr/client/mod/comms_mods.py

@@ -32,14 +32,17 @@ def message_size_mod(
 
     This mod logs the size in bytes of the message being transmited.
     """
-    message_size_in_bytes = 0
+    # Log the size of the incoming message in bytes
+    total_bytes = sum(record.count_bytes() for record in msg.content.values())
+    log(INFO, "Incoming message size: %i bytes", total_bytes)
 
-    for record in msg.content.values():
-        message_size_in_bytes += record.count_bytes()
+    # Call the next layer
+    msg = call_next(msg, ctxt)
 
-    log(INFO, "Message size: %i bytes", message_size_in_bytes)
-
-    return call_next(msg, ctxt)
+    # Log the size of the outgoing message in bytes
+    total_bytes = sum(record.count_bytes() for record in msg.content.values())
+    log(INFO, "Outgoing message size: %i bytes", total_bytes)
+    return msg
 
 
 def arrays_size_mod(
@@ -50,25 +53,41 @@ def arrays_size_mod(
     This mod logs the number of array elements transmitted in ``ArrayRecord`` objects
     of the message as well as their sizes in bytes.
     """
-    model_size_stats = {}
-    arrays_size_in_bytes = 0
+    # Log the ArrayRecord size statistics and the total size in the incoming message
+    array_record_size_stats = _get_array_record_size_stats(msg)
+    total_bytes = sum(stat["bytes"] for stat in array_record_size_stats.values())
+    if array_record_size_stats:
+        log(INFO, "Incoming `ArrayRecord` size statistics:")
+        log(INFO, array_record_size_stats)
+    log(INFO, "Total array elements received: %i bytes", total_bytes)
+
+    msg = call_next(msg, ctxt)
+
+    # Log the ArrayRecord size statistics and the total size in the outgoing message
+    array_record_size_stats = _get_array_record_size_stats(msg)
+    total_bytes = sum(stat["bytes"] for stat in array_record_size_stats.values())
+    if array_record_size_stats:
+        log(INFO, "Outgoing `ArrayRecord` size statistics:")
+        log(INFO, array_record_size_stats)
+    log(INFO, "Total array elements sent: %i bytes", total_bytes)
+    return msg
+
+
+def _get_array_record_size_stats(
+    msg: Message,
+) -> dict[str, dict[str, int]]:
+    """Get `ArrayRecord` size statistics from the message."""
+    array_record_size_stats = {}
     for record_name, arr_record in msg.content.array_records.items():
         arr_record_bytes = arr_record.count_bytes()
-        arrays_size_in_bytes += arr_record_bytes
         element_count = 0
         for array in arr_record.values():
             element_count += (
                 int(np.prod(array.shape)) if array.shape else array.numpy().size
             )
 
-        model_size_stats[f"{record_name}"] = {
+        array_record_size_stats[record_name] = {
             "elements": element_count,
             "bytes": arr_record_bytes,
         }
-
-    if model_size_stats:
-        log(INFO, model_size_stats)
-
-    log(INFO, "Total array elements transmitted: %i bytes", arrays_size_in_bytes)
-
-    return call_next(msg, ctxt)
+    return array_record_size_stats

flwr/client/rest_client/connection.py

@@ -15,30 +15,26 @@
 """Contextmanager for a REST request-response channel to the Flower server."""
 
 
-import random
-import threading
 from collections.abc import Iterator
 from contextlib import contextmanager
-from copy import copy
-from logging import ERROR, INFO, WARN
+from logging import ERROR, WARN
 from typing import Callable, Optional, TypeVar, Union
 
 from cryptography.hazmat.primitives.asymmetric import ec
 from google.protobuf.message import Message as GrpcMessage
 from requests.exceptions import ConnectionError as RequestsConnectionError
 
-from flwr.client.heartbeat import start_ping_loop
-from flwr.client.message_handler.message_handler import validate_out_message
 from flwr.common import GRPC_MAX_MESSAGE_LENGTH
-from flwr.common.constant import (
-    PING_BASE_MULTIPLIER,
-    PING_CALL_TIMEOUT,
-    PING_DEFAULT_INTERVAL,
-    PING_RANDOM_RANGE,
-)
+from flwr.common.constant import HEARTBEAT_DEFAULT_INTERVAL
 from flwr.common.exit import ExitCode, flwr_exit
+from flwr.common.heartbeat import HeartbeatSender
+from flwr.common.inflatable_protobuf_utils import (
+    make_confirm_message_received_fn_protobuf,
+    make_pull_object_fn_protobuf,
+    make_push_object_fn_protobuf,
+)
 from flwr.common.logger import log
-from flwr.common.message import Message, Metadata
+from flwr.common.message import Message, remove_content_from_message
 from flwr.common.retry_invoker import RetryInvoker
 from flwr.common.serde import message_from_proto, message_to_proto, run_from_proto
 from flwr.common.typing import Fab, Run
@@ -48,13 +44,24 @@ from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
     CreateNodeResponse,
     DeleteNodeRequest,
     DeleteNodeResponse,
-    PingRequest,
-    PingResponse,
     PullMessagesRequest,
     PullMessagesResponse,
     PushMessagesRequest,
     PushMessagesResponse,
 )
+from flwr.proto.heartbeat_pb2 import (  # pylint: disable=E0611
+    SendNodeHeartbeatRequest,
+    SendNodeHeartbeatResponse,
+)
+from flwr.proto.message_pb2 import (  # pylint: disable=E0611
+    ConfirmMessageReceivedRequest,
+    ConfirmMessageReceivedResponse,
+    ObjectTree,
+    PullObjectRequest,
+    PullObjectResponse,
+    PushObjectRequest,
+    PushObjectResponse,
+)
 from flwr.proto.node_pb2 import Node  # pylint: disable=E0611
 from flwr.proto.run_pb2 import GetRunRequest, GetRunResponse  # pylint: disable=E0611
 
@@ -68,9 +75,12 @@ PATH_CREATE_NODE: str = "api/v0/fleet/create-node"
 PATH_DELETE_NODE: str = "api/v0/fleet/delete-node"
 PATH_PULL_MESSAGES: str = "/api/v0/fleet/pull-messages"
 PATH_PUSH_MESSAGES: str = "/api/v0/fleet/push-messages"
-PATH_PING: str = "api/v0/fleet/ping"
+PATH_PULL_OBJECT: str = "/api/v0/fleet/pull-object"
+PATH_PUSH_OBJECT: str = "/api/v0/fleet/push-object"
+PATH_SEND_NODE_HEARTBEAT: str = "api/v0/fleet/send-node-heartbeat"
 PATH_GET_RUN: str = "/api/v0/fleet/get-run"
 PATH_GET_FAB: str = "/api/v0/fleet/get-fab"
+PATH_CONFIRM_MESSAGE_RECEIVED: str = "/api/v0/fleet/confirm-message-received"
 
 T = TypeVar("T", bound=GrpcMessage)
 
@@ -89,12 +99,15 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
     ] = None,
 ) -> Iterator[
     tuple[
-        Callable[[], Optional[Message]],
-        Callable[[Message], None],
-        Optional[Callable[[], Optional[int]]],
-        Optional[Callable[[], None]],
-        Optional[Callable[[int], Run]],
-        Optional[Callable[[str, int], Fab]],
+        Callable[[], Optional[tuple[Message, ObjectTree]]],
+        Callable[[Message, ObjectTree], set[str]],
+        Callable[[], Optional[int]],
+        Callable[[], None],
+        Callable[[int], Run],
+        Callable[[str, int], Fab],
+        Callable[[int, str], bytes],
+        Callable[[int, str, bytes], None],
+        Callable[[int, str], None],
     ]
 ]:
     """Primitives for request/response-based interaction with a server.
@@ -130,6 +143,9 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
     create_node : Optional[Callable]
     delete_node : Optional[Callable]
     get_run : Optional[Callable]
+    pull_object : Callable[[str], bytes]
+    push_object : Callable[[str, bytes], None]
+    confirm_message_received : Callable[[str], None]
     """
     log(
         WARN,
@@ -158,13 +174,10 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
         log(ERROR, "Client authentication is not supported for this transport type.")
 
     # Shared variables for inner functions
-    metadata: Optional[Metadata] = None
     node: Optional[Node] = None
-    ping_thread: Optional[threading.Thread] = None
-    ping_stop_event = threading.Event()
 
     ###########################################################################
-    # ping/create_node/delete_node/receive/send/get_run functions
+    # heartbeat/create_node/delete_node/receive/send/get_run functions
     ###########################################################################
 
     def _request(
@@ -214,57 +227,89 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
         grpc_res.ParseFromString(res.content)
         return grpc_res
 
-    def ping() -> None:
+    def _pull_object_protobuf(request: PullObjectRequest) -> PullObjectResponse:
+        res = _request(
+            req=request,
+            res_type=PullObjectResponse,
+            api_path=PATH_PULL_OBJECT,
+        )
+        if res is None:
+            raise ValueError(f"{PullObjectResponse.__name__} is None.")
+        return res
+
+    def _push_object_protobuf(request: PushObjectRequest) -> PushObjectResponse:
+        res = _request(
+            req=request,
+            res_type=PushObjectResponse,
+            api_path=PATH_PUSH_OBJECT,
+        )
+        if res is None:
+            raise ValueError(f"{PushObjectResponse.__name__} is None.")
+        return res
+
+    def _confirm_message_received_protobuf(
+        request: ConfirmMessageReceivedRequest,
+    ) -> ConfirmMessageReceivedResponse:
+        res = _request(
+            req=request,
+            res_type=ConfirmMessageReceivedResponse,
+            api_path=PATH_CONFIRM_MESSAGE_RECEIVED,
+        )
+        if res is None:
+            raise ValueError(f"{ConfirmMessageReceivedResponse.__name__} is None.")
+        return res
+
+    def send_node_heartbeat() -> bool:
         # Get Node
         if node is None:
             log(ERROR, "Node instance missing")
-            return
+            return False
 
-        # Construct the ping request
-        req = PingRequest(node=node, ping_interval=PING_DEFAULT_INTERVAL)
+        # Construct the heartbeat request
+        req = SendNodeHeartbeatRequest(
+            node=node, heartbeat_interval=HEARTBEAT_DEFAULT_INTERVAL
+        )
 
         # Send the request
-        res = _request(req, PingResponse, PATH_PING, retry=False)
+        res = _request(
+            req, SendNodeHeartbeatResponse, PATH_SEND_NODE_HEARTBEAT, retry=False
+        )
         if res is None:
-            return
+            return False
 
         # Check if success
         if not res.success:
-            raise RuntimeError("Ping failed unexpectedly.")
+            raise RuntimeError(
+                "Heartbeat failed unexpectedly. The SuperLink does not "
+                "recognize this SuperNode."
+            )
+        return True
 
-        # Wait
-        rd = random.uniform(*PING_RANDOM_RANGE)
-        next_interval: float = PING_DEFAULT_INTERVAL - PING_CALL_TIMEOUT
-        next_interval *= PING_BASE_MULTIPLIER + rd
-        if not ping_stop_event.is_set():
-            ping_stop_event.wait(next_interval)
+    heartbeat_sender = HeartbeatSender(send_node_heartbeat)
 
     def create_node() -> Optional[int]:
         """Set create_node."""
-        req = CreateNodeRequest(ping_interval=PING_DEFAULT_INTERVAL)
+        req = CreateNodeRequest(heartbeat_interval=HEARTBEAT_DEFAULT_INTERVAL)
 
         # Send the request
         res = _request(req, CreateNodeResponse, PATH_CREATE_NODE)
         if res is None:
             return None
 
-        # Remember the node and the ping-loop thread
-        nonlocal node, ping_thread
+        # Remember the node and start the heartbeat sender
+        nonlocal node
         node = res.node
-        ping_thread = start_ping_loop(ping, ping_stop_event)
+        heartbeat_sender.start()
         return node.node_id
 
     def delete_node() -> None:
         """Set delete_node."""
         nonlocal node
         if node is None:
-            log(ERROR, "Node instance missing")
-            return
+            raise RuntimeError("Node instance missing")
 
-        # Stop the ping-loop thread
-        ping_stop_event.set()
-        if ping_thread is not None:
-            ping_thread.join()
+        # Stop the heartbeat sender
+        heartbeat_sender.stop()
 
         # Send DeleteNode request
         req = DeleteNodeRequest(node=node)
@@ -277,75 +322,54 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
         # Cleanup
         node = None
 
-    def receive() -> Optional[Message]:
-        """Receive next Message from server."""
+    def receive() -> Optional[tuple[Message, ObjectTree]]:
+        """Pull a message with its ObjectTree from SuperLink."""
         # Get Node
         if node is None:
-            log(ERROR, "Node instance missing")
-            return None
+            raise RuntimeError("Node instance missing")
 
-        # Request instructions (message) from server
+        # Try to pull a message with its object tree from SuperLink
         req = PullMessagesRequest(node=node)
-
-        # Send the request
         res = _request(req, PullMessagesResponse, PATH_PULL_MESSAGES)
         if res is None:
+            raise ValueError("PushMessagesResponse is None.")
+
+        # If no messages are available, return None
+        if len(res.messages_list) == 0:
             return None
 
-        # Get the current Messages
-        message_proto = None if len(res.messages_list) == 0 else res.messages_list[0]
-
-        # Discard the current message if not valid
-        if message_proto is not None and not (
-            message_proto.metadata.dst_node_id == node.node_id
-        ):
-            message_proto = None
-
-        # Return the Message if available
-        nonlocal metadata
-        message = None
-        if message_proto is not None:
-            message = message_from_proto(message_proto)
-            metadata = copy(message.metadata)
-            log(INFO, "[Node] POST /%s: success", PATH_PULL_MESSAGES)
-        return message
-
-    def send(message: Message) -> None:
-        """Send Message result back to server."""
-        # Get Node
-        if node is None:
-            log(ERROR, "Node instance missing")
-            return
+        # Get the current Message and its object tree
+        message_proto = res.messages_list[0]
+        object_tree = res.message_object_trees[0]
 
-        # Get incoming message
-        nonlocal metadata
-        if metadata is None:
-            log(ERROR, "No current message")
-            return
+        # Construct the Message
+        in_message = message_from_proto(message_proto)
 
-        # Validate out message
-        if not validate_out_message(message, metadata):
-            log(ERROR, "Invalid out message")
-            return
-        metadata = None
+        # Return the Message and its object tree
+        return in_message, object_tree
 
-        # Serialize ProtoBuf to bytes
-        message_proto = message_to_proto(message=message)
+    def send(message: Message, object_tree: ObjectTree) -> set[str]:
+        """Send the message with its ObjectTree to SuperLink."""
+        # Get Node
+        if node is None:
+            raise RuntimeError("Node instance missing")
 
-        # Serialize ProtoBuf to bytes
-        req = PushMessagesRequest(node=node, messages_list=[message_proto])
+        # Remove the content from the message if it has
+        if message.has_content():
+            message = remove_content_from_message(message)
 
-        # Send the request
+        # Send the message with its ObjectTree to SuperLink
+        req = PushMessagesRequest(
+            node=node,
+            messages_list=[message_to_proto(message)],
+            message_object_trees=[object_tree],
+        )
         res = _request(req, PushMessagesResponse, PATH_PUSH_MESSAGES)
         if res is None:
-            return
+            raise ValueError("PushMessagesResponse is None.")
 
-        log(
-            INFO,
-            "[Node] POST /%s: success, created result %s",
-            PATH_PUSH_MESSAGES,
-            res.results,  # pylint: disable=no-member
-        )
+        # Get and return the object IDs to push
+        return set(res.objects_to_push)
 
     def get_run(run_id: int) -> Run:
         # Construct the request
@@ -372,9 +396,58 @@ def http_request_response(  # pylint: disable=R0913,R0914,R0915,R0917
             res.fab.content,
         )
 
+    def pull_object(run_id: int, object_id: str) -> bytes:
+        """Pull the object from the SuperLink."""
+        # Check Node
+        if node is None:
+            raise RuntimeError("Node instance missing")
+
+        fn = make_pull_object_fn_protobuf(
+            pull_object_protobuf=_pull_object_protobuf,
+            node=node,
+            run_id=run_id,
+        )
+        return fn(object_id)
+
+    def push_object(run_id: int, object_id: str, contents: bytes) -> None:
+        """Push the object to the SuperLink."""
+        # Check Node
+        if node is None:
+            raise RuntimeError("Node instance missing")
+
+        fn = make_push_object_fn_protobuf(
+            push_object_protobuf=_push_object_protobuf,
+            node=node,
+            run_id=run_id,
+        )
+        fn(object_id, contents)
+
+    def confirm_message_received(run_id: int, object_id: str) -> None:
+        """Confirm that the message has been received."""
+        # Check Node
+        if node is None:
+            raise RuntimeError("Node instance missing")
+
+        fn = make_confirm_message_received_fn_protobuf(
+            confirm_message_received_protobuf=_confirm_message_received_protobuf,
+            node=node,
+            run_id=run_id,
+        )
+        fn(object_id)
+
     try:
         # Yield methods
-        yield (receive, send, create_node, delete_node, get_run, get_fab)
+        yield (
+            receive,
+            send,
+            create_node,
+            delete_node,
+            get_run,
+            get_fab,
+            pull_object,
+            push_object,
+            confirm_message_received,
+        )
     except Exception as exc:  # pylint: disable=broad-except
         log(ERROR, exc)
     # Cleanup

flwr/clientapp/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2025 Flower Labs GmbH. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+"""Public Flower ClientApp APIs."""

flwr/common/__init__.py

@@ -15,6 +15,8 @@
 """Common components shared between server and client."""
 
 
+from ..app.error import Error as Error
+from ..app.metadata import Metadata as Metadata
 from .constant import MessageType as MessageType
 from .constant import MessageTypeLegacy as MessageTypeLegacy
 from .context import Context as Context
@@ -23,9 +25,7 @@ from .grpc import GRPC_MAX_MESSAGE_LENGTH
 from .logger import configure as configure
 from .logger import log as log
 from .message import DEFAULT_TTL
-from .message import Error as Error
 from .message import Message as Message
-from .message import Metadata as Metadata
 from .parameter import bytes_to_ndarray as bytes_to_ndarray
 from .parameter import ndarray_to_bytes as ndarray_to_bytes
 from .parameter import ndarrays_to_parameters as ndarrays_to_parameters

flwr/common/auth_plugin/__init__.py

@@ -17,8 +17,10 @@
 
 from .auth_plugin import CliAuthPlugin as CliAuthPlugin
 from .auth_plugin import ExecAuthPlugin as ExecAuthPlugin
+from .auth_plugin import ExecAuthzPlugin as ExecAuthzPlugin
 
 __all__ = [
     "CliAuthPlugin",
     "ExecAuthPlugin",
+    "ExecAuthzPlugin",
 ]

flwr/common/auth_plugin/auth_plugin.py

@@ -20,7 +20,7 @@ from collections.abc import Sequence
 from pathlib import Path
 from typing import Optional, Union
 
-from flwr.common.typing import UserInfo
+from flwr.common.typing import AccountInfo
 from flwr.proto.exec_pb2_grpc import ExecStub
 
 from ..typing import UserAuthCredentials, UserAuthLoginDetails
@@ -33,6 +33,9 @@ class ExecAuthPlugin(ABC):
     ----------
     user_auth_config_path : Path
         Path to the YAML file containing the authentication configuration.
+    verify_tls_cert : bool
+        Boolean indicating whether to verify the TLS certificate
+        when making requests to the server.
     """
 
     @abstractmethod
@@ -50,7 +53,7 @@ class ExecAuthPlugin(ABC):
     @abstractmethod
     def validate_tokens_in_metadata(
         self, metadata: Sequence[tuple[str, Union[str, bytes]]]
-    ) -> tuple[bool, Optional[UserInfo]]:
+    ) -> tuple[bool, Optional[AccountInfo]]:
         """Validate authentication tokens in the provided metadata."""
 
     @abstractmethod
@@ -60,10 +63,33 @@ class ExecAuthPlugin(ABC):
     @abstractmethod
     def refresh_tokens(
         self, metadata: Sequence[tuple[str, Union[str, bytes]]]
-    ) -> Optional[Sequence[tuple[str, Union[str, bytes]]]]:
+    ) -> tuple[
+        Optional[Sequence[tuple[str, Union[str, bytes]]]], Optional[AccountInfo]
+    ]:
         """Refresh authentication tokens in the provided metadata."""
 
 
+class ExecAuthzPlugin(ABC):  # pylint: disable=too-few-public-methods
+    """Abstract Flower Authorization Plugin class for ExecServicer.
+
+    Parameters
+    ----------
+    user_auth_config_path : Path
+        Path to the YAML file containing the authorization configuration.
+    verify_tls_cert : bool
+        Boolean indicating whether to verify the TLS certificate
+        when making requests to the server.
+    """
+
+    @abstractmethod
+    def __init__(self, user_auth_config_path: Path, verify_tls_cert: bool):
+        """Abstract constructor."""
+
+    @abstractmethod
+    def verify_user_authorization(self, account_info: AccountInfo) -> bool:
+        """Verify user authorization request."""
+
+
 class CliAuthPlugin(ABC):
     """Abstract Flower Auth Plugin class for CLI.