Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(did-comm): sendDIDCommMessage - returnMessage #1283

Merged
merged 2 commits into from
Nov 1, 2023
Merged

feat(did-comm): sendDIDCommMessage - returnMessage #1283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0acf227
feat(did-comm): sendDIDCommMessage - returnMessage
simonas-notcat Oct 25, 2023
46bed1b
docs(did-comm): adapt inline docs for IDIDComm
mirceanis Nov 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions packages/did-comm/src/__tests__/messagepickup-message-handler.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,33 @@ describe('messagepickup-message-handler', () => {
)
})

it('should contain returnMessage', async () => {

// Send StatusRequest
const statusRequestMessage: IDIDCommMessage = {
id: v4(),
type: STATUS_REQUEST_MESSAGE_TYPE,
to: mediator.did,
from: recipient.did,
return_route: 'all',
body: {
recipient_key: `${recipient.did}#${recipient.keys[0].kid}`,
},
}
const packedMessage = await agent.packDIDCommMessage({
packing: 'authcrypt',
message: statusRequestMessage,
})
const result = await agent.sendDIDCommMessage({
messageId: statusRequestMessage.id,
packedMessage,
recipientDidUrl: mediator.did,
})

expect(result.transportId).toBeDefined()
expect(result.returnMessage).toBeDefined()
})

