changeset 2294:58df9b14b8ec

Development guide: documented ngx_explicit_memzero().
author Roman Arutyunyan <arut@nginx.com>
date Tue, 27 Nov 2018 16:49:07 +0300
parents 3b1b6a5ce915
children a1d0238ffb61
files xml/en/docs/dev/development_guide.xml
diffstat 1 files changed, 8 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/dev/development_guide.xml
+++ b/xml/en/docs/dev/development_guide.xml
@@ -9,7 +9,7 @@
 <article name="Development guide"
          link="/en/docs/dev/development_guide.html"
          lang="en"
-         rev="4">
+         rev="5">
 
 <section name="Introduction" id="introduction">
 
@@ -350,6 +350,13 @@ Other string functions are nginx-specifi
 </listitem>
 
 <listitem>
+<literal>ngx_explicit_memzero()</literal> — Does the same as
+<literal>ngx_memzero()</literal>, but this call is never removed by the
+compiler's dead store elimination optimization.
+This function can be used to clear sensitive data such as passwords and keys.
+</listitem>
+
+<listitem>
 <literal>ngx_cpymem()</literal> — Does the same as
 <literal>ngx_memcpy()</literal>, but returns the final destination address
 This one is handy for appending multiple strings in a row.