-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Add a signature validation budget during path construction #14960
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
Merged
+184
−12
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
6b83902
Add a signature validation budget during path construction
woodruffw 6e45a21
Bump limbo
woodruffw bcdb680
Temporary commit
woodruffw 5ac19e9
Revert "Temporary commit"
woodruffw 63842d3
Fudge a coverage test into place
woodruffw 5eeb87b
Coverage for the coverage god
woodruffw File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,10 +18,14 @@ use std::vec; | |
| use asn1::ObjectIdentifier; | ||
| use cryptography_x509::common::Asn1Read; | ||
| use cryptography_x509::extensions::{ | ||
| DuplicateExtensionsError, Extensions, NameConstraints, SubjectAlternativeName, | ||
| AuthorityKeyIdentifier, DuplicateExtensionsError, Extensions, NameConstraints, | ||
| SubjectAlternativeName, | ||
| }; | ||
| use cryptography_x509::name::GeneralName; | ||
| use cryptography_x509::oid::{NAME_CONSTRAINTS_OID, SUBJECT_ALTERNATIVE_NAME_OID}; | ||
| use cryptography_x509::oid::{ | ||
| AUTHORITY_KEY_IDENTIFIER_OID, NAME_CONSTRAINTS_OID, SUBJECT_ALTERNATIVE_NAME_OID, | ||
| SUBJECT_KEY_IDENTIFIER_OID, | ||
| }; | ||
|
|
||
| use crate::certificate::cert_is_self_issued; | ||
| use crate::ops::{CryptoOps, VerificationCertificate}; | ||
|
|
@@ -98,15 +102,23 @@ impl<B: CryptoOps> Display for ValidationError<'_, B> { | |
|
|
||
| struct Budget { | ||
| name_constraint_checks: usize, | ||
| signature_checks: usize, | ||
| } | ||
|
|
||
| impl Budget { | ||
| // Same limit as other validators | ||
| // The maximum number of name constraint checks performed when attempting | ||
| // path construction. This is the same limit as other validators. | ||
| const DEFAULT_NAME_CONSTRAINT_CHECK_LIMIT: usize = 1 << 20; | ||
|
|
||
| // The maximum number of signature verifications performed when attempting | ||
| // path construction. The is similar to other validators: | ||
| // both Go and rustls-webpki pick 100. | ||
| const DEFAULT_SIGNATURE_CHECK_LIMIT: usize = 1 << 7; | ||
|
|
||
| fn new() -> Budget { | ||
| Budget { | ||
| name_constraint_checks: Self::DEFAULT_NAME_CONSTRAINT_CHECK_LIMIT, | ||
| signature_checks: Self::DEFAULT_SIGNATURE_CHECK_LIMIT, | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -119,6 +131,15 @@ impl Budget { | |
| })?; | ||
| Ok(()) | ||
| } | ||
|
|
||
| fn signature_check<'chain, B: CryptoOps>(&mut self) -> ValidationResult<'chain, (), B> { | ||
| self.signature_checks = self.signature_checks.checked_sub(1).ok_or_else(|| { | ||
| ValidationError::new(ValidationErrorKind::FatalError( | ||
| "Exceeded maximum signature check limit", | ||
| )) | ||
| })?; | ||
| Ok(()) | ||
| } | ||
| } | ||
|
|
||
| struct NameChain<'a, 'chain> { | ||
|
|
@@ -341,18 +362,57 @@ impl<'a, 'chain, B: CryptoOps> ChainBuilder<'a, 'chain, B> { | |
| } | ||
| } | ||
|
|
||
| /// Identify and return potential issuers for `cert`, considering | ||
| /// candidates from both the trusted store and untrusted intermediate set. | ||
| /// Trusted candidates are returned before untrusted intermediate | ||
| /// candidates, and both groups are opportunisitically ordered by | ||
| /// "likeliness" in terms of AKI/SKI match. | ||
| fn potential_issuers( | ||
| &self, | ||
| cert: &'a VerificationCertificate<'chain, B>, | ||
| ) -> impl Iterator<Item = &'a VerificationCertificate<'chain, B>> + '_ { | ||
| // TODO: Optimizations: | ||
| // * Search by AKI and other identifiers? | ||
| self.store | ||
| cert_extensions: &Extensions<'chain>, | ||
| ) -> Vec<&'a VerificationCertificate<'chain, B>> { | ||
| let mut candidates: Vec<&'a VerificationCertificate<'chain, B>> = self | ||
| .store | ||
| .get_by_subject(&cert.certificate().tbs_cert.issuer) | ||
| .iter() | ||
| .chain(self.intermediates.iter().filter(|&candidate| { | ||
| candidate.certificate().subject() == cert.certificate().issuer() | ||
| })) | ||
| .collect(); | ||
|
|
||
| let want_kid: Option<&[u8]> = cert_extensions | ||
| .get_extension(&AUTHORITY_KEY_IDENTIFIER_OID) | ||
| .and_then(|ext| ext.value::<AuthorityKeyIdentifier<'_, Asn1Read>>().ok()) | ||
| .and_then(|aki| aki.key_identifier); | ||
|
|
||
| // This mirrors Go's `findPotentialParents`: we have a global | ||
| // signature budget, so we want to bucket candidates by likeliness | ||
| // to avoid wasting budget on (potentially adversarial) name collisions. | ||
| // | ||
| // Observe that we use a stable sort to preserve trusted candidates | ||
| // before untrusted candidates in each likeliness bucket. In other | ||
| // words, we always try a likely trusted candidate over an equally | ||
| // likely untrusted one. | ||
| // | ||
| // See: <https://github.com/golang/go/blob/d00c67f297e/src/crypto/x509/cert_pool.go#L136> | ||
| candidates.sort_by_key(|candidate| { | ||
| let have_kid: Option<&[u8]> = | ||
| candidate.certificate().extensions().ok().and_then(|exts| { | ||
| exts.get_extension(&SUBJECT_KEY_IDENTIFIER_OID) | ||
| .and_then(|ext| ext.value::<&[u8]>().ok()) | ||
| }); | ||
|
|
||
| match (want_kid, have_kid) { | ||
| // cert AKID matches candidate SKID, highest likelihood. | ||
| (Some(want), Some(have)) if want == have => 0, | ||
| // cert AKID and candidate SKID don't match, lowest likelihood. | ||
| (Some(_), Some(_)) => 2, | ||
| // cert AKID and/or candidate SKID is not present, medium likelihood. | ||
| _ => 1u8, | ||
| } | ||
| }); | ||
| candidates | ||
| } | ||
|
|
||
| fn build_chain_inner( | ||
|
|
@@ -385,7 +445,8 @@ impl<'a, 'chain, B: CryptoOps> ChainBuilder<'a, 'chain, B> { | |
| // Otherwise, we collect a list of potential issuers for this cert, | ||
| // and continue with the first that verifies. | ||
| let mut last_err: Option<ValidationError<'_, B>> = None; | ||
| for issuing_cert_candidate in self.potential_issuers(working_cert) { | ||
| for issuing_cert_candidate in self.potential_issuers(working_cert, working_cert_extensions) | ||
| { | ||
| // A candidate issuer is said to verify if it both | ||
| // signs for the working certificate and conforms to the | ||
| // policy. | ||
|
|
@@ -395,6 +456,7 @@ impl<'a, 'chain, B: CryptoOps> ChainBuilder<'a, 'chain, B> { | |
| working_cert, | ||
| current_depth, | ||
| &issuer_extensions, | ||
| budget, | ||
| ) { | ||
| Ok(_) => { | ||
| match self.build_chain_inner( | ||
|
|
@@ -503,10 +565,15 @@ impl<'a, 'chain, B: CryptoOps> ChainBuilder<'a, 'chain, B> { | |
| #[cfg(test)] | ||
| mod tests { | ||
| use asn1::ParseError; | ||
| use cryptography_x509::certificate::Certificate; | ||
| use cryptography_x509::oid::SUBJECT_ALTERNATIVE_NAME_OID; | ||
|
|
||
| use crate::certificate::tests::PublicKeyErrorOps; | ||
| use crate::{ValidationError, ValidationErrorKind}; | ||
| use crate::ops::{CryptoOps, VerificationCertificate}; | ||
| use crate::policy::{Policy, PolicyDefinition, Subject}; | ||
| use crate::trust_store::Store; | ||
| use crate::types::DNSName; | ||
| use crate::{Budget, ChainBuilder, NameChain, ValidationError, ValidationErrorKind}; | ||
|
|
||
| #[test] | ||
| fn test_validationerror_display() { | ||
|
|
@@ -528,4 +595,102 @@ mod tests { | |
| ValidationError::<PublicKeyErrorOps>::new(ValidationErrorKind::FatalError("oops")); | ||
| assert_eq!(err.to_string(), "fatal error: oops"); | ||
| } | ||
|
|
||
| /// A `CryptoOps` whose public key extraction and signature verification | ||
| /// always succeed, so that `valid_issuer` can be driven to completion | ||
| /// without real cryptographic material. | ||
| struct NullOps; | ||
|
|
||
| impl CryptoOps for NullOps { | ||
| type Key = (); | ||
| type Err = (); | ||
| type CertificateExtra = (); | ||
| type PolicyExtra = (); | ||
|
|
||
| fn public_key(&self, _cert: &Certificate<'_>) -> Result<Self::Key, Self::Err> { | ||
| Ok(()) | ||
| } | ||
|
|
||
| fn verify_signed_by( | ||
| &self, | ||
| _cert: &Certificate<'_>, | ||
| _key: &Self::Key, | ||
| ) -> Result<(), Self::Err> { | ||
| Ok(()) | ||
| } | ||
|
|
||
| fn clone_public_key(_key: &Self::Key) -> Self::Key {} | ||
|
|
||
| fn clone_extra(_extra: &Self::CertificateExtra) -> Self::CertificateExtra {} | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_clone() { | ||
| assert_eq!(NullOps::clone_public_key(&()), ()); | ||
| assert_eq!(NullOps::clone_extra(&()), ()); | ||
| } | ||
|
|
||
| // A self-issued ("looping") CA certificate that is its own issuer. | ||
| fn looping_ca_pem() -> pem::Pem { | ||
| pem::parse( | ||
| "-----BEGIN CERTIFICATE----- | ||
| MIIBcjCCARmgAwIBAgIBATAKBggqhkjOPQQDAjAhMR8wHQYDVQQDDBZsb29waW5n | ||
| IHNlbGYtc2lnbmVkIENBMB4XDTIzMTIzMTAwMDAwMFoXDTI0MDEzMTAwMDAwMFow | ||
| ITEfMB0GA1UEAwwWbG9vcGluZyBzZWxmLXNpZ25lZCBDQTBZMBMGByqGSM49AgEG | ||
| CCqGSM49AwEHA0IABKAoXUGnHdfXJbSXjRjeW+PCVHmlo4KEki69N5pJUA0QyQMR | ||
| v9ySOMnWf3Ea7TR4g3zdguwTP7LdpSku3uR1QkmjQjBAMA8GA1UdEwEB/wQFMAMB | ||
| Af8wDgYDVR0PAQH/BAQDAgGGMB0GA1UdDgQWBBR23MGdG1Ma9iR+3CxKTafD/OE0 | ||
| dTAKBggqhkjOPQQDAgNHADBEAiA4RCr07KfZdM16VfGNZAQFjvC60SWIU3RRVY/L | ||
| qolIOwIgCaIgj9ipK0Q0p+45UJiq+L/ncrxsweJkFq/UYubzhX0= | ||
| -----END CERTIFICATE-----", | ||
| ) | ||
| .unwrap() | ||
| } | ||
|
|
||
| /// Exercises our pathlen overflow error scenario. | ||
| /// | ||
| /// This condition is logically unreachable from Python, since | ||
| /// we unconditionally limit signature checks to a number smaller | ||
| /// than `u8::MAX`, meaning that we always exhaust the signature budget | ||
| /// before potentially exhausting the pathlen budget. | ||
| /// | ||
| /// To test that directly, we manually lift the signature budget | ||
| /// and start our pathlen state right at `u8::MAX`, guaranteeing | ||
| /// an overflow on the immediate chain building step. | ||
| #[test] | ||
| fn test_build_chain_inner_depth_overflow() { | ||
| let pem = looping_ca_pem(); | ||
| let ca = asn1::parse_single::<Certificate<'_>>(pem.contents()).unwrap(); | ||
| let ca_exts = ca.extensions().ok().unwrap(); | ||
|
|
||
| // The same self-issued CA is both the working certificate and its own | ||
| // (only) candidate issuer, so the search recurses on itself. | ||
| let working = VerificationCertificate::<NullOps>::new(&ca, ()); | ||
| let intermediates = [VerificationCertificate::<NullOps>::new(&ca, ())]; | ||
| let store: Store<'_, NullOps> = Store::new([]); | ||
|
|
||
| let subject = Subject::DNS(DNSName::new("example.com").unwrap()); | ||
| let time = asn1::DateTime::new(2024, 1, 1, 0, 0, 0).unwrap(); | ||
| let policy_def = | ||
| PolicyDefinition::server(NullOps, subject, time, Some(u8::MAX), None, None).unwrap(); | ||
| let policy = Policy::new(&policy_def, ()); | ||
|
|
||
| let builder = ChainBuilder::new(&intermediates, &policy, &store); | ||
| let mut budget = Budget { | ||
| name_constraint_checks: usize::MAX, | ||
| signature_checks: usize::MAX, | ||
| }; | ||
|
|
||
| let name_chain = NameChain::new::<NullOps>(None, &ca_exts, false) | ||
| .ok() | ||
| .unwrap(); | ||
| let err = builder | ||
| .build_chain_inner(&working, u8::MAX, &ca_exts, name_chain, &mut budget) | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This single line is the coverage-bearing one. |
||
| .unwrap_err(); | ||
|
|
||
| assert!(matches!( | ||
| err.kind, | ||
| ValidationErrorKind::Other(msg) if msg.contains("current depth calculation overflowed") | ||
| )); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need
NullOpsfor the coverage below, which means we need to "test" the empty trait impl bodies we add.(We already do this for another test-only impl,
PulicKeyErrorOps.)