arne
/
cryptopp
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update documentation

pull/873/head
Jeffrey Walton 2019-08-03 22:33:46 -04:00
parent c3e0d123b2
commit 4e6dd922f7
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
3 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
fhmqv.h
View File

@ -201,7 +201,7 @@ public:
memcpy(publicKey, privateKey+StaticPrivateKeyLength(), EphemeralPublicKeyLength());
}
/// \brief Derive shared secre from your private keys and couterparty's public keys
/// \brief Derive shared secret from your private keys and couterparty's public keys
/// \param agreedValue the shared secret
/// \param staticPrivateKey your long term private key
/// \param ephemeralPrivateKey your ephemeral private key
@ -216,11 +216,11 @@ public:
/// static public key is validated. If you have previously validated the
/// couterparty's static public key, then use
/// <tt>validateStaticOtherPublicKey=false</tt> to save time.
/// \pre size of agreedValue == AgreedValueLength()
/// \pre length of staticPrivateKey == StaticPrivateKeyLength()
/// \pre length of ephemeralPrivateKey == EphemeralPrivateKeyLength()
/// \pre length of staticOtherPublicKey == StaticPublicKeyLength()
/// \pre length of ephemeralOtherPublicKey == EphemeralPublicKeyLength()
/// \pre <tt>COUNTOF(agreedValue) == AgreedValueLength()
/// \pre <tt>COUNTOF(staticPrivateKey) == StaticPrivateKeyLength()</tt>
/// \pre <tt>COUNTOF(ephemeralPrivateKey) == EphemeralPrivateKeyLength()</tt>
/// \pre <tt>COUNTOF(staticOtherPublicKey) == StaticPublicKeyLength()</tt>
/// \pre <tt>COUNTOF(ephemeralOtherPublicKey) == EphemeralPublicKeyLength()</tt>
bool Agree(byte *agreedValue,
const byte *staticPrivateKey, const byte *ephemeralPrivateKey,
const byte *staticOtherPublicKey, const byte *ephemeralOtherPublicKey,

12
hmqv.h
View File

@ -200,7 +200,7 @@ public:
memcpy(publicKey, privateKey+StaticPrivateKeyLength(), EphemeralPublicKeyLength());
}
/// \brief Derive shared secre from your private keys and couterparty's public keys
/// \brief Derive shared secret from your private keys and couterparty's public keys
/// \param agreedValue the shared secret
/// \param staticPrivateKey your long term private key
/// \param ephemeralPrivateKey your ephemeral private key
@ -215,11 +215,11 @@ public:
/// static public key is validated. If you have previously validated the
/// couterparty's static public key, then use
/// <tt>validateStaticOtherPublicKey=false</tt> to save time.
/// \pre size of agreedValue == AgreedValueLength()
/// \pre length of staticPrivateKey == StaticPrivateKeyLength()
/// \pre length of ephemeralPrivateKey == EphemeralPrivateKeyLength()
/// \pre length of staticOtherPublicKey == StaticPublicKeyLength()
/// \pre length of ephemeralOtherPublicKey == EphemeralPublicKeyLength()
/// \pre <tt>COUNTOF(agreedValue) == AgreedValueLength()
/// \pre <tt>COUNTOF(staticPrivateKey) == StaticPrivateKeyLength()</tt>
/// \pre <tt>COUNTOF(ephemeralPrivateKey) == EphemeralPrivateKeyLength()</tt>
/// \pre <tt>COUNTOF(staticOtherPublicKey) == StaticPublicKeyLength()</tt>
/// \pre <tt>COUNTOF(ephemeralOtherPublicKey) == EphemeralPublicKeyLength()</tt>
bool Agree(byte *agreedValue,
const byte *staticPrivateKey, const byte *ephemeralPrivateKey,
const byte *staticOtherPublicKey, const byte *ephemeralOtherPublicKey,

12
mqv.h
View File

@ -161,7 +161,7 @@ public:
memcpy(publicKey, privateKey+StaticPrivateKeyLength(), EphemeralPublicKeyLength());
}
/// \brief Derive shared secre from your private keys and couterparty's public keys
/// \brief Derive shared secret from your private keys and couterparty's public keys
/// \param agreedValue the shared secret
/// \param staticPrivateKey your long term private key
/// \param ephemeralPrivateKey your ephemeral private key
@ -176,11 +176,11 @@ public:
/// static public key is validated. If you have previously validated the
/// couterparty's static public key, then use
/// <tt>validateStaticOtherPublicKey=false</tt> to save time.
/// \pre size of agreedValue == AgreedValueLength()
/// \pre length of staticPrivateKey == StaticPrivateKeyLength()
/// \pre length of ephemeralPrivateKey == EphemeralPrivateKeyLength()
/// \pre length of staticOtherPublicKey == StaticPublicKeyLength()
/// \pre length of ephemeralOtherPublicKey == EphemeralPublicKeyLength()
/// \pre <tt>COUNTOF(agreedValue) == AgreedValueLength()
/// \pre <tt>COUNTOF(staticPrivateKey) == StaticPrivateKeyLength()</tt>
/// \pre <tt>COUNTOF(ephemeralPrivateKey) == EphemeralPrivateKeyLength()</tt>
/// \pre <tt>COUNTOF(staticOtherPublicKey) == StaticPublicKeyLength()</tt>
/// \pre <tt>COUNTOF(ephemeralOtherPublicKey) == EphemeralPublicKeyLength()</tt>
bool Agree(byte *agreedValue,
const byte *staticPrivateKey, const byte *ephemeralPrivateKey,
const byte *staticOtherPublicKey, const byte *ephemeralOtherPublicKey,