[pull] main from hyperledger:main

.github/workflows/blackformat.yml

@@ -17,4 +17,4 @@ jobs:
       - name: Black Code Formatter Check
         # The version of black should be adjusted at the same time dev
         # dependencies are updated.
-        uses: psf/black@24.2.0
+        uses: psf/black@24.3.0

aries_cloudagent/config/argparse.py

@@ -618,12 +618,6 @@ def add_arguments(self, parser: ArgumentParser):
             env_var="ACAPY_PROFILE_ENDPOINT",
             help="Specifies the profile endpoint for the (public) DID.",
         )
-        parser.add_argument(
-            "--read-only-ledger",
-            action="store_true",
-            env_var="ACAPY_READ_ONLY_LEDGER",
-            help="Sets ledger to read-only to prevent updates. Default: false.",
-        )
         parser.add_argument(
             "--universal-resolver",
             type=str,
@@ -691,9 +685,6 @@ def get_settings(self, args: Namespace) -> dict:
         if args.profile_endpoint:
             settings["profile_endpoint"] = args.profile_endpoint
 
-        if args.read_only_ledger:
-            settings["read_only_ledger"] = True
-
         if args.universal_resolver_regex and not args.universal_resolver:
             raise ArgsParseError(
                 "--universal-resolver-regex cannot be used without --universal-resolver"
@@ -855,6 +846,12 @@ def add_arguments(self, parser: ArgumentParser):
                 "specified ledger or genesis configurations.  Default: false."
             ),
         )
