Merge pull request #713

5b568b0 minor tweaks, add readme for crypto_ops_builder (Riccardo Spagni)
0a4dd68 minor tweaks, add readme for crypto_ops_builder (Riccardo Spagni)

src/crypto/crypto_ops_builder/README.md

@@ -0,0 +1,21 @@
+# Monero
+
+Copyright (c) 2014-2016, The Monero Project
+
+## Crypto Ops Builder
+
+In order to ensure the safest implementation of the cryptography in use by Monero we have opted to use the SUPERCOP ref10 implementations wherever possible. The main reason is that SUPERCOP ref10 is old, well tested, and primarily the work of Daniel J. Bernstein and Tanja Lange (among others, see ```designers``` in the ref10 folder). This is particularly relevant, as the team that designed Curve25519 and EdDSA, both of which are at Monero's core, is the same team that created the SUPERCOP implementation.
+
+SUPERCOP ref10 is a fairly secure implementation that focuses on things like constant-time algorithms, to reduce side-channel attacks, sometimes at the cost of performance. However, we consider this a fair trade-off, especially considering that Monero is not that performance sensitive at this stage. In future we may consider faster implementations that still have a measure of safety against side-channel attacks.
+
+## Additional Cryptography
+
+Unfortunately SUPERCOP ref10 does not contain every function Monero's ```crypto-ops``` class needs. Thus there are several new files in the ```ref10CommentedCombined``` folder which allow for the class to be built during compilation. The original ref10 is included in the source tree in order to allow for a comparison to be made between the two, and also to allow for a quick comparison to be made between our in-source copy of SUPERCOP ref10 and an independently downloaded copy.
+
+## Usage
+
+The operation to produce the ```crypto-ops.c``` is automatic and part of the build process. If, however, you want to manually run the build process to verify the output, you can use ```MakeCryptoOps.py```.
+
+## Attribution
+
+The majority of the work we are using is from SUPERCOP, and copyrights and attribution fall to those developers and cryptographers. Beyond that we also include some of the original CryptoNote reference code. The entire build process, and all of the work analysing the functions and figuring out what comes from where, has been done by the Monero Research Lab. Shen Noether, in particular, deserves the bulk of the attribution for that.

src/crypto/crypto_ops_builder/ref10CommentedCombined/description

@@ -1,7 +1,7 @@
 shen_ed25519_ref10
-MakeCryptoOps.py makes crypto-ops.c in the monero source from the ref10 implementation
+MakeCryptoOps.py makes crypto-ops.c in the Monero source from the ref10 implementation
 
 EdDSA signatures using Curve25519
 from http://hyperelliptic.org/ebats/supercop-20141124.tar.bz2
 
-commented / combined by shen noether, monero research labs
+Commented / combined by Shen Noether, Monero Research Lab

src/crypto/crypto_ops_builder/ref10CommentedCombined/designers

@@ -5,5 +5,5 @@ Tanja Lange
 Peter Schwabe
 Bo-Yin Yang
 
-MakeCryptoOps.py
-Shen Noether monero research labs
+MakeCryptoOps.py:
+Shen Noether, Monero Research Labs