Update comments and documentation

pull/765/head
Jeffrey Walton 2018-12-14 04:35:07 -05:00
parent 6f2188af79
commit 00f777661d
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
2 changed files with 17 additions and 5 deletions

View File

@ -1,6 +1,7 @@
// xed25519_32.cpp - written and placed in public domain by Jeffrey Walton
// Crypto++ specific implementation wrapped around Adam
// Langley's curve25519-donna.
// xed25519.cpp - written and placed in public domain by Jeffrey Walton
// Crypto++ specific implementation wrapped around Andrew
// Moon's public domain curve25519-donna. Also see
// https://github.com/floodyberry/curve25519-donna.
#include "pch.h"

View File

@ -1,12 +1,21 @@
// xed25519.h - written and placed in public domain by Jeffrey Walton
// Crypto++ specific implementation wrapped around Adam
// Langley's curve25519-donna.
// Crypto++ specific implementation wrapped around Andrew
// Moon's public domain curve25519-donna. Also see
// https://github.com/floodyberry/curve25519-donna.
// Typically the key agreement classes encapsulate their data more
// than x25519 does below. We made them a little more accessible
// due to crypto_box operations. Once the library cuts-in the
// crypto_box operations the x25519 class will be more restricted.
/// \file xed25519.h
/// \brief Classes for x25519 and ed25519 operations
/// \details This implementation integrates Andrew Moon's public domain
/// curve25519-donna.
/// \sa Andrew Moon's GitHub <A
/// HREF="https://github.com/floodyberry/curve25519-donna">curve25519-donna</A>
/// \since Crypto++ 8.0
#ifndef CRYPTOPP_XED25519_H
#define CRYPTOPP_XED25519_H
@ -33,6 +42,8 @@ public:
/// \param x private key
static void ClampKey(byte x[32]);
virtual ~x25519() {}
/// \brief Create a x25519 object
/// \param y public key
/// \param x private key