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.

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: [Source Validation] Check linkage #18964

Merged
merged 2 commits into from
Aug 14, 2024
Merged

Conversation

amnn
Copy link
Member

@amnn amnn commented Aug 12, 2024

Description

Source validation additionally checks that dependencies in the linkage table of the on-chain package match the published dependencies from the source package.

Previously it was possible to construct a scenario where source verification would succeed even though a package's representation on-chain did not exactly match, because one of the dependencies mismatched on version but between two versions that were themselves identical.

Test plan

New tests exercising the scenario mentioned above:

sui-source-validation$ cargo nextest run -- linkage_differs

Stack


Release notes

Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.

For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.

  • Protocol:
  • Nodes (Validators and Full nodes):
  • Indexer:
  • JSON-RPC:
  • GraphQL:
  • CLI: sui client verify-source now also confirms that a package's linkage table matches its source dependencies.
  • Rust SDK:
  • REST API:

@amnn amnn requested review from rvantonder and a team August 12, 2024 20:39
@amnn amnn self-assigned this Aug 12, 2024
Copy link

vercel bot commented Aug 12, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sui-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 14, 2024 6:04pm
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
multisig-toolkit ⬜️ Ignored (Inspect) Visit Preview Aug 14, 2024 6:04pm
sui-kiosk ⬜️ Ignored (Inspect) Visit Preview Aug 14, 2024 6:04pm
sui-typescript-docs ⬜️ Ignored (Inspect) Visit Preview Aug 14, 2024 6:04pm

// SAFETY: The error type does not implement `Clone` so we need to take the
// error by value. We do that by calling `next` to take the value we just
// peeked, which we know is an error type.
errs.push(modules.next().unwrap().unwrap_err());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😓

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this covered by tests?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quite difficult to do that in this case, because it requires publishing a package that fails deserialization.

Copy link
Contributor

@stefan-mysten stefan-mysten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not familiar with the code, but stamping to get this workstream unblocked.
I'd suggest that @rvantonder or someone else that is more familiar with the code has a look at it as well!

## Description

Fix a bug in tests that publish packages where the publish transaction
was always constructed referring to dependencies at their original IDs,
and not their storage IDs.

This has not caused a problem to date, meaning these tests may not
publish a package that depends on an upgrade package, but to avoid
confusion `get_dependency_original_package_ids` has been replaced with
`get_dependency_storage_package_ids`.

Similarly, `get_package_dependencies_hex` has been replaced with an
invocation of `get_dependency_storage_package_ids`.

## Test plan

CI +:

```
sui$ cargo build --bin sui
sui$ cd tmp
sui$ ~/sui/target/debug/sui move new test
sui$ # make it possible to compile
sui$ ~/sui/target/debug/ui move build --dump-bytecode-as-base64
```
## Description

Source validation additionally checks that dependencies in the linkage
table of the on-chain package match the published dependencies from the
source package.

Previously it was possible to construct a scenario where source
verification would succeed even though a package's representation
on-chain did not exactly match, because one of the dependencies
mismatched on version but between two versions that were themselves
identical.

## Test plan

New tests exercising the scenario mentioned above:

```
sui-source-validation$ cargo nextest run -- linkage_differs
```
@amnn amnn force-pushed the amnn/test-publish-storage-id branch from 7283d3c to fa858a5 Compare August 14, 2024 17:42
Base automatically changed from amnn/test-publish-storage-id to amnn/src-valid-err August 14, 2024 17:55
@amnn amnn merged commit 9656196 into amnn/src-valid-err Aug 14, 2024
53 of 55 checks passed
@amnn amnn deleted the amnn/src-verify-link branch August 14, 2024 17:57
amnn added a commit that referenced this pull request Aug 15, 2024
## Description

Source validation additionally checks that dependencies in the linkage
table of the on-chain package match the published dependencies from the
source package.

Previously it was possible to construct a scenario where source
verification would succeed even though a package's representation
on-chain did not exactly match, because one of the dependencies
mismatched on version but between two versions that were themselves
identical.

## Test plan

New tests exercising the scenario mentioned above:

```
sui-source-validation$ cargo nextest run -- linkage_differs
```

## Stack

- #18956 
- #18959
- #18978
- #18960 
- #18962

---

## Release notes

Check each box that your changes affect. If none of the boxes relate to
your changes, release notes aren't required.

For each box you select, include information after the relevant heading
that describes the impact of your changes that a user might notice and
any actions they must take to implement updates.

- [ ] Protocol: 
- [ ] Nodes (Validators and Full nodes): 
- [ ] Indexer: 
- [ ] JSON-RPC: 
- [ ] GraphQL: 
- [x] CLI: `sui client verify-source` now also confirms a package's
linkage table matches its source dependencies.
- [ ] Rust SDK:
- [ ] REST API:
suiwombat pushed a commit that referenced this pull request Sep 16, 2024
## Description

Source validation additionally checks that dependencies in the linkage
table of the on-chain package match the published dependencies from the
source package.

Previously it was possible to construct a scenario where source
verification would succeed even though a package's representation
on-chain did not exactly match, because one of the dependencies
mismatched on version but between two versions that were themselves
identical.

## Test plan

New tests exercising the scenario mentioned above:

```
sui-source-validation$ cargo nextest run -- linkage_differs
```

## Stack

- #18956 
- #18959
- #18978
- #18960 
- #18962

---

## Release notes

Check each box that your changes affect. If none of the boxes relate to
your changes, release notes aren't required.

For each box you select, include information after the relevant heading
that describes the impact of your changes that a user might notice and
any actions they must take to implement updates.

- [ ] Protocol: 
- [ ] Nodes (Validators and Full nodes): 
- [ ] Indexer: 
- [ ] JSON-RPC: 
- [ ] GraphQL: 
- [x] CLI: `sui client verify-source` now also confirms a package's
linkage table matches its source dependencies.
- [ ] Rust SDK:
- [ ] REST API:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants