[tor-commits] [tor/master] Improve documentation on get_{peer, own}_certificate()

[nickm at torproject.org]

commit ec84fc1d8ecb56fde887eb01d3bca1a031bd1e89
Author: Nick Mathewson <nickm at torproject.org>
Date:   Mon Jun 5 09:42:02 2017 -0400

    Improve documentation on get_{peer,own}_certificate()
    
    Make it clear that we're returning a newly allocated copy.
---
 src/common/tortls.c | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/src/common/tortls.c b/src/common/tortls.c
index 1661b7e..d61cc2e 100644
--- a/src/common/tortls.c
+++ b/src/common/tortls.c
@@ -2018,7 +2018,8 @@ tor_tls_peer_has_cert(tor_tls_t *tls)
   return 1;
 }
 
-/** Return the peer certificate, or NULL if there isn't one. */
+/** Return a newly allocated copy of the peer certificate, or NULL if there
+ * isn't one. */
 MOCK_IMPL(tor_x509_cert_t *,
 tor_tls_get_peer_cert,(tor_tls_t *tls))
 {
@@ -2030,8 +2031,8 @@ tor_tls_get_peer_cert,(tor_tls_t *tls))
   return tor_x509_cert_new(cert);
 }
 
-/** Return the cerficate we used on the connection, or NULL if somehow
- * we didn't use one. */
+/** Return a newly allocated copy of the cerficate we used on the connection,
+ * or NULL if somehow we didn't use one. */
 MOCK_IMPL(tor_x509_cert_t *,
 tor_tls_get_own_cert,(tor_tls_t *tls))
 {