Skip to content

itn-trust/itn-did-spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 

Repository files navigation

The DID ITN Method Specification 1.0

Specification Status: Working Draft

Latest Draft: ITN DID Specification

Draft Created: April 10, 2024

Latest Update: June 24, 2024

Contributors & Editors:

  1. Andreas Freund
  2. Dmitry Zotov
  3. Parth Bhatt
  4. Umed Khudoiberdiev

Abstract

Integrated Trust Network (ITN) is a community-built and operated network. The objective is to build a Federated Trust Layer (Core Services) and Business Automation Interoperability Infrastructure (User Agents) for ITN. The ITN Identifier is specified in accordance with the W3C DID Core specification.

ITN Identifier = ITN DID

The syntax of the identifier and accompanying data model used by the protocol is conformant with the DID-CORE specification and shall be registered with the DID-SPEC-REGISTRIES.

For a detailed read on DID and other DID method specifications, one can refer WebOfTrustInfo - DID Primer

Architecture Overview

The ITN is a permissioned network of nodes operated by ITN Node Operators.

Each ITN Node is comprised of the following elements depicted in the figure below:

  • ITN Agent for Core Services ~ (former name used - Self Sovereign Digital Twin (SSDT) of the Core Services OR Core Services SSDT)
  • DLT Gateway: An application integrating with the Core Services SSDT, Apache Kafka, and the different DLT networks of the ITN.
  • DID Resolver: The DID resolver utilizes the Decentralized Identity Foundation DID resolver and is integrated with the Core Services SSDT.
  • Content Addressable Storage Network: A database with content-addressable hashes and replication between ITN Nodes. Additionally, supports peer-to-peer replication.
  • DLT Networks: It is comprised of a Hyperledger Fabric network and Arbitrum One EVM equivalent network (with more to follow, in particular, based on Integrated Trust Network (ITN) expansion).

All applications external to the ITN and wishing to utilize the ITN Core Services must implement an ITN Agent as their abstraction layer. An ITN Agent represents a user’s capabilities on ITN and serves as an abstraction and integration layer between ITN and other applications/networks.

ITN Architecture Overview

The ITN Agent utilized in each ITN node is comprised of the following elements:

  • API Endpoint Service for both REST APIs and Decentralized Identity Foundation (DIF) DIDcomm messaging protocol for integration with ITN Core Services, other Agents, and Legacy Applications via REST APIs
  • Authentication service utilizing OAuth2 for REST APIs and DIF DID AuthN for DIF DIDcomm messaging
  • An implementation of the W3C Universal Wallet for key and document management
  • An implementation of the W3C Verifiable Credential Issuance and Verification standard both as REST APIs and as DIDcomm endpoints
  • Implementation of ITN Data Sharing APIs both as REST APIs and as DIDcomm endpoints
  • An implementation of ITN Core Services functionality via DIF DIDcomm
  • An implementation of the W3C/DIF Encrypted Data Vault for document storage

ITN Agent Integration can be achieved through an SDK, as utilized by the ITN. ITN Agent is an implementation of the Aries Agent RFC with a flexible plugin architecture.

Depending on which plugins and DIDComm protocols you use, your instance of ITN Agent can perform a variety of roles:

  • Create and manage cryptographic keys
  • Create and manage Decentralized Identifiers
  • Issue and verify Verifiable Credentials (VCs) and Presentations (VPs)
  • Communicate with other Agents over DIDComm

Agent provides a common interface for plugins to expand its functionality. It is designed to be modular and extensible, so you can add new protocols, transports, and managers to fit your needs.

ITN SDK

ITN_SDK

The ITN SDK provides methods to manage DIDs & DID Documents.

Conformance

