Add external types CI check + config #183

Previously this file had some places where members of a type were separated by whitespace, and some places where they weren't. In my experience it's more common to use whitespace here, and I think it reads better, so this commit standardizes on that (at least within key_pair.rs).

This trait offers a way to convert errors from dependencies into `rcgen::Error` instances without manually mapping the error in each instance, or leaking the error type into the public API with a `From<x> for Error` impl.

Having `From<ring::error::KeyRejected>` defined on the public `Error` type means that the `*ring*` type leaks into rcgen's public API, complicating semver incompatible updates. This commit takes the simple approach of using the crate-internal `ExternalError` trait to convert from the `*ring*` error type to our generic rcgen `Error::RingKeyRejected` type as needed. This allows the `From` impl on `Error` to be removed, fixing the type leak.

Having `From<ring::error::Unspecified>` defined on the public `Error` type means that the `*ring*` type leaks into rcgen's public API, complicating semver incompatible updates. This commit updates the sites that previously used this trait to instead use a crate internal `ExternalError` trait implementation to map to the generic rcgen `Error::RingUnspecified` err. This allows the `From` impl on `Error` to be removed, fixing the type leak.

Having `From<pem::PemError>` defined on the public `Error` type means that the `pem` type leaks into rcgen's public API, complicating semver incompatible updates. This commit updates the sites that previously used this trait to use the crate internal `ExternalError` extension trait to map the `PemError` err to the generic rcgen `Error::PemError` err. Additionally, the `rcgen::Error::PemError` variant is changed to hold a `String` with the `pem::PemError` error string instead of the type itself. This allows the `From` impl on `Error` to be removed, fixing the type leak.

This commit adds configuration and a CI task for checking that no types from dependencies are accidentally leaked through the Rcgen public API unintentionally. The previous commits in this branch fixed the `*ring*` type leaks, so our configuration only has two white-listed types as of this branch: 1. `time::offset_date_time::OffsetDateTime` It's unclear whether usage of that type should be adjusted, so for now we explicitly allow-list it in the cargo-check-external-types config. We can deal with this type (or not) in the future. 2. `zeroize::Zeroize` We could probably avoid leaking this type by implementing `Drop` and calling `zeroize` on fields directly from the `drop` impl. In the meantime we add this type to the allow list.

This commit bumps the rcgen version from `0.11.3` to `0.12.0` to reflect there are breaking changes in `main`.

This commit adds `cargo-semver-checks`[0] to CI. This tool helps detect when semver incompatible changes are being made without properly incrementing the `Cargo.toml` version. Note that this is necessary, but not sufficient, for ensuring semver compatibility. This tool is helpful, but not perfect, and can miss some breakages. [0]: https://github.com/obi1kenobi/cargo-semver-checks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add external types CI check + config #183

Add external types CI check + config #183

Commits on Dec 8, 2023