Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/ceramicstudio/js-3id-did-provider

DID Provider for 3IDs in JavaScript
https://github.com/ceramicstudio/js-3id-did-provider
3id-did ceramic did-provider dids
Last synced: about 1 month ago
JSON representation
DID Provider for 3IDs in JavaScript
Host: GitHub
URL: https://github.com/ceramicstudio/js-3id-did-provider
Owner: ceramicstudio
License: other
Archived: true
Created: 2019-07-11T08:25:49.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2022-04-21T12:43:18.000Z (over 2 years ago)
Last Synced: 2024-10-23T16:45:46.289Z (about 2 months ago)
Topics: 3id-did, ceramic, did-provider, dids
Language: TypeScript
Homepage:
Size: 3.62 MB
Stars: 61
Watchers: 7
Forks: 18
Open Issues: 3
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE
Awesome Lists containing this project

awesome - `3id-did-provider`
README

        # ⚠️ Library moved

The 3ID DID provider source has been moved to the [3ID repository](https://github.com/ceramicstudio/js-3id/tree/develop/packages/did-provider) and the package is now [available on npm as `@3id/did-provider`](https://www.npmjs.com/package/@3id/did-provider).

The `3id-did-provider` package is no longer maintained.

# ThreeIdProvider

ThreeIdProvider is a JavaScript SDK that allows developers to create and manage 3ID identities on the Ceramic network. It exposes a [DID Provider](https://eips.ethereum.org/EIPS/eip-2844) interface which exposes JOSE signing and decryption though a JSON-RPC interface. ThreeIdProvider can be used in combination with [js-did](https://github.com/ceramicnetwork/js-did).

## Getting Started

### Installation

Install 3id-did-provider in your npm project:

```

$ npm install 3id-did-provider

```

### Usage

#### Import ThreeIdProvider into your project

Import the 3id-did-provider module

```js

import { ThreeIdProvider } from '3id-did-provider'

```

Import using the dist build in your html code

```js

```

#### Understanding the `getPermission` function

the `getPermission` configuration parameter is always required when creating an instance of ThreeIdProvider. It is used to give an application permission to decrypt and sign data. What this function should do is to present a dialog to the user in the wallet UI, asking for permission to access the given paths.

The function is called with one parameter which is the `request` object. It looks like this:

```js

{

  type: 'authenticate',

  origin: 'https://my.app.origin',

  payload: {

    paths: ['/path/1', '/path/2']

  }

}

```

In the above example the app with origin `https://my.app.origin` is requesting access to `/path/1` and `/path/2`. If the user consents to this the function should just return the `paths` array, otherwise an empty array. Note that an array containing only some of the requested paths may also be returned.

#### Instantiate ThreeIdProvider with an authentication method

To create an instance with an auth method you can pass two params to the create function as shown below. If the auth method doesn't have a 3ID associated with it yet a new 3ID will be created. This means that a seed will be randomly generated in the background. and the given *authSecret* will be added as an authentication method to the newly created 3ID.

```js

const authSecret = new Uint8Array([ ... ]) // 32 bytes of entropy used to authenticate

const authId = 'myAuthenticationMethod' // a name of the auth method

const ceramic = ... // An instance of Ceramic (either @ceramicnetwork/core, or @ceramicnetwork/http-client)

const threeId = await ThreeIdProvider.create({ getPermission, authSecret, authId, ceramic })

```

#### Instantiate ThreeIdProvider with a seed

To create a wallet with a seed you can simply pass it as an option to the constructor. This will create an instance of the ThreeIdProvider that derives all it's keys from this seed. Be careful, if this seed is lost the DID and all of it's data will be lost as well. Note that you will get different 3IDs every time the `create` method is invoked with the same seed. An authentication method must be used in order to interact with the same 3ID consistently.

```js

const seed = new Uint8Array([ ... ]) // 32 bytes of entropy used as the seed

const ceramic = ... // An instance of Ceramic (either @ceramicnetwork/core, or @ceramicnetwork/http-client)

const threeId = await ThreeIdProvider.create({ getPermission, seed, ceramic })

```

#### Using the ThreeIdProvider with js-did

An instance of the DID provider from ThreeIdProvider can be passed directly to js-did.

```js

import ThreeIdResolver from '@ceramicnetwork/3id-did-resolve'

import Ceramic from '@ceramicnetwork/http-client'

const provider = threeId.getDidProvider()

const resolver = ThreeIdResolver.getResolver(new Ceramic())

const did = new DID({ provider, resolver })

```

## Maintainers

[@oed](https://github.com/oed)

##  API Documentation



### Keychain

**Kind**: global class  

* [Keychain](#Keychain)

    * [new Keychain()](#new_Keychain_new)

    * [.list()](#Keychain+list) ⇒ Array.<string>

    * [.add(authId, authSecret)](#Keychain+add)

    * [.remove(authId)](#Keychain+remove)

    * [.status()](#Keychain+status) ⇒ KeychainStatus

    * [.commit()](#Keychain+commit)



#### new Keychain()

The Keychain enables adding and removing of authentication methods.



#### keychain.list() ⇒ Array.<string>

List all current authentication methods.

**Kind**: instance method of [Keychain](#Keychain)  

**Returns**: Array.<string> - A list of authIds.  



#### keychain.add(authId, authSecret)

Add a new authentication method (adds to staging).

**Kind**: instance method of [Keychain](#Keychain)  

| Param | Type | Description |

| --- | --- | --- |

| authId | String | An identifier for the auth method |

| authSecret | Uint8Array | The authSecret to use, should be of sufficient entropy |



#### keychain.remove(authId)

Remove an authentication method (adds to staging).

**Kind**: instance method of [Keychain](#Keychain)  

| Param | Type | Description |

| --- | --- | --- |

| authId | String | An identifier for the auth method |



#### keychain.status() ⇒ KeychainStatus

Show the staging status of the keychain.

Since removing auth methods will rotate the keys of the 3ID its a good idea

to remove multiple auth methods at once if desired. Therefore we introduce

a commit pattern to do multiple updates to the keychain at once.

**Kind**: instance method of [Keychain](#Keychain)  

**Returns**: KeychainStatus - Object that states the staging status of the keychain  



#### keychain.commit()

Commit the staged changes to the keychain.

**Kind**: instance method of [Keychain](#Keychain)  



### Permissions

**Kind**: global class  

* [Permissions](#Permissions)

    * [new Permissions()](#new_Permissions_new)

    * [.request(origin, paths)](#Permissions+request) ⇒ Array.<String>

    * [.has(origin, paths)](#Permissions+has) ⇒ Boolean

    * [.get(origin)](#Permissions+get) ⇒ Array.<String>

    * [.set(origin, paths)](#Permissions+set)



#### new Permissions()

The Permissions class exposes methods to read and update the given permissions



#### permissions.request(origin, paths) ⇒ Array.<String>

Request permission for given paths for a given origin.

**Kind**: instance method of [Permissions](#Permissions)  

**Returns**: Array.<String> - The paths that where granted permission for  

| Param | Type | Description |

| --- | --- | --- |

| origin | String | Application domain |

| paths | Array.<String> | The desired paths |



#### permissions.has(origin, paths) ⇒ Boolean

Determine if permission has been given for paths for a given origin.

**Kind**: instance method of [Permissions](#Permissions)  

**Returns**: Boolean - True if permission has previously been given  

| Param | Type | Description |

| --- | --- | --- |

| origin | String | Application domain |

| paths | Array.<String> | The desired paths |



#### permissions.get(origin) ⇒ Array.<String>

Get the paths which the given origin has permission for.

**Kind**: instance method of [Permissions](#Permissions)  

**Returns**: Array.<String> - The permissioned paths  

| Param | Type | Description |

| --- | --- | --- |

| origin | String | Application domain |



#### permissions.set(origin, paths)

Set the paths which the given origin should have permission for.

**Kind**: instance method of [Permissions](#Permissions)  

| Param | Type | Description |

| --- | --- | --- |

| origin | String | Application domain |

| paths | Array.<String> | The desired paths |



### ThreeIdProvider

**Kind**: global class  

* [ThreeIdProvider](#ThreeIdProvider)

    * [new ThreeIdProvider()](#new_ThreeIdProvider_new)

    * _instance_

        * [.keychain](#ThreeIdProvider+keychain)

        * [.permissions](#ThreeIdProvider+permissions)

        * [.id](#ThreeIdProvider+id)

        * [.getDidProvider()](#ThreeIdProvider+getDidProvider) ⇒ DidProvider

    * _static_

        * [.create(config)](#ThreeIdProvider.create) ⇒ [ThreeIdProvider](#ThreeIdProvider)



#### new ThreeIdProvider()

Use ThreeIdProvider.create() to create an ThreeIdProvider instance



#### threeIdProvider.keychain

**Kind**: instance property of [ThreeIdProvider](#ThreeIdProvider)  

**Properties**

| Name | Type | Description |

| --- | --- | --- |

| keychain | [Keychain](#Keychain) | Edit the keychain |



#### threeIdProvider.permissions

**Kind**: instance property of [ThreeIdProvider](#ThreeIdProvider)  

**Properties**

| Name | Type | Description |

| --- | --- | --- |

| permissions | [Permissions](#Permissions) | Edit permissions |



#### threeIdProvider.id

**Kind**: instance property of [ThreeIdProvider](#ThreeIdProvider)  

**Properties**

| Name | Type | Description |

| --- | --- | --- |

| id | string | The DID of the ThreeIdProvider instance |



#### threeIdProvider.getDidProvider() ⇒ DidProvider

Get the DIDProvider

**Kind**: instance method of [ThreeIdProvider](#ThreeIdProvider)  

**Returns**: DidProvider - The DIDProvider for this ThreeIdProvider instance  



#### ThreeIdProvider.create(config) ⇒ [ThreeIdProvider](#ThreeIdProvider)

Creates an instance of ThreeIdProvider

**Kind**: static method of [ThreeIdProvider](#ThreeIdProvider)  

**Returns**: [ThreeIdProvider](#ThreeIdProvider) - An ThreeIdProvider instance  

| Param | Type | Description |

| --- | --- | --- |

| config | Object | The configuration to be used |

| config.getPermission | function | The function that is called to ask the user for permission |

| config.ceramic | CeramicApi | The ceramic instance to use |

| config.loader | TileLoader | An optional TileLoader instance to use |

| config.seed | Uint8Array | The seed of the 3ID, 32 bytes |

| config.authSecret | Uint8Array | The authSecret to use, 32 bytes |

| config.authId | String | The authId is used to identify the authSecret |

| config.disableIDX | Boolean | Disable creation of the IDX document |

| config.v03ID | String | A v0 3ID, has to be passed if a migration is being preformed |