tbd54566975 / dwn-sdk-js Goto Github PK

View Code? Open in Web Editor NEW

323.0 323.0 96.0 5.37 MB

Decentralized Web Node (DWN) Reference implementation

Home Page: https://identity.foundation/decentralized-web-node/spec/

License: Apache License 2.0

JavaScript 1.49% TypeScript 98.48% Shell 0.04%

dwn-sdk-js's Introduction

well-known files for universal links to TBD projects

dwn-sdk-js's People

Contributors

Stargazers

Watchers

Forkers

noidlehq seanpwhitehurst alrubinger joegesualdo duaneking 22388o nully0x stevenconnors jorge-menjivar akay74 veevee77 opssy oldeucryptoboi ashiqdey nwylynko jm-lozano dgarc359 teamchong rynst takashimamorino theseyi bayramcavlak mootpt shobitb spicyzboss yuyatinnefeld peteoleary bnonni heacare boldaslions virajjiwane annmalavet amansbhandari acmpm vink007 cxxshyy baristikir flothjl pancaldi marcusdiaz rajakash-dev adaptivefailure grahnj shibaone carez td-bn gtaylor5 moisesja cmamba pdxjohnny michaelneale atlbitlab lone-starr mykin-ai wavesrcool mileashter kodepirate jakefernandes98 dissy123 duncanmak bobbilee19 arealayer ebonylouis vlad-timofeev 13x-tech achingbrain rgrunau ryalsjosh14 coinhubx shamilovtim aneeshakota arealayer adalundhe andorsk ethicalsecurity-agency modernfoundry galaxy-bytes captain-akshay hkwi maryamkhan14 adarsh-a-tw 0scvr sreeranjani14 rizina petsamuel aryan4884 mishmanners lchauha qblockq volland angiejones theisens ianpatton theisens-forked-dwn-sdk kirahsapong

dwn-sdk-js's Issues

why not use solid ?

https://solidproject.org/

Explicit check to ensure only 1 signer

Should we add an explicit check to ensure that there's only 1 signer?

dwn-sdk-js/src/interfaces/permissions/handlers/permissions-request.ts

Lines 21 to 28 in fcea849

 // TODO: should we add an explicit check to ensure that there's only 1 signer? 

 const { signers } = await request.verifyAuth(didResolver); 

 const [ signer ] = signers; 

 if (signer !== request.grantedTo) { 

 throw new Error('grantee must be signer'); 

 }

Replace publicKeyJwk validation with JSON Schema based validation

Replace publicKeyJwk validation with JSON Schema-based validation

more info about the publicKeyJwk property can be found here:
https://www.w3.org/TR/did-spec-registries/#publickeyjwk

dwn-sdk-js/src/message.ts

Lines 146 to 151 in 98202be

 // TODO: replace with JSON Schema based validation 

 // more info about the `publicKeyJwk` property can be found here: 

 // https://www.w3.org/TR/did-spec-registries/#publickeyjwk 

 if (!publicKeyJwk) { 

 throw new Error(`publicKeyJwk property not found on verification method [${kid}]`); 

 }

Replace verificationMethod checks with JSON Schema based validation (JsonWebKey2020)

Replace with JSON Schema based validation for JsonWebKey2020. More info about the JsonWebKey2020 type can be found here: https://www.w3.org/TR/did-spec-registries/#jsonwebkey2020

dwn-sdk-js/src/jose/jws/general/verifier.ts

Lines 66 to 73 in fcea849

 
 // TODO: replace with JSON Schema based validation 

 // more info about the `JsonWebKey2020` type can be found here: 

 // https://www.w3.org/TR/did-spec-registries/#jsonwebkey2020 

 if (verificationMethod.type !== 'JsonWebKey2020') { 

 throw new Error(`verification method [${kid}] must be JsonWebKey2020`); 

 }

Clean up code and make composable

Clean this up and likely move it elsewhere (e.g. a different function) so that it can be used elsewhere

dwn-sdk-js/src/store/message-store-level.ts

Lines 110 to 118 in 98202be

 const indexDocument: any = { _id: encodedBlock.cid.toString(), method, objectId }; 

 // TODO: clean this up and likely move it elsewhere (e.g. a different function) so that it can be used elsewhere 

 if (descriptor.method === 'PermissionsRequest') { 

 indexDocument.ability = descriptor.ability; 

 indexDocument.requester = descriptor.requester; 

 } 

 await this.index.PUT([indexDocument]);

Implement `MessageIndex` interface

