Skip to content

Fix parseStructTag to reject malformed inputs #898

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

Open
Danny-Devs wants to merge 1 commit into
base: main
Choose a base branch
from
+27 −0
Open

Fix parseStructTag to reject malformed inputs #898

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .changeset/harden-parse-struct-tag.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@mysten/sui': patch
---

Fix `parseStructTag` to reject malformed inputs: empty address/module/name components (e.g. `::foo::Bar`) and trailing content after type parameters (e.g. `Coin<u8>GARBAGE`).
10 changes: 10 additions & 0 deletions packages/sui/src/utils/sui-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,10 +125,20 @@ export function parseStructTag(type: string): StructTag {
}

const [address, module] = parts;

if (!address || !module) {
throw new Error(`Invalid struct tag: ${type}`);
}

const isMvrPackage = isValidNamedPackage(address);

const rest = type.slice(address.length + module.length + 4);
const name = rest.includes('<') ? rest.slice(0, rest.indexOf('<')) : rest;

if (!name || (rest.includes('<') && !rest.endsWith('>'))) {
throw new Error(`Invalid struct tag: ${type}`);
}

const typeParams = rest.includes('<')
? splitGenericParameters(rest.slice(rest.indexOf('<') + 1, rest.lastIndexOf('>'))).map(
(typeParam) => parseTypeTag(typeParam.trim()),
Expand Down
12 changes: 12 additions & 0 deletions packages/sui/test/unit/types/common.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,18 @@ describe('parseStructTag', () => {
expect(() => parseStructTag('0x2::foo::Bar<vector<u8>')).toThrow('Invalid type tag');
});

it('rejects struct tags with empty components', () => {
expect(() => parseStructTag('::foo::Bar')).toThrow('Invalid struct tag');
expect(() => parseStructTag('0x2::::Bar')).toThrow('Invalid struct tag');
expect(() => parseStructTag('0x2::foo::')).toThrow('Invalid struct tag');
});

it('rejects struct tags with trailing content after type parameters', () => {
expect(() => parseStructTag('0x2::coin::Coin<u8>GARBAGE')).toThrow('Invalid struct tag');
expect(() => parseStructTag('0x2::foo::Bar<bool> ')).toThrow('Invalid struct tag');
expect(() => parseStructTag('0x2::foo::Bar<u64>xyz')).toThrow('Invalid struct tag');
});

it('parses named struct tags correctly', () => {
expect(parseStructTag('@mvr/demo::foo::bar')).toMatchInlineSnapshot(`
{
Expand Down