Skip to content

Commit 7ffbabe

Browse files
committed
end_entity: fix dns_names rustdoc comment
Prior to this commit the rustdoc comment on `EndEntityCert.dns_names` mentioned using `verify_is_valid_for_dns_name` and `verify_is_valid_for_at_least_one_dns_name`, but these functions don't exist anymore. This commit updates the comment to point to `EndEntityCert::verify_is_valid_for_subject_name`, and does so with a proper Rustdoc link so that future updates will be caught by `cargo doc` if we forget to fix this reference to match.
1 parent 22cebce commit 7ffbabe

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/end_entity.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,8 +151,8 @@ impl<'a> EndEntityCert<'a> {
151151
/// Returns a list of the DNS names provided in the subject alternative names extension
152152
///
153153
/// This function must not be used to implement custom DNS name verification.
154-
/// Verification functions are already provided as `verify_is_valid_for_dns_name`
155-
/// and `verify_is_valid_for_at_least_one_dns_name`.
154+
/// Checking that a certificate is valid for a given subject name should always be done with
155+
/// [EndEntityCert::verify_is_valid_for_subject_name].
156156
#[cfg(feature = "alloc")]
157157
pub fn dns_names(&'a self) -> Result<impl Iterator<Item = &'a str>, Error> {
158158
subject_name::list_cert_dns_names(self)

0 commit comments

Comments
 (0)