https://github.com/decentralized-identity/web-did-resolver

DID resolver for HTTPS domains
https://github.com/decentralized-identity/web-did-resolver

wg-id

Last synced: about 15 hours ago
JSON representation

DID resolver for HTTPS domains

• Host: GitHub
• URL: https://github.com/decentralized-identity/web-did-resolver
• Owner: decentralized-identity
• License: apache-2.0
• Created: 2018-09-20T21:44:09.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T14:26:23.000Z (about 2 months ago)
• Last Synced: 2024-10-29T17:35:10.321Z (about 2 months ago)
• Topics: wg-id
• Language: TypeScript
• Size: 2.79 MB
• Stars: 84
• Watchers: 15
• Forks: 18
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![npm](https://img.shields.io/npm/dt/web-did-resolver.svg)](https://www.npmjs.com/package/web-did-resolver)

[![npm](https://img.shields.io/npm/v/web-did-resolver.svg)](https://www.npmjs.com/package/web-did-resolver)

[![codecov](https://codecov.io/gh/decentralized-identity/web-did-resolver/branch/develop/graph/badge.svg)](https://codecov.io/gh/decentralized-identity/web-did-resolver)

# Web DID Resolver

This library is intended to represent domains accessed through https as

[Decentralized Identifiers](https://w3c.github.io/did-core/#identifier)

and retrieve an associated [DID Document](https://w3c.github.io/did-core/#did-document-properties)

It supports the proposed [`did:web` method spec](https://w3c-ccg.github.io/did-method-web/) from

the [W3C Credentials Community Group](https://w3c-ccg.github.io).

It requires the `did-resolver` library, which is the primary interface for resolving DIDs.

## DID method

To encode a DID for an HTTPS domain, simply prepend `did:web:` to domain name.

eg: `https://example.com -> did:web:example.com`

## DID Document

The DID resolver takes the domain and forms a [well-known URI](https://tools.ietf.org/html/rfc5785)

to access the DID Document.

For a did `did:web:example.com`, the resolver will attempt to access the document at

`https://example.com/.well-known/did.json`

A minimal DID Document might contain the following information:

```json

{

  "@context": "https://w3id.org/did/v1",

  "id": "did:web:example.com",

  "publicKey": [

    {

      "id": "did:web:example.com#owner",

      "type": "Secp256k1VerificationKey2018",

      "controller": "did:web:example.com",

      "publicKeyHex": "04ab0102bcae6c7c3a90b01a3879d9518081bc06123038488db9cb109b082a77d97ea3373e3dfde0eccd9adbdce11d0302ea5c098dbb0b310234c8689501749274"

    }

  ],

  "assertionMethod": [ "did:web:example.com#owner" ],

  "authentication": [ "did:web:example.com#owner" ]

}

```

Note: this example uses the `Secp256k1VerificationKey2018` type and an `publicKeyHex` as a publicKey entry, signaling

that this DID is claiming to control the private key associated with that publicKey.

## Resolving a DID document

The resolver presents a simple `resolver()` function that returns a ES6 Promise returning the DID document.

```js

import { Resolver } from 'did-resolver'

import { getResolver } from 'web-did-resolver'

const webResolver = getResolver()

const didResolver = new Resolver({

    ...webResolver

    //...you can flatten multiple resolver methods into the Resolver

})

didResolver.resolve('did:web:uport.me').then(doc => console.log(doc))

// You can also use ES7 async/await syntax

;(async () => {

    const doc = await didResolver.resolve('did:web:uport.me')

    console.log(doc)

})();

```