Fix verification for steps with plugins, part 2 #2339
Merged
Conversation
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
triarius
approved these changes
Aug 30, 2023
| Value: "Kuzco", | ||
| }, | ||
| ), | ||
| Config: map[string]any{"llama": "Kuzco"}, |
There was a problem hiding this comment.
Given that this PR was made to address the order of keys in plugin config, we should have a test that would have failed if the order weren't stable.
It might be impossible to write such a test using the json marshaller in go, but it's still worth having. The fact that json.Marshal sorts the keys before writing them is pretty crucial, so we should assert in our tests that it does to prevent regression.
There was a problem hiding this comment.
I've added a test that I think should capture encoding stability problems. It initially failed, but the reason was how I was holding Sign and Verify, so I made their argument processing more consistent.
Verify was fine assuming all env vars come from env, because that's how the backend produces output. But it made Sign and Verify look a bit different, and causes confusion when the same arguments don't verify.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Dogfooding showed that signed steps with plugins still tended to fail verification. After digging around with
--debug-http, it turns out that plugin config maps/hashes tend to be reordered by the backend.On the plus side: we're free to reorder keys within plugin configs! 🎉
Changes here:
pipeline.Pluginscan now be unmarshaled directly from JSON. For consistency it reuses the underlyingUnmarshalOrderedusing the same technique as forCommandStep.orderednow hasToMapRecursive, which replaces*Map[string, any]withmap[string]anyrecursively.Pluginis unmarshaled usingToMapRecursive.api.Job.ValuesForFieldsnow passesBUILDKITE_PLUGINSthrough a JSON unmarshal-marshal round-trip. The JSON marshaler writes (plain) map keys in sorted order.Net effect - signatures should verify.