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.

Sign up for GitHub

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

Disable default features for aws-lc-rs #286

Merged
merged 1 commit into from
Aug 1, 2024
Merged

Disable default features for aws-lc-rs #286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 4 additions & 11 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ members = ["rcgen", "rustls-cert-gen"]
resolver = "2"

[workspace.dependencies]
aws-lc-rs = "1.6.0"
aws-lc-rs = { version = "1.6.0", default-features = false }
daxpedda marked this conversation as resolved.
Show resolved Hide resolved
pem = "3.0.2"
pki-types = { package = "rustls-pki-types", version = "1.4.1" }
rand = "0.8"
Expand Down
4 changes: 2 additions & 2 deletions rcgen/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ zeroize = { version = "1.2", optional = true }
[features]
default = ["crypto", "pem", "ring"]
crypto = []
aws_lc_rs = ["crypto", "dep:aws-lc-rs"]
aws_lc_rs = ["crypto", "dep:aws-lc-rs", "aws-lc-rs/aws-lc-sys"]
ring = ["crypto", "dep:ring"]
fips = ["aws_lc_rs", "aws-lc-rs?/fips"]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I removed the ? because it didn't make sense, or was it there for a reason?

Copy link
Member

@cpu cpu Jul 30, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

I think you're right that in this context it doesn't make sense and should be removed. My understanding of the ? is that it (docs):

"will only enable the given feature if something else enables the optional dependency."

But in this case, the fips feature is activating aws_lc_rs right alongside aws-lc-rs/fips.

@djc Does that match your understanding? The usage came along with #234 and wasn't discussed explicitly as far as I can tell.

Copy link
Member

Choose a reason for hiding this comment

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

IIRC there was a bug in older Cargo versions that needed the ? to be there. If it works without it on the project's MSRV, I'm fine with this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I tried it locally with Rust v1.66 and it compiles for me.

Copy link
Member

Choose a reason for hiding this comment

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

"aws_lc_rs", "aws-lc-rs?/fips" is the new way of writing "aws-lc-rs/fips" and makes it explicit that the enabling the aws-lc-rs feature is vital for the fips feature.

Copy link
Member

Choose a reason for hiding this comment

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

In this case I don't think it makes sense to preserve the ?, since we unconditionally enable the optional dependency anyway when the fips feature is enabled.

Copy link
Member

Choose a reason for hiding this comment

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

In this case I don't think it makes sense to preserve the ?

I agree. Since @est31 didn't request any changes and approved the PR I think it's fair to merge with the removal?

fips = ["crypto", "dep:aws-lc-rs", "aws-lc-rs/fips"]
cpu marked this conversation as resolved.
Show resolved Hide resolved

[package.metadata.docs.rs]
features = ["x509-parser"]
Expand Down
4 changes: 2 additions & 2 deletions rustls-cert-gen/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ keywords.workspace = true

[features]
default = ["ring"]
aws_lc_rs = ["dep:aws-lc-rs", "rcgen/aws_lc_rs"]
aws_lc_rs = ["dep:aws-lc-rs", "rcgen/aws_lc_rs", "aws-lc-rs/aws-lc-sys"]
ring = ["dep:ring", "rcgen/ring"]
fips = ["aws_lc_rs", "aws-lc-rs?/fips"]
fips = ["dep:aws-lc-rs", "rcgen/aws_lc_rs", "aws-lc-rs/fips"]

[dependencies]
rcgen = { version = "0.13", path = "../rcgen", default-features = false, features = ["pem"] }
Expand Down