Scope agent database access to a thread or a database (#936)

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

Author: theomonnom

.changeset/agent-db-scoped-grants.md

@@ -0,0 +1,6 @@
+---
+"livekit-api": patch
+"livekit-protocol": patch
+---
+
+Scope agent database access to a thread or a database: `AgentThreadGrants` gains `sql`, the new `agentDatabase` claim (`AgentDatabaseGrants`, `with_agent_database_grants`) grants `read`, `write` and `delete` on listed databases plus project-wide `create` and `list`, and `AgentGrants.database_admin` is removed.

livekit-api/livekit/api/__init__.py

@@ -50,6 +50,7 @@
     AgentGrants,
     AgentEndpointGrants,
     AgentThreadGrants,
+    AgentDatabaseGrants,
     VideoGrants,
     SIPGrants,
     AccessToken,
@@ -71,6 +72,7 @@
     "AgentGrants",
     "AgentEndpointGrants",
     "AgentThreadGrants",
+    "AgentDatabaseGrants",
     "VideoGrants",
     "SIPGrants",
     "AccessToken",

livekit-api/livekit/api/access_token.py

@@ -101,8 +101,6 @@ class AgentGrants:
     admin: bool = False
     # manage simulations and scenarios for evaluating agents
     simulation_admin: bool = False
-    # access the project's agent databases
-    database_admin: bool = False
     # manage the project's agent dispatch queue
     dispatch_admin: bool = False
 
@@ -130,6 +128,21 @@ class AgentThreadGrants:
     write: bool = False
     read: bool = False
     delete: bool = False
+    # open a covered thread's database, whose id is the thread's
+    sql: bool = False
+
+
+@dataclass
+class AgentDatabaseGrants:
+    # databases that may be read, written and deleted
+    database_ids: Optional[List[str]] = None
+    read: bool = False
+    write: bool = False
+    delete: bool = False
+    # create databases in the project
+    create: bool = False
+    # list the project's databases
+    list: bool = False
 
 
 @dataclass
@@ -145,6 +158,7 @@ class Claims:
     agent: Optional[AgentGrants] = None
     agent_endpoint: Optional[AgentEndpointGrants] = None
     agent_thread: Optional[AgentThreadGrants] = None
+    agent_database: Optional[AgentDatabaseGrants] = None
     attributes: Optional[dict[str, str]] = None
     sha256: Optional[str] = None
     room_preset: Optional[str] = None
@@ -217,6 +231,10 @@ def with_agent_thread_grants(self, grants: AgentThreadGrants) -> "AccessToken":
         self.claims.agent_thread = grants
         return self
 
+    def with_agent_database_grants(self, grants: AgentDatabaseGrants) -> "AccessToken":
+        self.claims.agent_database = grants
+        return self
+
     def with_identity(self, identity: str) -> "AccessToken":
         self.identity = identity
         return self
@@ -322,6 +340,7 @@ def verify(self, token: str, *, verify_signature: bool = True) -> Claims:
             agent=_parse_grants(claims, "agent", AgentGrants),
             agent_endpoint=_parse_grants(claims, "agentEndpoint", AgentEndpointGrants),
             agent_thread=_parse_grants(claims, "agentThread", AgentThreadGrants),
+            agent_database=_parse_grants(claims, "agentDatabase", AgentDatabaseGrants),
         )
 
         if claims.get("roomPreset"):