coordinator: validate location before marshaling - #880
Open
damilolaedwards wants to merge 1 commit into
Open
Conversation
UpsertCannonLocation and UpsertRelayMonitorLocation dereferenced the incoming location without checking for nil, so a request with the field omitted crashed the whole server. Both handlers now reject a nil location with InvalidArgument before touching it. Marshal also accepted a request where the type was set but the matching data payload was missing, and silently wrote an empty marker instead of the real value. That marker looks like a valid location to every reader downstream, so it quietly resets whatever checkpoint or cursor the entry represented. Both the cannon and relay monitor Marshal implementations now reject this case with a new ErrLocationDataRequired error. The cannon implementation also had several types marshaling inline instead of going through the shared helper, so those were consolidated to keep the check in one place. Added a recovery interceptor to the grpc server so a panic in a handler returns an internal error to the caller instead of taking down the process. This is a backstop for bugs like the one above, not a replacement for validating input.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
UpsertCannonLocation and UpsertRelayMonitorLocation dereferenced the incoming location without checking for nil, so a request with the field omitted crashed the whole server. Both handlers now reject a nil location with InvalidArgument before touching it.
Marshal also accepted a request where the type was set but the matching data payload was missing, and silently wrote an empty marker instead of the real value. That marker looks like a valid location to every downstream reader, so it quietly resets whatever checkpoint or cursor the entry represented. Both the cannon and relay monitor Marshal implementations now reject this case with a new ErrLocationDataRequired error. The cannon implementation also had several types marshaling inline instead of going through the shared helper, so those were consolidated to keep the check in one place.
Added a recovery interceptor to the grpc server so a panic in a handler returns an internal error to the caller instead of taking down the process. This is a backstop for bugs like the one above, not a replacement for validating input.
Test plan
go build ./...go test ./pkg/server/persistence/cannon/... ./pkg/server/persistence/relaymonitor/... ./pkg/server/service/coordinator/...