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

New unprotected-update-current-contract-wasm documentation #304

Merged
merged 2 commits into from
Aug 14, 2024
Merged

New unprotected-update-current-contract-wasm documentation #304

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ec7732
New unprotected-update-current-contract-wasm documentation
tomasavola Aug 7, 2024
aa47f87
Remove "If users are (...)"
tomasavola Aug 12, 2024
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
44 changes: 31 additions & 13 deletions docs/docs/detectors/6-unprotected-update-current-contract-wasm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,26 @@
# Unprotected update of current contract wasm
# Unprotected update current contract wasm

### What it does
## Description

It warns you if `update_current_contract_wasm()` function is called without a previous check of the address of the caller.
- Category: `Authorization`
- Severity: `Critical`
- Detector: [`unprotected-update-current-contract-wasm`](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/unprotected-update-current-contract-wasm)
- Test Cases: [`unprotected-update-current-contract-wasm-1`](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/unprotected-update-current-contract-wasm/unprotected-update-current-contract-wasm-1) [`unprotected-update-current-contract-wasm-2`](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/unprotected-update-current-contract-wasm/unprotected-update-current-contract-wasm-2)

It warns you if `update_current_contract_wasm()` function is called without a previous check of the address of the caller. If users are allowed to call `update_current_contract_wasm()`, they can intentionally modify the contract behaviour, leading to the loss of all associated data/tokens and functionalities given by this contract or by others that depend on it.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Sacar la oración "If users are allowed..." dado que es la misma que está en la sección "Why is this bad?"


### Why is this bad?

## Why is this bad?

If users are allowed to call `update_current_contract_wasm()`, they can intentionally modify the contract behaviour, leading to the loss of all associated data/tokens and functionalities given by this contract or by others that depend on it.

### Example
## Issue example

Consider the following `Soroban` contract:

```rust
#[contractimpl]

#[contractimpl]
impl UpgradeableContract {
pub fn init(e: Env, admin: Address) {
e.storage().instance().set(&DataKey::Admin, &admin);
Expand All @@ -22,17 +31,24 @@ impl UpgradeableContract {
}

pub fn upgrade(e: Env, new_wasm_hash: BytesN<32>) {
let admin: Address = e.storage().instance().get(&DataKey::Admin).unwrap();

e.deployer().update_current_contract_wasm(new_wasm_hash);
}
}
```

Use instead:
```

This contract allows upgrades through the `update_current_contract_wasm` function. If just anyone can call this function, they could modify the contract behaviour.

The code example can be found [here](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/unprotected-update-current-contract-wasm/unprotected-update-current-contract-wasm-1/vulnerable-example).


## Remediated example

To prevent this, the function should be restricted to administrators or authorized users only.

```rust
#[contractimpl]

#[contractimpl]
impl UpgradeableContract {
pub fn init(e: Env, admin: Address) {
e.storage().instance().set(&DataKey::Admin, &admin);
Expand All @@ -51,6 +67,8 @@ impl UpgradeableContract {
}
```

### Implementation
The remediated code example can be found [here](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/unprotected-update-current-contract-wasm/unprotected-update-current-contract-wasm-1/remediated-example).

The detector's implementation can be found at [this link](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/unprotected-update-current-contract-wasm)
## How is it detected?

It warns you if `update_current_contract_wasm()` function is called without a previous check of the address of the caller.