merge

.github/workflows/integrationtests.yml

@@ -16,10 +16,10 @@ jobs:
         uses: actions/checkout@v2
         with:
           path: acapy
-      - name: run-von-network
-        uses: ./acapy/actions/run-von-network
-      - name: run-indy-tails-server
-        uses: ./acapy/actions/run-indy-tails-server
+      #- name: run-von-network
+      #  uses: ./acapy/actions/run-von-network
+      #- name: run-indy-tails-server
+      #  uses: ./acapy/actions/run-indy-tails-server
       - name: run-integration-tests
         uses: ./acapy/actions/run-integration-tests
         # to run with a specific set of tests include the following parameter:

CHANGELOG.md

@@ -1,3 +1,32 @@
+# 0.7.1
+
+## August 31, 2021
+
+A relatively minor maintenance release to address issues found since the 0.7.0 Release.
+Includes some cleanups of JSON-LD Verifiable Credentials and Verifiable Presentations
+
+- W3C  Verifiable Credential cleanups
+  - Timezone inclusion [ISO 8601] for W3C VC and Proofs ([#1373](https://github.com/hyperledger/aries-cloudagent-python/pull/1373))
+  - W3C VC handling where attachment is JSON and not Base64 encoded ([#1352](https://github.com/hyperledger/aries-cloudagent-python/pull/1352))
+- Refactor outbound queue interface ([#1348](https://github.com/hyperledger/aries-cloudagent-python/pull/1348))
+- Command line parameter handling for arbitrary plugins ([#1347](https://github.com/hyperledger/aries-cloudagent-python/pull/1347))
+- Add an optional parameter '--ledger-socks-proxy' ([#1342](https://github.com/hyperledger/aries-cloudagent-python/pull/1342))
+- OOB Protocol - CredentialOffer Support ([#1316](https://github.com/hyperledger/aries-cloudagent-python/pull/1316)), ([#1216](https://github.com/hyperledger/aries-cloudagent-python/pull/1216))
+- Updated IndyCredPrecisSchema - pres_referents renamed to presentation_referents ([#1334](https://github.com/hyperledger/aries-cloudagent-python/pull/1334))
+- Handle unpadded protected header in PackWireFormat::get_recipient_keys ([#1324](https://github.com/hyperledger/aries-cloudagent-python/pull/1324))
+- Initial cut of OpenAPI Code Generation guidelines ([#1339](https://github.com/hyperledger/aries-cloudagent-python/pull/1339))
+- Correct revocation API in credential revocation documentation ([#612](https://github.com/hyperledger/aries-cloudagent-python/pull/612))
+- Documentation updates for Read-The-Docs ([#1359](https://github.com/hyperledger/aries-cloudagent-python/pull/1359),
+[#1366](https://github.com/hyperledger/aries-cloudagent-python/pull/1366), [#1371](https://github.com/hyperledger/aries-cloudagent-python/pull/1371))
+- Add `inject_or` method to dynamic injection framework to resolve typing ambiguity ([#1376](https://github.com/hyperledger/aries-cloudagent-python/pull/1376))
+- Other fixes:
+  - Indy Proof processing fix, error not raised in predicate timestamp check ([#1364](https://github.com/hyperledger/aries-cloudagent-python/pull/1364))
+  - Problem Report handler for connection specific problems ([#1356](https://github.com/hyperledger/aries-cloudagent-python/pull/1356))
+  - fix: error on deserializing conn record with protocol ([#1325](https://github.com/hyperledger/aries-cloudagent-python/pull/1325))
+  - fix: failure to verify jsonld on non-conformant doc but vaild vmethod ([#1301](https://github.com/hyperledger/aries-cloudagent-python/pull/1301))
+  - fix: allow underscore in endpoints ([#1378](https://github.com/hyperledger/aries-cloudagent-python/pull/1378))
+
+
 # 0.7.0
 
 ## July 14, 2021

actions/run-integration-tests/action.yml

@@ -6,13 +6,21 @@ inputs:
     description: "Set of flags that defines the test scope"
     required: false
     default: "-t @GHA"
+  IN_LEDGER_URL:
+    description: "URL to the von network ledger browser"
+    required: false
+    default: "http://test.bcovrin.vonx.io"
+  IN_PUBLIC_TAILS_URL:
+    description: "URL to the tails server"
+    required: false
+    default: "https://tails.vonx.io"
 runs:
   using: "composite"
   steps:
     - name: run-integration-tests-acapy
       # to run with external ledger and tails server run as follows (and remove the ledger and tails actions from the workflow):
       # run: LEDGER_URL=http://test.bcovrin.vonx.io PUBLIC_TAILS_URL=https://tails.vonx.io ./run_bdd ${{ inputs.TEST_SCOPE }}
-      run: ./run_bdd ${{ inputs.TEST_SCOPE }}
+      run: LEDGER_URL=${{inputs.IN_LEDGER_URL}} PUBLIC_TAILS_URL=${{inputs.IN_PUBLIC_TAILS_URL}} ./run_bdd ${{ inputs.TEST_SCOPE }}
       shell: bash
       env:
         NO_TTY: "1"

aries_cloudagent/admin/request_context.py

@@ -61,9 +61,7 @@ def inject(
         self,
         base_cls: Type[InjectType],
         settings: Mapping[str, object] = None,
-        *,
-        required: bool = True
-    ) -> Optional[InjectType]:
+    ) -> InjectType:
         """
         Get the provided instance of a given class identifier.
 
@@ -75,7 +73,27 @@ def inject(
             An instance of the base class, or None
 
         """
-        return self._context.inject(base_cls, settings, required=required)
+        return self._context.inject(base_cls, settings)
+
+    def inject_or(
+        self,
+        base_cls: Type[InjectType],
+        settings: Mapping[str, object] = None,
+        default: Optional[InjectType] = None,
+    ) -> Optional[InjectType]:
+        """
+        Get the provided instance of a given class identifier or default if not found.
+
+        Args:
+            base_cls: The base class to retrieve an instance of
+            settings: An optional dict providing configuration to the provider
+            default: default return value if no instance is found
+
+        Returns:
+            An instance of the base class, or None
+
+        """
+        return self._context.inject_or(base_cls, settings, default)
 
     def update_settings(self, settings: Mapping[str, object]):
         """Update the current scope with additional settings."""
@@ -96,17 +114,26 @@ def test_context(
     def _test_session(self) -> ProfileSession:
         session = self.profile.session(self._context)
 
-        def _inject(base_cls, required=True):
+        def _inject(base_cls):
             if session._active and base_cls in self.session_inject:
                 ret = self.session_inject[base_cls]
-                if ret is None and required:
+                if ret is None:
                     raise InjectionError(
                         "No instance provided for class: {}".format(base_cls.__name__)
                     )
                 return ret
-            return session._context.injector.inject(base_cls, required=required)
+            return session._context.injector.inject(base_cls)
+
+        def _inject_or(base_cls, default=None):
+            if session._active and base_cls in self.session_inject:
+                ret = self.session_inject[base_cls]
+                if ret is None:
+                    ret = default
+                return ret
+            return session._context.injector.inject_or(base_cls, default)
 
         setattr(session, "inject", _inject)
+        setattr(session, "inject_or", _inject_or)
         return session
 
     def __repr__(self) -> str:

aries_cloudagent/admin/server.py

@@ -26,7 +26,7 @@
 from ..ledger.error import LedgerConfigError, LedgerTransactionError
 from ..messaging.models.openapi import OpenAPISchema
 from ..messaging.responder import BaseResponder
-from ..multitenant.manager import MultitenantManager, MultitenantManagerError
+from ..multitenant.base import BaseMultitenantManager, MultitenantManagerError
 from ..storage.error import StorageNotFoundError
 from ..transport.outbound.message import OutboundMessage
 from ..transport.outbound.status import OutboundSendStatus
@@ -251,7 +251,7 @@ def __init__(
         self.webhook_router = webhook_router
         self.websocket_queues = {}
         self.site = None
-        self.multitenant_manager = context.inject(MultitenantManager, required=False)
+        self.multitenant_manager = context.inject_or(BaseMultitenantManager)
 
         self.server_paths = []
 
@@ -293,7 +293,7 @@ async def check_token(request: web.Request, handler):
 
             middlewares.append(check_token)
 
-        collector = self.context.inject(Collector, required=False)
+        collector = self.context.inject_or(Collector)
 
         if self.multitenant_manager:
 
@@ -393,7 +393,7 @@ async def setup_context(request: web.Request, handler):
         self.server_paths = [route.path for route in server_routes]
         app.add_routes(server_routes)
 
-        plugin_registry = self.context.inject(PluginRegistry, required=False)
+        plugin_registry = self.context.inject_or(PluginRegistry)
         if plugin_registry:
             await plugin_registry.register_admin_routes(app)
 
@@ -445,11 +445,11 @@ def sort_dict(raw: dict) -> dict:
         runner = web.AppRunner(self.app)
         await runner.setup()
 
-        plugin_registry = self.context.inject(PluginRegistry, required=False)
+        plugin_registry = self.context.inject_or(PluginRegistry)
         if plugin_registry:
             plugin_registry.post_process_routes(self.app)
 
-        event_bus = self.context.inject(EventBus, required=False)
+        event_bus = self.context.inject_or(EventBus)
         if event_bus:
             event_bus.subscribe(EVENT_PATTERN_WEBHOOK, self._on_webhook_event)
             event_bus.subscribe(EVENT_PATTERN_RECORD, self._on_record_event)
@@ -548,7 +548,7 @@ async def plugins_handler(self, request: web.BaseRequest):
             The module list response
 
         """
-        registry = self.context.inject(PluginRegistry, required=False)
+        registry = self.context.inject_or(PluginRegistry)
         plugins = registry and sorted(registry.plugin_names) or []
         return web.json_response({"result": plugins})
 
@@ -602,7 +602,7 @@ async def status_handler(self, request: web.BaseRequest):
         """
         status = {"version": __version__}
         status["label"] = self.context.settings.get("default_label")
-        collector = self.context.inject(Collector, required=False)
+        collector = self.context.inject_or(Collector)
         if collector:
             status["timing"] = collector.results
         if self.conductor_stats:
@@ -622,7 +622,7 @@ async def status_reset_handler(self, request: web.BaseRequest):
             The web response
 
         """
-        collector = self.context.inject(Collector, required=False)
+        collector = self.context.inject_or(Collector)
         if collector:
             collector.reset()
         return web.json_response({})

aries_cloudagent/admin/tests/test_admin_server.py

@@ -197,8 +197,8 @@ async def test_import_routes_multitenant_middleware(self):
         context.injector.bind_instance(ProtocolRegistry, ProtocolRegistry())
         profile = InMemoryProfile.test_profile()
         context.injector.bind_instance(
-            test_module.MultitenantManager,
-            test_module.MultitenantManager(profile),
+            test_module.BaseMultitenantManager,
+            test_module.BaseMultitenantManager(profile),
         )
         await DefaultContextBuilder().load_plugins(context)
         server = self.get_admin_server(

aries_cloudagent/admin/tests/test_request_context.py

@@ -22,4 +22,4 @@ async def test_session_inject_x(self):
         test_ctx = test_module.AdminRequestContext.test_context({Collector: None})
         async with test_ctx.session() as test_sesn:
             with self.assertRaises(test_module.InjectionError):
-                test_sesn.inject(Collector, required=True)
+                test_sesn.inject(Collector)

aries_cloudagent/askar/profile.py

@@ -54,6 +54,11 @@ def store(self) -> Store:
         """Accessor for the opened Store instance."""
         return self.opened.store
 
+    async def remove(self):
+        """Remove the profile."""
+        if self.settings.get("multitenant.wallet_type") == "askar-profile":
+            await self.store.remove_profile(self.settings.get("wallet.askar_profile"))
+
     def init_ledger_pool(self):
         """Initialize the ledger pool."""
         if self.settings.get("ledger.disabled"):
@@ -67,7 +72,7 @@ def init_ledger_pool(self):
         if read_only:
             LOGGER.error("Note: setting ledger to read-only mode")
         genesis_transactions = self.settings.get("ledger.genesis_transactions")
-        cache = self.context.injector.inject(BaseCache, required=False)
+        cache = self.context.injector.inject_or(BaseCache)
         self.ledger_pool = IndyVdrLedgerPool(
             pool_name,
             keepalive=keepalive,
@@ -154,10 +159,11 @@ def __init__(
     ):
         """Create a new IndySdkProfileSession instance."""
         super().__init__(profile=profile, context=context, settings=settings)
+        profile_id = profile.context.settings.get("wallet.askar_profile")
         if is_txn:
-            self._opener = self.profile.store.transaction()
+            self._opener = self.profile.store.transaction(profile_id)
         else:
-            self._opener = self.profile.store.session()
+            self._opener = self.profile.store.session(profile_id)
         self._handle: Session = None
         self._acquire_start: float = None
         self._acquire_end: float = None

aries_cloudagent/askar/store.py

@@ -41,6 +41,15 @@ def __init__(self, config: dict = None):
         self.key_derivation_method = (
             config.get("key_derivation_method") or self.DEFAULT_KEY_DERIVATION
         )
+
+        if (
+            self.key_derivation_method.lower() == self.KEY_DERIVATION_RAW.lower()
+            and self.key == ""
+        ):
+            raise ProfileError(
+                f"With key derivation method '{self.KEY_DERIVATION_RAW}',"
+                "key should also be provided"
+            )
         # self.rekey = config.get("rekey")
         # self.rekey_derivation_method = config.get("rekey_derivation_method")
 

aries_cloudagent/askar/tests/test_profile.py

@@ -0,0 +1,86 @@
+import asyncio
+import pytest
+
+from asynctest import TestCase as AsyncTestCase, mock
+
+from ...askar.profile import AskarProfile
+from ...config.injection_context import InjectionContext
+
+from .. import profile as test_module
+
+
+class TestProfile(AsyncTestCase):
+    @mock.patch("aries_cloudagent.askar.store.AskarOpenStore")
+    async def test_init_success(self, AskarOpenStore):
+        askar_profile = AskarProfile(
+            AskarOpenStore,
+        )
+
+        assert askar_profile.opened == AskarOpenStore
+
+    @mock.patch("aries_cloudagent.askar.store.AskarOpenStore")
+    async def test_remove_success(self, AskarOpenStore):
+        openStore = AskarOpenStore
+        context = InjectionContext()
+        profile_id = "profile_id"
+        context.settings = {
+            "multitenant.wallet_type": "askar-profile",
+            "wallet.askar_profile": profile_id,
+        }
+        askar_profile = AskarProfile(openStore, context)
+        remove_profile_stub = asyncio.Future()
+        remove_profile_stub.set_result(True)
+        openStore.store.remove_profile.return_value = remove_profile_stub
+
+        await askar_profile.remove()
+
+        openStore.store.remove_profile.assert_called_once_with(profile_id)
+
+    @mock.patch("aries_cloudagent.askar.store.AskarOpenStore")
+    async def test_remove_profile_not_removed_if_wallet_type_not_askar_profile(
+        self, AskarOpenStore
+    ):
+        openStore = AskarOpenStore
+        context = InjectionContext()
+        context.settings = {"multitenant.wallet_type": "basic"}
+        askar_profile = AskarProfile(openStore, context)
+
+        await askar_profile.remove()
+
+        openStore.store.remove_profile.assert_not_called()
+
+    @pytest.mark.asyncio
+    async def test_profile_manager_transaction(self):
+        profile = "profileId"
+
+        with mock.patch("aries_cloudagent.askar.profile.AskarProfile") as AskarProfile:
+            askar_profile = AskarProfile(None, True)
+            askar_profile_transaction = mock.MagicMock()
+            askar_profile.store.transaction.return_value = askar_profile_transaction
+            askar_profile.context.settings.get.return_value = profile
+
+            transactionProfile = test_module.AskarProfileSession(askar_profile, True)
+
+            assert transactionProfile._opener == askar_profile_transaction
+            askar_profile.context.settings.get.assert_called_once_with(
+                "wallet.askar_profile"
+            )
+            askar_profile.store.transaction.assert_called_once_with(profile)
+
+    @pytest.mark.asyncio
+    async def test_profile_manager_store(self):
+        profile = "profileId"
+
+        with mock.patch("aries_cloudagent.askar.profile.AskarProfile") as AskarProfile:
+            askar_profile = AskarProfile(None, False)
+            askar_profile_session = mock.MagicMock()
+            askar_profile.store.session.return_value = askar_profile_session
+            askar_profile.context.settings.get.return_value = profile
+
+            sessionProfile = test_module.AskarProfileSession(askar_profile, False)
+
+            assert sessionProfile._opener == askar_profile_session
+            askar_profile.context.settings.get.assert_called_once_with(
+                "wallet.askar_profile"
+            )
+            askar_profile.store.session.assert_called_once_with(profile)