From 1c2c91945b2cb9bdbb03e689bca3c5cf2293e012 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Thu, 8 Sep 2016 14:30:01 -0400 Subject: [PATCH] Updated documentation --- cryptlib.h | 4 ++-- fhmqv.h | 2 ++ hmqv.h | 2 ++ mqv.h | 2 ++ 4 files changed, 8 insertions(+), 2 deletions(-) diff --git a/cryptlib.h b/cryptlib.h index 98bf5fe5..e934718c 100644 --- a/cryptlib.h +++ b/cryptlib.h @@ -17,7 +17,7 @@ Square, TEA, \ref ThreeWay "3-Way", Twofish, XTEA
Stream Ciphers
ChaCha8, ChaCha12, ChaCha20, \ref Panama "Panama-LE", \ref Panama "Panama-BE", Salsa20, \ref SEAL "SEAL-LE", \ref SEAL "SEAL-BE", WAKE, XSalsa20
Hash Functions
- BLAKE2s, BLAKE2b, SHA1, SHA224, SHA256, SHA384, SHA512, \ref SHA3 "SHA-3", Tiger, Whirlpool, RIPEMD160, RIPEMD320, RIPEMD128, RIPEMD256, Weak::MD2, Weak::MD4, Weak::MD5 + BLAKE2s, BLAKE2b, \ref Keccak "Keccak (F1600)", SHA1, SHA224, SHA256, SHA384, SHA512, \ref SHA3 "SHA-3", Tiger, Whirlpool, RIPEMD160, RIPEMD320, RIPEMD128, RIPEMD256, Weak::MD2, Weak::MD4, Weak::MD5
Non-Cryptographic Checksums
CRC32, Adler32
Message Authentication Codes
@@ -32,7 +32,7 @@ Square, TEA, \ref ThreeWay "3-Way", Twofish, XTEA
Public Key Signature Schemes
DSA2, GDSA, ECDSA, NR, ECNR, LUCSS, RSASS, RSASS_ISO, RabinSS, RWSS, ESIGN
Key Agreement
- DH, DH2, MQV, ECDH, ECMQV, XTR_DH + DH, DH2, \ref MQV_Domain "MQV", \ref HMQV_Domain "HMQV", \ref FHMQV_Domain "FHMQV", ECDH, ECMQV, ECHMQV, ECFHMQV, XTR_DH
Algebraic Structures
Integer, PolynomialMod2, PolynomialOver, RingOfPolynomialsOver, ModularArithmetic, MontgomeryRepresentation, GFP2_ONB, GF2NP, GF256, GF2_32, EC2N, ECP diff --git a/fhmqv.h b/fhmqv.h index 980f6c2f..6a527b70 100644 --- a/fhmqv.h +++ b/fhmqv.h @@ -17,6 +17,7 @@ NAMESPACE_BEGIN(CryptoPP) //! \details This implementation follows Augustin P. Sarr and Philippe Elbaz–Vincent, and Jean–Claude Bajard's //! A Secure and Efficient Authenticated Diffie-Hellman Protocol. //! Note: this is FHMQV, Protocol 5, from page 11; and not FHMQV-C. +//! \sa MQV, HMQV, FHMQV, and AuthenticatedKeyAgreementDomain template class FHMQV_Domain : public AuthenticatedKeyAgreementDomain { @@ -292,6 +293,7 @@ private: //! \details This implementation follows Augustin P. Sarr and Philippe Elbaz–Vincent, and Jean–Claude Bajard's //! A Secure and Efficient Authenticated Diffie-Hellman Protocol. //! Note: this is FHMQV, Protocol 5, from page 11; and not FHMQV-C. +//! \sa FHMQV, MQV_Domain, HMQV_Domain, AuthenticatedKeyAgreementDomain typedef FHMQV_Domain FHMQV; NAMESPACE_END diff --git a/hmqv.h b/hmqv.h index 87866e1b..697ae343 100644 --- a/hmqv.h +++ b/hmqv.h @@ -16,6 +16,7 @@ NAMESPACE_BEGIN(CryptoPP) //! \brief Hashed Menezes-Qu-Vanstone in GF(p) //! \details This implementation follows Hugo Krawczyk's HMQV: A High-Performance //! Secure Diffie-Hellman Protocol. Note: this implements HMQV only. HMQV-C with Key Confirmation is not provided. +//! \sa MQV, HMQV, FHMQV, and AuthenticatedKeyAgreementDomain template class HMQV_Domain: public AuthenticatedKeyAgreementDomain { @@ -300,6 +301,7 @@ private: //! \brief Hashed Menezes-Qu-Vanstone in GF(p) //! \details This implementation follows Hugo Krawczyk's HMQV: A High-Performance //! Secure Diffie-Hellman Protocol. Note: this implements HMQV only. HMQV-C with Key Confirmation is not provided. +//! \sa HMQV, MQV_Domain, FHMQV_Domain, AuthenticatedKeyAgreementDomain typedef HMQV_Domain HMQV; NAMESPACE_END diff --git a/mqv.h b/mqv.h index 673b1e68..cad30117 100644 --- a/mqv.h +++ b/mqv.h @@ -22,6 +22,7 @@ NAMESPACE_BEGIN(CryptoPP) //! \details GROUP_PARAMETERS paramters include the curve coefcients and the base point. //! Binary curves use a polynomial to represent its characteristic, while prime curves //! use a prime number. +//! \sa MQV, HMQV, FHMQV, and AuthenticatedKeyAgreementDomain template class MQV_Domain : public AuthenticatedKeyAgreementDomain { @@ -212,6 +213,7 @@ private: }; //! Menezes-Qu-Vanstone in GF(p) with key validation, AKA MQV +//! \sa MQV, HMQV_Domain, FHMQV_Domain, AuthenticatedKeyAgreementDomain typedef MQV_Domain MQV; NAMESPACE_END