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

update: improve unhandled initializers in unprotected-upgrade detector #2203

Merged
merged 6 commits into from
Jun 4, 2024
Merged

update: improve unhandled initializers in unprotected-upgrade detector #2203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e38966c
detect reinitializer in unprotected_upgrade detector
vovikhangcdv Oct 25, 2023
314ceeb
remove ambiguous relation between _is_upgradeable and _is_upgradeable…
vovikhangcdv Oct 26, 2023
2b81c02
make lint
vovikhangcdv Oct 30, 2023
ca851e2
make lint
vovikhangcdv Oct 30, 2023
4c90475
Merge branch 'dev' into dev
vovikhangcdv Oct 30, 2023
1f15416
Merge branch 'dev' into dev
vovikhangcdv May 9, 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
2 changes: 0 additions & 2 deletions slither/core/declarations/contract.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1372,8 +1372,6 @@ def update_read_write_using_ssa(self) -> None:
def is_upgradeable(self) -> bool:
if self._is_upgradeable is None:
self._is_upgradeable = False
if self.is_upgradeable_proxy:
return False
initializable = self.file_scope.get_contract_from_name("Initializable")
if initializable:
if initializable in self.inheritance:
Expand Down
9 changes: 8 additions & 1 deletion slither/detectors/statements/unprotected_upgradeable.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,14 @@ def _whitelisted_modifiers(f: Function) -> bool:

def _initialize_functions(contract: Contract) -> List[Function]:
return list(
filter(_whitelisted_modifiers, [f for f in contract.functions if f.name == "initialize"])
filter(
_whitelisted_modifiers,
[
f
for f in contract.functions
if any((m.name in ["initializer", "reinitializer"]) for m in f.modifiers)
],
)
)


