Skip to content

README.md

Latest commit

 

History

History
64 lines (40 loc) · 2.48 KB

README.md

File metadata and controls

64 lines (40 loc) · 2.48 KB
Raw

rustls-cng-crypto

A rustls Crypto Provider for Windows that uses CNG for cryptographic operations.

This repository is a Datadog-maintained fork of tofay/rustls-cng-crypto.

See the documentation for supported cipher suites and algorithms, along with instructions for running in FIPS mode.

crates.io Build Status Documentation License: MIT

Testing

This project tests the crypto provider operations using test vectors from Project Wycheproof where applicable.

Full test coverage requires Windows because the provider calls Windows CNG APIs:

cargo test

The default test suite is hermetic. The crates.io interoperability test is ignored by default because it requires live network access; run it explicitly when needed:

cargo test test_to_internet -- --ignored

This crate only builds for Windows targets. From non-Windows hosts, run check and documentation workflows with an explicit Windows target:

cargo check --target x86_64-pc-windows-msvc
RUSTDOCFLAGS='-D warnings' cargo doc --no-deps --target x86_64-pc-windows-msvc

Run formatting checks before submitting changes:

cargo fmt -- --check

Third-party licenses

Third-party Rust dependencies are tracked in LICENSE-3rdparty.csv. The file is generated from Cargo.lock with Datadog's Rust license inventory tool.

After changing dependencies, run:

make sync-licenses
make check-licenses

Contributing

See CONTRIBUTING.md for development and pull request guidance.

Security

See SECURITY.md for vulnerability reporting instructions.

License

This repository is licensed under the MIT License. Unless explicitly stated otherwise, files in this repository are licensed under the MIT License.