Merge branch 'main' into fix/respect-auto-verify-pres-v2

ianco · web-flow · commit 1f5e4ae32f66 · 2023-02-15T14:16:30.000-08:00
diff --git a/aries_cloudagent/config/argparse.py b/aries_cloudagent/config/argparse.py
@@ -1309,6 +1309,12 @@ def add_arguments(self, parser: ArgumentParser):
             env_var="ACAPY_MAX_MESSAGE_SIZE",
             help="Set the maximum size in bytes for inbound agent messages.",
         )
+        parser.add_argument(
+            "--light-weight-webhook",
+            action="store_true",
+            env_var="ACAPY_LIGHT_WEIGHT_WEBHOOK",
+            help="omitted client's info from issue-credential related webhook",
+        )
         parser.add_argument(
             "--enable-undelivered-queue",
             action="store_true",
@@ -1372,6 +1378,8 @@ def get_settings(self, args: Namespace):
             settings["image_url"] = args.image_url
         if args.max_message_size:
             settings["transport.max_message_size"] = args.max_message_size
+        if args.light_weight_webhook:
+            settings["transport.light_weight_webhook"] = True
         if args.max_outbound_retry:
             settings["transport.max_outbound_retry"] = args.max_outbound_retry
         if args.ws_heartbeat_interval:
diff --git a/aries_cloudagent/protocols/issue_credential/v1_0/messages/credential_exchange_webhook.py b/aries_cloudagent/protocols/issue_credential/v1_0/messages/credential_exchange_webhook.py
@@ -0,0 +1,47 @@
+"""v1.0 credential exchange light weight webhook."""
+
+
+class LightWeightV10CredentialExchangeWebhook:
+    """Class representing a state only credential exchange webhook."""
+
+    __acceptable_keys_list = [
+        "connection_id",
+        "credential_exchange_id",
+        "cred_ex_id",
+        "cred_def_id",
+        "role",
+        "initiator",
+        "revoc_reg_id",
+        "revocation_id",
+        "auto_offer",
+        "auto_issue",
+        "auto_remove",
+        "error_msg",
+        "thread_id",
+        "parent_thread_id",
+        "state",
+        "credential_definition_id",
+        "schema_id",
+        "credential_id",
+        "trace",
+        "public_did",
+        "cred_id_stored",
+        "conn_id",
+    ]
+
+    def __init__(
+        self,
+        **kwargs,
+    ):
+        """
+        Initialize webhook object from V10CredentialExchange.
+
+        from a list of accepted attributes.
+        """
+        [
+            self.__setattr__(key, kwargs.get(key))
+            for key in self.__acceptable_keys_list
+            if kwargs.get(key) is not None
+        ]
+        if kwargs.get("_id") is not None:
+            self.credential_exchange_id = kwargs.get("_id")
diff --git a/aries_cloudagent/protocols/issue_credential/v1_0/models/credential_exchange.py b/aries_cloudagent/protocols/issue_credential/v1_0/models/credential_exchange.py
@@ -17,6 +17,9 @@
 
 from ..messages.credential_proposal import CredentialProposal, CredentialProposalSchema
 from ..messages.credential_offer import CredentialOffer, CredentialOfferSchema
+from ..messages.credential_exchange_webhook import (
+    LightWeightV10CredentialExchangeWebhook,
+)
 
 from . import UNENCRYPTED_TAGS
 
@@ -221,6 +224,33 @@ async def save_error_state(
         except StorageError:
             LOGGER.exception("Error saving credential exchange error state")
 
+    # Override
+    async def emit_event(self, session: ProfileSession, payload: Any = None):
+        """
+        Emit an event.
+
+        Args:
+            session: The profile session to use
+            payload: The event payload
+        """
+
+        if not self.RECORD_TOPIC:
+            return
+
+        if self.state:
+            topic = f"{self.EVENT_NAMESPACE}::{self.RECORD_TOPIC}::{self.state}"
+        else:
+            topic = f"{self.EVENT_NAMESPACE}::{self.RECORD_TOPIC}"
+
+        if not payload:
+            payload = self.serialize()
+
+        if session.profile.settings.get("transport.light_weight_webhook"):
+            payload = LightWeightV10CredentialExchangeWebhook(**self.__dict__)
+            payload = payload.__dict__
+
+        await session.profile.notify(topic, payload)
+
     @property
     def record_value(self) -> dict:
         """Accessor for the JSON record value generated for this invitation."""
diff --git a/aries_cloudagent/protocols/issue_credential/v2_0/messages/cred_ex_record_webhook.py b/aries_cloudagent/protocols/issue_credential/v2_0/messages/cred_ex_record_webhook.py
@@ -0,0 +1,47 @@
+"""v2.0 credential exchange light weight webhook."""
+
+
+class LightWeightV20CredExRecordWebhook:
+    """Class representing a state only credential exchange webhook."""
+
+    __acceptable_keys_list = [
+        "connection_id",
+        "credential_exchange_id",
+        "cred_ex_id",
+        "cred_def_id",
+        "role",
+        "initiator",
+        "revoc_reg_id",
+        "revocation_id",
+        "auto_offer",
+        "auto_issue",
+        "auto_remove",
+        "error_msg",
+        "thread_id",
+        "parent_thread_id",
+        "state",
+        "credential_definition_id",
+        "schema_id",
+        "credential_id",
+        "trace",
+        "public_did",
+        "cred_id_stored",
+        "conn_id",
+    ]
+
+    def __init__(
+        self,
+        **kwargs,
+    ):
+        """
+        Initialize webhook object from V20CredExRecord.
+
+        from a list of accepted attributes.
+        """
+        [
+            self.__setattr__(key, kwargs.get(key))
+            for key in self.__acceptable_keys_list
+            if kwargs.get(key) is not None
+        ]
+        if kwargs.get("_id") is not None:
+            self.cred_ex_id = kwargs.get("_id")
diff --git a/aries_cloudagent/protocols/issue_credential/v2_0/models/cred_ex_record.py b/aries_cloudagent/protocols/issue_credential/v2_0/models/cred_ex_record.py
@@ -17,6 +17,7 @@
 from ..messages.cred_offer import V20CredOffer, V20CredOfferSchema
 from ..messages.cred_request import V20CredRequest, V20CredRequestSchema
 from ..messages.inner.cred_preview import V20CredPreviewSchema
+from ..messages.cred_ex_record_webhook import LightWeightV20CredExRecordWebhook
 
 from . import UNENCRYPTED_TAGS
 
@@ -181,6 +182,33 @@ async def save_error_state(
         except StorageError as err:
             LOGGER.exception(err)
 
+    # Override
+    async def emit_event(self, session: ProfileSession, payload: Any = None):
+        """
+        Emit an event.
+
+        Args:
+            session: The profile session to use
+            payload: The event payload
+        """
+
+        if not self.RECORD_TOPIC:
+            return
+
+        if self.state:
+            topic = f"{self.EVENT_NAMESPACE}::{self.RECORD_TOPIC}::{self.state}"
+        else:
+            topic = f"{self.EVENT_NAMESPACE}::{self.RECORD_TOPIC}"
+
+        if not payload:
+            payload = self.serialize()
+
+        if session.profile.settings.get("transport.light_weight_webhook"):
+            payload = LightWeightV20CredExRecordWebhook(**self.__dict__)
+            payload = payload.__dict__
+
+        await session.profile.notify(topic, payload)
+
     @property
     def record_value(self) -> Mapping:
         """Accessor for the JSON record value generated for this credential exchange."""
diff --git a/aries_cloudagent/revocation/routes.py b/aries_cloudagent/revocation/routes.py
@@ -2,6 +2,8 @@
 
 import json
 import logging
+import os
+import shutil
 from asyncio import shield
 import re
 
@@ -146,6 +148,31 @@ def validate_fields(self, data, **kwargs):
     )
 
 
+class RevRegId(OpenAPISchema):
+    """Parameters and validators for delete tails file request."""
+
+    @validates_schema
+    def validate_fields(self, data, **kwargs):
+        """Validate schema fields - must have either rr-id or cr-id."""
+
+        rev_reg_id = data.get("rev_reg_id")
+        cred_def_id = data.get("cred_def_id")
+
+        if not (rev_reg_id or cred_def_id):
+            raise ValidationError("Request must have either rev_reg_id or cred_def_id")
+
+    rev_reg_id = fields.Str(
+        description="Revocation registry identifier",
+        required=False,
+        **INDY_REV_REG_ID,
+    )
+    cred_def_id = fields.Str(
+        description="Credential definition identifier",
+        required=False,
+        **INDY_CRED_DEF_ID,
+    )
+
+
 class RevokeRequestSchema(CredRevRecordQueryStringSchema):
     """Parameters and validators for revocation request."""
 
@@ -1467,6 +1494,51 @@ async def on_revocation_registry_endorsed_event(profile: Profile, event: Event):
         )
 
 
+@querystring_schema(RevRegId())
+@docs(tags=["revocation"], summary="Delete the tail files")
+async def delete_tails(request: web.BaseRequest) -> json:
+    """Delete Tails Files."""
+    context: AdminRequestContext = request["context"]
+    rev_reg_id = request.query.get("rev_reg_id")
+    cred_def_id = request.query.get("cred_def_id")
+    revoc = IndyRevocation(context.profile)
+    session = revoc._profile.session()
+    if rev_reg_id:
+        rev_reg = await revoc.get_issuer_rev_reg_record(rev_reg_id)
+        tails_path = rev_reg.tails_local_path
+        main_dir_rev = os.path.dirname(tails_path)
+        try:
+            shutil.rmtree(main_dir_rev)
+            return web.json_response({"message": "All files deleted successfully"})
+        except Exception as e:
+            return web.json_response({"message": str(e)})
+    elif cred_def_id:
+        async with session:
+            cred_reg = sorted(
+                await IssuerRevRegRecord.query_by_cred_def_id(
+                    session, cred_def_id, IssuerRevRegRecord.STATE_GENERATED
+                )
+            )[0]
+        tails_path = cred_reg.tails_local_path
+        main_dir_rev = os.path.dirname(tails_path)
+        main_dir_cred = os.path.dirname(main_dir_rev)
+        filenames = os.listdir(main_dir_cred)
+        try:
+            flag = 0
+            for i in filenames:
+                safe_cred_def_id = re.escape(cred_def_id)
+                if re.search(safe_cred_def_id, i):
+                    shutil.rmtree(main_dir_cred + "/" + i)
+                    flag = 1
+            if flag:
+                return web.json_response({"message": "All files deleted successfully"})
+            else:
+                return web.json_response({"message": "No such file or directory"})
+
+        except Exception as e:
+            return web.json_response({"message": str(e)})
+
+
 async def register(app: web.Application):
     """Register routes."""
     app.add_routes(
@@ -1524,6 +1596,7 @@ async def register(app: web.Application):
                 "/revocation/registry/{rev_reg_id}/fix-revocation-entry-state",
                 update_rev_reg_revoked_state,
             ),
+            web.delete("/revocation/registry/delete-tails-file", delete_tails),
         ]
     )
 
