Unrevocation notification.

Author: thiagoromanos

aries_cloudagent/protocols/revocation_notification/definition.py

@@ -10,7 +10,7 @@
     {
         "major_version": 2,
         "minimum_minor_version": 0,
-        "current_minor_version": 0,
+        "current_minor_version": 1,
         "path": "v2_0",
     },
 ]

aries_cloudagent/protocols/revocation_notification/v1_0/models/rev_notification_record.py

@@ -70,7 +70,8 @@ def revocation_notification_id(self) -> Optional[str]:
     def record_value(self) -> dict:
         """Return record value."""
         return {
-            prop: getattr(self, prop) for prop in ("thread_id", "comment", "unrevoke")
+            prop: getattr(self, prop)
+            for prop in ("thread_id", "comment", "revocation_format", "unrevoke")
         }
 
     @classmethod

aries_cloudagent/protocols/revocation_notification/v2_0/handlers/revoke_handler.py

@@ -1,10 +1,12 @@
 """Handler for revoke message."""
 
+from aries_cloudagent.protocols.didcomm_prefix import DIDCommPrefix
+
 from .....messaging.base_handler import BaseHandler
 from .....messaging.request_context import RequestContext
 from .....messaging.responder import BaseResponder
-
 from ..messages.revoke import Revoke
+from ..messages.unrevoke import Unrevoke
 
 
 class RevokeHandler(BaseHandler):
@@ -15,18 +17,22 @@ class RevokeHandler(BaseHandler):
 
     async def handle(self, context: RequestContext, responder: BaseResponder):
         """Handle revoke message."""
-        assert isinstance(context.message, Revoke)
+        assert isinstance(context.message, (Revoke, Unrevoke))
         self._logger.debug(
             "Received notification of revocation for %s cred %s with comment: %s",
             context.message.revocation_format,
             context.message.credential_id,
             context.message.comment,
         )
