feat: only expose iurls as needed

WebOfTrust · Nov 8, 2024 · 30140bc · 30140bc
1 parent 5a221d9
commit 30140bc
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 23 deletions.
diff --git a/src/keria/app/agenting.py b/src/keria/app/agenting.py
@@ -1332,27 +1332,28 @@ def recur(self, tyme, deeds=None):
 
 class ConfigResourceEnd:
 
-    """ Config GET endpoint
-
-    Parameters:
-        req (Request): falcon.Request HTTP request
-        rep (Response): falcon.Response HTTP response
-
-    ---
-    summary: Retrieve agent configuration
-    description:  Retrieve agent configuration file as JSON
-    tags:
-      - Config
-    responses:
-       200:
-          description: Configuration dict as JSON
-
-    """
     @staticmethod
     def on_get(req, rep):
+        """ Config GET endpoint
+
+        Parameters:
+            req (Request): falcon.Request HTTP request
+            rep (Response): falcon.Response HTTP response
+
+        ---
+        summary: Retrieve agent configuration
+        description:  Retrieve agent configuration (only necessary fields are exposed)
+        tags:
+          - Config
+        responses:
+           200:
+              description: Subset of configuration dict as JSON
+
+        """
         agent = req.context.agent
         config = agent.hby.cf.get()
+        subset = {key: config[key] for key in ["iurls"] if key in config}
 
         rep.status = falcon.HTTP_200
         rep.content_type = "application/json"
-        rep.data = json.dumps(config).encode("utf-8")
+        rep.data = json.dumps(subset).encode("utf-8")
diff --git a/tests/app/test_agenting.py b/tests/app/test_agenting.py
@@ -86,6 +86,9 @@ def test_load_tocks_config(helpers):
                 "dt": "2022-01-20T12:57:59.823350+00:00",
                 "curls": ["http://127.0.0.1:3902/"]
             },
+            "iurls": [
+                "http://127.0.0.1:5642/oobi/BBilc4-L3tFUnfM_wJr4S4OJanAv_VmF_dJNN6vkf2Ha/controller&tag=witness"
+            ],
             "tocks": {
                 "initer": 0.0,
                 "escrower": 1.0
@@ -359,6 +362,9 @@ def test_oobi_ends(seeder, helpers):
         result = client.simulate_post(path="/oobi", body=b)
         assert result.status == falcon.HTTP_501
 
+        # initiated from keria.json config file (iurls), so remove
+        oobiery.hby.db.oobis.rem(keys=("http://127.0.0.1:5642/oobi/BBilc4-L3tFUnfM_wJr4S4OJanAv_VmF_dJNN6vkf2Ha/controller&tag=witness",))
+
         data = dict(url="http://127.0.0.1:5644/oobi/E6Dqo6tHmYTuQ3Lope4mZF_4hBoGJl93cBHRekr_iD_A/witness/")
         b = json.dumps(data).encode("utf-8")
         result = client.simulate_post(path="/oobi", body=b)
@@ -714,8 +720,7 @@ def test_config_ends(helpers):
         app.add_route("/config", configEnd)
         res = client.simulate_get(path="/config")
         assert res.status == falcon.HTTP_200
-        assert res.json == {'dt': '2022-01-20T12:57:59.823350+00:00',
-                            'keria': {'dt': '2022-01-20T12:57:59.823350+00:00', 'curls': ['http://127.0.0.1:3902/']},
-                            'EK35JRNdfVkO4JwhXaSTdV4qzB_ibk_tGJmSVcY4pZqx': {'dt': '2022-01-20T12:57:59.823350+00:00', 'curls': ['http://127.0.0.1:3902/']},
-                            'EI7AkI40M11MS7lkTCb10JC9-nDt-tXwQh44OHAFlv_9': {'dt': '2022-01-20T12:57:59.823350+00:00', 'curls': ['http://127.0.0.1:3902/']},
-                            'tocks': {'initer': 0, 'escrower': 1}}
+        assert res.json == {'iurls':
+                            ['http://127.0.0.1:5642/oobi/BBilc4-L3tFUnfM_wJr4S4OJanAv_VmF_dJNN6vkf2Ha/controller&tag=witness']}
+
+        agent.cf
diff --git a/tests/app/test_specing.py b/tests/app/test_specing.py
diff --git a/tests/scripts/keri/cf/main/keria.json b/tests/scripts/keri/cf/main/keria.json
@@ -12,6 +12,9 @@
     "dt": "2022-01-20T12:57:59.823350+00:00",
     "curls": ["http://127.0.0.1:3902/"]
   },
+  "iurls": [
+    "http://127.0.0.1:5642/oobi/BBilc4-L3tFUnfM_wJr4S4OJanAv_VmF_dJNN6vkf2Ha/controller&tag=witness"
+  ],
   "tocks": {
     "initer": 0.0,
     "escrower": 1.0