-
Notifications
You must be signed in to change notification settings - Fork 200
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.
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
fix: update inbound message validation #678
Merged
jakubkoci
merged 4 commits into
openwallet-foundation:main
from
niall-shaw:receiveMessageFix
Mar 28, 2022
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -11,6 +11,7 @@ import { AriesFrameworkError } from '../error' | |||||
import { ConnectionRepository } from '../modules/connections' | ||||||
import { DidRepository } from '../modules/dids/repository/DidRepository' | ||||||
import { ProblemReportError, ProblemReportMessage, ProblemReportReason } from '../modules/problem-reports' | ||||||
import { isValidJweStructure } from '../utils/JWE' | ||||||
import { JsonTransformer } from '../utils/JsonTransformer' | ||||||
import { MessageValidator } from '../utils/MessageValidator' | ||||||
import { replaceLegacyDidSovPrefixOnMessage } from '../utils/messageType' | ||||||
|
@@ -66,11 +67,12 @@ export class MessageReceiver { | |||||
*/ | ||||||
public async receiveMessage(inboundMessage: unknown, session?: TransportSession) { | ||||||
this.logger.debug(`Agent ${this.config.label} received message`) | ||||||
|
||||||
if (this.isPlaintextMessage(inboundMessage)) { | ||||||
if (this.isEncryptedMessage(inboundMessage)) { | ||||||
await this.receiveEncryptedMessage(inboundMessage as EncryptedMessage, session) | ||||||
} else if (this.isPlaintextMessage(inboundMessage)) { | ||||||
await this.receivePlaintextMessage(inboundMessage) | ||||||
} else { | ||||||
await this.receiveEncryptedMessage(inboundMessage as EncryptedMessage, session) | ||||||
throw new AriesFrameworkError('Unable to parse incoming message: unrecognized format') | ||||||
} | ||||||
} | ||||||
|
||||||
|
@@ -143,12 +145,17 @@ export class MessageReceiver { | |||||
|
||||||
private isPlaintextMessage(message: unknown): message is PlaintextMessage { | ||||||
if (typeof message !== 'object' || message == null) { | ||||||
throw new AriesFrameworkError('Invalid message received. Message should be object') | ||||||
return false | ||||||
} | ||||||
// If the message does have an @type field we assume the message is in plaintext and it is not encrypted. | ||||||
// If the message has a @type field we assume the message is in plaintext and it is not encrypted. | ||||||
return '@type' in message | ||||||
} | ||||||
|
||||||
private isEncryptedMessage(message: unknown): message is EncryptedMessage { | ||||||
// If the message does has valid JWE structure, we can assume the message is encrypted. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
return isValidJweStructure(message) | ||||||
} | ||||||
|
||||||
private async transformAndValidate( | ||||||
plaintextMessage: PlaintextMessage, | ||||||
connection?: ConnectionRecord | null | ||||||
|
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 |
---|---|---|
@@ -1,6 +1,6 @@ | ||
import type { EncryptedMessage } from '../types' | ||
|
||
// eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
export function isValidJweStucture(message: any): message is EncryptedMessage { | ||
export function isValidJweStructure(message: any): message is EncryptedMessage { | ||
return message && typeof message === 'object' && message.protected && message.iv && message.ciphertext && message.tag | ||
} |
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar logic is already present in the http / ws outbound transport:
Could you remove the checks there and reuse the
isValidJweStucture
method that is already available? (and fix the typo in the method name 😄 )