+
+        message_type = DIDCommPrefix.NEW.qualify(context.message.Meta.message_type)
+
         # Emit a webhook
         if context.settings.get("revocation.monitor_notification"):
             await context.profile.notify(
                 self.WEBHOOK_TOPIC,
                 {
+                    "@type": message_type,
                     "revocation_format": context.message.revocation_format,
                     "credential_id": context.message.credential_id,
                     "comment": context.message.comment,
@@ -37,6 +43,7 @@ async def handle(self, context: RequestContext, responder: BaseResponder):
         await context.profile.notify(
             self.RECEIVED_TOPIC,
             {
+                "@type": message_type,
                 "revocation_format": context.message.revocation_format,
                 "credential_id": context.message.credential_id,
                 "comment": context.message.comment,

aries_cloudagent/protocols/revocation_notification/v2_0/message_types.py

@@ -1,20 +1,27 @@
 """Message type identifiers for Revocation Notification protocol."""
 
+from ....messaging.util import get_proto_default_version
 from ...didcomm_prefix import DIDCommPrefix
-
+from ..definition import versions
 
 SPEC_URI = (
     "https://github.com/hyperledger/aries-rfcs/blob/main/features/"
     "0721-revocation-notification-v2/README.md"
 )
+
+CURRENT_VERSION = get_proto_default_version(versions, 2)
+REV_NOTIF_2_0 = "revocation_notification/2.0"
 PROTOCOL = "revocation_notification"
-VERSION = "2.0"
-BASE = f"{PROTOCOL}/{VERSION}"
+BASE = f"{PROTOCOL}/{CURRENT_VERSION}"
 
 # Message types
 REVOKE = f"{BASE}/revoke"
+UNREVOKE = f"{BASE}/unrevoke"
 
 PROTOCOL_PACKAGE = "aries_cloudagent.protocols.revocation_notification.v2_0"
 MESSAGE_TYPES = DIDCommPrefix.qualify_all(
-    {REVOKE: f"{PROTOCOL_PACKAGE}.messages.revoke.Revoke"}
+    {
+        REVOKE: f"{PROTOCOL_PACKAGE}.messages.revoke.Revoke",
+        UNREVOKE: f"{PROTOCOL_PACKAGE}.messages.unrevoke.Unrevoke",
+    }
 )

aries_cloudagent/protocols/revocation_notification/v2_0/messages/revoke.py

@@ -49,7 +49,7 @@ class Meta:
 
     revocation_format = fields.Str(
         required=True,
-        validate=validate.OneOf(["indy-anoncreds"]),
+        validate=validate.OneOf(["indy-anoncreds", "anoncreds"]),
         metadata={
             "description": "The format of the credential revocation ID",
             "example": "indy-anoncreds",

aries_cloudagent/protocols/revocation_notification/v2_0/models/rev_notification_record.py

@@ -5,6 +5,10 @@
 from marshmallow import fields
 from marshmallow.utils import EXCLUDE
 
+from aries_cloudagent.protocols.revocation_notification.v2_0.messages.unrevoke import (
+    Unrevoke,
+)
+
 from .....core.profile import ProfileSession
 from .....messaging.models.base_record import BaseRecord, BaseRecordSchema
 from .....messaging.valid import (
@@ -46,6 +50,7 @@ def __init__(
         thread_id: str = None,
         comment: str = None,
         version: str = None,
+        unrevoke: bool = None,
         revocation_format: str = "indy-anoncreds",
         **kwargs,
     ):
@@ -57,6 +62,7 @@ def __init__(
         self.thread_id = thread_id
         self.comment = comment
         self.version = version
+        self.unrevoke = unrevoke
         self.revocation_format = revocation_format
 
     @property
@@ -67,7 +73,10 @@ def revocation_notification_id(self) -> Optional[str]:
     @property
     def record_value(self) -> dict:
         """Return record value."""
-        return {prop: getattr(self, prop) for prop in ("thread_id", "comment")}
+        return {
+            prop: getattr(self, prop)
+            for prop in ("thread_id", "comment", "revocation_format", "unrevoke")
+        }
 
     @classmethod
     async def query_by_ids(
@@ -84,7 +93,12 @@ async def query_by_ids(
             rev_reg_id: the rev reg id by which to filter
         """
         tag_filter = {
-            **{"version": "v2_0"},
+            **{
+                "$or": [
+                    {"version": "v2_0"},
+                    {"version": "v2_1"},
+                ]
+            },
             **{"cred_rev_id": cred_rev_id for _ in [""] if cred_rev_id},
             **{"rev_reg_id": rev_reg_id for _ in [""] if rev_reg_id},
         }
@@ -113,7 +127,12 @@ async def query_by_rev_reg_id(
             rev_reg_id: the rev reg id by which to filter
         """
         tag_filter = {
-            **{"version": "v2_0"},
+            **{
+                "$or": [
+                    {"version": "v2_0"},
+                    {"version": "v2_1"},
+                ]
+            },
             **{"rev_reg_id": rev_reg_id for _ in [""] if rev_reg_id},
         }
 
@@ -126,11 +145,19 @@ def to_message(self):
                 "No thread ID set on revocation notification record, "
                 "cannot create message"
             )
-        return Revoke(
-            revocation_format=self.revocation_format,
-            credential_id=f"{self.rev_reg_id}::{self.cred_rev_id}",
-            comment=self.comment,
-        )
+
+        if self.unrevoke and self.version == "v2_1":
+            return Unrevoke(
+                revocation_format=self.revocation_format,
+                credential_id=f"{self.rev_reg_id}::{self.cred_rev_id}",
+                comment=self.comment,
+            )
+        else:
+            return Revoke(
+                revocation_format=self.revocation_format,
+                credential_id=f"{self.rev_reg_id}::{self.cred_rev_id}",
+                comment=self.comment,
+            )
 
 
 class RevNotificationRecordSchema(BaseRecordSchema):
@@ -188,3 +215,7 @@ class Meta:
         required=False,
         metadata={"description": "Version of Revocation Notification to send out"},
     )
+    unrevoke = fields.Bool(
+        required=False,
+        metadata={"description": "If it is Unrevoked"},
+    )