diff options
author | Jeffrey Walton <noloader@gmail.com> | 2019-09-26 11:57:08 -0400 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2019-09-26 11:57:08 -0400 |
commit | 4e7d0c36df75a6f3eae009c48fce4639b3156eb1 (patch) | |
tree | 339e97ea42dd7d2a891800b0bac646cb71c5d9ff /dsa.h | |
parent | 0c82df181c98912a01b00bed298b567724feafba (diff) | |
download | cryptopp-git-4e7d0c36df75a6f3eae009c48fce4639b3156eb1.tar.gz |
Update documentation
Diffstat (limited to 'dsa.h')
-rw-r--r-- | dsa.h | 16 |
1 files changed, 11 insertions, 5 deletions
@@ -13,11 +13,14 @@ NAMESPACE_BEGIN(CryptoPP) /// \brief DSA Signature Format
/// \details The DSA signature format used by Crypto++ is as defined by IEEE P1363.
-/// Java and .Net use the DER format, and OpenPGP uses the OpenPGP format.
+/// OpenSSL, Java and .Net use the DER format, and OpenPGP uses the OpenPGP format.
+/// \sa <A HREF="http://www.cryptopp.com/wiki/DSAConvertSignatureFormat">DSAConvertSignatureFormat</A>
+/// on the Crypto++ wiki.
+/// \since Crypto++ 1.0
enum DSASignatureFormat {
/// \brief Crypto++ native signature encoding format
DSA_P1363,
- /// \brief signature encoding format used by Java and .Net
+ /// \brief signature encoding format used by OpenSSL, Java and .Net
DSA_DER,
/// \brief OpenPGP signature encoding format
DSA_OPENPGP
@@ -31,12 +34,15 @@ enum DSASignatureFormat { /// \param signatureLen the length of the existing signature encoding buffer
/// \param fromFormat the source signature format
/// \details This function converts between these formats, and returns length
-/// of signature in the target format. If <tt>toFormat == DSA_P1363</tt>, then
-/// <tt>bufferSize</tt> must equal <tt>publicKey.SignatureLength()</tt>
+/// of signature in the target format. If <tt>toFormat == DSA_P1363</tt>, then
+/// <tt>bufferSize</tt> must equal <tt>publicKey.SignatureLength()</tt>
+/// \sa <A HREF="http://www.cryptopp.com/wiki/DSAConvertSignatureFormat">DSAConvertSignatureFormat</A>
+/// on the Crypto++ wiki.
/// \since Crypto++ 1.0
size_t DSAConvertSignatureFormat(byte *buffer, size_t bufferSize, DSASignatureFormat toFormat,
const byte *signature, size_t signatureLen, DSASignatureFormat fromFormat);
NAMESPACE_END
-#endif
+#endif // CRYPTOPP_DSA_H
+
|