Merge branch 'feature/keytypes-pluggable' into feature/did-method-key-type-registry

Author: burdettadam

aries_cloudagent/config/default_context.py

@@ -18,6 +18,7 @@
 from ..utils.dependencies import is_indy_sdk_module_installed
 from ..utils.stats import Collector
 from ..wallet.did_method import DIDMethods
+from ..wallet.key_type import KeyTypes
 from .base_context import ContextBuilder
 from .injection_context import InjectionContext
 from .provider import CachedProvider, ClassProvider
@@ -51,6 +52,7 @@ async def build_context(self) -> InjectionContext:
         # Global did resolver
         context.injector.bind_instance(DIDResolver, DIDResolver([]))
         context.injector.bind_instance(DIDMethods, DIDMethods())
+        context.injector.bind_instance(KeyTypes, KeyTypes())
 
         await self.bind_providers(context)
         await self.load_plugins(context)
@@ -68,7 +70,8 @@ async def bind_providers(self, context: InjectionContext):
         # so it can be shared by all wallet instances. If we set it in the indy sdk
         # profile provider it could mean other wallets won't have access to the provider
         if is_indy_sdk_module_installed():
-            from ..ledger.indy import IndySdkLedgerPool, IndySdkLedgerPoolProvider
+            from ..ledger.indy import (IndySdkLedgerPool,
+                                       IndySdkLedgerPoolProvider)
 
             context.injector.bind_provider(
                 IndySdkLedgerPool,

aries_cloudagent/config/wallet.py

@@ -12,7 +12,7 @@
 from ..wallet.crypto import seed_to_did
 from ..wallet.did_info import DIDInfo
 from ..wallet.did_method import SOV
-from ..wallet.key_type import KeyType
+from ..wallet.key_type import ED25519
 from .base import ConfigError
 from .injection_context import InjectionContext
 
@@ -79,7 +79,7 @@ async def wallet_config(
         if wallet_seed and seed_to_did(wallet_seed) != public_did:
             if context.settings.get("wallet.replace_public_did"):
                 replace_did_info = await wallet.create_local_did(
-                    method=SOV, key_type=KeyType.ED25519, seed=wallet_seed
+                    method=SOV, key_type=ED25519, seed=wallet_seed
                 )
                 public_did = replace_did_info.did
                 await wallet.set_public_did(public_did)
@@ -100,7 +100,7 @@ async def wallet_config(
 
             local_did_info = await wallet.create_local_did(
                 method=SOV,
-                key_type=KeyType.ED25519,
+                key_type=ED25519,
                 seed=wallet_seed,
                 metadata=metadata,
             )
@@ -110,7 +110,7 @@ async def wallet_config(
                 print(f"Verkey: {local_did_info.verkey}")
         else:
             public_did_info = await wallet.create_public_did(
-                method=SOV, key_type=KeyType.ED25519, seed=wallet_seed
+                method=SOV, key_type=ED25519, seed=wallet_seed
             )
             public_did = public_did_info.did
             if provision:
@@ -129,7 +129,7 @@ async def wallet_config(
     if test_seed:
         await wallet.create_local_did(
             method=SOV,
-            key_type=KeyType.ED25519,
+            key_type=ED25519,
             seed=test_seed,
             metadata={"endpoint": "1.2.3.4:8021"},
         )

aries_cloudagent/core/tests/test_conductor.py

@@ -8,25 +8,19 @@
 from ...config.injection_context import InjectionContext
 from ...connections.models.conn_record import ConnRecord
 from ...connections.models.connection_target import ConnectionTarget
-from ...connections.models.diddoc import (
-    DIDDoc,
-    PublicKey,
-    PublicKeyType,
-    Service,
-)
+from ...connections.models.diddoc import (DIDDoc, PublicKey, PublicKeyType,
+                                          Service)
 from ...core.event_bus import EventBus, MockEventBus
 from ...core.in_memory import InMemoryProfileManager
 from ...core.profile import ProfileManager
 from ...core.protocol_registry import ProtocolRegistry
-from ...protocols.coordinate_mediation.mediation_invite_store import (
-    MediationInviteRecord,
-)
-from ...protocols.coordinate_mediation.v1_0.models.mediation_record import (
-    MediationRecord,
-)
-from ...resolver.did_resolver import DIDResolver
 from ...multitenant.base import BaseMultitenantManager
 from ...multitenant.manager import MultitenantManager
+from ...protocols.coordinate_mediation.mediation_invite_store import \
+    MediationInviteRecord
+from ...protocols.coordinate_mediation.v1_0.models.mediation_record import \
+    MediationRecord
+from ...resolver.did_resolver import DIDResolver
 from ...storage.base import BaseStorage
 from ...storage.error import StorageNotFoundError
 from ...transport.inbound.message import InboundMessage
@@ -35,14 +29,13 @@
 from ...transport.outbound.manager import QueuedOutboundMessage
 from ...transport.outbound.message import OutboundMessage
 from ...transport.outbound.status import OutboundSendStatus
-from ...transport.wire_format import BaseWireFormat
 from ...transport.pack_format import PackWireFormat
+from ...transport.wire_format import BaseWireFormat
 from ...utils.stats import Collector
 from ...version import __version__
 from ...wallet.base import BaseWallet
-from ...wallet.key_type import KeyType
 from ...wallet.did_method import SOV
-
+from ...wallet.key_type import ED25519
 from .. import conductor as test_module
 
 
@@ -132,7 +125,7 @@ async def test_startup(self):
             wallet = session.inject(BaseWallet)
             await wallet.create_public_did(
                 SOV,
-                KeyType.ED25519,
+                ED25519,
             )
 
             mock_inbound_mgr.return_value.setup.assert_awaited_once()
@@ -601,7 +594,7 @@ async def test_admin(self):
         wallet = session.inject(BaseWallet)
         await wallet.create_public_did(
             SOV,
-            KeyType.ED25519,
+            ED25519,
         )
 
         with async_mock.patch.object(
@@ -645,7 +638,7 @@ async def test_admin_startx(self):
         wallet = session.inject(BaseWallet)
         await wallet.create_public_did(
             SOV,
-            KeyType.ED25519,
+            ED25519,
         )
 
         with async_mock.patch.object(
@@ -717,7 +710,7 @@ async def test_start_static(self):
             wallet = session.inject(BaseWallet)
             await wallet.create_public_did(
                 SOV,
-                KeyType.ED25519,
+                ED25519,
             )
 
             mock_mgr.return_value.create_static_connection = async_mock.AsyncMock()
@@ -887,7 +880,7 @@ async def test_print_invite_connection(self):
             wallet = session.inject(BaseWallet)
             await wallet.create_public_did(
                 SOV,
-                KeyType.ED25519,
+                ED25519,
             )
 
             await conductor.start()
@@ -1390,7 +1383,7 @@ async def test_startup_x_version_mismatch(self):
             wallet = session.inject(BaseWallet)
             await wallet.create_public_did(
                 SOV,
-                KeyType.ED25519,
+                ED25519,
             )
 
             mock_inbound_mgr.return_value.setup.assert_awaited_once()
@@ -1427,7 +1420,7 @@ async def test_startup_x_no_storage_version(self):
             wallet = session.inject(BaseWallet)
             await wallet.create_public_did(
                 SOV,
-                KeyType.ED25519,
+                ED25519,
             )
 
             mock_inbound_mgr.return_value.setup.assert_awaited_once()

aries_cloudagent/did/did_key.py

@@ -1,7 +1,15 @@
 """DID Key class and resolver methods."""
 
 from ..wallet.crypto import ed25519_pk_to_curve25519
-from ..wallet.key_type import KeyType
+from ..wallet.key_type import (
+    BLS12381G1G2,
+    ED25519,
+    KeyType,
+    BLS12381G1,
+    X25519,
+    BLS12381G2,
+    KeyTypes,
+)
 from ..wallet.util import b58_to_bytes, bytes_to_b58
 
 from ..vc.ld_proofs.constants import DID_V1_CONTEXT_URL
@@ -31,7 +39,7 @@ def from_public_key_b58(cls, public_key: str, key_type: KeyType) -> "DIDKey":
         return cls.from_public_key(public_key_bytes, key_type)
 
     @classmethod
-    def from_fingerprint(cls, fingerprint: str) -> "DIDKey":
+    def from_fingerprint(cls, fingerprint: str, key_types=None) -> "DIDKey":
         """Initialize new DIDKey instance from multibase encoded fingerprint.
 
         The fingerprint contains both the public key and key type.
@@ -43,7 +51,9 @@ def from_fingerprint(cls, fingerprint: str) -> "DIDKey":
         key_bytes_with_prefix = b58_to_bytes(fingerprint[1:])
 
         # Get associated key type with prefixed bytes
-        key_type = KeyType.from_prefixed_bytes(key_bytes_with_prefix)
+        if not key_types:
+            key_types = KeyTypes()
+        key_type = key_types.from_prefixed_bytes(key_bytes_with_prefix)
 
         if not key_type:
             raise Exception(
@@ -169,8 +179,8 @@ def construct_did_key_bls12381g1g2(did_key: "DIDKey") -> dict:
     g1_public_key = did_key.public_key[:48]
     g2_public_key = did_key.public_key[48:]
 
-    bls12381g1_key = DIDKey.from_public_key(g1_public_key, KeyType.BLS12381G1)
-    bls12381g2_key = DIDKey.from_public_key(g2_public_key, KeyType.BLS12381G2)
+    bls12381g1_key = DIDKey.from_public_key(g1_public_key, BLS12381G1)
+    bls12381g2_key = DIDKey.from_public_key(g2_public_key, BLS12381G2)
 
     bls12381g1_key_id = f"{did_key.did}#{bls12381g1_key.fingerprint}"
     bls12381g2_key_id = f"{did_key.did}#{bls12381g2_key.fingerprint}"
@@ -241,7 +251,7 @@ def construct_did_key_ed25519(did_key: "DIDKey") -> dict:
 
     """
     curve25519 = ed25519_pk_to_curve25519(did_key.public_key)
-    x25519 = DIDKey.from_public_key(curve25519, KeyType.X25519)
+    x25519 = DIDKey.from_public_key(curve25519, X25519)
 
     did_doc = construct_did_signature_key_base(
         id=did_key.did,
@@ -289,9 +299,9 @@ def construct_did_signature_key_base(
 
 
 DID_KEY_RESOLVERS = {
-    KeyType.ED25519: construct_did_key_ed25519,
-    KeyType.X25519: construct_did_key_x25519,
-    KeyType.BLS12381G2: construct_did_key_bls12381g2,
-    KeyType.BLS12381G1: construct_did_key_bls12381g1,
-    KeyType.BLS12381G1G2: construct_did_key_bls12381g1g2,
+    ED25519: construct_did_key_ed25519,
+    X25519: construct_did_key_x25519,
+    BLS12381G2: construct_did_key_bls12381g2,
+    BLS12381G1: construct_did_key_bls12381g1,
+    BLS12381G1G2: construct_did_key_bls12381g1g2,
 }

aries_cloudagent/did/tests/test_did_key_bls12381g1.py

@@ -1,7 +1,7 @@
 from unittest import TestCase
 
 
-from ...wallet.key_type import KeyType
+from ...wallet.key_type import BLS12381G1
 from ...wallet.util import b58_to_bytes
 from ..did_key import DIDKey, DID_KEY_RESOLVERS
 from .test_dids import (
@@ -24,14 +24,12 @@
 class TestDIDKey(TestCase):
     def test_bls12381g1_from_public_key(self):
         key_bytes = b58_to_bytes(TEST_BLS12381G1_BASE58_KEY)
-        did_key = DIDKey.from_public_key(key_bytes, KeyType.BLS12381G1)
+        did_key = DIDKey.from_public_key(key_bytes, BLS12381G1)
 
         assert did_key.did == TEST_BLS12381G1_DID
 
     def test_bls12381g1_from_public_key_b58(self):
-        did_key = DIDKey.from_public_key_b58(
-            TEST_BLS12381G1_BASE58_KEY, KeyType.BLS12381G1
-        )
+        did_key = DIDKey.from_public_key_b58(TEST_BLS12381G1_BASE58_KEY, BLS12381G1)
 
         assert did_key.did == TEST_BLS12381G1_DID
 
@@ -53,20 +51,20 @@ def test_bls12381g1_properties(self):
         assert did_key.did == TEST_BLS12381G1_DID
         assert did_key.public_key_b58 == TEST_BLS12381G1_BASE58_KEY
         assert did_key.public_key == b58_to_bytes(TEST_BLS12381G1_BASE58_KEY)
-        assert did_key.key_type == KeyType.BLS12381G1
+        assert did_key.key_type == BLS12381G1
         assert did_key.key_id == TEST_BLS12381G1_KEY_ID
         assert did_key.prefixed_public_key == TEST_BLS12381G1_PREFIX_BYTES
 
     def test_bls12381g1_diddoc(self):
         did_key = DIDKey.from_did(TEST_BLS12381G1_DID)
 
-        resolver = DID_KEY_RESOLVERS[KeyType.BLS12381G1]
+        resolver = DID_KEY_RESOLVERS[BLS12381G1]
 
         assert resolver(did_key) == did_key.did_doc
 
     def test_bls12381g1_resolver(self):
         did_key = DIDKey.from_did(TEST_BLS12381G1_DID)
-        resolver = DID_KEY_RESOLVERS[KeyType.BLS12381G1]
+        resolver = DID_KEY_RESOLVERS[BLS12381G1]
         did_doc = resolver(did_key)
 
         assert (

aries_cloudagent/did/tests/test_did_key_bls12381g1g2.py

@@ -1,6 +1,6 @@
 from unittest import TestCase
 
-from ...wallet.key_type import KeyType
+from ...wallet.key_type import BLS12381G1, BLS12381G1G2, BLS12381G2
 from ...wallet.util import b58_to_bytes
 from ..did_key import DIDKey, DID_KEY_RESOLVERS
 from .test_dids import (
@@ -31,14 +31,12 @@
 class TestDIDKey(TestCase):
     def test_bls12381g1g2_from_public_key(self):
         key_bytes = b58_to_bytes(TEST_BLS12381G1G2_BASE58_KEY)
-        did_key = DIDKey.from_public_key(key_bytes, KeyType.BLS12381G1G2)
+        did_key = DIDKey.from_public_key(key_bytes, BLS12381G1G2)
 
         assert did_key.did == TEST_BLS12381G1G2_DID
 
     def test_bls12381g1g2_from_public_key_b58(self):
-        did_key = DIDKey.from_public_key_b58(
-            TEST_BLS12381G1G2_BASE58_KEY, KeyType.BLS12381G1G2
-        )
+        did_key = DIDKey.from_public_key_b58(TEST_BLS12381G1G2_BASE58_KEY, BLS12381G1G2)
 
         assert did_key.did == TEST_BLS12381G1G2_DID
 
@@ -60,21 +58,21 @@ def test_bls12381g1g2_properties(self):
         assert did_key.did == TEST_BLS12381G1G2_DID
         assert did_key.public_key_b58 == TEST_BLS12381G1G2_BASE58_KEY
         assert did_key.public_key == b58_to_bytes(TEST_BLS12381G1G2_BASE58_KEY)
-        assert did_key.key_type == KeyType.BLS12381G1G2
+        assert did_key.key_type == BLS12381G1G2
         assert did_key.prefixed_public_key == TEST_BLS12381G1G2_PREFIX_BYTES
 
     def test_bls12381g1g2_diddoc(self):
         did_key = DIDKey.from_did(TEST_BLS12381G1G2_DID)
 
-        resolver = DID_KEY_RESOLVERS[KeyType.BLS12381G1G2]
+        resolver = DID_KEY_RESOLVERS[BLS12381G1G2]
 
         assert resolver(did_key) == did_key.did_doc
 
     def test_bls12381g1g2_resolver(self):
         did_key = DIDKey.from_did(
             "did:key:z5TcESXuYUE9aZWYwSdrUEGK1HNQFHyTt4aVpaCTVZcDXQmUheFwfNZmRksaAbBneNm5KyE52SdJeRCN1g6PJmF31GsHWwFiqUDujvasK3wTiDr3vvkYwEJHt7H5RGEKYEp1ErtQtcEBgsgY2DA9JZkHj1J9HZ8MRDTguAhoFtR4aTBQhgnkP4SwVbxDYMEZoF2TMYn3s"
         )
-        resolver = DID_KEY_RESOLVERS[KeyType.BLS12381G1G2]
+        resolver = DID_KEY_RESOLVERS[BLS12381G1G2]
         did_doc = resolver(did_key)
 
         assert (
@@ -88,24 +86,24 @@ def test_bls12381g1g1_to_g1(self):
         # TODO: add easier method to go form g1 <- g1g2 -> g2
         # First 48 bytes is g1 key
         g1_public_key = g1g2_did.public_key[:48]
-        g1_did = DIDKey.from_public_key(g1_public_key, KeyType.BLS12381G1)
+        g1_did = DIDKey.from_public_key(g1_public_key, BLS12381G1)
 
         assert g1_did.fingerprint == TEST_BLS12381G1_FINGERPRINT
         assert g1_did.did == TEST_BLS12381G1_DID
         assert g1_did.public_key_b58 == TEST_BLS12381G1_BASE58_KEY
         assert g1_did.public_key == b58_to_bytes(TEST_BLS12381G1_BASE58_KEY)
-        assert g1_did.key_type == KeyType.BLS12381G1
+        assert g1_did.key_type == BLS12381G1
 
     def test_bls12381g1g1_to_g2(self):
         g1g2_did = DIDKey.from_did(TEST_BLS12381G1G2_DID)
 
         # TODO: add easier method to go form g1 <- g1g2 -> g2
         # From 48 bytes is g2 key
         g2_public_key = g1g2_did.public_key[48:]
-        g2_did = DIDKey.from_public_key(g2_public_key, KeyType.BLS12381G2)
+        g2_did = DIDKey.from_public_key(g2_public_key, BLS12381G2)
 
         assert g2_did.fingerprint == TEST_BLS12381G2_FINGERPRINT
         assert g2_did.did == TEST_BLS12381G2_DID
         assert g2_did.public_key_b58 == TEST_BLS12381G2_BASE58_KEY
         assert g2_did.public_key == b58_to_bytes(TEST_BLS12381G2_BASE58_KEY)
-        assert g2_did.key_type == KeyType.BLS12381G2
+        assert g2_did.key_type == BLS12381G2