The keywords MAY, MUST, MUST NOT, RECOMMENDED, SHOULD, and SHOULD NOT in this document are to be interpreted according to RFC2119`

Terminology

  1. Integrated Trust Network (ITN) is a block-chain based, protocol-agnostic, federated network delivering decentralized identity services for a new generation of secure digital commerce. ITN provides decentralized digital infrastructure as the required core trust services of governance, authority, identity, & assurance for multi-party business ecosystems.
  2. Encrypted Data Vault (EDV) for document storage.
  3. Content Addressable Storage (CAS) is a database with content-addressable hashes and replication between ITN Nodes.
  4. Distributed Ledger Technology (DLT) (also called a distributed ledger or shared ledger) is the consensus of replicated, shared, and synchronized digital data that is geographically spread (distributed) across many sites, countries, or institutions. A distributed ledger requires peer-to-peer network and consensus algorithms to ensure the ledger is reliably replicated across nodes. Blockchains are the most well-known example.
  5. Decentralized Identifier (DID) is a globally unique identifier that can be resolved to a DID Document, or de-referenced on a specific distributed ledger network, much like a URL on the Internet.
  6. Verifiable Credential (VC) is a tamper-evident credential that has authorship that can be cryptographically verified. Verifiable credentials can be used to build verifiable presentations, which can also be cryptographically verified.
  7. Verifiable Presentation (VP) is a tamper-evident presentation encoded in such a way that authorship of the data can be trusted after a process of cryptographic verification.

DID ITN Method Specification

Format

The ITN DID is derived as follow:

  1. A random 32 byte string is generated
  2. The seed is hashed using sha512
  3. An Ed25519 key pair is generated from the hash. The key pair will be used as the recovery key pair
  4. The identifier of the did:itn is the first 16 bytes of the recovery key pair's public key encoded into Base58 format.
  5. Prefix the generated identifier with did:itn

All operations on the DID (update, revoke, recover) are signed by private recovery key and verified by public recovery key. Verification process also includes the DID identifier validation - having the public recovery key, the verifier repeats steps 4 and 5 on his side and makes sure the DID matches the recovery key.

The format of ITN DID conform to the W3C DID Core specification. The W3C DID Core specification does not specify how a DID is generated, and leaves it up to the implementation provided it ensures uniqueness to a high degree of confidence.

Backus–Naur Form of ITN DID

  • ITN-DID ::= “did:itn:” itn-specific-id
  • itn-specific-id ::= base58-encoded-key
  • base58-encoded-key ::= base58-char
  • base58-char ::= [1-9] | [A-H] | [J-N] | [P-Z] | [a-k] | [m-z]

Explanation:

  • An ITN DID consists of the prefix “did:itn:” followed by the ITN-specific identifier.
  • The ITN-specific identifier is the base58 encoding of the first 16 bytes of the recovery key pair’s public key.
  • The “base58-encoded-key” represents the encoded key in base58 format, which is a special encoding scheme that excludes easily confused characters such as 0 (zero), O (capital letter O), I (capital letter i), and l (lowercase letter L).

Note: Format section ensures the ITN DID Format complies with W3C DID Method Syntax

Operations

Create

Description: Based on the DID data schema context file and DID method, the network anchors a DID and its DID document and delivers it to the requestor.

Requirements:

  • The provided DID MUST be compliant with the did:itn method.
  • The provided DID document MUST be compliant with the DID V1.0 DID document specification.

Here is how create operation works:

  • The create DID request is parsed by the ITN agent, which validates its syntax as well as the value of each field to follow specific rules.
  • The sender (requestor) generates the DID identifier based on the did:itn method specification, then the network stores the Hash(DID) and Hash(DID Document) in a smart contract on all the utilized ledger (one private and one public)
  • The DID document is stored in a federated content-addressable storage solution.
  • The valid DID document is the JSON object returned as the reply of the request.

Resolve

Description: Based on the DID data schema context file and DID method, the network delivers a DID document in accordance with the W3C DID standard.

Requirements:

  • A DID string MUST be provided.
  • The provided DID MUST be compliant with the did:itn method.

Here is how resolve operation works:

  • The ITN Agent is not involved in DID resolution process. The request goes directly to the DID Resolver.

Update

Description: Based on the DID data schema context file and DID method, the network creates an updated DID document in accordance with the W3C DID standard.

Requirements:

  • The provided DID string MUST be compliant with the did:itn method.
  • The provided DID document MUST be compliant with the DID V1.0 DID document specification.

Here is how update operation works:

  • The ITN Agent is responsible to very sender’s update request, the update request sender must be specified as a DID Document Controller and is authenticated by verifying the update request signature. The update request must be signed by the recovery key which is used before to generate the DID identifier. Note: DID Document is updated in the CAS and ledgers.

Revoke

Description: Based on the DID data schema context file and DID method, the network revokes an existing DID and its DID document in accordance with the W3C DID standard.

Requirements:

  • A DID string MUST be provided that has to be revoked.
  • The provided DID string MUST be compliant with the did:itn method.
  • The provided DID document MUST be compliant with the DID V1.0 DID document specification.

Here is how revoke operation works:

  • The ITN Agent is responsible to very sender’s revoke request, the revoke request sender must be specified as a DID Document Controller and is authenticated by verifying the revoke request signature. The revoke request must be signed by the recovery key which is used before to generate the DID identifier. Note: DID Document is updated in the CAS and ledgers.

Recover

Description: Based on the DID data schema context file and DID method, the network recovers a DID and its DID document in accordance with the W3C DID standard.

Requirements:

  • A DID string MUST be provided that has to be recovered.
  • The provided DID string MUST be compliant with the did:itn method.
  • The provided DID document MUST be compliant with the DID V1.0 DID document specification.

Here is how recover operation works:

  • The ITN Agent is responsible to very sender’s recover request, the recover request sender must be specified as a DID Document Controller and is authenticated by verifying the recover request signature. The recover request must be signed by the recovery key which is used before to generate the DID identifier. Note: DID Document is updated in the CAS and ledgers.

Deactivate

The revoke operation also deactivate the DID.

Sample DID Document

{
  "didDocument": {
    "@context": [
      "https://www.w3.org/ns/did/v1"
    ],
    "assertionMethod": [
      "did:itn:NL28Bubaa8xUmhJAARNkNS#z6MkiYmb7ncfDAAhcxtAAGsm1oySq4KYJtsi2wHaoKAnmVXC"
    ],
    "authentication": [
      "did:itn:NL28Bubaa8xUmhJAARNkNS#z6MkiYmb7ncfDAAhcxtAAGsm1oySq4KYJtsi2wHaoKAnmVXC"
    ],
    "id": "did:itn:NL28Bubaa8xUmhJAARNkNS",
    "keyAgreement": [
      {
        "id": "did:itn:NL28Bubaa8xUmhJAARNkNS#z6LSd76Tk2UJ3RVxcTjYjZ8TfvHMQgZG5HmbKPmCidPXyTGZ",
        "type": "X25519KeyAgreementKey2020",
        "controller": "did:itn:NL28Bubaa8xUmhJAARNkNS",
        "publicKeyMultibase": "z6LSd76Tk2UJ3RVxcTjYjZ8TfvHMQgZG5HmbKPmCidPXyTGZ"
      }
    ],
    "verificationMethod": [
      {
        "id": "did:itn:NL28Bubaa8xUmhJAARNkNS#z6MkiYmb7ncfDAAhcxtAAGsm1oySq4KYJtsi2wHaoKAnmVXC",
        "type": "Ed25519VerificationKey2020",
        "controller": "did:itn:NL28Bubaa8xUmhJAARNkNS",
        "publicKeyMultibase": "z6MkiYmb7ncfDAAhcxtAAGsm1oySq4KYJtsi2wHaoKAnmVXC"
      }
    ]
  },
  "didDocumentMetadata": {
    "created": "2024-04-16T14:46:33Z",
    "updated": "2024-04-16T14:46:33Z",
    "deactivated": false,
    "recoveryCommitment": "b45a0730f9c3227eae0338c8f95e140cff12393e90272fd32f2f21dadd242df0",
    "hlfProof": {
        "dataHash": "a440e6586566c3370cf968a8fbee40620fc9ac70e2bc2d2c482902576183f30e",
        "blockNumber": "19519",
        "transactionId": "812cbef8d667c28e939e3ee8f46fe7550f11b6c0042ae8bc3c7965c7e93a262f"
    },
    "evmProof": {
        "blockHash": "0xadddd6ae2eddbe50117357e8fbcd3921c4b0c6e3be2859a0cc9a75920bf876e3",
        "blockNumber": 34291384,
        "txHash": "0x4da901b643c05025c262fff27c80f0a30cb635783d057bebd79ef4f5cfed07e7"
    }
  },
  "didResolutionMetadata": { }
}

Security Considerations

  • ITN heavily relies on W3C DIDs (Decentralized Identifiers) and VCs (Verifiable Credentials) cryptographic mechanisms and decentralized trust models to mitigate the risks associated with various attacks.
  • Authentication service utilizing OAuth2 for REST APIs and DIF DID AuthN for DIF DIDcomm messaging.
  • Authentication is involved, particularly user-host authentication, the security characteristics are those of OAuth2 and DIDCom 2.0.
  • Beyond the residual risks specified in the utilized authentication and authorization protocols, there are the normal implementation security risks that should be addressed through a security audit of any implementation.
  • ITN DID Method relies on cryptographic protection mechanisms, ensuring that DID AuthN for all endpoints and communication channels and asymmetric encryption for all data.
  • Only the private keys are held in secret and that is up to the user to implement. ITN nodes employ the EDV standard for secret securing including Secure Hardware Elements (HSMs).
  • Keys are specified in the DID Document in Verification Methods object for various Verification Relationships.

Here's how ITN can prevent the specific attacks outlined:

  1. Eavesdropping: ITN DID can facilitate the establishment of secure communication channels between parties by encrypting messages exchanged between DIDs using cryptographic keys defined in the corresponding DID Documents. DIDs and VCs use cryptographic signatures to ensure that communication between parties is encrypted and authenticated. This prevents unauthorized interception and eavesdropping of sensitive information.

  2. Replay: Digital signatures utilized between the ITN and a user utilize nonces and DLT transactions on either of the utilized networks utilize both chainIds and account nonces to prevent DLT transaction replays.

  3. Message Insertion: Since ITN communication channels are using asymmetric encryption, the only way to insert a message would be to gain access to the private keys used for encryption, DID AuthN, and VC signatures.

  4. Deletion: The DLT transactions on the two anchor DLTs cannot be deleted and DID document entries in the CAS can only be deleted by ITN Node Operators. ITN Node Operators are permissioned, and known legal entities. In addition, currently, only three ITN nodes have write permissions into the CAS. Lastly, existing CAS data redundancies make a CAS deletion not practical.

  5. Modification: DID anchoring transactions on a DLT cannot be altered once the anchoring transaction is finalized on the respective DLT. CAS DID doc entries could only be maliciously modified by three specific ITN Nodes. Furthermore, data redundancies with rollbacks make modification attacks useless.

  6. Denial of Service (DoS): The ITN can operate as long as one honest node is operational. This means that besides typical (D)DoS protections enterprises utilize, the node redundancies in the network mitigate a DoS attack.

  7. Amplification: All DID operations apart from DID creation require DID AuthN. Therefore, each attack on a DID operation endpoint requires a DID and a secure communications channel. Hence, any attacks are limited to that established channel which can be disconnected at any time by an Operator. Lastly, the DID creation operation also requires establishing a secure communications channel which again restricts any attack to that channel, and, therefore, mitigation is as already mentioned. DOSing a channel would lead to a blacklisting of the malicious DID and a new DID would have to be created to perform an attack. Since the network only requires one honestly operating node, attacks by individual nodes would be recognized by other network nodes and access to that node can be easily removed by each node operator in their node, isolating the malicious node. And since network transactions have to be reimbursed to the ITN as an organization, spamming attacks of a compromised node lead to economic damage to the Operator operating the malicious node. This is an economic security guarantee since all Node Operators are known legal entities to which exists legal recourse.```

  8. Man-in-the-Middle (MitM): Asymmetric encryption of all ITN communication channels ensures a high degree of safety against MitM attacks unless the relevant private keys are compromised.

