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

Update documentation

pull/769/head
Jeffrey Walton 2018-12-25 11:08:14 -05:00
parent 567eef2d4d
commit c55e58c205
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
1 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
xed25519.h
View File

@ -121,7 +121,7 @@ public:
/// \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 id-X25519. /// \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.
OID GetAlgorithmID() const { OID GetAlgorithmID() const {
return m_oid.Empty() ? ASN1::X25519() : m_oid; return m_oid.Empty() ? ASN1::X25519() : m_oid;
@ -146,7 +146,7 @@ public:
/// \details Save() will write the OID associated with algorithm or scheme. /// \details Save() will write the OID associated with algorithm or scheme.
/// In the case of public and private keys, this function writes the /// In the case of public and private keys, this function writes the
/// subjectPubicKeyInfo parts. /// subjectPubicKeyInfo parts.
/// \details The default OID is from RFC 8410 using id-X25519. /// \details The default OID is from RFC 8410 using <tt>id-X25519</tt>.
/// The default private key format is RFC 5208, which is the old format. /// The default private key format is RFC 5208, which is the old format.
/// The old format provides the best interop, and keys will work /// The old format provides the best interop, and keys will work
/// with OpenSSL. /// with OpenSSL.
@ -156,19 +156,19 @@ public:
/// \brief DER encode ASN.1 object /// \brief DER encode ASN.1 object
/// \param bt BufferedTransformation object /// \param bt BufferedTransformation object
/// \param v0 flag indicating v0 /// \param v1 flag indicating v1
/// \details Save() will write the OID associated with algorithm or scheme. /// \details Save() will write the OID associated with algorithm or scheme.
/// In the case of public and private keys, this function writes the /// In the case of public and private keys, this function writes the
/// subjectPubicKeyInfo parts. /// subjectPubicKeyInfo parts.
/// \details The default OID is from RFC 8410 using id-X25519. /// \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.
/// \details v0 means version 0 INTEGER is written. Version 0 means /// \details v1 means INTEGER 0 is written. INTEGER 0 means
/// RFC 5208 format, which is the old format. The old format provides /// RFC 5208 format, which is the old format. The old format provides
/// the best interop, and keys will work with OpenSSL. The the other /// the best interop, and keys will work with OpenSSL. The other
/// option is using version 1 INTEGER. Version 1 means RFC 5958 format, /// option is using INTEGER 1. INTEGER 1 means RFC 5958 format,
/// which is the new format. /// which is the new format.
void Save(BufferedTransformation &bt, bool v0) const { void Save(BufferedTransformation &bt, bool v1) const {
DEREncode(bt, v0 ? 0 : 1); DEREncode(bt, v1 ? 0 : 1);
} }
/// \brief BER decode ASN.1 object /// \brief BER decode ASN.1 object
@ -189,11 +189,11 @@ public:
/// \details DEREncode() will write the OID associated with algorithm or /// \details DEREncode() will write the OID associated with algorithm or
/// scheme. In the case of public and private keys, this function writes /// scheme. In the case of public and private keys, this function writes
/// the subjectPubicKeyInfo parts. /// the subjectPubicKeyInfo parts.
/// \details The default OID is from RFC 8410 using id-X25519. /// \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.
/// \details The value of version is written as the INTEGER. Version 0 means /// \details The value of version is written as the INTEGER. INTEGER 0 means
/// RFC 5208 format, which is the old format. The old format provides /// RFC 5208 format, which is the old format. The old format provides
/// the best interop, and keys will work with OpenSSL. The value 1 INTEGER /// the best interop, and keys will work with OpenSSL. The INTEGER 1
/// means RFC 5958 format, which is the new format. /// means RFC 5958 format, which is the new format.
void DEREncode(BufferedTransformation &bt, int version) const; void DEREncode(BufferedTransformation &bt, int version) const;
@ -328,7 +328,7 @@ struct ed25519PrivateKey : public PKCS8PrivateKey
/// \details Save() will write the OID associated with algorithm or scheme. /// \details Save() will write the OID associated with algorithm or scheme.
/// In the case of public and private keys, this function writes the /// In the case of public and private keys, this function writes the
/// subjectPubicKeyInfo parts. /// subjectPubicKeyInfo parts.
/// \details The default OID is from RFC 8410 using id-Ed25519. /// \details The default OID is from RFC 8410 using <tt>id-Ed25519</tt>.
/// The default private key format is RFC 5208, which is the old format. /// The default private key format is RFC 5208, which is the old format.
/// The old format provides the best interop, and keys will work /// The old format provides the best interop, and keys will work
/// with OpenSSL. /// with OpenSSL.
@ -338,19 +338,19 @@ struct ed25519PrivateKey : public PKCS8PrivateKey
/// \brief DER encode ASN.1 object /// \brief DER encode ASN.1 object
/// \param bt BufferedTransformation object /// \param bt BufferedTransformation object
/// \param v0 flag indicating v0 /// \param v1 flag indicating v1
/// \details Save() will write the OID associated with algorithm or scheme. /// \details Save() will write the OID associated with algorithm or scheme.
/// In the case of public and private keys, this function writes the /// In the case of public and private keys, this function writes the
/// subjectPubicKeyInfo parts. /// subjectPubicKeyInfo parts.
/// \details The default OID is from RFC 8410 using id-Ed25519. /// \details The default OID is from RFC 8410 using <tt>id-Ed25519</tt>.
/// The default private key format is RFC 5208. /// The default private key format is RFC 5208.
/// \details v0 means version 0 INTEGER is written. Version 0 means /// \details v1 means INTEGER 0 is written. INTEGER 0 means
/// RFC 5208 format, which is the old format. The old format provides /// RFC 5208 format, which is the old format. The old format provides
/// the best interop, and keys will work with OpenSSL. The the other /// the best interop, and keys will work with OpenSSL. The other
/// option is using version 1 INTEGER. Version 1 means RFC 5958 format, /// option is using INTEGER 1. INTEGER 1 means RFC 5958 format,
/// which is the new format. /// which is the new format.
void Save(BufferedTransformation &bt, bool v0) const { void Save(BufferedTransformation &bt, bool v1) const {
DEREncode(bt, v0 ? 0 : 1); DEREncode(bt, v1 ? 0 : 1);
} }
/// \brief BER decode ASN.1 object /// \brief BER decode ASN.1 object
@ -375,11 +375,11 @@ struct ed25519PrivateKey : public PKCS8PrivateKey
/// \details DEREncode() will write the OID associated with algorithm or /// \details DEREncode() will write the OID associated with algorithm or
/// scheme. In the case of public and private keys, this function writes /// scheme. In the case of public and private keys, this function writes
/// the subjectPubicKeyInfo parts. /// the subjectPubicKeyInfo parts.
/// \details The default OID is from RFC 8410 using id-X25519. /// \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.
/// \details The value of version is written as the INTEGER. Version 0 means /// \details The value of version is written as the INTEGER. INTEGER 0 means
/// RFC 5208 format, which is the old format. The old format provides /// RFC 5208 format, which is the old format. The old format provides
/// the best interop, and keys will work with OpenSSL. The value 1 INTEGER /// the best interop, and keys will work with OpenSSL. The INTEGER 1
/// means RFC 5958 format, which is the new format. /// means RFC 5958 format, which is the new format.
void DEREncode(BufferedTransformation &bt, int version) const; void DEREncode(BufferedTransformation &bt, int version) const;
@ -546,7 +546,7 @@ struct ed25519PublicKey : public X509PublicKey
/// \details Save() will write the OID associated with algorithm or scheme. /// \details Save() will write the OID associated with algorithm or scheme.
/// In the case of public and private keys, this function writes the /// In the case of public and private keys, this function writes the
/// subjectPubicKeyInfo parts. /// subjectPubicKeyInfo parts.
/// \details The default OID is from RFC 8410 using id-X25519. /// \details The default OID is from RFC 8410 using <tt>id-X25519</tt>.
/// The default private key format is RFC 5208, which is the old format. /// The default private key format is RFC 5208, which is the old format.
/// The old format provides the best interop, and keys will work /// The old format provides the best interop, and keys will work
/// with OpenSSL. /// with OpenSSL.