diff --git a/aries_cloudagent/revocation/tests/test_routes.py b/aries_cloudagent/revocation/tests/test_routes.py
@@ -1,3 +1,7 @@
+import os
+import shutil
+import unittest
+
 from aiohttp.web import HTTPBadRequest, HTTPNotFound
 from asynctest import TestCase as AsyncTestCase
 from asynctest import mock as async_mock
@@ -903,3 +907,63 @@ async def test_post_process_routes(self):
         ]["get"]["responses"]["200"]["schema"] == {"type": "string", "format": "binary"}
 
         assert "tags" in mock_app._state["swagger_dict"]
+
+
+class TestDeleteTails(unittest.TestCase):
+    def setUp(self):
+        self.rev_reg_id = "rev_reg_id_123"
+        self.cred_def_id = "cred_def_id_456"
+
+        self.main_dir_rev = "path/to/main/dir/rev"
+        self.tails_path = os.path.join(self.main_dir_rev, "tails")
+        if not (os.path.exists(self.main_dir_rev)):
+            os.makedirs(self.main_dir_rev)
+        open(self.tails_path, "w").close()
+
+    async def test_delete_tails_by_rev_reg_id(self):
+        # Setup
+        rev_reg_id = self.rev_reg_id
+
+        # Test
+        result = await test_module.delete_tails(
+            {"context": None, "query": {"rev_reg_id": rev_reg_id}}
+        )
+
+        # Assert
+        self.assertEqual(result, {"message": "All files deleted successfully"})
+        self.assertFalse(os.path.exists(self.tails_path))
+
+    async def test_delete_tails_by_cred_def_id(self):
+        # Setup
+        cred_def_id = self.cred_def_id
+        main_dir_cred = "path/to/main/dir/cred"
+        os.makedirs(main_dir_cred)
+        cred_dir = os.path.join(main_dir_cred, cred_def_id)
+        os.makedirs(cred_dir)
+
+        # Test
+        result = await test_module.delete_tails(
+            {"context": None, "query": {"cred_def_id": cred_def_id}}
+        )
+
+        # Assert
+        self.assertEqual(result, {"message": "All files deleted successfully"})
+        self.assertFalse(os.path.exists(cred_dir))
+        self.assertTrue(os.path.exists(main_dir_cred))
+
+    async def test_delete_tails_not_found(self):
+        # Setup
+        cred_def_id = "invalid_cred_def_id"
+
+        # Test
+        result = await test_module.delete_tails(
+            {"context": None, "query": {"cred_def_id": cred_def_id}}
+        )
+
+        # Assert
+        self.assertEqual(result, {"message": "No such file or directory"})
+        self.assertTrue(os.path.exists(self.main_dir_rev))
+
+    async def tearDown(self):
+        if os.path.exists(self.main_dir_rev):
+            shutil.rmtree(self.main_dir_rev)
diff --git a/demo/Endorser.md b/demo/Endorser.md
diff --git a/demo/README.md b/demo/README.md
