Merge pull request #42 from sicpa-dlab/main

Release 0.5.0
sicpa-dlab · Jul 27, 2022 · bf9d3f9 · bf9d3f9
2 parents b1ab788 + efb6b8e
commit bf9d3f9
Show file tree

Hide file tree

Showing 27 changed files with 1,276 additions and 2,473 deletions.
diff --git a/.github/workflows/verify.yml b/.github/workflows/verify.yml
@@ -88,14 +88,13 @@ jobs:
   unit:
     strategy:
       matrix:
-        python-version: [ '3.6', '3.7', '3.8', '3.9', '3.10' ]
+        python-version: [ '3.7', '3.8', '3.9', '3.10' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         include:
           - {python-version: '3.10', toxenv: py310}
           - {python-version: '3.9', toxenv: py39}
           - {python-version: '3.8', toxenv: py38}
           - {python-version: '3.7', toxenv: py37}
-          - {python-version: '3.6', toxenv: py36}
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v2

diff --git a/README.md b/README.md
@@ -19,102 +19,112 @@ See https://github.com/sicpa-dlab/didcomm-demo.
 ## Example
 
 Example code:
-```
-    encryption_keys = [
-        VerificationMaterialAgreement(
-            type=VerificationMethodTypeAgreement.X25519_KEY_AGREEMENT_KEY_2019,
-            format=VerificationMaterialFormatPeerDID.BASE58,
-            value="DmgBSHMqaZiYqwNMEJJuxWzsGGC8jUYADrfSdBrC6L8s",
-        )
-    ]
-    signing_keys = [
-        VerificationMaterialAuthentication(
-            type=VerificationMethodTypeAuthentication.ED25519_VERIFICATION_KEY_2018,
-            format=VerificationMaterialFormatPeerDID.BASE58,
-            value="ByHnpUCFb1vAfh9CFZ8ZkmUZguURW8nSw889hy6rD8L7",
-        )
-    ]
-    service = """
-                {
-                    "type": "DIDCommMessaging",
-                    "serviceEndpoint": "https://example.com/endpoint1",
-                    "routingKeys": ["did:example:somemediator#somekey1"],
-                    "accept": ["didcomm/v2", "didcomm/aip2;env=rfc587"]
-                }
-              """
-
-    peer_did_algo_0 = create_peer_did_numalgo_0(inception_key=signing_keys[0])
-    peer_did_algo_2 = create_peer_did_numalgo_2(
-        encryption_keys=encryption_keys, signing_keys=signing_keys, service=service
-    )
-
-    did_doc_algo_0_json = resolve_peer_did(peer_did=peer_did_algo_0)
-    did_doc_algo_2_json = resolve_peer_did(peer_did=peer_did_algo_2)
 
-    did_doc_algo_0 = DIDDocPeerDID.from_json(did_doc_algo_0_json)
-    did_doc_algo_2 = DIDDocPeerDID.from_json(did_doc_algo_2_json)
+```python
+from peerdid.dids import (
+    create_peer_did_numalgo_0,
+    create_peer_did_numalgo_2,
+    resolve_peer_did,
+)
+from peerdid.keys import Ed25519VerificationKey, X25519KeyAgreementKey
+
+encryption_keys = [
+    X25519KeyAgreementKey.from_base58(
+        "DmgBSHMqaZiYqwNMEJJuxWzsGGC8jUYADrfSdBrC6L8s"
+    )
+]
+signing_keys = [
+    Ed25519VerificationKey.from_base58(
+        "ByHnpUCFb1vAfh9CFZ8ZkmUZguURW8nSw889hy6rD8L7"
+    )
+]
+service = {
+    "type": "DIDCommMessaging",
+    "serviceEndpoint": "https://example.com/endpoint1",
+    "routingKeys": ["did:example:somemediator#somekey1"],
+    "accept": ["didcomm/v2", "didcomm/aip2;env=rfc587"],
+}
+
+peer_did_algo_0 = create_peer_did_numalgo_0(inception_key=signing_keys[0])
+peer_did_algo_2 = create_peer_did_numalgo_2(
+    encryption_keys=encryption_keys, signing_keys=signing_keys, service=service
+)
+
+did_doc_algo_0 = resolve_peer_did(peer_did_algo_0)
+did_doc_algo_2 = resolve_peer_did(peer_did_algo_2)
+
+did_doc_algo_0_json = did_doc_algo_0.to_json()
+did_doc_algo_2_json = did_doc_algo_2.to_json()
 ```
 
 Example of DID documents:
 
-    # did_doc_algo_0
-    {
-        "id": "did:peer:0z6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V",
-        "authentication": [
-          {
-              "id": "did:peer:0z6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V#6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V",
-              "type": "Ed25519VerificationKey2020",
-              "controller": "did:peer:0z6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V",
-              "publicKeyMultibase": "z6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V"
-          }
-        ]
-    }
-
-    # did_doc_algo_2
+```jsonc
+// did_doc_algo_0_json
+{
+    "@context": [
+        "https://www.w3.org/ns/did/v1",
+        "https://w3id.org/security/suites/ed25519-2020/v1"
+    ],
+    "id": "did:peer:0z6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V",
+    "verificationMethod": [
+        {
+            "id": "#6MkqRYqQ",
+            "type": "Ed25519VerificationKey2020",
+            "controller": "did:peer:0z6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V",
+            "publicKeyMultibase": "z6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V"
+        }
+    ],
+    "authentication": ["#6MkqRYqQ"],
+    "assertionMethod": ["#6MkqRYqQ"],
+    "capabilityInvocation": ["#6MkqRYqQ"],
+    "capabilityDelegation": ["#6MkqRYqQ"]
+}
+
+// did_doc_algo_2_json
+{
+    "@context": [
+        "https://www.w3.org/ns/did/v1",
+        "https://w3id.org/security/suites/x25519-2020/v1",
+        "https://w3id.org/security/suites/ed25519-2020/v1"
+    ],
+    "id": "did:peer:2.Ez6LSpSrLxbAhg2SHwKk7kwpsH7DM7QjFS5iK6qP87eViohud.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludDEiLCJyIjpbImRpZDpleGFtcGxlOnNvbWVtZWRpYXRvciNzb21la2V5MSJdLCJhIjpbImRpZGNvbW0vdjIiLCJkaWRjb21tL2FpcDI7ZW52PXJmYzU4NyJdfQ",
+    "verificationMethod": [
+        {
+            "id": "#6LSpSrLx",
+            "type": "X25519KeyAgreementKey2020",
+            "controller": "did:peer:2.Ez6LSpSrLxbAhg2SHwKk7kwpsH7DM7QjFS5iK6qP87eViohud.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludDEiLCJyIjpbImRpZDpleGFtcGxlOnNvbWVtZWRpYXRvciNzb21la2V5MSJdLCJhIjpbImRpZGNvbW0vdjIiLCJkaWRjb21tL2FpcDI7ZW52PXJmYzU4NyJdfQ",
+            "publicKeyMultibase": "z6LSpSrLxbAhg2SHwKk7kwpsH7DM7QjFS5iK6qP87eViohud"
+        },
         {
-           "id": "did:peer:2.Ez6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.Vz6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludCIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkiXSwiYSI6WyJkaWRjb21tL3YyIiwiZGlkY29tbS9haXAyO2Vudj1yZmM1ODciXX0",
-           "authentication": [
-               {
-                   "id": "did:peer:2.Ez6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.Vz6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludCIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkiXSwiYSI6WyJkaWRjb21tL3YyIiwiZGlkY29tbS9haXAyO2Vudj1yZmM1ODciXX0#6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V",
-                   "type": "Ed25519VerificationKey2020",
-                   "controller": "did:peer:2.Ez6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.Vz6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludCIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkiXSwiYSI6WyJkaWRjb21tL3YyIiwiZGlkY29tbS9haXAyO2Vudj1yZmM1ODciXX0",
-                   "publicKeyMultibase": "z6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V"
-               },
-               {
-                   "id": "did:peer:2.Ez6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.Vz6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludCIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkiXSwiYSI6WyJkaWRjb21tL3YyIiwiZGlkY29tbS9haXAyO2Vudj1yZmM1ODciXX0#6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg",
-                   "type": "Ed25519VerificationKey2020",
-                   "controller": "did:peer:2.Ez6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.Vz6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludCIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkiXSwiYSI6WyJkaWRjb21tL3YyIiwiZGlkY29tbS9haXAyO2Vudj1yZmM1ODciXX0",
-                   "publicKeyMultibase": "z6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg"
-               }
-           ],
-           "keyAgreement": [
-               {
-                   "id": "did:peer:2.Ez6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.Vz6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludCIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkiXSwiYSI6WyJkaWRjb21tL3YyIiwiZGlkY29tbS9haXAyO2Vudj1yZmM1ODciXX0#6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc",
-                   "type": "X25519KeyAgreementKey2020",
-                   "controller": "did:peer:2.Ez6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.Vz6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludCIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkiXSwiYSI6WyJkaWRjb21tL3YyIiwiZGlkY29tbS9haXAyO2Vudj1yZmM1ODciXX0",
-                   "publicKeyMultibase": "z6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc"
-               }
-           ],
-           "service": [
-               {
-                   "id": "did:peer:2.Ez6LSbysY2xFMRpGMhb7tFTLMpeuPRaqaWM1yECx2AtzE3KCc.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.Vz6MkgoLTnTypo3tDRwCkZXSccTPHRLhF4ZnjhueYAFpEX6vg.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludCIsInIiOlsiZGlkOmV4YW1wbGU6c29tZW1lZGlhdG9yI3NvbWVrZXkiXSwiYSI6WyJkaWRjb21tL3YyIiwiZGlkY29tbS9haXAyO2Vudj1yZmM1ODciXX0#didcommmessaging-0",
-                   "type": "DIDCommMessaging",
-                   "serviceEndpoint": "https://example.com/endpoint",
-                   "routingKeys": [
-                       "did:example:somemediator#somekey"
-                   ],
-                   "accept": [
-                        "didcomm/v2", "didcomm/aip2;env=rfc587"
-                   ]
-               }
-           ]
-       }
+            "id": "#6MkqRYqQ",
+            "type": "Ed25519VerificationKey2020",
+            "controller": "did:peer:2.Ez6LSpSrLxbAhg2SHwKk7kwpsH7DM7QjFS5iK6qP87eViohud.Vz6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V.SeyJ0IjoiZG0iLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludDEiLCJyIjpbImRpZDpleGFtcGxlOnNvbWVtZWRpYXRvciNzb21la2V5MSJdLCJhIjpbImRpZGNvbW0vdjIiLCJkaWRjb21tL2FpcDI7ZW52PXJmYzU4NyJdfQ",
+            "publicKeyMultibase": "z6MkqRYqQiSgvZQdnBytw86Qbs2ZWUkGv22od935YF4s8M7V"
+        }
+    ],
+    "authentication": ["#6MkqRYqQ"],
+    "assertionMethod": ["#6MkqRYqQ"],
+    "keyAgreement": ["#6LSpSrLx"],
+    "capabilityInvocation": ["#6MkqRYqQ"],
+    "capabilityDelegation": ["#6MkqRYqQ"],
+    "service": [
+        {
+            "id": "#didcommmessaging-0",
+            "type": "DIDCommMessaging",
+            "serviceEndpoint": "https://example.com/endpoint1",
+            "accept": ["didcomm/v2", "didcomm/aip2;env=rfc587"],
+            "routingKeys": ["did:example:somemediator#somekey1"]
+        }
+    ]
+}
+```
 
 ## Assumptions and limitations
 - Only static layers [1, 2a, 2b](https://identity.foundation/peer-did-method-spec/#layers-of-support) are supported
 - Only `X25519` keys are supported for key agreement
 - Only `Ed25519` keys are supported for authentication
-- Supported verification materials (input and in the resolved DID DOC):
+- Supported verification materials (input and in the resolved DID Document):
   - [Default] 2020 verification materials (`Ed25519VerificationKey2020` and `X25519KeyAgreementKey2020`) with multibase base58 (`publicKeyMultibase`) public key encoding.
   - JWK (`JsonWebKey2020`) using JWK (`publicKeyJwk`) public key encoding 
   - 2018/2019 verification materials (`Ed25519VerificationKey2018` and `X25519KeyAgreementKey2019`) using base58 (`publicKeyBase58`) public key encoding. 

diff --git a/demo/demo.py b/demo/demo.py
@@ -1,63 +1,47 @@
-from peerdid.did_doc import DIDDocPeerDID
-from peerdid.peer_did import (
+"""Demo application."""
+
+from peerdid.dids import (
     create_peer_did_numalgo_0,
     create_peer_did_numalgo_2,
     resolve_peer_did,
 )
-from peerdid.types import (
-    VerificationMaterialAuthentication,
-    VerificationMaterialAgreement,
-    VerificationMethodTypeAgreement,
-    VerificationMethodTypeAuthentication,
-    VerificationMaterialFormatPeerDID,
-)
+from peerdid.keys import Ed25519VerificationKey, X25519KeyAgreementKey
 
 
 def demo():
+    """Generate peer DIDs using both numalgo methods."""
     encryption_keys = [
-        VerificationMaterialAgreement(
-            type=VerificationMethodTypeAgreement.X25519_KEY_AGREEMENT_KEY_2019,
-            format=VerificationMaterialFormatPeerDID.BASE58,
-            value="DmgBSHMqaZiYqwNMEJJuxWzsGGC8jUYADrfSdBrC6L8s",
+        X25519KeyAgreementKey.from_base58(
+            "DmgBSHMqaZiYqwNMEJJuxWzsGGC8jUYADrfSdBrC6L8s"
         )
     ]
     signing_keys = [
-        VerificationMaterialAuthentication(
-            type=VerificationMethodTypeAuthentication.ED25519_VERIFICATION_KEY_2018,
-            format=VerificationMaterialFormatPeerDID.BASE58,
-            value="ByHnpUCFb1vAfh9CFZ8ZkmUZguURW8nSw889hy6rD8L7",
+        Ed25519VerificationKey.from_base58(
+            "ByHnpUCFb1vAfh9CFZ8ZkmUZguURW8nSw889hy6rD8L7"
         )
     ]
-    service = """
-                {
-                    "type": "DIDCommMessaging",
-                    "serviceEndpoint": "https://example.com/endpoint1",
-                    "routingKeys": ["did:example:somemediator#somekey1"],
-                    "accept": ["didcomm/v2", "didcomm/aip2;env=rfc587"]
-                }
-            """
+    service = {
+        "type": "DIDCommMessaging",
+        "serviceEndpoint": "https://example.com/endpoint1",
+        "routingKeys": ["did:example:somemediator#somekey1"],
+        "accept": ["didcomm/v2", "didcomm/aip2;env=rfc587"],
+    }
 
     peer_did_algo_0 = create_peer_did_numalgo_0(inception_key=signing_keys[0])
     peer_did_algo_2 = create_peer_did_numalgo_2(
         encryption_keys=encryption_keys, signing_keys=signing_keys, service=service
     )
 
-    print("peer_did_algo_0:" + peer_did_algo_0)
+    print("peer_did_algo_0:", peer_did_algo_0)
     print("==================================")
-    print("peer_did_algo_2:" + peer_did_algo_2)
-    print("==================================")
-
-    did_doc_algo_0_json = resolve_peer_did(peer_did=peer_did_algo_0)
-    did_doc_algo_2_json = resolve_peer_did(peer_did=peer_did_algo_2)
-    print("did_doc_algo_0 as JSON:" + did_doc_algo_0_json)
+    print("peer_did_algo_2:", peer_did_algo_2)
     print("==================================")
-    print("did_doc_algo_2 as JSON:" + did_doc_algo_2_json)
 
-    did_doc_algo_0 = DIDDocPeerDID.from_json(did_doc_algo_0_json)
-    did_doc_algo_2 = DIDDocPeerDID.from_json(did_doc_algo_2_json)
-    print("did_doc_algo_0 as object:" + str(did_doc_algo_0.to_dict()))
+    did_doc_algo_0 = resolve_peer_did(peer_did_algo_0)
+    did_doc_algo_2 = resolve_peer_did(peer_did_algo_2)
+    print("did_doc_algo_0 as JSON:", did_doc_algo_0.to_json())
     print("==================================")
-    print("did_doc_algo_2 as object:" + str(did_doc_algo_2.to_dict()))
+    print("did_doc_algo_2 as JSON:", did_doc_algo_2.to_json())
 
 
 if __name__ == "__main__":

diff --git a/peerdid/__init__.py b/peerdid/__init__.py
@@ -1 +1,9 @@
-__version__ = "0.4.0"
+"""Peer DID document generation and resolution."""
+
+from . import core, dids, errors, keys
+
+from pydid import DID, DIDDocument
+
+__version__ = "0.5.0"
+
+__all__ = ["__version__", "core", "errors", "dids", "keys", "DID", "DIDDocument"]