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

Update documentation

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

18
xed25519.h
View File

@ -150,6 +150,8 @@ public:
/// 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.
/// \sa <A HREF="https://tools.ietf.org/rfc/rfc5958.txt">RFC 5958, Asymmetric
/// Key Packages</A>
void Save(BufferedTransformation &bt) const { void Save(BufferedTransformation &bt) const {
DEREncode(bt, 0); DEREncode(bt, 0);
} }
@ -165,14 +167,18 @@ public:
/// \details v1 means INTEGER 0 is written. INTEGER 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 other /// the best interop, and keys will work with OpenSSL. The other
/// option is using INTEGER 1. INTEGER 1 means RFC 5958 format, /// option uses INTEGER 1. INTEGER 1 means RFC 5958 format,
/// which is the new format. /// which is the new format.
/// \sa <A HREF="https://tools.ietf.org/rfc/rfc5958.txt">RFC 5958, Asymmetric
/// Key Packages</A>
void Save(BufferedTransformation &bt, bool v1) const { void Save(BufferedTransformation &bt, bool v1) const {
DEREncode(bt, v1 ? 0 : 1); DEREncode(bt, v1 ? 0 : 1);
} }
/// \brief BER decode ASN.1 object /// \brief BER decode ASN.1 object
/// \param bt BufferedTransformation object /// \param bt BufferedTransformation object
/// \sa <A HREF="https://tools.ietf.org/rfc/rfc5958.txt">RFC 5958, Asymmetric
/// Key Packages</A>
void Load(BufferedTransformation &bt) { void Load(BufferedTransformation &bt) {
BERDecode(bt); BERDecode(bt);
} }
@ -332,6 +338,8 @@ struct ed25519PrivateKey : public PKCS8PrivateKey
/// 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.
/// \sa <A HREF="https://tools.ietf.org/rfc/rfc5958.txt">RFC 5958, Asymmetric
/// Key Packages</A>
void Save(BufferedTransformation &bt) const { void Save(BufferedTransformation &bt) const {
DEREncode(bt, 0); DEREncode(bt, 0);
} }
@ -347,14 +355,18 @@ struct ed25519PrivateKey : public PKCS8PrivateKey
/// \details v1 means INTEGER 0 is written. INTEGER 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 other /// the best interop, and keys will work with OpenSSL. The other
/// option is using INTEGER 1. INTEGER 1 means RFC 5958 format, /// option uses INTEGER 1. INTEGER 1 means RFC 5958 format,
/// which is the new format. /// which is the new format.
/// \sa <A HREF="https://tools.ietf.org/rfc/rfc5958.txt">RFC 5958, Asymmetric
/// Key Packages</A>
void Save(BufferedTransformation &bt, bool v1) const { void Save(BufferedTransformation &bt, bool v1) const {
DEREncode(bt, v1 ? 0 : 1); DEREncode(bt, v1 ? 0 : 1);
} }
/// \brief BER decode ASN.1 object /// \brief BER decode ASN.1 object
/// \param bt BufferedTransformation object /// \param bt BufferedTransformation object
/// \sa <A HREF="https://tools.ietf.org/rfc/rfc5958.txt">RFC 5958, Asymmetric
/// Key Packages</A>
void Load(BufferedTransformation &bt) { void Load(BufferedTransformation &bt) {
BERDecode(bt); BERDecode(bt);
} }
@ -556,6 +568,8 @@ struct ed25519PublicKey : public X509PublicKey
/// \brief BER decode ASN.1 object /// \brief BER decode ASN.1 object
/// \param bt BufferedTransformation object /// \param bt BufferedTransformation object
/// \sa <A HREF="https://tools.ietf.org/rfc/rfc5958.txt">RFC 5958, Asymmetric
/// Key Packages</A>
void Load(BufferedTransformation &bt) { void Load(BufferedTransformation &bt) {
BERDecode(bt); BERDecode(bt);
} }