Expand Down
1 change: 1 addition & 0 deletions ...ors/snapshots/detectors__detector_UnprotectedUpgradeable_0_4_25_AnyInitializer_sol__0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
AnyInitializer (tests/e2e/detectors/test_data/unprotected-upgrade/0.4.25/AnyInitializer.sol#3-15) is an upgradeable contract that does not protect its initialize functions: AnyInitializer.anyName() (tests/e2e/detectors/test_data/unprotected-upgrade/0.4.25/AnyInitializer.sol#6-9). Anyone can delete the contract with: AnyInitializer.kill() (tests/e2e/detectors/test_data/unprotected-upgrade/0.4.25/AnyInitializer.sol#11-14)
1 change: 1 addition & 0 deletions ...tors/snapshots/detectors__detector_UnprotectedUpgradeable_0_4_25_Reinitializer_sol__0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Reinitializer (tests/e2e/detectors/test_data/unprotected-upgrade/0.4.25/Reinitializer.sol#3-15) is an upgradeable contract that does not protect its initialize functions: Reinitializer.initialize() (tests/e2e/detectors/test_data/unprotected-upgrade/0.4.25/Reinitializer.sol#6-9). Anyone can delete the contract with: Reinitializer.kill() (tests/e2e/detectors/test_data/unprotected-upgrade/0.4.25/Reinitializer.sol#11-14)
1 change: 1 addition & 0 deletions ...ors/snapshots/detectors__detector_UnprotectedUpgradeable_0_5_16_AnyInitializer_sol__0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
AnyInitializer (tests/e2e/detectors/test_data/unprotected-upgrade/0.5.16/AnyInitializer.sol#3-15) is an upgradeable contract that does not protect its initialize functions: AnyInitializer.anyName() (tests/e2e/detectors/test_data/unprotected-upgrade/0.5.16/AnyInitializer.sol#6-9). Anyone can delete the contract with: AnyInitializer.kill() (tests/e2e/detectors/test_data/unprotected-upgrade/0.5.16/AnyInitializer.sol#11-14)
1 change: 1 addition & 0 deletions ...tors/snapshots/detectors__detector_UnprotectedUpgradeable_0_5_16_Reinitializer_sol__0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Reinitializer (tests/e2e/detectors/test_data/unprotected-upgrade/0.5.16/Reinitializer.sol#3-15) is an upgradeable contract that does not protect its initialize functions: Reinitializer.initialize() (tests/e2e/detectors/test_data/unprotected-upgrade/0.5.16/Reinitializer.sol#6-9). Anyone can delete the contract with: Reinitializer.kill() (tests/e2e/detectors/test_data/unprotected-upgrade/0.5.16/Reinitializer.sol#11-14)
1 change: 1 addition & 0 deletions ...ors/snapshots/detectors__detector_UnprotectedUpgradeable_0_6_11_AnyInitializer_sol__0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
AnyInitializer (tests/e2e/detectors/test_data/unprotected-upgrade/0.6.11/AnyInitializer.sol#3-15) is an upgradeable contract that does not protect its initialize functions: AnyInitializer.anyName() (tests/e2e/detectors/test_data/unprotected-upgrade/0.6.11/AnyInitializer.sol#6-9). Anyone can delete the contract with: AnyInitializer.kill() (tests/e2e/detectors/test_data/unprotected-upgrade/0.6.11/AnyInitializer.sol#11-14)
1 change: 1 addition & 0 deletions ...tors/snapshots/detectors__detector_UnprotectedUpgradeable_0_6_11_Reinitializer_sol__0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Reinitializer (tests/e2e/detectors/test_data/unprotected-upgrade/0.6.11/Reinitializer.sol#3-15) is an upgradeable contract that does not protect its initialize functions: Reinitializer.initialize() (tests/e2e/detectors/test_data/unprotected-upgrade/0.6.11/Reinitializer.sol#6-9). Anyone can delete the contract with: Reinitializer.kill() (tests/e2e/detectors/test_data/unprotected-upgrade/0.6.11/Reinitializer.sol#11-14)
1 change: 1 addition & 0 deletions ...tors/snapshots/detectors__detector_UnprotectedUpgradeable_0_7_6_AnyInitializer_sol__0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
AnyInitializer (tests/e2e/detectors/test_data/unprotected-upgrade/0.7.6/AnyInitializer.sol#3-15) is an upgradeable contract that does not protect its initialize functions: AnyInitializer.anyName() (tests/e2e/detectors/test_data/unprotected-upgrade/0.7.6/AnyInitializer.sol#6-9). Anyone can delete the contract with: AnyInitializer.kill() (tests/e2e/detectors/test_data/unprotected-upgrade/0.7.6/AnyInitializer.sol#11-14)
1 change: 1 addition & 0 deletions ...ctors/snapshots/detectors__detector_UnprotectedUpgradeable_0_7_6_Reinitializer_sol__0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Reinitializer (tests/e2e/detectors/test_data/unprotected-upgrade/0.7.6/Reinitializer.sol#3-15) is an upgradeable contract that does not protect its initialize functions: Reinitializer.initialize() (tests/e2e/detectors/test_data/unprotected-upgrade/0.7.6/Reinitializer.sol#6-9). Anyone can delete the contract with: Reinitializer.kill() (tests/e2e/detectors/test_data/unprotected-upgrade/0.7.6/Reinitializer.sol#11-14)
1 change: 1 addition & 0 deletions ...ors/snapshots/detectors__detector_UnprotectedUpgradeable_0_8_15_AnyInitializer_sol__0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
AnyInitializer (tests/e2e/detectors/test_data/unprotected-upgrade/0.8.15/AnyInitializer.sol#3-15) is an upgradeable contract that does not protect its initialize functions: AnyInitializer.anyName() (tests/e2e/detectors/test_data/unprotected-upgrade/0.8.15/AnyInitializer.sol#6-9). Anyone can delete the contract with: AnyInitializer.kill() (tests/e2e/detectors/test_data/unprotected-upgrade/0.8.15/AnyInitializer.sol#11-14)
1 change: 1 addition & 0 deletions ...tors/snapshots/detectors__detector_UnprotectedUpgradeable_0_8_15_Reinitializer_sol__0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Reinitializer (tests/e2e/detectors/test_data/unprotected-upgrade/0.8.15/Reinitializer.sol#3-15) is an upgradeable contract that does not protect its initialize functions: Reinitializer.initialize() (tests/e2e/detectors/test_data/unprotected-upgrade/0.8.15/Reinitializer.sol#6-9). Anyone can delete the contract with: Reinitializer.kill() (tests/e2e/detectors/test_data/unprotected-upgrade/0.8.15/Reinitializer.sol#11-14)
15 changes: 15 additions & 0 deletions tests/e2e/detectors/test_data/unprotected-upgrade/0.4.25/AnyInitializer.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import "./Initializable.sol";

contract AnyInitializer is Initializable {
address owner;

function anyName() external initializer {
require(owner == address(0));
owner = msg.sender;
}

function kill() external {
require(msg.sender == owner);
selfdestruct(owner);
}
}
Binary file added tests/e2e/detectors/test_data/unprotected-upgrade/0.4.25/AnyInitializer.sol-0.4.25.zip
View file
Open in desktop
Binary file not shown.
14 changes: 9 additions & 5 deletions tests/e2e/detectors/test_data/unprotected-upgrade/0.4.25/Initializable.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
contract Initializable{
modifier initializer() {
_;
}
}
contract Initializable {
modifier initializer() {
_;
}

modifier reinitializer(uint64 version) {
_;
}
}
15 changes: 15 additions & 0 deletions tests/e2e/detectors/test_data/unprotected-upgrade/0.4.25/Reinitializer.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import "./Initializable.sol";

contract Reinitializer is Initializable {
address owner;

function initialize() external reinitializer(2) {
require(owner == address(0));
owner = msg.sender;
}

function kill() external {
require(msg.sender == owner);
selfdestruct(owner);
}
}
Binary file added tests/e2e/detectors/test_data/unprotected-upgrade/0.4.25/Reinitializer.sol-0.4.25.zip
View file
Open in desktop
Binary file not shown.
15 changes: 15 additions & 0 deletions tests/e2e/detectors/test_data/unprotected-upgrade/0.5.16/AnyInitializer.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import "./Initializable.sol";

contract AnyInitializer is Initializable {
address payable owner;

function anyName() external initializer {
require(owner == address(0));
owner = msg.sender;
}

function kill() external {
require(msg.sender == owner);
selfdestruct(owner);
}
}
Binary file added tests/e2e/detectors/test_data/unprotected-upgrade/0.5.16/AnyInitializer.sol-0.5.16.zip
View file
Open in desktop
Binary file not shown.
14 changes: 9 additions & 5 deletions tests/e2e/detectors/test_data/unprotected-upgrade/0.5.16/Initializable.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
contract Initializable{
modifier initializer() {
_;
}
}
contract Initializable {
modifier initializer() {
_;
}

modifier reinitializer(uint64 version) {
_;
}
}
15 changes: 15 additions & 0 deletions tests/e2e/detectors/test_data/unprotected-upgrade/0.5.16/Reinitializer.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import "./Initializable.sol";

contract Reinitializer is Initializable {
address payable owner;

function initialize() external reinitializer(2) {
require(owner == address(0));
owner = msg.sender;
}

function kill() external {
require(msg.sender == owner);
selfdestruct(owner);
}
}
Binary file added tests/e2e/detectors/test_data/unprotected-upgrade/0.5.16/Reinitializer.sol-0.5.16.zip
View file
Open in desktop
Binary file not shown.
15 changes: 15 additions & 0 deletions tests/e2e/detectors/test_data/unprotected-upgrade/0.6.11/AnyInitializer.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import "./Initializable.sol";

contract AnyInitializer is Initializable {
address payable owner;

function anyName() external initializer {
require(owner == address(0));
owner = payable(msg.sender);
}

function kill() external {
require(msg.sender == owner);
selfdestruct(owner);
}
}
Binary file added tests/e2e/detectors/test_data/unprotected-upgrade/0.6.11/AnyInitializer.sol-0.6.11.zip
View file
Open in desktop
Binary file not shown.
14 changes: 9 additions & 5 deletions tests/e2e/detectors/test_data/unprotected-upgrade/0.6.11/Initializable.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
contract Initializable{
modifier initializer() {
_;
}
}
contract Initializable {
modifier initializer() {
_;
}

modifier reinitializer(uint64 version) {
_;
}
}
15 changes: 15 additions & 0 deletions tests/e2e/detectors/test_data/unprotected-upgrade/0.6.11/Reinitializer.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import "./Initializable.sol";

contract Reinitializer is Initializable {
address payable owner;

function initialize() external reinitializer(2) {
require(owner == address(0));
owner = payable(msg.sender);
}

function kill() external {
require(msg.sender == owner);
selfdestruct(owner);
}
}
Binary file added tests/e2e/detectors/test_data/unprotected-upgrade/0.6.11/Reinitializer.sol-0.6.11.zip
View file
Open in desktop
Binary file not shown.
15 changes: 15 additions & 0 deletions tests/e2e/detectors/test_data/unprotected-upgrade/0.7.6/AnyInitializer.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import "./Initializable.sol";

contract AnyInitializer is Initializable {
address payable owner;

function anyName() external initializer {
require(owner == address(0));
owner = payable(msg.sender);
}

function kill() external {
require(msg.sender == owner);
selfdestruct(owner);
}
}
Binary file added tests/e2e/detectors/test_data/unprotected-upgrade/0.7.6/AnyInitializer.sol-0.7.6.zip
View file
Open in desktop
Binary file not shown.
8 changes: 6 additions & 2 deletions tests/e2e/detectors/test_data/unprotected-upgrade/0.7.6/Initializable.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
contract Initializable{
contract Initializable {
uint8 private _initialized;
bool private _initializing;

modifier initializer() {
_;
}

modifier reinitializer(uint64 version) {
_;
}

Comment on lines +9 to +11
Copy link

Choose a reason for hiding this comment

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

Consider implementing logic in the reinitializer modifier or provide a comment explaining its intended use.

function _disableInitializers() internal virtual {
require(!_initializing, "Initializable: contract is initializing");
if (_initialized < type(uint8).max) {
_initialized = type(uint8).max;
}
}
}
}
15 changes: 15 additions & 0 deletions tests/e2e/detectors/test_data/unprotected-upgrade/0.7.6/Reinitializer.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import "./Initializable.sol";

contract Reinitializer is Initializable {
address payable owner;

function initialize() external reinitializer(2) {
require(owner == address(0));
owner = payable(msg.sender);
}

function kill() external {
require(msg.sender == owner);
selfdestruct(owner);
}
}
Binary file added tests/e2e/detectors/test_data/unprotected-upgrade/0.7.6/Reinitializer.sol-0.7.6.zip
View file
Open in desktop
Binary file not shown.
15 changes: 15 additions & 0 deletions tests/e2e/detectors/test_data/unprotected-upgrade/0.8.15/AnyInitializer.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import "./Initializable.sol";

contract AnyInitializer is Initializable {
address payable owner;

function anyName() external initializer {
require(owner == address(0));
owner = payable(msg.sender);
}

function kill() external {
require(msg.sender == owner);
selfdestruct(owner);
}
}
Binary file added tests/e2e/detectors/test_data/unprotected-upgrade/0.8.15/AnyInitializer.sol-0.8.15.zip
View file
Open in desktop
Binary file not shown.
6 changes: 5 additions & 1 deletion tests/e2e/detectors/test_data/unprotected-upgrade/0.8.15/Initializable.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,14 @@ contract Initializable {
_;
}

modifier reinitializer(uint64 version) {
_;
}

function _disableInitializers() internal virtual {
require(!_initializing, "Initializable: contract is initializing");
if (_initialized < type(uint8).max) {
_initialized = type(uint8).max;
}
}
}
}
15 changes: 15 additions & 0 deletions tests/e2e/detectors/test_data/unprotected-upgrade/0.8.15/Reinitializer.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import "./Initializable.sol";

contract Reinitializer is Initializable {
address payable owner;

function initialize() external reinitializer(2) {
require(owner == address(0));
owner = payable(msg.sender);
}

function kill() external {
require(msg.sender == owner);
selfdestruct(owner);
}
}
Binary file added tests/e2e/detectors/test_data/unprotected-upgrade/0.8.15/Reinitializer.sol-0.8.15.zip
View file
Open in desktop
Binary file not shown.
50 changes: 50 additions & 0 deletions tests/e2e/detectors/test_detectors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -938,6 +938,16 @@ def id_test(test_item: Test):
"whitelisted.sol",
"0.4.25",
),
Test(
all_detectors.UnprotectedUpgradeable,
"Reinitializer.sol",
"0.4.25",
),
Test(
all_detectors.UnprotectedUpgradeable,
"AnyInitializer.sol",
"0.4.25",
),
Test(
all_detectors.UnprotectedUpgradeable,
"Buggy.sol",
Expand All @@ -953,6 +963,16 @@ def id_test(test_item: Test):
"whitelisted.sol",
"0.5.16",
),
Test(
all_detectors.UnprotectedUpgradeable,
"Reinitializer.sol",
"0.5.16",
),
Test(
all_detectors.UnprotectedUpgradeable,
"AnyInitializer.sol",
"0.5.16",
),
Test(
all_detectors.UnprotectedUpgradeable,
"Buggy.sol",
Expand All @@ -968,6 +988,16 @@ def id_test(test_item: Test):
"whitelisted.sol",
"0.6.11",
),
Test(
all_detectors.UnprotectedUpgradeable,
"Reinitializer.sol",
"0.6.11",
),
Test(
all_detectors.UnprotectedUpgradeable,
"AnyInitializer.sol",
"0.6.11",
),
Test(
all_detectors.UnprotectedUpgradeable,
"Buggy.sol",
Expand All @@ -978,6 +1008,16 @@ def id_test(test_item: Test):
"Fixed.sol",
"0.7.6",
),
Test(
all_detectors.UnprotectedUpgradeable,
"Reinitializer.sol",
"0.7.6",
),
Test(
all_detectors.UnprotectedUpgradeable,
"AnyInitializer.sol",
"0.7.6",
),
Test(
all_detectors.UnprotectedUpgradeable,
"whitelisted.sol",
Expand All @@ -998,6 +1038,16 @@ def id_test(test_item: Test):
"whitelisted.sol",
"0.8.15",
),
Test(
all_detectors.UnprotectedUpgradeable,
"Reinitializer.sol",
"0.8.15",
),
Test(
all_detectors.UnprotectedUpgradeable,
"AnyInitializer.sol",
"0.8.15",
),
Test(
all_detectors.ABIEncoderV2Array,
"storage_ABIEncoderV2_array.sol",
Expand Down
Loading