Addressing smartnode-issue-572 #621
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,188 @@ | ||
| package validator | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "github.com/rocket-pool/node-manager-core/beacon" | ||
| "github.com/rocket-pool/node-manager-core/utils" | ||
| "golang.org/x/exp/maps" | ||
| "strings" | ||
| ) | ||
|
|
||
| type KeyRecoveryManager struct { | ||
| manager *ValidatorManager | ||
| partialEnabled bool | ||
| testOnly bool | ||
| } | ||
|
|
||
| func NewKeyRecoveryManager(m *ValidatorManager, partialEnabled bool, testOnly bool) *KeyRecoveryManager { | ||
| return &KeyRecoveryManager{ | ||
| manager: m, | ||
| partialEnabled: partialEnabled, | ||
| testOnly: testOnly, | ||
| } | ||
| } | ||
|
|
||
| func (s *KeyRecoveryManager) RecoverMinipoolKeys() ([]beacon.ValidatorPubkey, map[beacon.ValidatorPubkey]error, error) { | ||
| publicKeys, err := s.manager.GetMinipools() | ||
| if err != nil { | ||
| return []beacon.ValidatorPubkey{}, map[beacon.ValidatorPubkey]error{}, err | ||
| } | ||
|
|
||
| recoveredCustomPublicKeys, unrecoverableCustomPublicKeys, err := s.checkForAndRecoverCustomKeys(publicKeys) | ||
| if err != nil && !s.partialEnabled { | ||
| return maps.Keys(recoveredCustomPublicKeys), unrecoverableCustomPublicKeys, err | ||
| } | ||
|
|
||
| recoveredConventionalPublicKeys, unrecoveredPublicKeys := s.recoverConventionalKeys(publicKeys) | ||
|
|
||
| var allRecoveredPublicKeys []beacon.ValidatorPubkey | ||
| allRecoveredPublicKeys = append(allRecoveredPublicKeys, maps.Keys(recoveredCustomPublicKeys)...) | ||
| allRecoveredPublicKeys = append(allRecoveredPublicKeys, recoveredConventionalPublicKeys...) | ||
|
|
||
| for publicKey, err := range unrecoveredPublicKeys { | ||
| unrecoverableCustomPublicKeys[publicKey] = err | ||
| } | ||
|
|
||
| return allRecoveredPublicKeys, unrecoveredPublicKeys, nil | ||
| } | ||
|
|
||
| func (s *KeyRecoveryManager) checkForAndRecoverCustomKeys( | ||
| publicKeys map[beacon.ValidatorPubkey]bool, | ||
| ) (map[beacon.ValidatorPubkey]bool, map[beacon.ValidatorPubkey]error, error) { | ||
|
|
||
| recoveredKeys := make(map[beacon.ValidatorPubkey]bool) | ||
| recoveryFailures := make(map[beacon.ValidatorPubkey]error) | ||
| var passwords map[string]string | ||
|
|
||
| keyFiles, err := s.manager.LoadFiles() | ||
| if err != nil { | ||
| return recoveredKeys, recoveryFailures, err | ||
| } | ||
|
|
||
| if len(keyFiles) == 0 { | ||
| return recoveredKeys, recoveryFailures, nil | ||
| } | ||
|
|
||
| passwords, err = s.manager.LoadCustomKeyPasswords() | ||
| if err != nil { | ||
| return recoveredKeys, recoveryFailures, err | ||
| } | ||
|
|
||
| for _, file := range keyFiles { | ||
| keystore, err := s.manager.ReadCustomKeystore(file) | ||
| if err != nil { | ||
| if s.partialEnabled { | ||
| continue | ||
| } | ||
| return recoveredKeys, recoveryFailures, err | ||
| } | ||
|
|
||
| if _, exists := publicKeys[keystore.Pubkey]; !exists { | ||
| err := fmt.Errorf("custom keystore for pubkey %s not found in minipool keyset", keystore.Pubkey.Hex()) | ||
| recoveryFailures[keystore.Pubkey] = err | ||
| if s.partialEnabled { | ||
| continue | ||
| } | ||
| return recoveredKeys, recoveryFailures, err | ||
| } | ||
|
|
||
| formattedPublicKey := strings.ToUpper(utils.RemovePrefix(keystore.Pubkey.Hex())) | ||
| password, exists := passwords[formattedPublicKey] | ||
| if !exists { | ||
| err := fmt.Errorf("custom keystore for pubkey %s needs a password, but none was provided", keystore.Pubkey.Hex()) | ||
| recoveryFailures[keystore.Pubkey] = err | ||
| if s.partialEnabled { | ||
| continue | ||
| } | ||
| return recoveredKeys, recoveryFailures, err | ||
| } | ||
|
|
||
| privateKey, err := s.manager.DecryptCustomKeystore(keystore, password) | ||
| if err != nil { | ||
| err := fmt.Errorf("error recreating private key for validator %s: %w", keystore.Pubkey.Hex(), err) | ||
| recoveryFailures[keystore.Pubkey] = err | ||
| if s.partialEnabled { | ||
| continue | ||
| } | ||
| return recoveredKeys, recoveryFailures, err | ||
| } | ||
|
|
||
| reconstructedPublicKey := beacon.ValidatorPubkey(privateKey.PublicKey().Marshal()) | ||
| if reconstructedPublicKey != keystore.Pubkey { | ||
| err := fmt.Errorf("private keystore file %s claims to be for validator %s but it's for validator %s", file.Name(), keystore.Pubkey.Hex(), reconstructedPublicKey.Hex()) | ||
| recoveryFailures[keystore.Pubkey] = err | ||
| if s.partialEnabled { | ||
| continue | ||
| } | ||
| return recoveredKeys, recoveryFailures, err | ||
| } | ||
|
|
||
| if !s.testOnly { | ||
| if err := s.manager.StoreValidatorKey(&privateKey, keystore.Path); err != nil { | ||
| recoveryFailures[keystore.Pubkey] = err | ||
| if s.partialEnabled { | ||
| continue | ||
| } | ||
| return recoveredKeys, recoveryFailures, err | ||
| } | ||
| } | ||
| recoveredKeys[reconstructedPublicKey] = true | ||
|
|
||
| delete(publicKeys, keystore.Pubkey) | ||
| } | ||
|
|
||
| return recoveredKeys, recoveryFailures, nil | ||
| } | ||
|
|
||
| func (s *KeyRecoveryManager) recoverConventionalKeys(publicKeys map[beacon.ValidatorPubkey]bool) ([]beacon.ValidatorPubkey, map[beacon.ValidatorPubkey]error) { | ||
| var recoveredPublicKeys []beacon.ValidatorPubkey | ||
| unrecoverablePublicKeys := map[beacon.ValidatorPubkey]error{} | ||
|
|
||
| bucketStart := uint64(0) | ||
| for { | ||
| if bucketStart >= bucketLimit { | ||
| break | ||
| } | ||
| bucketEnd := bucketStart + bucketSize | ||
| if bucketEnd > bucketLimit { | ||
| bucketEnd = bucketLimit | ||
| } | ||
|
|
||
| keys, err := s.manager.GetValidatorKeys(bucketStart, bucketEnd-bucketStart) | ||
| if err != nil { | ||
| return recoveredPublicKeys, map[beacon.ValidatorPubkey]error{beacon.ValidatorPubkey{}: fmt.Errorf("error getting node's validator keys")} | ||
| } | ||
|
|
||
| for _, validatorKey := range keys { | ||
| if exists := publicKeys[validatorKey.PublicKey]; exists { | ||
| delete(publicKeys, validatorKey.PublicKey) | ||
| if !s.testOnly { | ||
| if err := s.manager.SaveValidatorKey(validatorKey); err != nil { | ||
| unrecoverablePublicKeys[validatorKey.PublicKey] = err | ||
| if s.partialEnabled { | ||
| continue | ||
| } | ||
| return recoveredPublicKeys, unrecoverablePublicKeys | ||
| } | ||
| } | ||
| recoveredPublicKeys = append(recoveredPublicKeys, validatorKey.PublicKey) | ||
|
|
||
| } else { | ||
| err := fmt.Errorf("keystore for pubkey %s not found in minipool keyset", validatorKey.PublicKey) | ||
| unrecoverablePublicKeys[validatorKey.PublicKey] = err | ||
| if !s.partialEnabled { | ||
| return recoveredPublicKeys, unrecoverablePublicKeys | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if len(publicKeys) == 0 { | ||
| // All keys have been recovered. | ||
| break | ||
| } | ||
|
|
||
| bucketStart = bucketEnd | ||
| } | ||
|
|
||
| return recoveredPublicKeys, unrecoverablePublicKeys | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
interesting. bool types are native json types- do we need to use a string?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe I was just following convention on this one. For example, the
skip-validator-key-recoveryparameter uses a similar code flow to translate the string to boolean.I could see the perspective that this is a bit silly since the parameter is a string, gets converted to a bool to call the method then is immediately converted back to a string for the payload. I also cringe at the idea of passing a string around which is serving as a boolean, so neither way is elegant.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The SendGetRequest method takes a map[string]string. Refactoring this down could make this more generic, but for now requires parameters as strings.