Merge branch 'master' of https://github.com/opentrv/OTAESGCM.git

opentrv · Oct 19, 2017 · 863dca4 · 863dca4
2 parents f7d7a0c + 740e0ca
commit 863dca4
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/content/OTAESGCM/utility/OTAESGCM_OTAESGCM.h b/content/OTAESGCM/utility/OTAESGCM_OTAESGCM.h
@@ -29,7 +29,16 @@ Author(s) / Copyright (s): Deniz Erbilgin 2015--2017
 #include "OTAESGCM_OTAES128.h"
 #include "OTAESGCM_OTAES128Impls.h"
 
+// IF DEFINED: Allow encryption/decryption functions to take unpadded input.
+// These are disabled by default as original implementation was incorrect,
+// increased flash size and is unnecessary for the OT secure frame.
 #undef OTAESGCM_ALLOW_UNPADDED
+// IF DEFINED: Enable non-workspace versions of AES128GCM.
+// These are disabled by default as:
+// - They make large (> 200 byte on AVR) stack allocations and are not
+//   recommended.
+// - When included they prevent -Werror and -Wstack-usage being used together
+//   for static analysis of stack allocations.
 #undef OTAESGCM_ALLOW_NON_WORKSPACE
 
 // Use namespaces to help avoid collisions.

diff --git a/portableUnitTests/main.cpp b/portableUnitTests/main.cpp
@@ -24,6 +24,13 @@ Author(s) / Copyright (s): Damon Hart-Davis 2016
 #include <gtest/gtest.h>
 #include <OTAESGCM.h>
 
+
+// IF DEFINED: Enable non-workspace versions of AES128GCM.
+// These are disabled by default as:
+// - They make large (> 200 byte on AVR) stack allocations and are not
+//   recommended.
+// - When included they prevent -Werror and -Wstack-usage being used together
+//   for static analysis of stack allocations.
 #undef OTAESGCM_ALLOW_NON_WORKSPACE
 
 // Sanity test.