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

Update documentation

pull/795/head
Jeffrey Walton 2019-01-24 02:09:03 -05:00
parent 0f70d0262b
commit b47f04418c
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
1 changed files with 10 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
xed25519.h
View File

@ -125,7 +125,7 @@ public:
/// \param y public key /// \param y public key
bool IsSmallOrder(const byte y[PUBLIC_KEYLENGTH]) const; bool IsSmallOrder(const byte y[PUBLIC_KEYLENGTH]) const;
/// \Brief Get the Object Identifier /// \brief Get the Object Identifier
/// \returns the Object Identifier /// \returns the Object Identifier
/// \details The default OID is from RFC 8410 using <tt>id-X25519</tt>. /// \details The default OID is from RFC 8410 using <tt>id-X25519</tt>.
/// The default private key format is RFC 5208. /// The default private key format is RFC 5208.
@ -133,7 +133,7 @@ public:
return m_oid.Empty() ? ASN1::X25519() : m_oid; return m_oid.Empty() ? ASN1::X25519() : m_oid;
} }
/// \Brief Set the Object Identifier /// \brief Set the Object Identifier
/// \param oid the new Object Identifier /// \param oid the new Object Identifier
void SetAlgorithmID(const OID& oid) { void SetAlgorithmID(const OID& oid) {
m_oid = oid; m_oid = oid;
@ -337,12 +337,10 @@ protected:
/// class members of interest are byte arrays and not Integers. /// class members of interest are byte arrays and not Integers.
/// In addition, the byte arrays are little-endian meaning /// In addition, the byte arrays are little-endian meaning
/// LSB is at element 0 and the MSB is at element 31. /// LSB is at element 0 and the MSB is at element 31.
/// If you call \ref ed25519PrivateKey::GetPrivateExponent() /// If you call GetPrivateExponent() then the little-endian byte
/// "GetPrivateExponent()" then the little-endian byte array is /// array is converted to a big-endian Integer() so it can be
/// converted to a big-endian Integer() so it can be returned /// returned the way a caller expects. And calling
/// the way a caller expects. And calling /// SetPrivateExponent perfoms a similar internal conversion.
/// \ref ed25519PrivateKey::SetPrivateExponent "SetPrivateExponent()"
/// perfoms a similar internal conversion.
/// \since Crypto++ 8.0 /// \since Crypto++ 8.0
struct ed25519PrivateKey : public PKCS8PrivateKey struct ed25519PrivateKey : public PKCS8PrivateKey
{ {
@ -598,12 +596,10 @@ protected:
/// class members of interest are byte arrays and not Integers. /// class members of interest are byte arrays and not Integers.
/// In addition, the byte arrays are little-endian meaning /// In addition, the byte arrays are little-endian meaning
/// LSB is at element 0 and the MSB is at element 31. /// LSB is at element 0 and the MSB is at element 31.
/// If you call \ref ed25519PublicKey::GetPublicElement() /// If you call GetPublicElement() then the little-endian byte
/// "GetPublicElement()" then the little-endian byte array is /// array is converted to a big-endian Integer() so it can be
/// converted to a big-endian Integer() so it can be returned /// returned the way a caller expects. And calling
/// the way a caller expects. And calling /// SetPublicElement() perfoms a similar internal conversion.
/// \ref ed25519PublicKey::SetPublicElement "SetPublicElement()"
/// perfoms a similar internal conversion.
/// \since Crypto++ 8.0 /// \since Crypto++ 8.0
struct ed25519PublicKey : public X509PublicKey struct ed25519PublicKey : public X509PublicKey
{ {