Implement serialization protection via magic #169
Merged
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.
What Changed?
This adds a u64 magic number to the beginning of the output artifact from
paralegal-flow
which is verified upon loading the artifact.The magic number is a hash of the modification dates of all files in the
paralegal-spdg
crate.Why Does It Need To?
At present there is no protection that the format expected by a policy application conforms to the format written by the flow analyzer. Specifically the analyzer may be compiled against an older or newer version of
paralegal-spdg
. In such cases the derivedserde
implementation for the output artifact may differ.bincode
, the serialization library we use, does not offer protection against this case, leading to out-of-memory errors and memory leaks in deserialization.The magic hash added detects this version mismatch and reports it.
Checklist
good record of what changed.
if necessary
.github/workflows/rust.yml
) either as compiler test or integration test.Or justification for their omission from CI has been provided in this PR
description.