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

x/auth/types: CountSubKeys inexplicably returns 1 when the public key isn't of type multisig.PubKeyMultisigThreshold yet naturally counts otherwise #6889

Closed
4 tasks
Tracked by #14883
odeke-em opened this issue Jul 30, 2020 · 5 comments · Fixed by #15059
Labels

Comments

@odeke-em
Copy link
Collaborator

The code in question is

func CountSubKeys(pub crypto.PubKey) int {
v, ok := pub.(multisig.PubKeyMultisigThreshold)
if !ok {
return 1
}
numKeys := 0
for _, subkey := range v.PubKeys {
numKeys += CountSubKeys(subkey)
}
return numKeys
}

Why does it return the magic number 1 if pub is not of the required yet, yet in the positive case is actually recursively counts subkeys. I don't see a test to affirm this behavior and could perhaps return random behavior. If this logic is intended, at least let's document it.


For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@odeke-em odeke-em changed the title x/auth/ante: CountSubKeys inexplicably returns 1 when the public key isn't of type multisig.PubKeyMultisigThreshold yet naturally counts otherwise x/auth/types: CountSubKeys inexplicably returns 1 when the public key isn't of type multisig.PubKeyMultisigThreshold yet naturally counts otherwise Jul 30, 2020
@alexanderbez
Copy link
Contributor

A non-multisig, i.e. a regular signature, it naturally a count of 1. If it is a multisig, then it recursively calls it on its pubkeys. The number one isn't magic here.

@aaronc
Copy link
Member

aaronc commented Jul 30, 2020

Is this just missing a test @odeke-em ? The logic looks correct to me.

@odeke-em
Copy link
Collaborator Author

odeke-em commented Jul 30, 2020 via email

@alexanderbez
Copy link
Contributor

Is recursive function lingo, returning 1 is the base-case -- i.e. when a key has no sub-keys. If tests are lacking, we should certainly add more tests/cases!

@hxrts hxrts added the C:Crypto label Nov 26, 2020
@JulianToledano
Copy link
Contributor

JulianToledano commented Dec 13, 2022

@odeke-em can we close this one? there are some test cases for this in here
https://github.com/cosmos/cosmos-sdk/blob/main/x/auth/ante/ante_test.go#L1281-L1313

@julienrbrt julienrbrt linked a pull request Feb 17, 2023 that will close this issue
19 tasks
@mergify mergify bot closed this as completed in #15059 Feb 19, 2023
mergify bot pushed a commit that referenced this issue Feb 19, 2023
## Description

Closes:
#6889
#15056



---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
@ainhoa-a ainhoa-a added the S:zondax Squad: Zondax label Mar 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

6 participants