diff options
| author | Carl Hetherington <cth@carlh.net> | 2021-02-26 10:08:02 +0100 |
|---|---|---|
| committer | Carl Hetherington <cth@carlh.net> | 2021-02-26 10:08:02 +0100 |
| commit | d16b830d2dcfc5c194851d1344448850da7f8ef7 (patch) | |
| tree | 7dc8c5d09e430a8a16cd76cdde105acdc6135351 | |
| parent | 8344c1c9786f8e06be6f256b3129ccc910b28b05 (diff) | |
Improved comments.
| -rw-r--r-- | src/certificate_chain.h | 10 |
1 files 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<std::string> _key; }; |
