address pr feedback

- add more explicit comments
sfackler · Feb 11, 2024 · 15b8a88 · 15b8a88
1 parent 9430774
commit 15b8a88
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/openssl/src/ssl/mod.rs b/openssl/src/ssl/mod.rs
@@ -3485,7 +3485,8 @@ impl SslRef {
         }
     }
 
-    /// this returns the hash, e.g. SHA1, SHA512
+    /// Returns the hash of the signature. For example, if the connection used an
+    /// RSA_PSS+SHA256 signature this will return the nid for SHA256.
     #[corresponds(SSL_get_signature_nid)]
     #[cfg(ossl111)]
     pub fn signature_nid(&self) -> Result<Nid, ErrorStack> {
@@ -3498,7 +3499,8 @@ impl SslRef {
         }
     }
 
-    /// this returns the hash, e.g. SHA1, SHA512
+    /// Returns the hash of the signature. For example, if the connection used an
+    /// RSA_PSS+SHA256 signature this will return the nid for SHA256.
     #[corresponds(SSL_get_peer_signature_nid)]
     #[cfg(ossl102)]
     pub fn peer_signature_nid(&self) -> Result<Nid, ErrorStack> {
@@ -3511,7 +3513,8 @@ impl SslRef {
         }
     }
 
-    /// this returns the signature algorithm e.g. RSA/RSA_PSS
+    /// Returns the signature algorithm. For example, if the connection used an
+    /// RSA_PSS+SHA256 signature this will return the nid for RSA_PSS.    
     #[corresponds(SSL_get_signature_type_nid)]
     #[cfg(ossl111)]
     pub fn signature_type_nid(&self) -> Result<Nid, ErrorStack> {
@@ -3525,7 +3528,8 @@ impl SslRef {
         }
     }
 
-    /// this returns the signature algorithm e.g. RSA/RSA_PSS
+    /// Returns the signature algorithm. For example, if the connection used an
+    /// RSA_PSS+SHA256 signature this will return the nid for RSA_PSS.
     #[corresponds(SSL_get_peer_signature_type_nid)]
     #[cfg(ossl111)]
     pub fn peer_signature_type_nid(&self) -> Result<Nid, ErrorStack> {