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

Jump to bottom

fix(x/accounts): check for overflows in multisig weights and votes #20384

Merged
merged 5 commits into from
May 21, 2024
Merged

fix(x/accounts): check for overflows in multisig weights and votes #20384

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ddf0294
fix(x/accounts): check for overflows in multisig weights and votes
facundomedica May 14, 2024
96289d8
lint fix
facundomedica May 14, 2024
00f8d18
check overflow on update config
facundomedica May 15, 2024
f800a92
fix
facundomedica May 15, 2024
3350270
remove check from tally and add test for update
facundomedica May 21, 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
37 changes: 32 additions & 5 deletions x/accounts/defaults/multisig/account.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,10 @@ func (a *Account) Init(ctx context.Context, msg *v1.MsgInit) (*v1.MsgInitRespons
return nil, err
}

totalWeight += msg.Members[i].Weight
totalWeight, err = safeAdd(totalWeight, msg.Members[i].Weight)
if err != nil {
return nil, err
}
}

if err := validateConfig(*msg.Config, totalWeight); err != nil {
Expand Down Expand Up @@ -266,19 +269,32 @@ func (a Account) ExecuteProposal(ctx context.Context, msg *v1.MsgExecuteProposal

switch v1.VoteOption(vote) {
case v1.VoteOption_VOTE_OPTION_YES:
yesVotes += weight
yesVotes, err = safeAdd(yesVotes, weight)
if err != nil {
return true, err
}
case v1.VoteOption_VOTE_OPTION_NO:
noVotes += weight
noVotes, err = safeAdd(noVotes, weight)
if err != nil {
return true, err
}
case v1.VoteOption_VOTE_OPTION_ABSTAIN:
abstainVotes += weight
abstainVotes, err = safeAdd(abstainVotes, weight)
if err != nil {
return true, err
}
}
return false, nil
})
if err != nil {
return nil, err
}

totalWeight := yesVotes + noVotes + abstainVotes
totalWeight, err := safeAdd(yesVotes, noVotes, abstainVotes)
if err != nil {
return nil, err
}

var (
rejectErr error
execErr error
Expand Down Expand Up @@ -387,3 +403,14 @@ func (a *Account) RegisterQueryHandlers(builder *accountstd.QueryBuilder) {
accountstd.RegisterQueryHandler(builder, a.QueryProposal)
accountstd.RegisterQueryHandler(builder, a.QueryConfig)
}

func safeAdd(nums ...uint64) (uint64, error) {
var sum uint64
for _, num := range nums {
if sum+num < sum {
Copy link
Member

Choose a reason for hiding this comment

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

minor nit, i would pefer sum > math.MaxUint64 - num for easier readability

return 0, errors.New("overflow")
Copy link
Member

Choose a reason for hiding this comment

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

should we set it to max instead? that way tallying will see the max number not 0. 0 could signify 0 votes and passing here now

Copy link
Member Author

Choose a reason for hiding this comment

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

If an error is returned we don't really care about the result, as we'll return it without continuing execution

Copy link
Member

Choose a reason for hiding this comment

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

Makes sense. Does it make sense to check if all weight equate to less than maxuint64 when adding memebers or creating the multisig

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'm doing that check here: https://github.com/cosmos/cosmos-sdk/pull/20384/files#diff-fdd6d41c43d4db2fca28c5b410bd647692b4f7fb78997c62abf0835c8052d9c6R94 but now I that I've double-check I'm not doing that on update config.

Copy link
Contributor

Choose a reason for hiding this comment

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

Q: why can't we simply ensure that total_weight <= math.Uint64Max at member lvl

Copy link
Member Author

Choose a reason for hiding this comment

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

@testinginprod can you explain a bit more? You mean that we should only check for overflow when creating/updating members? That sounds good, because then in the tally we'd never go over that

Copy link
Contributor

Choose a reason for hiding this comment

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

Good thinking. Checks on init/ update would be enough but tally seems not to be on the criticial path for performance so I would not mind safety over performance.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done, I've removed the check on tally and added the test on update

}
sum += num
}
return sum, nil
}
31 changes: 31 additions & 0 deletions x/accounts/defaults/multisig/account_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package multisig

import (
"context"
"math"
"testing"
"time"

Expand Down Expand Up @@ -658,3 +659,33 @@ func TestProposalPassing(t *testing.T) {

require.Equal(t, expectedMembers, cfg.Members)
}

func TestWeightOverflow(t *testing.T) {
ctx, ss := newMockContext(t)
acc := setup(t, ctx, ss, nil)

startAcc := &v1.MsgInit{
Config: &v1.Config{
Threshold: 2640,
Quorum: 2000,
VotingPeriod: 60,
},
Members: []*v1.Member{
{
Address: "addr1",
Weight: math.MaxUint64,
},
},
}

_, err := acc.Init(ctx, startAcc)
require.NoError(t, err)

// add another member with weight 1 to trigger an overflow
startAcc.Members = append(startAcc.Members, &v1.Member{
Address: "addr2",
Weight: 1,
})
_, err = acc.Init(ctx, startAcc)
require.ErrorContains(t, err, "overflow")
}
6 changes: 5 additions & 1 deletion x/accounts/defaults/multisig/update_config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,11 @@ func (a Account) UpdateConfig(ctx context.Context, msg *v1.MsgUpdateConfig) (*v1
// get the weight from the stored members
totalWeight := uint64(0)
err := a.Members.Walk(ctx, nil, func(_ []byte, value uint64) (stop bool, err error) {
totalWeight += value
var adderr error
totalWeight, adderr = safeAdd(totalWeight, value)
if adderr != nil {
return true, err
}
facundomedica marked this conversation as resolved.
Show resolved Hide resolved
return false, nil
})
if err != nil {
Expand Down
Loading