Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to workspace, move ech-fetch to separate crate, add ECH CI coverage #509

Merged
merged 9 commits into from
Dec 21, 2024

Conversation

cpu
Copy link
Member

@cpu cpu commented Dec 19, 2024

This branch switches the project to be a cargo workspace, moving the existing crate from the root of git repo into a crate named librustls. At the same time, switch all the non-rustls deps to be workspace deps, and use the pki_types export from rustls instead of importing it directly.

Next, we move librustls/tests/ech_fetch.rs to a new tools crate in the workspace where we can implement it as a proper binary instead of a weird integration test that disables the test runner. The tools crate will be used for other items in the near future (e.g. an API doc generator utility for #215).

Finally, use the ech_fetch.rs utility in CI to test the client.c example can successfully negotiate ECH against a test server from linux, macOS and windows (for the aws-lc-rs builds since ring lacks support for HPKE). This resolves #498.

One other fix comes along for the ride: I accidentally broke the "keep the rustls.h header file up-to-date" CI check in the transition to CMake. That's fixed and I had to regen the header to pick up some changes that weren't sync'd from #231.

cpu added 9 commits December 19, 2024 15:26
When we switched to `cmake` the CI task for using `cbindgen` was left
behind trying to use `make` in a way that failed silently.

This commit both fixes the CI test, and regenerates the .h with updates
that were missed (mostly moving items around after the mod split).
This commit moves the existing crate into a `librustls` sub-crate in
a workspace.

Using a workspace will give us more flexibility for introducing helper
code without having to awkwardly jam it into integration test binaries
or examples.
We'll keep `rustls` as a "normal" dependency in `librustls` so that it's
clearer that its version must match the `librustls/build.rs` version.
This also means we don't have to change the
`librustls/tests/rustls_version.rs` test.
We don't need to manage our own `pki_types` dep this way.
The `ech_fetch.rs` test was never really a test, it's a tool that can be
used alongside some of the testcode. Having to define it as a test sort
of sucks, we need to disable the normal test runner, and it makes taking
command-line arguments awkward.

Instead, let's make a separate crate and make ech-fetch.rs a normal
binary within that (not published) crate.
* Gets ech configs using the tools crate's ech-fetch binary
* Runs the built client example with the fetched ECH config lists
@cpu cpu self-assigned this Dec 19, 2024
@cpu cpu requested a review from ctz December 19, 2024 22:02
Copy link
Collaborator

@jsha jsha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me 👍🏻

@cpu
Copy link
Member Author

cpu commented Dec 21, 2024

Since this doesn't introduce any new code I'm going to merge with the one review. Thanks!

@cpu cpu merged commit 5003f40 into main Dec 21, 2024
70 checks passed
@cpu cpu deleted the cpu-workspace branch December 21, 2024 14:55
yedayak added a commit to yedayak/rustls-ffi that referenced this pull request Dec 23, 2024
This seems to have been missed in rustls#509
cpu pushed a commit that referenced this pull request Dec 23, 2024
This seems to have been missed in #509
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add CI coverage for ECH client
2 participants