Check controller and DID in kid are the same

Figure out if we need to check to ensure that controller === did in kid are the same. This may matter more for a PermissionsRequest

dwn-sdk-js/src/message.ts

Lines 150 to 154 in 98202be

 throw new Error(`publicKeyJwk property not found on verification method [${kid}]`); 

 } 

 // TODO: figure out if we need to check to ensure that `controller` === did in kid 

 // are the same. This may matter more for a `PermissionsRequest`

Decide on how we want to handle errors

Currently all we do is Throw new Error all over the place, and that may or may not be the path we want to stick with moving forward. Use this issue as a means to discuss pros/cons of different approaches for handling errors

Fill out `README.md`

Implement Threads interface

Add docs to `dwn.ts`

Add docs to dwn.ts processMessage(rawMessage: object, ctx: Context)

dwn-sdk-js/src/dwn.ts

Lines 82 to 88 in fcea849

 /** 

  * TODO: add docs 

  * @param message 

  */ 

 async processMessage(rawMessage: object, ctx: Context): Promise<MessageReply> { 

 let message: MessageSchema;

Decide whether to use typescript or JSDoc + type definitions

instrument telemetry into codebase

document reasons for why having telemetry in dwn would be beneficial
choose lib we want to use for telemetry
instrument codebase with said lib. Consider using open telemetry

Write DMZ spec proposal

Add better DID validation

Current requester DID validation uses naive technique. Add better DID validation.

dwn-sdk-js/src/did/did-resolver.ts

Lines 26 to 33 in fcea849

 public async resolve(did: string): Promise<DIDResolutionResult> { 

 // naively validate requester DID 

 // TODO: add better DID validation 

 const splitDID = did.split(':', 3); 

 if (splitDID.length < 3) { 

 throw new Error(`${did} is not a valid DID`); 

 }

Proposed changes in PR #60. New function validateDID(did):

dwn-sdk-js/src/did/did-resolver.ts

Lines 26 to 30 in e9b76bc

 public async resolve(did: string): Promise<DIDResolutionResult> { 

 // naively validate requester DID 

 validateDID(did); 

 const splitDID = did.split(':', 3);

Function implementation:

dwn-sdk-js/src/did/did-resolver.ts

Lines 53 to 68 in e9b76bc

 /** 

  * @param did - the DID to validate 

  */ 

 export function validateDID(did: unknown): void { 

 // @see https://www.w3.org/TR/2021/PR-did-core-20210803/#did-syntax 

 const DID_REGEX = /^did:[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+:[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+$/; 

 if (typeof did !== 'string') { 

 throw new TypeError(`DID is not string: ${did}`); 

 } 

 if (!DID_REGEX.test(did)) { 

 throw new TypeError(`DID is not a valid DID: ${did}`); 

 } 

 }

Set up Github Action to build `dist` bundles whenever commits are pushed to main

Scaffold Project

Add cache support to avoid costly validation of the same signature

Add logic to prevent validating duplicate signatures

dwn-sdk-js/src/jose/jws/general/verifier.ts

Lines 14 to 44 in fcea849

 // TODO: add logic to prevent validating duplicate signatures 

 export class GeneralJwsVerifier { 

 jws: GeneralJws; 

 constructor(jws: GeneralJws) { 

 this.jws = jws; 

 } 

 async verify(didResolver: DIDResolver): Promise<VerificationResult> { 

 const signers: string[] = []; 

 for (const signature of this.jws.signatures) { 

 const protectedBytes = base64url.baseDecode(signature.protected); 

 const protectedJson = new TextDecoder().decode(protectedBytes); 

 const { kid } = JSON.parse(protectedJson); 

 const did = GeneralJwsVerifier.extractDid(kid); 

 const publicJwk = await GeneralJwsVerifier.getPublicKey(did, kid, didResolver); 

 const isVerified = await GeneralJwsVerifier.verifySignature(this.jws.payload, signature, publicJwk); 

 if (isVerified) { 

 signers.push(did); 

 } else { 

 throw new Error(`signature verification failed for ${did}`); 

 } 

 } 

 return { signers }; 

 }

Figure out how we want to approach logging

Add cache support to DidResolver

Add DIDCache to constructor method signature.

dwn-sdk-js/src/did/did-resolver.ts

Lines 9 to 17 in fcea849

 // TODO: add DIDCache to constructor method signature 

 constructor(resolvers: DIDMethodResolver[]) { 

 this.didResolvers = new Map(); 

 for (const resolver of resolvers) { 

 this.didResolvers.set(resolver.method(), resolver); 

 } 

 }

Paramaterize name in message-store-level.ts

Calling searchIndex twice causes the process to hang, so check to see if the index has already been "opened" before opening it again.

dwn-sdk-js/src/store/message-store-level.ts

Lines 43 to 53 in 98202be

 async open(): Promise<void> { 

 await this.db.open(); 

 // TODO: look into using the same level we're using for blockstore 

 // TODO: parameterize `name` 

 // calling `searchIndex` twice causes the process to hang, so check to see if the index 

 // has already been "opened" before opening it again. 

 if (!this.index) { 

 this.index = await searchIndex({ name: this.config.indexLocation }); 

 } 

 }

Change test files to follow convention of `*.spec.ts`

Build helpful errors object using returned errors

Every time a validation function is called the errors property is overwritten.
eg const errors = [...validateFn.errors];

dwn-sdk-js/src/message.ts

Lines 50 to 56 in 98202be

 if (!isValid) { 

 // TODO: build helpful errors object using returned errors 

 // Every time a validation function is called the errors property is overwritten. 

 // const errors = [...validateFn.errors]; 

 throw new Error('Invalid message.'); 

 } 

 }

Workaround for search-indexlib not importing type

Find a workaround for search-indexlib not importing type SearchIndex

dwn-sdk-js/src/store/message-store-level.ts

Lines 18 to 24 in 98202be

 export class MessageStoreLevel implements MessageStore { 

 config: MessageStoreLevelConfig; 

 db: BlockstoreLevel; 

 // levelDB doesn't natively provide the querying capabilities needed for DWN. To accommodate, we're leveraging 

 // a level-backed inverted index 

 // TODO: search-index lib does not import type `SearchIndex`. find a workaround 

 index;

Implement Collections interface

Figure out if support needed for all W3 verification method properties

Figure out if we need to support ALL verification method properties.

dwn-sdk-js/src/did/did-resolver.ts

Lines 97 to 112 in fcea849

 // TODO: figure out if we need to support ALL verification method properties 

 // listed here: https://www.w3.org/TR/did-spec-registries/#verification-method-properties 

 export type VerificationMethod = { 

 id: string 

 // one of the valid verification method types as per 

 // https://www.w3.org/TR/did-spec-registries/#verification-method-types 

 type: string 

 // DID of the key's controller 

 controller: string 

 // a JSON Web Key that conforms to https://datatracker.ietf.org/doc/html/rfc7517 

 publicKeyJwk?: PublicJwk 

 // a string representation of 

 // https://datatracker.ietf.org/doc/html/draft-multiformats-multibase-05 

 publicKeyMultibase?: string 

 };

Add JSDoc to validator.ts

Add JSDoc to validator.ts validate(schemaName: string, payload: any)

dwn-sdk-js/src/validation/validator.ts

Lines 13 to 20 in fcea849

 
 /** 

  * TODO: add JSDoc 

  * @param schemaName 

  * @param payload 

  * @returns 

  */ 

 export function validate(schemaName: string, payload: any): void {

Fill out `CODEOWNERS`

Implement logic to verify message signature

Resolved by #23

Create GH issues for each TODO in codebase and link the corresponding issue number (eg. #123)

For each // TODO: in codebase:

create respective GH issue
reference issue # next to each TODO in codebase

Decide on whether to publish lib to npm or Github package registry

Run tests against browser bundles in headless browsers

Add permission verification to `Collections` interface

Set up Github Action to run tests whenever a non-draft PR is opened

Implement Sync

related proposal issue: decentralized-identity/decentralized-web-node#128

Add support for `EdDSA` and `ES256K` key types in the browser.

JOSE doesn't support EdDSA or ES256K (aka secp256k1) in the browser. I went ahead and added automated headless browser testing against our browser bundles so that we can fish out issues like these programmatically.

The tests that generate EdDSA keys are currently failing in the browser.

Replace verificationMethod checks with JSON Schema based validation (publicJwk)

Replace with JSON Schema based validation for publicJwk. More info about the publicJwk property can be found here: https://www.w3.org/TR/did-spec-registries/#publicJwk

dwn-sdk-js/src/jose/jws/general/verifier.ts

Lines 74 to 84 in fcea849

 const { publicKeyJwk: publicJwk } = verificationMethod; 

 // TODO: replace with JSON Schema based validation 

 // more info about the `publicJwk` property can be found here: 

 // https://www.w3.org/TR/did-spec-registries/#publicJwk 

 if (!publicJwk) { 

 throw new Error(`publicKeyJwk property not found on verification method [${kid}]`); 

 } 

 return publicJwk as PublicJwk; 

 }

Update Markdown-based doc links to absolute from relative

As required for surfacing documentation on Developer Site

Starting point for request:

https://github.com/TBD54566975/dwn-sdk-js/blob/main/CONTRIBUTING.md
Link to : .eslintrc.cjs should be fully qualified (https://github.com/TBD54566975/dwn-sdk-js/blob/main/.eslintrc.cjs)
https://github.com/TBD54566975/dwn-sdk-js/blob/main/GOVERNANCE.md
Broken links:
[List of maintainers - MAINTAINERS.md](https://github.com/TBD54566975/dwn-sdk-js/blob/main/MAINTAINERS.md)

Implement `MessageStore` interface

Fill out `CONTRIBUTING.md`

Use the same level for index as blockstore is using

dwn-sdk-js/src/store/message-store-level.ts

Lines 43 to 53 in 98202be

 async open(): Promise<void> { 

 await this.db.open(); 

 // TODO: look into using the same level we're using for blockstore 

 // TODO: parameterize `name` 

 // calling `searchIndex` twice causes the process to hang, so check to see if the index 

 // has already been "opened" before opening it again. 

 if (!this.index) { 

 this.index = await searchIndex({ name: this.config.indexLocation }); 

 } 

 }

Line 34 in 98202be

* TODO: add docs

Declare proper typing for `includeCriteria` and `excludeCriteria` in MessageStore and MessageStoreLevel

Change type of query

dwn-sdk-js/src/store/message-store.ts

Lines 32 to 34 in fcea849

 // TODO: change type of `query` 

 query(query: any, ctx: Context): Promise<MessageSchema[]>;

Add docs to `DIDResolver` class

Add docs to DIDResolver class

dwn-sdk-js/src/did/did-resolver.ts

Lines 3 to 8 in fcea849

 /** 

  * TODO: add docs 

  */ 

 export class DIDResolver { 

 didResolvers: Map<string, DIDMethodResolver>;

Consider simplifying the SDK by using a singleton for DID Resolver

With a singleton, we will not need to pass the DID resolver around in many methods in the SDK.

Implement Hooks

related proposal issue: decentralized-identity/decentralized-web-node#127

	// TODO: should we add an explicit check to ensure that there's only 1 signer?
	const { signers } = await request.verifyAuth(didResolver);
	const [ signer ] = signers;

	if (signer !== request.grantedTo) {
	throw new Error('grantee must be signer');
	}

	// TODO: replace with JSON Schema based validation
	// more info about the `publicKeyJwk` property can be found here:
	// https://www.w3.org/TR/did-spec-registries/#publickeyjwk
	if (!publicKeyJwk) {
	throw new Error(`publicKeyJwk property not found on verification method [${kid}]`);
	}


	// TODO: replace with JSON Schema based validation
	// more info about the `JsonWebKey2020` type can be found here:
	// https://www.w3.org/TR/did-spec-registries/#jsonwebkey2020
	if (verificationMethod.type !== 'JsonWebKey2020') {
	throw new Error(`verification method [${kid}] must be JsonWebKey2020`);
	}

	const indexDocument: any = { _id: encodedBlock.cid.toString(), method, objectId };

	// TODO: clean this up and likely move it elsewhere (e.g. a different function) so that it can be used elsewhere
	if (descriptor.method === 'PermissionsRequest') {
	indexDocument.ability = descriptor.ability;
	indexDocument.requester = descriptor.requester;
	}

	await this.index.PUT([indexDocument]);

	throw new Error(`publicKeyJwk property not found on verification method [${kid}]`);
	}

	// TODO: figure out if we need to check to ensure that `controller` === did in kid
	// are the same. This may matter more for a `PermissionsRequest`

	/**
	* TODO: add docs
	* @param message
	*/
	async processMessage(rawMessage: object, ctx: Context): Promise<MessageReply> {
	let message: MessageSchema;

	public async resolve(did: string): Promise<DIDResolutionResult> {
	// naively validate requester DID
	// TODO: add better DID validation
	const splitDID = did.split(':', 3);
	if (splitDID.length < 3) {
	throw new Error(`${did} is not a valid DID`);
	}

	public async resolve(did: string): Promise<DIDResolutionResult> {
	// naively validate requester DID
	validateDID(did);
	const splitDID = did.split(':', 3);

	/**
	* @param did - the DID to validate
	*/
	export function validateDID(did: unknown): void {
	// @see https://www.w3.org/TR/2021/PR-did-core-20210803/#did-syntax
	const DID_REGEX = /^did:[a-zA-Z0-9.!#$%&'+\/=?^_`{\|}~-]+:[a-zA-Z0-9.!#$%&'+\/=?^_`{\|}~-]+$/;

	if (typeof did !== 'string') {
	throw new TypeError(`DID is not string: ${did}`);
	}

	if (!DID_REGEX.test(did)) {
	throw new TypeError(`DID is not a valid DID: ${did}`);
	}
	}

	// TODO: add logic to prevent validating duplicate signatures
	export class GeneralJwsVerifier {
	jws: GeneralJws;

	constructor(jws: GeneralJws) {
	this.jws = jws;
	}

	async verify(didResolver: DIDResolver): Promise<VerificationResult> {
	const signers: string[] = [];

	for (const signature of this.jws.signatures) {
	const protectedBytes = base64url.baseDecode(signature.protected);
	const protectedJson = new TextDecoder().decode(protectedBytes);

	const { kid } = JSON.parse(protectedJson);
	const did = GeneralJwsVerifier.extractDid(kid);
	const publicJwk = await GeneralJwsVerifier.getPublicKey(did, kid, didResolver);

	const isVerified = await GeneralJwsVerifier.verifySignature(this.jws.payload, signature, publicJwk);

	if (isVerified) {
	signers.push(did);
	} else {
	throw new Error(`signature verification failed for ${did}`);
	}
	}

	return { signers };
	}

	// TODO: add DIDCache to constructor method signature
	constructor(resolvers: DIDMethodResolver[]) {
	this.didResolvers = new Map();

	for (const resolver of resolvers) {
	this.didResolvers.set(resolver.method(), resolver);
	}
	}

	async open(): Promise<void> {
	await this.db.open();

	// TODO: look into using the same level we're using for blockstore
	// TODO: parameterize `name`
	// calling `searchIndex` twice causes the process to hang, so check to see if the index
	// has already been "opened" before opening it again.
	if (!this.index) {
	this.index = await searchIndex({ name: this.config.indexLocation });
	}
	}

	if (!isValid) {
	// TODO: build helpful errors object using returned errors
	// Every time a validation function is called the errors property is overwritten.
	// const errors = [...validateFn.errors];
	throw new Error('Invalid message.');
	}
	}

	export class MessageStoreLevel implements MessageStore {
	config: MessageStoreLevelConfig;
	db: BlockstoreLevel;
	// levelDB doesn't natively provide the querying capabilities needed for DWN. To accommodate, we're leveraging
	// a level-backed inverted index
	// TODO: search-index lib does not import type `SearchIndex`. find a workaround
	index;

	// TODO: figure out if we need to support ALL verification method properties
	// listed here: https://www.w3.org/TR/did-spec-registries/#verification-method-properties
	export type VerificationMethod = {
	id: string
	// one of the valid verification method types as per
	// https://www.w3.org/TR/did-spec-registries/#verification-method-types
	type: string
	// DID of the key's controller
	controller: string
	// a JSON Web Key that conforms to https://datatracker.ietf.org/doc/html/rfc7517
	publicKeyJwk?: PublicJwk
	// a string representation of
	// https://datatracker.ietf.org/doc/html/draft-multiformats-multibase-05
	publicKeyMultibase?: string
	};


	/**
	* TODO: add JSDoc
	* @param schemaName
	* @param payload
	* @returns
	*/
	export function validate(schemaName: string, payload: any): void {

	const { publicKeyJwk: publicJwk } = verificationMethod;

	// TODO: replace with JSON Schema based validation
	// more info about the `publicJwk` property can be found here:
	// https://www.w3.org/TR/did-spec-registries/#publicJwk
	if (!publicJwk) {
	throw new Error(`publicKeyJwk property not found on verification method [${kid}]`);
	}

	return publicJwk as PublicJwk;
	}

	// TODO: change type of `query`
	query(query: any, ctx: Context): Promise<MessageSchema[]>;

	/**
	* TODO: add docs
	*/
	export class DIDResolver {
	didResolvers: Map<string, DIDMethodResolver>;

tbd54566975 / dwn-sdk-js Goto Github PK

dwn-sdk-js's Introduction

dwn-sdk-js's People

Contributors

Stargazers

Watchers

Forkers

dwn-sdk-js's Issues

Recommend Projects

Recommend Topics

Recommend Org