From 94856ec765986b9b04a9a84cae0cccd552c2c06d Mon Sep 17 00:00:00 2001
From: Tony Arcieri <bascule@gmail.com>
Date: Wed, 3 May 2023 17:13:52 -0600
Subject: [PATCH] pkcs1v15: note `RSASSA-PKCS1-v1_5` in docs (#324)

This is the name for PKCS#1v1.5 signatures originally specified in
RFC3447 but is also used by RFC8017 (which we cite)
---
 src/pkcs1v15.rs               | 2 +-
 src/pkcs1v15/signature.rs     | 2 +-
 src/pkcs1v15/signing_key.rs   | 2 +-
 src/pkcs1v15/verifying_key.rs | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/pkcs1v15.rs b/src/pkcs1v15.rs
index 1beca6a..4600aeb 100644
--- a/src/pkcs1v15.rs
+++ b/src/pkcs1v15.rs
@@ -56,7 +56,7 @@ impl PaddingScheme for Pkcs1v15Encrypt {
     }
 }
 
-/// Digital signatures using PKCS#1 v1.5 padding.
+/// `RSASSA-PKCS1-v1_5`: digital signatures using PKCS#1 v1.5 padding.
 #[derive(Clone, Debug, Eq, PartialEq)]
 pub struct Pkcs1v15Sign {
     /// Length of hash to use.
diff --git a/src/pkcs1v15/signature.rs b/src/pkcs1v15/signature.rs
index 2dd169a..ea57b34 100644
--- a/src/pkcs1v15/signature.rs
+++ b/src/pkcs1v15/signature.rs
@@ -8,7 +8,7 @@ use alloc::{boxed::Box, string::ToString};
 use core::fmt::{Debug, Display, Formatter, LowerHex, UpperHex};
 use num_bigint::BigUint;
 
-/// PKCS#1 v1.5 signatures as described in [RFC8017 § 8.2].
+/// `RSASSA-PKCS1-v1_5` signatures as described in [RFC8017 § 8.2].
 ///
 /// [RFC8017 § 8.2]: https://datatracker.ietf.org/doc/html/rfc8017#section-8.2
 #[derive(Clone, PartialEq, Eq)]
diff --git a/src/pkcs1v15/signing_key.rs b/src/pkcs1v15/signing_key.rs
index fc38958..66bc2b9 100644
--- a/src/pkcs1v15/signing_key.rs
+++ b/src/pkcs1v15/signing_key.rs
@@ -16,7 +16,7 @@ use signature::{
 };
 use zeroize::ZeroizeOnDrop;
 
-/// Signing key for PKCS#1 v1.5 signatures as described in [RFC8017 § 8.2].
+/// Signing key for `RSASSA-PKCS1-v1_5` signatures as described in [RFC8017 § 8.2].
 ///
 /// [RFC8017 § 8.2]: https://datatracker.ietf.org/doc/html/rfc8017#section-8.2
 #[derive(Debug, Clone)]
diff --git a/src/pkcs1v15/verifying_key.rs b/src/pkcs1v15/verifying_key.rs
index 789a153..d787dfb 100644
--- a/src/pkcs1v15/verifying_key.rs
+++ b/src/pkcs1v15/verifying_key.rs
@@ -12,7 +12,7 @@ use pkcs8::{
 };
 use signature::{hazmat::PrehashVerifier, DigestVerifier, Verifier};
 
-/// Verifying key for PKCS#1 v1.5 signatures as described in [RFC8017 § 8.2].
+/// Verifying key for `RSASSA-PKCS1-v1_5` signatures as described in [RFC8017 § 8.2].
 ///
 /// [RFC8017 § 8.2]: https://datatracker.ietf.org/doc/html/rfc8017#section-8.2
 #[derive(Debug)]