Note: Security Considerations section ensures the ITN DID Method Security considerations comply with W3C DID Method Security Requirements

Privacy Considerations

ITN is only storing the following data:

  • Public Keys in DID documents stored in our CAS, and in Smart Contracts stored on our DLTs
  • Hashed data in Smart Contracts on our DLTs representing DID documents, in our CAS for our VC revocation lists, and aggregate application state data
  • Service endpoints in DID documents on our CAS

In the ITN context, only Public Keys and Service Endpoints may refer to an individual. ITN ensures proper management in the following way:

  1. DID documents may be deleted by their controllers, and, therefore, access to DID documents from the outside by a 3rd party is no longer possible.
  2. While public keys and hashes of DID documents remain on the DLTs of the ITN, ITN will not maintain logs of IP addresses that requested ITN service operations, and, therefore, makes the correlation of a public key with personal data (the IP assigned to an individual’s router at a specific physical address by the ISP) from the point of view of the ITN, or an entity breaching the ITN, not possible. However, if a public key is used outside of the context of ITN more than once, then it may be subject to linkability to other personal data.

The reason why within ITN hashed data may be considered sufficiently anonymized is as follows: While hashed data may contain personal data through public keys or service endpoints in the DID documents, it is combined with randomized, non-personal data such as a DID itself, per European Commission (EC) guideline.

