Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
inikulin committed Jul 10, 2023
1 parent d1ee9bf commit d59d170
Show file tree
Hide file tree
Showing 15 changed files with 850 additions and 805 deletions.
33 changes: 5 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,34 +5,11 @@
BoringSSL bindings for the Rust programming language and TLS adapters for [tokio](https://github.com/tokio-rs/tokio)
and [hyper](https://github.com/hyperium/hyper) built on top of it.

[Documentation](https://docs.rs/boring).

## Release Support

By default, the crate statically links with the latest BoringSSL master branch.

## Support for pre-built binaries

While this crate can build BoringSSL on its own, you may want to provide pre-built binaries instead.
To do so, specify the environment variable `BORING_BSSL_PATH` with the path to the binaries.

You can also provide specific headers by setting `BORING_BSSL_INCLUDE_PATH`.

_Notes_: The crate will look for headers in the `$BORING_BSSL_INCLUDE_PATH/openssl/` folder, make sure to place your headers there.

_Warning_: When providing a different version of BoringSSL make sure to use a compatible one, the crate relies on the presence of certain functions.

## Building with a FIPS-validated module

Only BoringCrypto module version 853ca1ea1168dff08011e5d42d94609cc0ca2e27, as certified with
[FIPS 140-2 certificate 4407](https://csrc.nist.gov/projects/cryptographic-module-validation-program/certificate/4407)
is supported by this crate. Support is enabled by this crate's `fips` feature.

`boring-sys` comes with a test that FIPS is enabled/disabled depending on the feature flag. You can run it as follows:

```bash
$ cargo test --features fips fips::is_enabled
```
## Documentation
- Boring API: <https://docs.rs/boring>
- tokio TLS adapters: <https://docs.rs/tokio-boring>
- hyper HTTPS connector: <https://docs.rs/hyper-boring>
- FFI bindings: <https://docs.rs/boring-sys>

## Contribution

Expand Down
2 changes: 1 addition & 1 deletion boring-sys/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ fn ensure_patches_applied() -> io::Result<()> {

if cfg!(feature = "rpk") {
println!("cargo:warning=applying RPK patch to boringssl");
run_apply_patch_script("scripts/apply_rpk_patch.sh", "src")?;
run_apply_patch_script("scripts/apply_rpk_patch.sh", "")?;
}

Ok(())
Expand Down
84 changes: 0 additions & 84 deletions boring-sys/patches/rpk-patch/include/openssl/ssl.h.patch

This file was deleted.

38 changes: 0 additions & 38 deletions boring-sys/patches/rpk-patch/include/openssl/tls1.h.patch

This file was deleted.

189 changes: 0 additions & 189 deletions boring-sys/patches/rpk-patch/ssl/extensions.cc.patch

This file was deleted.

Loading

0 comments on commit d59d170

Please sign in to comment.