From 03f94058c410162091ce9168609908abd2caaba3 Mon Sep 17 00:00:00 2001
From: Hans Nilsson <hans@erlang.org>
Date: Wed, 20 Mar 2019 13:57:35 +0100
Subject: crypto: Update types of hash algorithms

---
 lib/crypto/doc/src/crypto.xml | 21 ++++++++++++++-------
 lib/crypto/src/crypto.erl     | 16 ++++++++--------
 2 files changed, 22 insertions(+), 15 deletions(-)

(limited to 'lib')

diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml
index aecb1890d0..ee95cc3074 100644
--- a/lib/crypto/doc/src/crypto.xml
+++ b/lib/crypto/doc/src/crypto.xml
@@ -257,20 +257,16 @@
       </desc>
     </datatype>
 
-    <datatype_title>Digests</datatype_title>
+    <datatype_title>Digests and hash</datatype_title>
     <datatype>
-      <name name="sha1"/>
-      <name name="sha2"/>
-      <name name="sha3"/>
-      <name name="blake2"/>
+      <name name="hash_algorithm"/>
       <desc>
       </desc>
     </datatype>
 
     <datatype>
-      <name name="compatibility_only_hash"/>
+      <name name="hmac_hash_algorithm"/>
       <desc>
-	<p>The <c>compatibility_only_hash()</c> algorithms are recommended only for compatibility with existing applications.</p>
       </desc>
     </datatype>
 
@@ -292,6 +288,17 @@
       </desc>
     </datatype>
 
+    <datatype>
+      <name name="sha1"/>
+      <name name="sha2"/>
+      <name name="sha3"/>
+      <name name="blake2"/>
+      <name name="compatibility_only_hash"/>
+      <desc>
+	<p>The <c>compatibility_only_hash()</c> algorithms are recommended only for compatibility with existing applications.</p>
+      </desc>
+    </datatype>
+
     <datatype_title>Elliptic Curves</datatype_title>
     <datatype>
       <name name="ec_named_curve"/>
diff --git a/lib/crypto/src/crypto.erl b/lib/crypto/src/crypto.erl
index 0ee3c92cce..ade4c17089 100644
--- a/lib/crypto/src/crypto.erl
+++ b/lib/crypto/src/crypto.erl
@@ -422,10 +422,10 @@ enable_fips_mode(_) -> ?nif_stub.
 %%%
 %%%================================================================
 
--define(HASH_HASH_ALGORITHM, sha1() | sha2() | sha3() | blake2() | ripemd160 | compatibility_only_hash() ).
+-type hash_algorithm() :: sha1() | sha2() | sha3() | blake2() | ripemd160 | compatibility_only_hash() .
 
 -spec hash_info(Type) -> Result | run_time_error()
-                             when Type :: ?HASH_HASH_ALGORITHM,
+                             when Type :: hash_algorithm(),
                                   Result :: #{size := integer(),
                                               block_size := integer(),
                                               type := integer()
@@ -433,7 +433,7 @@ enable_fips_mode(_) -> ?nif_stub.
 hash_info(Type) ->
     notsup_to_error(hash_info_nif(Type)).
 
--spec hash(Type, Data) -> Digest when Type :: ?HASH_HASH_ALGORITHM,
+-spec hash(Type, Data) -> Digest when Type :: hash_algorithm(),
                                       Data :: iodata(),
                                       Digest :: binary().
 hash(Type, Data) ->
@@ -443,7 +443,7 @@ hash(Type, Data) ->
 
 -opaque hash_state() :: reference().
 
--spec hash_init(Type) -> State when Type :: ?HASH_HASH_ALGORITHM,
+-spec hash_init(Type) -> State when Type :: hash_algorithm(),
                                     State :: hash_state().
 hash_init(Type) -> 
     notsup_to_error(hash_init_nif(Type)).
@@ -469,12 +469,12 @@ hash_final(Context) ->
 
 %%%---- HMAC
 
--define(HMAC_HASH_ALGORITHM,  sha1() | sha2() | sha3() | compatibility_only_hash()).
+-type hmac_hash_algorithm() ::  sha1() | sha2() | sha3() | compatibility_only_hash().
 
 %%%---- hmac/3,4 
 
 -spec hmac(Type, Key, Data) -> 
-                  Mac when Type :: ?HMAC_HASH_ALGORITHM,
+                  Mac when Type :: hmac_hash_algorithm(),
                            Key :: iodata(),
                            Data :: iodata(),
                            Mac :: binary() .
@@ -483,7 +483,7 @@ hmac(Type, Key, Data) ->
     hmac(Type, Key, Data1, undefined, erlang:byte_size(Data1), max_bytes()).
 
 -spec hmac(Type, Key, Data, MacLength) -> 
-                  Mac when Type :: ?HMAC_HASH_ALGORITHM,
+                  Mac when Type :: hmac_hash_algorithm(),
                            Key :: iodata(),
                            Data :: iodata(),
                            MacLength :: integer(),
@@ -498,7 +498,7 @@ hmac(Type, Key, Data, MacLength) ->
 -opaque hmac_state() :: binary().
 
 -spec hmac_init(Type, Key) ->
-                       State when Type :: ?HMAC_HASH_ALGORITHM,
+                       State when Type :: hmac_hash_algorithm(),
                                   Key :: iodata(),
                                   State :: hmac_state() .
 hmac_init(Type, Key) ->
-- 
cgit v1.2.3