-
Notifications
You must be signed in to change notification settings - Fork 135
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(coordinate-mediation): implement did-comm coordinate-mediation v…
…3.0 (#1282) Implement coordinate mediation from v3 (https://didcomm.org/coordinate-mediation/3.0/) - add recipient update - add recipient update response - add recipient query - add recipient add grant or deny control mechanism - add default logic - add TODO for injection of grant/deny mechanism logic add datastore for: - mediation - recipient did - mediation policy define types: - IDataStore - IMediation - IMediationPolicy - IRecipientDid add tests for new functionality - modify mediate test suite - add recipient update test suite - add recipient query test suite documentation: - add documentation on introduced methods cli: - add mediate allow-from command - add mediate deny-from command - add mediate list - add mediate remove --------- Co-authored-by: Paul Parker
- Loading branch information
1 parent
d89a4dd
commit 462735d
Showing
39 changed files
with
3,142 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -64,3 +64,4 @@ agent: | |
| - createSelectiveDisclosureRequest | ||
| - getVerifiableCredentialsForSdr | ||
| - validatePresentationAgainstSdr | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,201 @@ | ||
| import { Command } from 'commander' | ||
| import inquirer from 'inquirer' | ||
|
|
||
| import { getAgent } from './setup.js' | ||
| import { PreMediationRequestPolicy, RecipientDid, RequesterDid } from '@veramo/mediation-manager' | ||
|
|
||
| type ConfiguredAgent = Awaited<ReturnType<typeof getAgent>> | ||
|
|
||
| const ALLOW = 'ALLOW' | ||
| const DENY = 'DENY' | ||
|
|
||
| type Options = Partial<{ | ||
| granted: boolean | ||
| denied: boolean | ||
| allowFrom: boolean | ||
| denyFrom: boolean | ||
| interactive: boolean | ||
| fileJson: string | ||
| }> | ||
|
|
||
| type UpdatePolicyParams = { | ||
| dids: string[] | ||
| agent: ConfiguredAgent | ||
| policy?: PreMediationRequestPolicy | ||
| remove?: boolean | ||
| } | ||
|
|
||
| /** | ||
| * private functions | ||
| **/ | ||
|
|
||
| const updatePolicies = async (options: UpdatePolicyParams): Promise<void> => { | ||
| const { dids, agent, policy, remove = false } = options | ||
| if (remove) { | ||
| return dids.forEach( | ||
| async (requesterDid) => await agent.mediationManagerRemoveMediationPolicy({ requesterDid }), | ||
| ) | ||
| } | ||
| if (!policy) throw new Error('No policy provided') | ||
| return dids.forEach( | ||
| async (requesterDid) => await agent.mediationManagerSaveMediationPolicy({ requesterDid, policy }), | ||
| ) | ||
| } | ||
|
|
||
| const promptForDids = async (action: string): Promise<string[]> => { | ||
| const { dids } = await inquirer.prompt<{ dids: string }>({ | ||
| type: 'input', | ||
| name: 'dids', | ||
| message: `Enter the dids you want to ${action.toLowerCase()} separated by spaces:`, | ||
| }) | ||
| return dids.split(' ') | ||
| } | ||
|
|
||
| /** | ||
| * cli action functions | ||
| **/ | ||
|
|
||
| const policy = (policy: PreMediationRequestPolicy) => { | ||
| return async function ( | ||
| { fileJson, interactive }: Pick<Options, 'fileJson' | 'interactive'>, | ||
| cmd: Command, | ||
| ): Promise<void> { | ||
| try { | ||
| if (fileJson && interactive) throw new Error('Please specify only one input method') | ||
|
|
||
| const agent = await getAgent(cmd.optsWithGlobals().config) | ||
| console.log('AGENT CREATED') | ||
|
|
||
| if (fileJson) { | ||
| const jsonData = await import(fileJson, { assert: { type: 'json' } }) | ||
| const dids = jsonData.default | ||
| await updatePolicies({ dids, agent, policy }) | ||
| } else if (interactive) { | ||
| const dids = await promptForDids(policy) | ||
| await updatePolicies({ dids, agent, policy }) | ||
| } else { | ||
| const dids = cmd.args | ||
| await updatePolicies({ dids, agent, policy }) | ||
| } | ||
|
|
||
| console.log('Mediation policies updated') | ||
| } catch (e) { | ||
| console.error(e.message) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| async function readPolicies(options: Pick<Options, 'interactive' | 'fileJson'>, cmd: Command): Promise<void> { | ||
| const agent = await getAgent(cmd.optsWithGlobals().config) | ||
| let dids: string[] | ||
| if (options.interactive) dids = await promptForDids('read') | ||
| else if (options.fileJson) dids = (await import(options.fileJson, { assert: { type: 'json' } })).default | ||
| else dids = cmd.args | ||
| if (!dids || !dids.length) throw new Error('No dids provided') | ||
| const policies: Record<RequesterDid, RecipientDid | null> = {} | ||
| for await (const requesterDid of dids) { | ||
| policies[requesterDid] = await agent.mediationManagerGetMediationPolicy({ requesterDid }) | ||
| } | ||
| console.log('POLICIES') | ||
| console.table(policies) | ||
| } | ||
|
|
||
| async function listPolicies(options: Pick<Options, 'allowFrom' | 'denyFrom'>, cmd: Command): Promise<void> { | ||
| try { | ||
| const agent = await getAgent(cmd.optsWithGlobals().config) | ||
| const res = await agent.mediationManagerListMediationPolicies() | ||
| console.log('POLICIES') | ||
| if (options.allowFrom) return console.table(Object.entries(res).filter(([, policy]) => policy === ALLOW)) | ||
| if (options.denyFrom) return console.table(Object.entries(res).filter(([, policy]) => policy === DENY)) | ||
| else console.table(res) | ||
| } catch (e) { | ||
| console.error(e.message) | ||
| } | ||
| } | ||
|
|
||
| async function listResponses( | ||
| { granted, denied }: Pick<Options, 'granted' | 'denied'>, | ||
| cmd: Command, | ||
| ): Promise<void> { | ||
| try { | ||
| const agent = await getAgent(cmd.optsWithGlobals().config) | ||
| const res = await agent.mediationManagerGetAllMediations() | ||
| console.log('MEDIATIONS') | ||
| if (granted) return console.table(Object.entries(res).filter(([, response]) => response === 'GRANTED')) | ||
| if (denied) return console.table(Object.entries(res).filter(([, response]) => response === 'DENIED')) | ||
| else console.table(res) | ||
| } catch (e) { | ||
| console.error(e.message) | ||
| } | ||
| } | ||
|
|
||
| async function removePolicies( | ||
| { fileJson, interactive }: Pick<Options, 'fileJson' | 'interactive'>, | ||
| cmd: Command, | ||
| ): Promise<void> { | ||
| try { | ||
| const agent = await getAgent(cmd.optsWithGlobals().config) | ||
|
|
||
| if (fileJson) { | ||
| const jsonData = await import(fileJson, { assert: { type: 'json' } }) | ||
| const dids = jsonData.default | ||
| await updatePolicies({ dids, remove: true, agent }) | ||
| } else if (interactive) { | ||
| const dids = await promptForDids('Remove') | ||
| await updatePolicies({ dids, remove: true, agent }) | ||
| } else { | ||
| const dids = cmd.args | ||
| await updatePolicies({ dids, remove: true, agent }) | ||
| } | ||
|
|
||
| console.log('Mediation policies removed') | ||
| } catch (e) { | ||
| console.error(e.message) | ||
| } | ||
| } | ||
|
|
||
| const mediate = new Command('mediate').description('Mediate allow or deny policy on dids') | ||
|
|
||
| mediate | ||
| .command('allow-from') | ||
| .description('add dids that should be allowed for mediation') | ||
| .option('-f, --file-json <string>', 'read dids from json file') | ||
| .option('-i, --interactive', 'interactively input dids') | ||
| .action(policy(ALLOW)) | ||
|
|
||
| mediate | ||
| .command('deny-from') | ||
| .description('deny dids that should be denied for mediation') | ||
| .option('-f, --file-json <string>', 'read dids from json file') | ||
| .option('-i, --interactive', 'interactively input dids') | ||
| .action(policy(DENY)) | ||
|
|
||
| mediate | ||
| .command('read') | ||
| .description('read mediation policy for a specific did') | ||
| .option('-i, --interactive', 'interactively input dids') | ||
| .option('-f, --file-json <string>', 'read dids from json file') | ||
| .action(readPolicies) | ||
|
|
||
| mediate | ||
| .command('list-policies') | ||
| .description('list mediation policies') | ||
| .option('-a, --allow-from', 'list allow policies') | ||
| .option('-d, --deny-from', 'list deny policies') | ||
| .action(listPolicies) | ||
|
|
||
| mediate | ||
| .command('list-responses') | ||
| .description('list mediation responses') | ||
| .option('-a, --granted', 'list granted policies') | ||
| .option('-d, --denied', 'list denied policies') | ||
| .action(listResponses) | ||
|
|
||
| mediate | ||
| .command('remove') | ||
| .description('remove mediation policies') | ||
| .option('-f, --file-json <string>', 'read dids from json file') | ||
| .option('-i, --interactive', 'interactively input dids') | ||
| .action(removePolicies) | ||
|
|
||
| export { mediate } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.