def make_did_doc(self):
doc = DIDDoc(did=self.test_did)
controller = self.test_did
ident = "1"
pk_value = self.test_verkey
pk = PublicKey(
self.test_did,
ident,
PublicKeyType.ED25519_SIG_2018,
controller,
pk_value,
False,
)
doc.verkeys.append(pk)
recip_keys = [pk_value]
routing_keys = []
service = Service(
self.test_did,
"indy",
"IndyAgent",
recip_keys,
routing_keys,
self.test_endpoint,
)
doc.services.append(service)
return doc
async def fetch_did_document(self, did: str) -> DIDDoc:
"""Retrieve a DID Document for a given DID.
Args:
did: The DID to search for
"""
storage: BaseStorage = await self.context.inject(BaseStorage)
record = await storage.search_records(self.RECORD_TYPE_DID_DOC, {
"did": did
}).fetch_single()
return DIDDoc.from_json(record.value)
def _deserialize(self, value, attr, data, **kwargs):
"""
Deserialize a value into a DIDDoc.
Args:
value: The value to deserialize
Returns:
The deserialized value
"""
# quick fix for missing optional values
if "authentication" not in value:
value["authentication"] = []
if "service" not in value:
value["service"] = []
return DIDDoc.deserialize(value)
async def store_did_document(self, did_doc: DIDDoc):
"""Store a DID document.
Args:
did_doc: The `DIDDoc` instance to be persisted
"""
assert did_doc.did
storage: BaseStorage = await self.context.inject(BaseStorage)
try:
record = await self.fetch_did_document(did_doc.did)
except StorageNotFoundError:
record = StorageRecord(self.RECORD_TYPE_DID_DOC, did_doc.to_json(),
{"did": did_doc.did})
await storage.add_record(record)
else:
await storage.update_record_value(record, did_doc.value)
await self.remove_keys_for_did(did_doc.did)
for key in did_doc.pubkey.values():
if key.controller == did_doc.did:
await self.add_key_for_did(did_doc.did, key.value)
async def create_did_document(self,
my_info: DIDInfo,
my_router_did: str = None,
my_endpoint: str = None) -> DIDDoc:
"""Create our DID document for a given DID.
Args:
my_info: The DID I am using in this connection
my_router_did: The DID of the router connection to use
my_endpoint: A custom endpoint for the DID Document
Returns:
The prepared `DIDDoc` instance
"""
did_doc = DIDDoc(did=my_info.did)
did_controller = my_info.did
did_key = my_info.verkey
pk = PublicKey(
my_info.did,
"1",
PublicKeyType.ED25519_SIG_2018,
did_controller,
did_key,
True,
)
did_doc.verkeys.append(pk)
if not my_endpoint:
my_endpoint = self.context.default_endpoint
service = Service(my_info.did, "indy", "IndyAgent", [did_key], [],
my_endpoint)
did_doc.services.append(service)
return did_doc
async def test_a2a():
print(Ink.YELLOW('\n\n== Testing DID Doc wranglers =='))
# One authn key by reference
dd_in = {
'@context': 'https://w3id.org/did/v1',
'id': 'did:sov:LjgpST2rjsoxYegQDRm7EL',
'publicKey': [
{
'id': '3',
'type': 'RsaVerificationKey2018',
'controller': 'did:sov:LjgpST2rjsoxYegQDRm7EL',
'publicKeyPem': '-----BEGIN PUBLIC X...'
},
{
'id': '4',
'type': 'RsaVerificationKey2018',
'controller': 'did:sov:LjgpST2rjsoxYegQDRm7EL',
'publicKeyPem': '-----BEGIN PUBLIC 9...'
},
{
'id': '6',
'type': 'RsaVerificationKey2018',
'controller': 'did:sov:LjgpST2rjsoxYegQDRm7EL',
'publicKeyPem': '-----BEGIN PUBLIC A...'
}
],
'authentication': [
{
'type': 'RsaSignatureAuthentication2018',
'publicKey': 'did:sov:LjgpST2rjsoxYegQDRm7EL#4'
}
],
'service': [
{
'id': '0',
'type': 'Agency',
'serviceEndpoint': 'did:sov:Q4zqM7aXqm7gDQkUVLng9h'
}
]
}
dd = DIDDoc.deserialize(dd_in)
assert len(dd.pubkey) == len(dd_in['publicKey'])
assert len(dd.authnkey) == len(dd_in['authentication'])
dd_out = dd.serialize()
print('\n\n== 1 == DID Doc {} on abbreviated identifiers: {}'.format(dd, ppjson(dd_out)))
# Exercise JSON, de/serialization
dd_json = dd.to_json()
dd_copy = dd.from_json(dd_json)
assert dd_copy.did == dd.did
assert all(dd_copy.authnkey[k].to_dict() == dd.authnkey[k].to_dict() for k in dd_copy.authnkey)
assert {k for k in dd_copy.authnkey} == {k for k in dd.authnkey}
assert all(dd_copy.pubkey[k].to_dict() == dd.pubkey[k].to_dict() for k in dd_copy.pubkey)
assert {k for k in dd_copy.pubkey} == {k for k in dd.pubkey}
assert all(dd_copy.service[k].to_dict() == dd.service[k].to_dict() for k in dd_copy.service)
assert {k for k in dd_copy.service} == {k for k in dd.service}
print('\n\n== 2 == DID Doc de/serialization operates OK:')
# Exercise accessors
dd.did = dd_out['id']
assert dd.did == canon_did(dd_out['id'])
try:
dd.set(['neither a service', 'nor a public key'])
assert False
except BadDIDDocItem:
pass
assert dd.service[[k for k in dd.service][0]].did == dd.did
print('\n\n== 3 == DID Doc accessors operate OK')
# One authn key embedded, all possible refs canonical
dd_in = {
'@context': 'https://w3id.org/did/v1',
'id': 'did:sov:LjgpST2rjsoxYegQDRm7EL',
'publicKey': [
{
'id': '3',
'type': 'RsaVerificationKey2018',
'controller': 'did:sov:LjgpST2rjsoxYegQDRm7EL',
'publicKeyPem': '-----BEGIN PUBLIC X...'
},
{
'id': 'did:sov:LjgpST2rjsoxYegQDRm7EL#4',
'type': 'RsaVerificationKey2018',
'controller': 'did:sov:LjgpST2rjsoxYegQDRm7EL',
'publicKeyPem': '-----BEGIN PUBLIC 9...'
}
],
'authentication': [
{
'type': 'RsaSignatureAuthentication2018',
'publicKey': 'did:sov:LjgpST2rjsoxYegQDRm7EL#4'
},
{
'id': 'did:sov:LjgpST2rjsoxYegQDRm7EL#6',
'type': 'RsaVerificationKey2018',
'controller': 'did:sov:LjgpST2rjsoxYegQDRm7EL',
'publicKeyPem': '-----BEGIN PUBLIC A...'
}
],
'service': [
{
'id': 'did:sov:LjgpST2rjsoxYegQDRm7EL;0',
'type': 'Agency',
'serviceEndpoint': 'https://www.von.ca'
}
]
}
dd = DIDDoc.deserialize(dd_in)
assert len(dd.pubkey) == len(dd_in['publicKey']) + 1
assert len(dd.authnkey) == len(dd_in['authentication'])
dd_out = dd.serialize()
print('\n\n== 4 == DID Doc on mixed reference styles, embedded and ref style authn keys: {}'.format(ppjson(dd_out)))
# All references canonical where possible; one authn key embedded and one by reference
dd_in = {
'@context': 'https://w3id.org/did/v1',
'id': 'did:sov:LjgpST2rjsoxYegQDRm7EL',
'publicKey': [
{
'id': 'did:sov:LjgpST2rjsoxYegQDRm7EL#3',
'type': 'RsaVerificationKey2018',
'controller': 'did:sov:LjgpST2rjsoxYegQDRm7EL',
'publicKeyPem': '-----BEGIN PUBLIC X...'
},
{
'id': 'did:sov:LjgpST2rjsoxYegQDRm7EL#4',
'type': 'RsaVerificationKey2018',
'controller': 'did:sov:LjgpST2rjsoxYegQDRm7EL',
'publicKeyPem': '-----BEGIN PUBLIC 9...'
}
],
'authentication': [
{
'type': 'RsaSignatureAuthentication2018',
'publicKey': 'did:sov:LjgpST2rjsoxYegQDRm7EL#4'
},
{
'id': 'did:sov:LjgpST2rjsoxYegQDRm7EL#6',
'type': 'RsaVerificationKey2018',
'controller': 'did:sov:LjgpST2rjsoxYegQDRm7EL',
'publicKeyPem': '-----BEGIN PUBLIC A...'
}
],
'service': [
{
'id': 'did:sov:LjgpST2rjsoxYegQDRm7EL;0',
'type': 'DidMessaging',
'serviceEndpoint': 'https://www.von.ca'
}
]
}
dd = DIDDoc.deserialize(dd_in)
assert len(dd.pubkey) == len(dd_in['publicKey']) + 1
assert len(dd.authnkey) == len(dd_in['authentication'])
dd_out = dd.serialize()
print('\n\n== 5 == DID Doc on canonical refs: {}'.format(ppjson(dd_out)))
# Minimal as per indy-agent test suite without explicit identifiers
dd_in = {
'@context': 'https://w3id.org/did/v1',
'publicKey': [
{
'id': 'LjgpST2rjsoxYegQDRm7EL#keys-1',
'type': 'Ed25519VerificationKey2018',
'controller': 'LjgpST2rjsoxYegQDRm7EL',
'publicKeyBase58': '~XXXXXXXXXXXXXXXX'
}
],
'service': [
{
'type': 'DidMessaging',
'recipientKeys': ['~XXXXXXXXXXXXXXXX'],
'serviceEndpoint': 'https://www.von.ca'
}
]
}
dd = DIDDoc.deserialize(dd_in)
assert len(dd.pubkey) == len(dd_in['publicKey'])
assert len(dd.authnkey) == 0
dd_out = dd.serialize()
print('\n\n== 6 == DID Doc miminal style, implcit DID document identifier: {}'.format(
ppjson(dd_out)))
# Minimal + ids as per indy-agent test suite with explicit identifiers; novel service recipient key on raw base58
dd_in = {
'@context': 'https://w3id.org/did/v1',
'id': 'LjgpST2rjsoxYegQDRm7EL',
'publicKey': [
{
'id': 'LjgpST2rjsoxYegQDRm7EL#keys-1',
'type': 'Ed25519VerificationKey2018',
'controller': 'LjgpST2rjsoxYegQDRm7EL',
'publicKeyBase58': '~XXXXXXXXXXXXXXXX'
}
],
'service': [
{
'id': 'LjgpST2rjsoxYegQDRm7EL;indy',
'type': 'DidMessaging',
'priority': 1,
'recipientKeys': ['~YYYYYYYYYYYYYYYY'],
'serviceEndpoint': 'https://www.von.ca'
}
]
}
dd = DIDDoc.deserialize(dd_in)
assert len(dd.pubkey) == 1 + len(dd_in['publicKey'])
assert len(dd.authnkey) == 0
dd_out = dd.serialize()
print('\n\n== 7 == DID Doc miminal style plus explicit idents and novel raw base58 service recip key: {}'.format(
ppjson(dd_out)))
# Minimal + ids as per indy-agent test suite with explicit identifiers; novel service recipient key on raw base58
dd_in = {
'@context': 'https://w3id.org/did/v1',
'id': 'LjgpST2rjsoxYegQDRm7EL',
'publicKey': [
{
'id': 'LjgpST2rjsoxYegQDRm7EL#keys-1',
'type': 'Ed25519VerificationKey2018',
'controller': 'LjgpST2rjsoxYegQDRm7EL',
'publicKeyBase58': '~XXXXXXXXXXXXXXXX'
},
{
'id': 'LjgpST2rjsoxYegQDRm7EL#keys-2',
'type': 'Ed25519VerificationKey2018',
'controller': 'LjgpST2rjsoxYegQDRm7EL',
'publicKeyBase58': '~YYYYYYYYYYYYYYYY'
},
{
'id': 'LjgpST2rjsoxYegQDRm7EL#keys-3',
'type': 'Secp256k1VerificationKey2018',
'controller': 'LjgpST2rjsoxYegQDRm7EL',
'publicKeyHex': '02b97c30de767f084ce3080168ee293053ba33b235d7116a3263d29f1450936b71'
},
{
'id': 'did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4',
'type': 'RsaVerificationKey2018',
'controller': 'did:sov:LjgpST2rjsoxYegQDRm7EL',
'publicKeyPem': '-----BEGIN PUBLIC A...'
}
],
'service': [
{
'id': 'LjgpST2rjsoxYegQDRm7EL;indy',
'type': 'DidMessaging',
'priority': 0,
'recipientKeys': ['~ZZZZZZZZZZZZZZZZ'],
'serviceEndpoint': 'did:sov:LjgpST2rjsoxYegQDRm7EL;1'
},
{
'id': '1',
'type': 'one',
'priority': 1,
'recipientKeys': [
'~XXXXXXXXXXXXXXXX',
'did:sov:LjgpST2rjsoxYegQDRm7EL#keys-1'
],
'routingKeys': [
'did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4'
],
'serviceEndpoint': 'LjgpST2rjsoxYegQDRm7EL;2'
},
{
'id': '2',
'type': 'two',
'priority': 2,
'recipientKeys': [
'~XXXXXXXXXXXXXXXX',
'did:sov:LjgpST2rjsoxYegQDRm7EL#keys-1'
],
'routingKeys': [
'did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4'
],
'serviceEndpoint': 'https://www.two.ca/two'
}
]
}
dd = DIDDoc.deserialize(dd_in)
assert len(dd.pubkey) == 1 + len(dd_in['publicKey'])
assert len(dd.authnkey) == 0
assert {s.priority for s in dd.service.values()} == {0, 1, 2}
assert len(dd.service) == 3
assert all(len(dd.service[k].to_dict()['recipientKeys']) == 1 for k in dd.service)
assert 'routingKeys' not in dd.service['did:sov:LjgpST2rjsoxYegQDRm7EL;indy'].to_dict()
assert all(len(dd.service[k].to_dict()['routingKeys']) == 1
for k in ('did:sov:LjgpST2rjsoxYegQDRm7EL;1', 'did:sov:LjgpST2rjsoxYegQDRm7EL;2'))
dd_out = dd.serialize()
print('\n\n== 8 == DID Doc on mixed service routing and recipient keys: {}'.format(ppjson(dd_out)))
pk = PublicKey(
dd.did,
'99',
'~AAAAAAAAAAAAAAAA',
PublicKeyType.ED25519_SIG_2018,
dd.did,
True)
dd.set(pk)
assert len(dd.pubkey) == 2 + len(dd_in['publicKey'])
assert canon_ref(dd.did, '99', '#') in dd.pubkey
assert len(dd.authnkey) == 1
service = Service(
dd.did,
'abc',
'IndyAgent',
[pk],
[pk],
'http://www.abc.ca/123'
)
dd.set(service)
assert len(dd.service) == 4
assert canon_ref(dd.did, 'abc', ';') in dd.service
print('\n\n== 9 == DID Doc adds public key and service via set() OK')
# Exercise missing service recipient key
dd_in = {
'@context': 'https://w3id.org/did/v1',
'id': 'LjgpST2rjsoxYegQDRm7EL',
'publicKey': [
{
'id': 'LjgpST2rjsoxYegQDRm7EL#keys-1',
'type': 'Ed25519VerificationKey2018',
'controller': 'LjgpST2rjsoxYegQDRm7EL',
'publicKeyBase58': '~XXXXXXXXXXXXXXXX'
}
],
'service': [
{
'id': 'LjgpST2rjsoxYegQDRm7EL;indy',
'type': 'DidMessaging',
'priority': 1,
'recipientKeys': [
'did:sov:LjgpST2rjsoxYegQDRm7EL#keys-3'
],
'serviceEndpoint': 'https://www.von.ca'
}
]
}
try:
dd = DIDDoc.deserialize(dd_in)
assert False
except AbsentDIDDocItem:
pass
print('\n\n== 10 == DID Doc on underspecified service key fails as expected')
# Minimal as per W3C Example 2, draft 0.12
dd_in = {
'@context': 'https://w3id.org/did/v1',
'id': 'did:sov:LjgpST2rjsoxYegQDRm7EL',
'authentication': [
{
'id': 'LjgpST2rjsoxYegQDRm7EL#keys-1',
'type': 'Ed25519VerificationKey2018',
'controller': 'did:sov:LjgpST2rjsoxYegQDRm7EL',
'publicKeyBase58': '~XXXXXXXXXXXXXXXX'
}
],
'service': [
{
'type': 'DidMessaging',
'serviceEndpoint': 'https://example.com/endpoint/8377464'
}
]
}
dd = DIDDoc.deserialize(dd_in)
assert len(dd.pubkey) == 1
assert len(dd.authnkey) == 1
assert len(dd.service) == 1
dd_out = dd.serialize()
print('\n\n== 11 == Minimal DID Doc (no pubkey except authentication) as per W3C spec parses OK: {}'.format(
ppjson(dd_out)))
# Exercise no-identifier case
dd_in = {
'@context': 'https://w3id.org/did/v1',
'authentication': [
{
'type': 'Ed25519VerificationKey2018',
'controller': 'did:sov:LjgpST2rjsoxYegQDRm7EL',
'publicKeyBase58': '~XXXXXXXXXXXXXXXX'
}
],
'service': [
{
'type': 'DidMessaging',
'serviceEndpoint': 'https://example.com/endpoint/8377464'
}
]
}
try:
dd = DIDDoc.deserialize(dd_in)
assert False
except AbsentDIDDocItem:
pass
print('\n\n== 12 == DID Doc without identifier rejected as expected')
# Exercise reference canonicalization, including failure paths
try:
canon_ref('not-a-DID', ref=dd.did, delimiter='#')
assert False
except BadIdentifier:
pass
try:
canon_ref(dd.did, ref='did:sov:not-a-DID', delimiter='#')
assert False
except BadIdentifier:
pass
urlref = 'https://www.clafouti-quasar.ca:8443/supply-management/fruit/index.html'
assert canon_ref(dd.did, ref=urlref) == urlref
print('\n\n== 13 == Reference canonicalization operates as expected')
assert PublicKeyType.get('no-such-type') is None
pubkey0 = dd.pubkey[[k for k in dd.pubkey][0]]
was_authn = pubkey0.authn
pubkey0.authn = not was_authn
assert pubkey0.authn != was_authn
print('\n\n== 14 == Changed authentication setting for DIDDoc {} in public key {}, now {}'.format(
pubkey0.did,
pubkey0.id,
repr(pubkey0)))
async def create_did_document(self,
my_info: DIDInfo,
inbound_connection_id: str = None,
my_endpoint: str = None) -> DIDDoc:
"""Create our DID document for a given DID.
Args:
my_info: The DID I am using in this connection
inbound_connection_id: The DID of the inbound routing connection to use
my_endpoint: A custom endpoint for the DID Document
Returns:
The prepared `DIDDoc` instance
"""
did_doc = DIDDoc(did=my_info.did)
did_controller = my_info.did
did_key = my_info.verkey
pk = PublicKey(
my_info.did,
"1",
did_key,
PublicKeyType.ED25519_SIG_2018,
did_controller,
True,
)
did_doc.set(pk)
router_id = inbound_connection_id
routing_keys = []
router_idx = 1
while router_id:
# look up routing connection information
router = await ConnectionRecord.retrieve_by_id(
self.context, router_id)
if router.state != ConnectionRecord.STATE_ACTIVE:
raise ConnectionManagerError(
f"Router connection not active: {router_id}")
routing_doc = await self.fetch_did_document(router.their_did)
if not routing_doc.service:
raise ConnectionManagerError(
f"No services defined by routing DIDDoc: {router_id}")
for service in routing_doc.service.values():
if not service.endpoint:
raise ConnectionManagerError(
"Routing DIDDoc service has no service endpoint")
if not service.recip_keys:
raise ConnectionManagerError(
"Routing DIDDoc service has no recipient key(s)")
rk = PublicKey(
my_info.did,
f"routing-{router_idx}",
service.recip_keys[0].value,
PublicKeyType.ED25519_SIG_2018,
did_controller,
True,
)
routing_keys.append(rk)
my_endpoint = service.endpoint
break
router_id = router.inbound_connection_id
if not my_endpoint:
my_endpoint = self.context.settings.get("default_endpoint")
service = Service(my_info.did, "indy", "IndyAgent", [pk], routing_keys,
my_endpoint)
did_doc.set(service)
return did_doc