Conversation
There was a problem hiding this comment.
Pull request overview
This PR hardens soroban-cli transaction signing by explicitly validating each Address-credential Soroban auth entry against the transaction’s host function before signing, rejecting entries that are unsafe to replay or malformed, and improving the error output by rendering the offending auth entry inline.
Changes:
- Added a host-function vs auth-root-invocation classifier and enforced “strict” auth validation in
sign_soroban_authorizations. - Introduced pretty-print formatting for auth entries to improve CLI error messages.
- Added coverage via a new auth fixture contract + integration tests, and added missing RPC network-passphrase verification in extend/restore commands.
Reviewed changes
Copilot reviewed 11 out of 12 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| cmd/soroban-cli/src/tx.rs | Updates comment to reflect new validation behavior prior to signing. |
| cmd/soroban-cli/src/signer/validation.rs | Adds auth root-invocation classification logic + unit tests. |
| cmd/soroban-cli/src/signer/mod.rs | Enforces strict validation before signing; adds new errors and source-account credential guard; adds unit tests. |
| cmd/soroban-cli/src/log/auth.rs | Replaces prior debug helper with structured formatting for auth entries. |
| cmd/soroban-cli/src/commands/contract/restore.rs | Adds verify_network_passphrase call on RPC client. |
| cmd/soroban-cli/src/commands/contract/extend.rs | Adds verify_network_passphrase call on RPC client. |
| cmd/crates/soroban-test/tests/it/integration/util.rs | Adds AUTH fixture constant. |
| cmd/crates/soroban-test/tests/it/integration/auth.rs | Adds integration coverage for strict vs non-strict/non-root auth scenarios. |
| cmd/crates/soroban-test/tests/it/integration.rs | Wires in the new auth integration test module. |
| cmd/crates/soroban-test/tests/fixtures/test-wasms/auth/src/lib.rs | Adds a Soroban test contract to generate various auth-tree shapes. |
| cmd/crates/soroban-test/tests/fixtures/test-wasms/auth/Cargo.toml | Adds the new test fixture crate manifest. |
| Cargo.lock | Records the new test_auth fixture crate dependency. |
There was a problem hiding this comment.
I haven't finished reviewing this, but it's not obvious to me that this is the appropriate action, it's rather restrictive, especially in the context of the known limitations in the pr description.
I think given the stellar-cli is a developer tool it would be more appropriate to do the following instead of rejecting outright:
-
validate the safe case and auto sign in that case (most commands other than invoke should have relatively predictable auth entries required)
-
identify the unsafe cases and display those to the user to confirm if they wish to continue
And for a tool that has narrower use, such as a wallet cli rather than a developer focused cli, to provide narrower restrictions like this to protect its use case.
Thanks for the feedback @leighmcculloch ! This PR is basically step 1, identify "safe" auth. In my mind, I defined this as any auth entry that is tied to the root invocation exactly. Since the idea of this is not to limit user actions, we can assume the user input the contract invocation as intended. Thus, even if the auth could be detached, the only way its valid is if the exact contract invocation the user intended was the root invocation. To add, I'd be shocked if this was actually restrictive. The only use case it blocks is non-source accounts signing Note - updated to add a bypass flag and approval mechanism. Created a follow up issue to support non-root auth: #2574 |
What
The CLI currently relies on the RPC to check that no non-root auths are included in simulation results. This PR adds an explicit, per-entry validation step inside
sign_soroban_authorizationsthat classifies everyAddress-credential auth entry against the transaction's host function before signing. Entries that don't match the host function exactly require approval. This approval can be bypassed with a--forceflag.Example output:
If the CLI is invoked in a non-interactive location and the force flag is not preset, it will fail:
Why
The CLI eagerly signs authorization entries returned from the user-specified RPC. If an unsafe auth entry is included, the user might unexpectedly sign for something they did not intend. This check ensures everything the CLI signs automatically is bound to the exact host function invocation in the transaction.
Close https://github.com/stellar/stellar-cli-internal/issues/50
Known limitations
require_auth_for_argsfor non-source accountsThe check flags contracts that use
require_auth_for_args(custom_args)at the root for non-source accounts. The auth tree's root carriescustom_args, not the host function's args, so the strict-match check fails even though the auth is genuinely rooted at the operation. A tampered auth entry with the same custom args at root could otherwise be signed and replayed. Source-account auth viaSorobanCredentials::SourceAccountis unaffected.