Note: Privacy Considerations section ensures the ITN DID Method Privacy considerations complies with W3C DID Method Privacy Requirements

Appendix

ITN SDK has crypto-ld-suite package that provides a set of functions to generate crypto keys for use with @digitalbazaar/crypto-ld library, a set of functions to create and verify signatures for use with @digitalbazaar/jsonld-signatures library and a set of utility functions for use with crypto keys.

Cryptographic Key Types supported

  • Ed25519VerificationKey2018
  • Ed25519VerificationKey2020
  • X25519KeyAgreementKey2019
  • X25519KeyAgreementKey2020
  • EcdsaSecp256k1VerificationKey2019
  • EcdsaSecp256r1VerificationKey2020
  • EcdsaSecp384r1VerificationKey2020
  • EcdsaSecp521r1VerificationKey2020
  • RsaVerificationKey2018
  • Bls12381G1Key2020
  • Bls12381G2Key2020

Supported curves are:

  • Ed25519
  • X25519
  • RSA
  • P-256
  • P-384
  • P-521
  • Bls12381G1
  • Bls12381G2
  • secp256k1 |

The following AEAD algorithms are supported for content encryption of the message

Algorithm Description
A256CBC-HS512 AES256-CBC + HMAC-SHA512 with a 512 bit key
A256GCM AES256-GCM with a 256 bit key
XC20P XChaCha20Poly1305 with a 256 bit key

The following Key Wrapping Algorithms are supported to wrap shared secret key

Algorithm Curve (epk crv) key type (epk kty)
ECDH-ES+A256KW P-256 EC
ECDH-ES+A256KW P-384 EC
ECDH-ES+A256KW P-521 EC
ECDH-ES+A256KW X25519 OKP
ECDH-1PU+A256KW P-256 EC
ECDH-1PU+A256KW P-384 EC
ECDH-1PU+A256KW P-521 EC
ECDH-1PU+A256KW X25519 OKP

References

[1] W3C Decentralized Identifiers (DIDs) v1.0, https://w3c.github.io/did-core/

About

ITN DID Method Specification

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •