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

whitelist replay deployer #4009

Merged
merged 3 commits into from
Jan 19, 2024
Merged

whitelist replay deployer #4009

merged 3 commits into from
Jan 19, 2024

Conversation

dustinxie
Copy link
Member

Description

(#3965) has enabled pre-EIP155 unprotected tx. To ensure safety against replay attack, we limit the deployer address to an expected whitelist.

Fixes #(issue)

Type of change

Please delete options that are not relevant.

  • [] Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • [] Code refactor or improvement
  • [] Breaking change (fix or feature that would cause a new or changed behavior of existing functionality)
  • [] This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • make test
  • [] fullsync
  • [] Other test (please specify)

Test Configuration:

  • Firmware version:
  • Hardware:
  • Toolchain:
  • SDK:

Checklist:

  • [] My code follows the style guidelines of this project
  • [] I have performed a self-review of my code
  • [] I have commented my code, particularly in hard-to-understand areas
  • [] I have made corresponding changes to the documentation
  • [] My changes generate no new warnings
  • [] I have added tests that prove my fix is effective or that my feature works
  • [] New and existing unit tests pass locally with my changes
  • [] Any dependent changes have been merged and published in downstream modules

@@ -132,6 +132,8 @@ type (
EVMNetworkID() uint32
// ChainID returns the chain id of evm
ChainID() uint32
// IsDeployerWhitelisted returns if the replay deployer is whitelisted
IsDeployerWhitelisted(address.Address) bool
Copy link
Collaborator

Choose a reason for hiding this comment

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

for what?

Copy link
Member Author

Choose a reason for hiding this comment

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

for check the received action

Copy link
Member

Choose a reason for hiding this comment

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

unnecessary to do filtering inside API

Copy link
Member Author

Choose a reason for hiding this comment

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

i think we should? otherwise it enters workingset and throws error
similar to ChainID check, we filter and reject inside API as well (also check and throw error in workingset)

Comment on lines 446 to 465
// reject action if a replay tx is not whitelisted
deployer := selp.SrcPubkey().Address()
if selp.Encoding() == uint32(iotextypes.Encoding_ETHEREUM_UNPROTECTED) && !core.IsDeployerWhitelisted(deployer) {
return "", status.Errorf(codes.InvalidArgument, "replay deployer %v not whitelisted", deployer.Hex())
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's leave it to next PR: not sure we need to add a function to the blockchain interface just for filtering purpose.

Copy link
Member Author

Choose a reason for hiding this comment

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

it is in blockchain interface for 2 reasons:

  1. workingset needs it when processing actions
  2. here core service use it for whitelist deployer check

or what is your suggestion?

Tip: tip,
ChainID: bc.ChainID(),
EvmNetworkID: bc.EvmNetworkID(),
IsDeployerWhitelisted: bc.config.IsDeployerWhitelisted,
Copy link
Collaborator

Choose a reason for hiding this comment

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

not sure whether it is appropriate to add it to context in this way. btw, if it is added to context, no need to add IsDeployerWhitelisted to Blockchain

Copy link
Member Author

Choose a reason for hiding this comment

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

add to context is for workingset to use when process actions, add to Blockchain is for coreservice to use, as explained above

or what is your suggestion?

Copy link
Collaborator

Choose a reason for hiding this comment

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

quote what you said above:

it is in blockchain interface for 2 reasons:

workingset needs it when processing actions
here core service use it for whitelist deployer check

@@ -37,6 +37,7 @@ type (
ID uint32 `yaml:"id"`
EVMNetworkID uint32 `yaml:"evmNetworkID"`
Address string `yaml:"address"`
ReplayDeployerWhitelist []string `yaml:"replayDeployerWhitelist"`
Copy link
Collaborator

Choose a reason for hiding this comment

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

what if the field is added to genesis?

Copy link
Member Author

@dustinxie dustinxie Dec 28, 2023

Choose a reason for hiding this comment

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

genesis.Blockchain is also an option, but looking at the fields I feel it is more appropriate to add here?
and by adding to genesis.Blockchain, we still need the new func in coreservice and context

Copy link
Collaborator

Choose a reason for hiding this comment

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

are you sure?

Copy link

codecov bot commented Dec 28, 2023

Codecov Report

Attention: 530 lines in your changes are missing coverage. Please review.

Comparison is base (e1f0636) 75.38% compared to head (fa9b5c6) 76.18%.
Report is 158 commits behind head on master.

Files Patch % Lines
action/protocol/staking/staking_statereader.go 69.76% 35 Missing and 17 partials ⚠️
action/protocol/execution/evm/evm.go 48.38% 47 Missing and 1 partial ⚠️
api/coreservice.go 62.96% 34 Missing and 6 partials ⚠️
api/web3server.go 79.24% 30 Missing and 3 partials ⚠️
action/candidate_endorsement.go 0.00% 31 Missing ⚠️
action/protocol/staking/protocol.go 36.36% 28 Missing ⚠️
action/candidate_activate.go 0.00% 25 Missing ⚠️
...tion/protocol/staking/contractstake_bucket_type.go 0.00% 24 Missing ⚠️
action/protocol/rewarding/fund.go 23.07% 19 Missing and 1 partial ⚠️
api/websocket.go 0.00% 20 Missing ⚠️
... and 36 more
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4009      +/-   ##
==========================================
+ Coverage   75.38%   76.18%   +0.80%     
==========================================
  Files         303      338      +35     
  Lines       25923    28795    +2872     
==========================================
+ Hits        19541    21938    +2397     
- Misses       5360     5738     +378     
- Partials     1022     1119      +97     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

// IsDeployerWhitelisted returns whether the address is whitelisted for replay transaction
func (cfg *Config) IsDeployerWhitelisted(deployer address.Address) bool {
for _, v := range cfg.ReplayDeployerWhitelist {
if v[:3] == "io1" {
Copy link
Member

Choose a reason for hiding this comment

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

It's better to use a function to parse string to address, supporting ethAddr and ioAddr. Some similar code lies in ioctl/util/util.go:157.

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed

@dustinxie dustinxie force-pushed the check branch 2 times, most recently from 807be0d to d3baef3 Compare December 28, 2023 23:36
return nil, err
}
}
// for replay tx, check against deployer whitelist
g := genesis.MustExtractGenesisContext(ctx)
Copy link
Member

Choose a reason for hiding this comment

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

This check maybe more suitable to be placed in the validate function, executed before the runAction function.

Copy link
Member Author

Choose a reason for hiding this comment

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

validate() does not have actions as input, so cannot check the sender address is whitelisted or not

Copy link

Quality Gate Passed Quality Gate passed

The SonarCloud Quality Gate passed, but some issues were introduced.

1 New issue
0 Security Hotspots
No data about Coverage
2.2% Duplication on New Code

See analysis details on SonarCloud

@dustinxie dustinxie merged commit e7f8bb8 into iotexproject:master Jan 19, 2024
4 of 5 checks passed
dustinxie added a commit that referenced this pull request Jan 29, 2024
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.

4 participants