From: Pauli <pauli@openssl.org>
Date: Thu, 29 Apr 2021 01:08:42 +0000 (+1000)
Subject: mac: update life-cycle description and diagrams to include finalXOF
X-Git-Tag: openssl-3.0.0-alpha16~21
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f14a2c9d7ac79afb36cacbf910a6363c7abc3135;p=thirdparty%2Fopenssl.git

mac: update life-cycle description and diagrams to include finalXOF

Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/15061)
---

diff --git a/doc/life-cycles/lifecycles.ods b/doc/life-cycles/lifecycles.ods
index b8f198a8e59..f80a76e622f 100644
Binary files a/doc/life-cycles/lifecycles.ods and b/doc/life-cycles/lifecycles.ods differ
diff --git a/doc/life-cycles/mac.dot b/doc/life-cycles/mac.dot
index c52701742ca..799d90e7d36 100644
--- a/doc/life-cycles/mac.dot
+++ b/doc/life-cycles/mac.dot
@@ -11,9 +11,11 @@ digraph mac {
     initialised -> updated [label="EVP_MAC_update"];
     updated -> updated [label="EVP_MAC_update"];
     updated -> finaled [label="EVP_MAC_final"];
+    updated -> finaled [label="EVP_MAC_finalXOF",
+                        fontcolor="#808080", color="#808080"];
     /* Once this works it should go back in:
-    updated -> finaled [label="EVP_MAC_final_XOF", style=dashed];
-    finaled -> finaled [label="EVP_MAC_final_XOF", style=dashed];
+    finaled -> finaled [label="EVP_MAC_final_XOF",
+                        fontcolor="#808080", color="#808080"];
     */
     finaled -> end [label="EVP_MAC_CTX_free"];
     updated -> initialised [label="EVP_MAC_init", style=dashed,
diff --git a/doc/man7/life_cycle-mac.pod b/doc/man7/life_cycle-mac.pod
index 0e7590740d6..17be432ab07 100644
--- a/doc/man7/life_cycle-mac.pod
+++ b/doc/man7/life_cycle-mac.pod
@@ -68,9 +68,9 @@ The usual life-cycle of a MAC is illustrated:
  EVP_MAC_init |  +-------------------+  |
               |  |      updated      | -+
               |  +-------------------+
-              |    |
-              |    | EVP_MAC_final
-              |    v
+              |    |               |
+              |    | EVP_MAC_final | EVP_MAC_finalXOF
+              |    v               v
               |  +-------------------+
               +- |      finaled      |
                  +-------------------+
@@ -98,6 +98,7 @@ This is the canonical list.
  EVP_MAC_init                         initialised initialised initialised initialised
  EVP_MAC_update                                     updated     updated
  EVP_MAC_final                                                  finaled
+ EVP_MAC_finalXOF                                               finaled
  EVP_MAC_CTX_free                freed   freed       freed       freed       freed
  EVP_MAC_CTX_get_params                  newed    initialised   updated
  EVP_MAC_CTX_set_params                  newed    initialised   updated
@@ -146,6 +147,13 @@ This is the canonical list.
     <td style="border:1px solid" align="center">finaled</td>
     <td style="border:1px solid" align="center"></td>
     <td style="border:1px solid" align="center"></td></tr>
+<tr><th style="border:1px solid" align="left">EVP_MAC_finalXOF</th>
+    <td style="border:1px solid" align="center"></td>
+    <td style="border:1px solid" align="center"></td>
+    <td style="border:1px solid" align="center"></td>
+    <td style="border:1px solid" align="center">finaled</td>
+    <td style="border:1px solid" align="center"></td>
+    <td style="border:1px solid" align="center"></td></tr>
 <tr><th style="border:1px solid" align="left">EVP_MAC_CTX_free</th>
     <td style="border:1px solid" align="center">freed</td>
     <td style="border:1px solid" align="center">freed</td>
diff --git a/doc/man7/mac.png b/doc/man7/mac.png
index 1c486e1ba40..620f50a6f32 100644
Binary files a/doc/man7/mac.png and b/doc/man7/mac.png differ