From 2fe678653b7dd9f61dbbcd5e7d862360882bd7e8 Mon Sep 17 00:00:00 2001
From: Matthias Schiffer <mschiffer@universe-factory.net>
Date: Thu, 29 May 2014 05:00:11 +0200
Subject: Document *everything*

---
 src/crypto/cipher/salsa2012/nacl/salsa2012_nacl.c | 14 +++++++++++++-
 src/crypto/cipher/salsa2012/salsa2012.c           |  7 +++++++
 src/crypto/cipher/salsa2012/xmm/salsa2012_xmm.c   | 22 ++++++++++++++++++----
 3 files changed, 38 insertions(+), 5 deletions(-)

(limited to 'src/crypto/cipher/salsa2012')

diff --git a/src/crypto/cipher/salsa2012/nacl/salsa2012_nacl.c b/src/crypto/cipher/salsa2012/nacl/salsa2012_nacl.c
index efe7089..18ec502 100644
--- a/src/crypto/cipher/salsa2012/nacl/salsa2012_nacl.c
+++ b/src/crypto/cipher/salsa2012/nacl/salsa2012_nacl.c
@@ -23,17 +23,25 @@
   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
+/**
+   \file
+
+   The Salsa20/12 implementation from NaCl
+*/
+
 
 #include "../../../../crypto.h"
 
 #include <crypto_stream_salsa2012.h>
 
 
+/** The cipher state */
 struct fastd_cipher_state {
-	uint8_t key[crypto_stream_salsa2012_KEYBYTES];
+	uint8_t key[crypto_stream_salsa2012_KEYBYTES];	/**< The encryption key */
 };
 
 
+/** Initializes the cipher state */
 static fastd_cipher_state_t* salsa2012_init(const uint8_t *key) {
 	fastd_cipher_state_t *state = malloc(sizeof(fastd_cipher_state_t));
 	memcpy(state->key, key, crypto_stream_salsa2012_KEYBYTES);
@@ -41,11 +49,13 @@ static fastd_cipher_state_t* salsa2012_init(const uint8_t *key) {
 	return state;
 }
 
+/** XORs data with the Salsa20/12 cipher stream */
 static bool salsa2012_crypt(const fastd_cipher_state_t *state, fastd_block128_t *out, const fastd_block128_t *in, size_t len, const uint8_t *iv) {
 	crypto_stream_salsa2012_xor(out->b, in->b, len, iv, state->key);
 	return true;
 }
 
+/** Frees the cipher state */
 static void salsa2012_free(fastd_cipher_state_t *state) {
 	if (state) {
 		secure_memzero(state, sizeof(*state));
@@ -53,6 +63,8 @@ static void salsa2012_free(fastd_cipher_state_t *state) {
 	}
 }
 
+
+/** The nacl salsa2012 implementation */
 const fastd_cipher_t fastd_cipher_salsa2012_nacl = {
 	.init = salsa2012_init,
 	.crypt = salsa2012_crypt,
diff --git a/src/crypto/cipher/salsa2012/salsa2012.c b/src/crypto/cipher/salsa2012/salsa2012.c
index 8dcfc33..d10c4fb 100644
--- a/src/crypto/cipher/salsa2012/salsa2012.c
+++ b/src/crypto/cipher/salsa2012/salsa2012.c
@@ -23,10 +23,17 @@
   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
+/**
+   \file
+
+   The Salsa20/12 stream cipher, a reduced-round version of Salsa20
+*/
+
 
 #include "../../../crypto.h"
 
 
+/** Cipher info about Salsa20/12 */
 const fastd_cipher_info_t fastd_cipher_info_salsa2012 = {
 	.key_length = 32,
 	.iv_length = 8,
diff --git a/src/crypto/cipher/salsa2012/xmm/salsa2012_xmm.c b/src/crypto/cipher/salsa2012/xmm/salsa2012_xmm.c
index 5e5862f..7e6fe80 100644
--- a/src/crypto/cipher/salsa2012/xmm/salsa2012_xmm.c
+++ b/src/crypto/cipher/salsa2012/xmm/salsa2012_xmm.c
@@ -23,15 +23,21 @@
   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
-/*
-  The assembly implementations were written by D. J. Bernstein and are
-  Public Domain. For more information see http://cr.yp.to/snuffle.html
+/**
+   \file
+
+   The XMM Salsa20/12 implementation for SSE2-capable x86 systems
+
+   The assembly implementations were written by D. J. Bernstein and are
+   Public Domain. For more information see http://cr.yp.to/snuffle.html
 */
 
+
 #include "../../../../crypto.h"
 #include "../../../../cpuid.h"
 
 
+/** The length of the key used by Salsa20/12 */
 #define KEYBYTES 32
 
 
@@ -44,18 +50,22 @@
 #endif
 
 
+/** The actual Salsa20/12 assembly implementation */
 int crypto_stream_salsa2012_xor(unsigned char *c, const unsigned char *m, unsigned long long mlen, const unsigned char *n, const unsigned char *k);
 
 
+/** The cipher state */
 struct fastd_cipher_state {
-	uint8_t key[KEYBYTES];
+	uint8_t key[KEYBYTES];		/**< The encryption key */
 };
 
 
+/** Checks if the runtime platform supports SSE2 */
 static bool salsa2012_available(void) {
 	return fastd_cpuid() & CPUID_SSE2;
 }
 
+/** Initializes the cipher state */
 static fastd_cipher_state_t* salsa2012_init(const uint8_t *key) {
 	fastd_cipher_state_t *state = malloc(sizeof(fastd_cipher_state_t));
 	memcpy(state->key, key, KEYBYTES);
@@ -63,11 +73,13 @@ static fastd_cipher_state_t* salsa2012_init(const uint8_t *key) {
 	return state;
 }
 
+/** XORs data with the Salsa20/12 cipher stream */
 static bool salsa2012_crypt(const fastd_cipher_state_t *state, fastd_block128_t *out, const fastd_block128_t *in, size_t len, const uint8_t *iv) {
 	crypto_stream_salsa2012_xor(out->b, in->b, len, iv, state->key);
 	return true;
 }
 
+/** Frees the cipher state */
 static void salsa2012_free(fastd_cipher_state_t *state) {
 	if (state) {
 		secure_memzero(state, sizeof(*state));
@@ -75,6 +87,8 @@ static void salsa2012_free(fastd_cipher_state_t *state) {
 	}
 }
 
+
+/** The xmm salsa2012 implementation */
 const fastd_cipher_t fastd_cipher_salsa2012_xmm = {
 	.available = salsa2012_available,
 
-- 
cgit v1.2.3