it('should not respond to StatusRequest with no return_route', async () => {
expect.assertions(1)
const statusRequestMessage: IDIDCommMessage = {
Expand Down
58 changes: 14 additions & 44 deletions packages/did-comm/src/didcomm.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,17 @@ import {
} from '@veramo/utils'

import Debug from 'debug'
import { IDIDComm } from './types/IDIDComm.js'
import {
IDIDComm,
IPackDIDCommMessageArgs,
ISendDIDCommMessageArgs,
ISendDIDCommMessageResponse,
IUnpackDIDCommMessageArgs,
} from './types/IDIDComm.js'
import { DIDCommHttpTransport, IDIDCommTransport } from './transports/transports.js'
import {
DIDCommMessageMediaType,
DIDCommMessagePacking,
IDIDCommMessage,
IDIDCommOptions,
IPackedDIDCommMessage,
IUnpackedDIDCommMessage,
} from './types/message-types.js'
Expand Down Expand Up @@ -119,42 +123,6 @@ export interface ISendMessageDIDCommAlpha1Args {
headers?: Record<string, string>
}

// interface arguments

/**
* The input to the {@link DIDComm.unpackDIDCommMessage} method.
*
* @beta This API may change without a BREAKING CHANGE notice.
*/
export type IUnpackDIDCommMessageArgs = IPackedDIDCommMessage

/**
* The input to the {@link DIDComm.packDIDCommMessage} method.
* When `packing` is `authcrypt` or `jws`, a `keyRef` MUST be provided.
*
* @beta This API may change without a BREAKING CHANGE notice.
*/
export interface IPackDIDCommMessageArgs {
message: IDIDCommMessage
packing: DIDCommMessagePacking
keyRef?: string
options?: IDIDCommOptions
}

/**
* The input to the {@link DIDComm.sendDIDCommMessage} method.
* The provided `messageId` will be used in the emitted
* event to allow event/message correlation.
*
* @beta This API may change without a BREAKING CHANGE notice.
*/
export interface ISendDIDCommMessageArgs {
packedMessage: IPackedDIDCommMessage
messageId: string
returnTransportId?: string
recipientDidUrl: string
}

/**
* DID Comm plugin for {@link @veramo/core#Agent}
*
Expand Down Expand Up @@ -422,7 +390,8 @@ export class DIDComm implements IAgentPlugin {
recipient.publicKeyBytes,
<ECDH>senderECDH,
{ kid: recipient.kid },
)} else if (options?.alg?.endsWith('+A256KW')) {
)
} else if (options?.alg?.endsWith('+A256KW')) {
// FIXME: the didcomm spec actually links to ECDH-1PU(v4)
return xc20pAuthEncrypterEcdh1PuV3x25519WithA256KW(recipient.publicKeyBytes, <ECDH>senderECDH, {
kid: recipient.kid,
Expand Down Expand Up @@ -715,8 +684,8 @@ export class DIDComm implements IAgentPlugin {
/** {@inheritdoc IDIDComm.sendDIDCommMessage} */
async sendDIDCommMessage(
args: ISendDIDCommMessageArgs,
context: IAgentContext<IDIDManager & IKeyManager & IResolver>,
): Promise<string> {
context: IAgentContext<IDIDManager & IKeyManager & IResolver & IMessageHandler>,
): Promise<ISendDIDCommMessageResponse> {
const { packedMessage, returnTransportId, recipientDidUrl, messageId } = args

if (returnTransportId) {
Expand Down Expand Up @@ -839,11 +808,12 @@ export class DIDComm implements IAgentPlugin {

if (response.returnMessage) {
// Handle return message
await context.agent.handleMessage({
const returnMessage = await context.agent.handleMessage({
raw: response.returnMessage,
})
return { transportId: transport.id, returnMessage }
}
return transport.id
return { transportId: transport.id }
}

/** {@inheritdoc IDIDComm.sendMessageDIDCommAlpha1} */
Expand Down
7 changes: 1 addition & 6 deletions packages/did-comm/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,7 @@
* @packageDocumentation
*/

export {
DIDComm,
ISendMessageDIDCommAlpha1Args,
IPackDIDCommMessageArgs,
IUnpackDIDCommMessageArgs,
} from './didcomm.js'
export * from './didcomm.js'
export * from './types/message-types.js'
export * from './types/utility-types.js'
export * from './types/IDIDComm.js'
Expand Down
115 changes: 65 additions & 50 deletions packages/did-comm/src/plugin.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"message",
"packing"
],
"description": "The input to the {@link DIDComm.packDIDCommMessage } method. When `packing` is `authcrypt` or `jws`, a `keyRef` MUST be provided."
"description": "The input to the {@link IDIDComm.packDIDCommMessage } method. When `packing` is `authcrypt` or `jws`, a `keyRef` MUST be provided."
},
"IDIDCommMessage": {
"type": "object",
Expand Down Expand Up @@ -222,61 +222,22 @@
"messageId",
"recipientDidUrl"
],
"description": "The input to the {@link DIDComm.sendDIDCommMessage } method. The provided `messageId` will be used in the emitted event to allow event/message correlation."
"description": "The input to the {@link IDIDComm.sendDIDCommMessage } method. The provided `messageId` will be used in the emitted event to allow event/message correlation."
},
"ISendMessageDIDCommAlpha1Args": {
"ISendDIDCommMessageResponse": {
"type": "object",
"properties": {
"url": {
"transportId": {
"type": "string"
},
"save": {
"type": "boolean"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"type": "string"
},
"to": {
"type": "string"
},
"type": {
"type": "string"
},
"body": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
},
"required": [
"from",
"to",
"type",
"body"
]
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
"returnMessage": {
"$ref": "#/components/schemas/IMessage"
}
},
"required": [
"data"
"transportId"
],
"deprecated": "Please use {@link IDIDComm.sendDIDCommMessage } instead. This will be removed in Veramo 4.0.\nInput arguments for {@link IDIDComm.sendMessageDIDCommAlpha1 }"
"description": "The response from the {@link IDIDComm.sendDIDCommMessage } method."
},
"IMessage": {
"type": "object",
Expand Down Expand Up @@ -647,9 +608,63 @@
},
"description": "The DIDComm message structure for data in an attachment. See https://identity.foundation/didcomm-messaging/spec/#attachments"
},
"ISendMessageDIDCommAlpha1Args": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"save": {
"type": "boolean"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"type": "string"
},
"to": {
"type": "string"
},
"type": {
"type": "string"
},
"body": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
},
"required": [
"from",
"to",
"type",
"body"
]
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"data"
],
"deprecated": "Please use {@link IDIDComm.sendDIDCommMessage } instead. This will be removed in Veramo 4.0.\nInput arguments for {@link IDIDComm.sendMessageDIDCommAlpha1 }"
},
"IUnpackDIDCommMessageArgs": {
"$ref": "#/components/schemas/IPackedDIDCommMessage",
"description": "The input to the {@link DIDComm.unpackDIDCommMessage } method."
"description": "The input to the {@link IDIDComm.unpackDIDCommMessage } method."
},
"IUnpackedDIDCommMessage": {
"type": "object",
Expand Down Expand Up @@ -700,12 +715,12 @@
}
},
"sendDIDCommMessage": {
"description": "Sends the given message to the recipient. If a return transport is provided it will be checked whether the parent thread allows reusing the route. You cannot reuse the transport if the message was forwarded from a DIDComm mediator.",
"description": "Sends the given message to the recipient. If a return-transport is provided it will be checked whether the parent thread allows reusing the route. You cannot reuse the transport if the message was forwarded from a DIDComm mediator.",
"arguments": {
"$ref": "#/components/schemas/ISendDIDCommMessageArgs"
},
"returnType": {
"type": "string"
"$ref": "#/components/schemas/ISendDIDCommMessageResponse"
}
},
"sendMessageDIDCommAlpha1": {
Expand Down
2 changes: 1 addition & 1 deletion packages/did-comm/src/protocols/trust-ping-message-handler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ export class TrustPingMessageHandler extends AbstractMessageHandler {
packedMessage: packedResponse,
recipientDidUrl: from!,
})
message.addMetaData({ type: 'TrustPingResponseSent', value: sent })
message.addMetaData({ type: 'TrustPingResponseSent', value: JSON.stringify(sent) })
} catch (ex) {
debug(ex)
}
Expand Down
Loading