+        parser.add_argument(
+            "--read-only-ledger",
+            action="store_true",
+            env_var="ACAPY_READ_ONLY_LEDGER",
+            help="Sets ledger to read-only to prevent updates. Default: false.",
+        )
         parser.add_argument(
             "--ledger-keepalive",
             default=5,
@@ -912,6 +909,9 @@ def get_settings(self, args: Namespace) -> dict:
             multi_configured = False
             update_pool_name = False
             write_ledger_specified = False
+
+            if args.read_only_ledger:
+                settings["read_only_ledger"] = True
             if args.genesis_url:
                 settings["ledger.genesis_url"] = args.genesis_url
                 single_configured = True
@@ -940,7 +940,7 @@ def get_settings(self, args: Namespace) -> dict:
                             txn_config["pool_name"] = txn_config["id"]
                         update_pool_name = True
                         ledger_config_list.append(txn_config)
-                    if not write_ledger_specified:
+                    if not write_ledger_specified and not args.read_only_ledger:
                         raise ArgsParseError(
                             "No write ledger genesis provided in multi-ledger config"
                         )

aries_cloudagent/config/ledger.py

@@ -110,10 +110,14 @@ async def load_multiple_genesis_transactions_from_config(settings: Settings):
         if "endorser_did" in config:
             config_item["endorser_did"] = config.get("endorser_did")
         ledger_txns_list.append(config_item)
-    if not write_ledger_set and not (
-        settings.get("ledger.genesis_transactions")
-        or settings.get("ledger.genesis_file")
-        or settings.get("ledger.genesis_url")
+    if (
+        not write_ledger_set
+        and not settings.get("ledger.read_only")
+        and not (
+            settings.get("ledger.genesis_transactions")
+            or settings.get("ledger.genesis_file")
+            or settings.get("ledger.genesis_url")
+        )
     ):
         raise ConfigError(
             "No is_write ledger set and no genesis_url,"

aries_cloudagent/connections/base_manager.py

@@ -5,7 +5,7 @@
 
 import json
 import logging
-from typing import List, Optional, Sequence, Text, Tuple, Union
+from typing import Dict, List, Optional, Sequence, Text, Tuple, Union
 
 import pydid
 from base58 import b58decode
@@ -52,7 +52,7 @@
 from ..utils.multiformats import multibase, multicodec
 from ..wallet.base import BaseWallet
 from ..wallet.crypto import create_keypair, seed_to_did
-from ..wallet.did_info import DIDInfo, KeyInfo
+from ..wallet.did_info import DIDInfo, KeyInfo, INVITATION_REUSE_KEY
 from ..wallet.did_method import PEER2, PEER4, SOV
 from ..wallet.error import WalletNotFoundError
 from ..wallet.key_type import ED25519
@@ -89,6 +89,12 @@ def _key_info_to_multikey(key_info: KeyInfo) -> str:
             multicodec.wrap("ed25519-pub", b58decode(key_info.verkey)), "base58btc"
         )
 
+    def long_did_peer_to_short(self, long_did: str) -> DIDInfo:
+        """Convert did:peer:4 long format to short format and return."""
+
+        short_did_peer = long_to_short(long_did)
+        return short_did_peer
+
     async def long_did_peer_4_to_short(self, long_dp4: str) -> DIDInfo:
         """Convert did:peer:4 long format to short format and store in wallet."""
 
@@ -113,6 +119,7 @@ async def create_did_peer_4(
         self,
         svc_endpoints: Optional[Sequence[str]] = None,
         mediation_records: Optional[List[MediationRecord]] = None,
+        metadata: Optional[Dict] = None,
     ) -> DIDInfo:
         """Create a did:peer:4 DID for a connection.
 
@@ -159,8 +166,13 @@ async def create_did_peer_4(
             )
             did = encode(input_doc)
 
+            did_metadata = metadata if metadata else {}
             did_info = DIDInfo(
-                did=did, method=PEER4, verkey=key.verkey, metadata={}, key_type=ED25519
+                did=did,
+                method=PEER4,
+                verkey=key.verkey,
+                metadata=did_metadata,
+                key_type=ED25519,
             )
             await wallet.store_did(did_info)
 
@@ -170,6 +182,7 @@ async def create_did_peer_2(
         self,
         svc_endpoints: Optional[Sequence[str]] = None,
         mediation_records: Optional[List[MediationRecord]] = None,
+        metadata: Optional[Dict] = None,
     ) -> DIDInfo:
         """Create a did:peer:2 DID for a connection.
 
@@ -215,13 +228,39 @@ async def create_did_peer_2(
                 [KeySpec.verification(self._key_info_to_multikey(key))], services
             )
 
+            did_metadata = metadata if metadata else {}
             did_info = DIDInfo(
-                did=did, method=PEER2, verkey=key.verkey, metadata={}, key_type=ED25519
+                did=did,
+                method=PEER2,
+                verkey=key.verkey,
+                metadata=did_metadata,
+                key_type=ED25519,
             )
             await wallet.store_did(did_info)
 
         return did_info
 
+    async def fetch_invitation_reuse_did(
+        self,
+        did_method: str,
+    ) -> DIDDoc:
+        """Fetch a DID from the wallet to use across multiple invitations.
+
+        Args:
+            did_method: The DID method used (e.g. PEER2 or PEER4)
+
+        Returns:
+            The `DIDDoc` instance, or "None" if no DID is found
+        """
+        did_info = None
+        async with self._profile.session() as session:
+            wallet = session.inject(BaseWallet)
+            did_list = await wallet.get_local_dids()
+            for did in did_list:
+                if did.method == did_method and INVITATION_REUSE_KEY in did.metadata:
+                    return did
+        return did_info
+
     async def create_did_document(
         self,
         did_info: DIDInfo,
@@ -314,7 +353,7 @@ async def store_did_document(self, value: Union[DIDDoc, dict]):
                 await storage.update_record(record, doc, {"did": did})
 
         await self.remove_keys_for_did(did)
-        await self.record_did(did)
+        await self.record_keys_for_resolvable_did(did)
 
     async def add_key_for_did(self, did: str, key: str):
         """Store a verkey for lookup against a DID.
@@ -346,7 +385,10 @@ async def find_did_for_key(self, key: str) -> str:
         async with self._profile.session() as session:
             storage: BaseStorage = session.inject(BaseStorage)
             record = await storage.find_record(self.RECORD_TYPE_DID_KEY, {"key": key})
-        return record.tags["did"]
+        ret_did = record.tags["did"]
+        if ret_did.startswith("did:peer:4"):
+            ret_did = self.long_did_peer_to_short(ret_did)
+        return ret_did
 
     async def remove_keys_for_did(self, did: str):
         """Remove all keys associated with a DID.
@@ -441,8 +483,8 @@ async def resolve_invitation(
             [self._extract_key_material_in_base58_format(key) for key in routing_keys],
         )
 
-    async def record_did(self, did: str):
-        """Record DID for later use.
+    async def record_keys_for_resolvable_did(self, did: str):
+        """Record the keys for a public DID.
 
         This is required to correlate sender verkeys back to a connection.
         """
@@ -739,6 +781,21 @@ async def get_connection_targets(
             targets = await self.fetch_connection_targets(connection)
         return targets
 
+    async def clear_connection_targets_cache(self, connection_id: str):
+        """Clear the connection targets cache for a given connection ID.
+
+        Historically, connections have not been updatable after the protocol
+        completes. However, with DID Rotation, we need to be able to update
+        the connection targets and clear the cache of targets.
+        """
+        # TODO it would be better to include the DIDs of the connection in the
+        # target cache key This solution only works when using whole cluster
+        # caching or have only a single instance with local caching
+        cache = self._profile.inject_or(BaseCache)
+        if cache:
+            cache_key = f"connection_target::{connection_id}"
+            await cache.clear(cache_key)
+
     def diddoc_connection_targets(
         self,
         doc: Optional[Union[DIDDoc, dict]],
@@ -959,6 +1016,7 @@ async def get_endpoints(self, conn_id: str) -> Tuple[Optional[str], Optional[str
             connection = await ConnRecord.retrieve_by_id(session, conn_id)
             wallet = session.inject(BaseWallet)
             my_did_info = await wallet.get_local_did(connection.my_did)
+
         my_endpoint = my_did_info.metadata.get(
             "endpoint",
             self._profile.settings.get("default_endpoint"),

aries_cloudagent/connections/models/conn_record.py

@@ -360,13 +360,16 @@ async def retrieve_by_invitation_msg_id(
     async def find_existing_connection(
         cls, session: ProfileSession, their_public_did: str
     ) -> Optional["ConnRecord"]:
-        """Retrieve existing active connection records (public did).
+        """Retrieve existing active connection records (public did or did:peer).
 
         Args:
             session: The active profile session
-            their_public_did: Inviter public DID
+            their_public_did: Inviter public DID (or did:peer)
         """
-        tag_filter = {"their_public_did": their_public_did}
+        if their_public_did.startswith("did:peer"):
+            tag_filter = {"their_did": their_public_did}
+        else:
+            tag_filter = {"their_public_did": their_public_did}
         conn_records = await cls.query(
             session,
             tag_filter=tag_filter,

aries_cloudagent/connections/tests/test_base_manager.py

@@ -1074,7 +1074,7 @@ async def test_resolve_connection_targets_x_unsupported_key(self):
             await self.manager.resolve_connection_targets(did)
         assert "not supported" in str(cm.exception)
 
-    async def test_record_did_empty(self):
+    async def test_record_keys_for_resolvable_did_empty(self):
         did = "did:sov:" + self.test_did
         service_builder = ServiceBuilder(DID(did))
         service_builder.add_didcomm(
@@ -1083,9 +1083,9 @@ async def test_record_did_empty(self):
         self.manager.resolve_didcomm_services = mock.CoroutineMock(
             return_value=(DIDDocument(id=DID(did)), service_builder.services)
         )
-        await self.manager.record_did(did)
+        await self.manager.record_keys_for_resolvable_did(did)
 
-    async def test_record_did(self):
+    async def test_record_keys_for_resolvable_did(self):
         did = "did:sov:" + self.test_did
         doc_builder = DIDDocumentBuilder(did)
         vm = doc_builder.verification_method.add(
@@ -1099,7 +1099,7 @@ async def test_record_did(self):
         self.manager.resolve_didcomm_services = mock.CoroutineMock(
             return_value=(doc, doc.service)
         )
-        await self.manager.record_did(did)
+        await self.manager.record_keys_for_resolvable_did(did)
 
     async def test_diddoc_connection_targets_diddoc_underspecified(self):
         with self.assertRaises(BaseConnectionManagerError):

aries_cloudagent/messaging/valid.py

@@ -932,6 +932,9 @@ def __init__(
 DID_POSTURE_VALIDATE = DIDPosture()
 DID_POSTURE_EXAMPLE = DIDPosture.EXAMPLE
 
+DID_WEB_VALIDATE = DIDWeb()
+DID_WEB_EXAMPLE = DIDWeb.EXAMPLE
+
 ROUTING_KEY_VALIDATE = RoutingKey()
 ROUTING_KEY_EXAMPLE = RoutingKey.EXAMPLE
 

aries_cloudagent/protocols/did_rotate/definition.py

@@ -0,0 +1,10 @@
+"""Version definitions for this protocol."""
+
+versions = [
+    {
+        "major_version": 1,
+        "minimum_minor_version": 0,
+        "current_minor_version": 0,
+        "path": "v1_0",
+    }
+]

aries_cloudagent/protocols/did_rotate/v1_0/handlers/ack_handler.py

@@ -0,0 +1,29 @@
+"""Rotate ack handler."""
+
+from .....messaging.base_handler import BaseHandler
+from .....messaging.request_context import RequestContext
+from .....messaging.responder import BaseResponder
+from ..manager import DIDRotateManager
+from ..messages.ack import RotateAck
+
+
+class RotateAckHandler(BaseHandler):
+    """Message handler class for rotate ack message."""
+
+    async def handle(self, context: RequestContext, responder: BaseResponder):
+        """Handle rotate ack message.
+
+        Args:
+            context: request context
+            responder: responder callback
+        """
+        self._logger.debug("RotateAckHandler called with context %s", context)
+        assert isinstance(context.message, RotateAck)
+
+        connection_record = context.connection_record
+        ack = context.message
+
+        profile = context.profile
+        did_rotate_mgr = DIDRotateManager(profile)
+
+        await did_rotate_mgr.receive_ack(connection_record, ack)

aries_cloudagent/protocols/did_rotate/v1_0/handlers/hangup_handler.py

@@ -0,0 +1,28 @@
+"""Rotate hangup handler."""
+
+from .....messaging.base_handler import BaseHandler
+from .....messaging.request_context import RequestContext
+from .....messaging.responder import BaseResponder
+from ..manager import DIDRotateManager
+from ..messages.hangup import Hangup
+
+
+class HangupHandler(BaseHandler):
+    """Message handler class for rotate message."""
+
+    async def handle(self, context: RequestContext, responder: BaseResponder):
+        """Handle rotate hangup message.
+
+        Args:
+            context: request context
+            responder: responder callback
+        """
+        self._logger.debug("HangupHandler called with context %s", context)
+        assert isinstance(context.message, Hangup)
+
+        connection_record = context.connection_record
+
+        profile = context.profile
+        did_rotate_mgr = DIDRotateManager(profile)
+
+        await did_rotate_mgr.receive_hangup(connection_record)