cloudflare / cloudflare/boring
README should mention the pinned version of boringssl
- Dominant language
- Rust
- Stars
- 522
- Forks
- 171
- PR merge metrics
- No merged PRs in 30d
Description
Currently, the README says the following:
> By default, the crate statically links with the latest BoringSSL master branch.
After reviewing the code, I think this is a bit misleading. By default, the crate statically links with a pinned version of boringssl, currently set to google/boringssl@f1c75347daa2ea81a941e953f2263e0a4d970c8d .
I think it'd be valuable to make this clearer in the README. After reading the current README, I initially thought it was dynamically fetching the latest version of boringssl in its build.rs. In fact, [there is a call to git submodule in a build.rs](https://github.com/cloudflare/boring/blob/master/boring-sys/build.rs#L332-L342), but it seems to only run when depending on boring via git!
It'd be nice to have a few lines in the README clearly spelling out that, by default, the crate pins a specific boringssl version (and thus doesn't break reproducibility).
Contributor guide
Assessment
This issue has not been assessed yet.