Fixed documentation (new include file for AEAD).

[BearSSL] / inc / bearssl.h

diff --git a/inc/bearssl.h b/inc/bearssl.h
index 6258e92..de62963 100644 (file)
--- a/inc/bearssl.h
+++ b/inc/bearssl.h
@@ -42,6 +42,7 @@
  * | bearssl_rand.h  | Pseudorandom byte generators                      |
  * | bearssl_prf.h   | PRF implementations (for SSL/TLS)                 |
  * | bearssl_block.h | Symmetric encryption                              |
+ * | bearssl_aead.h  | AEAD algorithms (combined encryption + MAC)       |
  * | bearssl_rsa.h   | RSA encryption and signatures                     |
  * | bearssl_ec.h    | Elliptic curves support (including ECDSA)         |
  * | bearssl_ssl.h   | SSL/TLS engine interface                          |
@@ -72,7 +73,17 @@
  * does not include much failsafes or error reporting when the problem
  * does not arise from external transient conditions, and can be fixed
  * only in the application code. This is done so in order to make the
- * total code footprint ligther.
+ * total code footprint lighter.
+ *
+ *
+ * ## `NULL` values
+ *
+ * Function parameters with a pointer type shall not be `NULL` unless
+ * explicitly authorised by the documentation. As an exception, when
+ * the pointer aims at a sequence of bytes and is accompanied with
+ * a length parameter, and the length is zero (meaning that there is
+ * no byte at all to retrieve), then the pointer may be `NULL` even if
+ * not explicitly allowed.
  *
  *
  * ## Memory Allocation
@@ -117,6 +128,7 @@
 #include "bearssl_rand.h"
 #include "bearssl_prf.h"
 #include "bearssl_block.h"
+#include "bearssl_aead.h"
 #include "bearssl_rsa.h"
 #include "bearssl_ec.h"
 #include "bearssl_ssl.h"