From d16b830d2dcfc5c194851d1344448850da7f8ef7 Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Fri, 26 Feb 2021 10:08:02 +0100 Subject: [PATCH] Improved comments. --- src/certificate_chain.h | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/certificate_chain.h b/src/certificate_chain.h index 56523a68..934e1fc5 100644 --- a/src/certificate_chain.h +++ b/src/certificate_chain.h @@ -67,6 +67,9 @@ namespace dcp { /** @class CertificateChain * @brief A chain of any number of certificates, from root to leaf. + * + * A CertificateChain object can also (optionally) hold the private key corresponding + * to the leaf certificate. */ class CertificateChain { @@ -90,7 +93,10 @@ public: std::string leaf_common_name = "CS.smpte-430-2.LEAF.NOT_FOR_PRODUCTION" ); - explicit CertificateChain (std::string); + /** Read a CertificateChain from a string. + * @param s A string containing one or more PEM-encoded certificates. + */ + explicit CertificateChain (std::string s); /** Add a certificate to the chain. * @param c Certificate to add. @@ -172,7 +178,7 @@ private: /** Our certificates, not in any particular order */ List _certificates; - /** Leaf certificate's private key, if known */ + /** Leaf certificate's private key, if known, in PEM format */ boost::optional _key; }; -- 2.30.2