From c7cab680b80ef9220832151ed2c8c23a5d590b8b Mon Sep 17 00:00:00 2001
From: Hans Nilsson <hans@erlang.org>
Date: Thu, 31 Jan 2019 10:27:23 +0100
Subject: crypto: New experimental api

The new files api_ng.h and api_ng.c implements an api using EVP.
The api is not by any mean new, except for the crypto application
in Erlang/OTP.

The aims at using the block api in a stream manor, that is
  1) call crypto_init/4
  2..N) call crypto_update/{2,3}

The purpose is to simplify and hopefully optimize the SSL and SSH
applications.

By keeping the crypto state in C in an enif_resource the costful state
copying in SSL and SSH is reduced with 1-2 per message sent or received.

Changes in other files are for adaptation like FIPS etc since many
functions uses the central get_cipher_type() function.
---
 lib/crypto/doc/src/crypto.xml | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

(limited to 'lib/crypto/doc')

diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml
index e0794a080e..83e10c4c78 100644
--- a/lib/crypto/doc/src/crypto.xml
+++ b/lib/crypto/doc/src/crypto.xml
@@ -193,10 +193,12 @@
     <datatype_title>Ciphers</datatype_title>
     <datatype>
       <name name="stream_cipher"/>
+      <name name="stream_cipher_iv"/>
+      <name name="stream_cipher_no_iv"/>
       <desc>
 	<p>Stream ciphers for
-	<seealso marker="#stream_encrypt-2">stream_encrypt/2</seealso> and
-	<seealso marker="#stream_decrypt-2">stream_decrypt/2</seealso> .
+	<seealso marker="#stream_init-3">stream_init/3</seealso> and
+	<seealso marker="#stream_init-2">stream_init/2</seealso> .
 	</p>
       </desc>
     </datatype>
@@ -213,6 +215,18 @@
       </desc>
     </datatype>
 
+    <datatype>
+      <name name="alias_cfb"/>
+      <name name="alias_cbc"/>
+      <desc>
+	<p>Names that are replaced by more common names. They may deprecated in futer releases.</p>
+	<p><c>des3_cbc</c> and <c>des_ede3</c> should be replaced by <c>des_ede3_cbc</c></p>
+	<p><c>des_ede3_cbf</c>, <c>des3_cbf</c> and <c>des3_cfb</c> should be replaced by <c>des_ede3_cfb</c>.</p>
+	<p><c>aes_cbc128</c> should be replaced by <c>aes_128_cbc</c>.</p>
+	<p><c>aes_cbc256</c> should be replaced by <c>aes_256_cbc</c>.</p>
+      </desc>
+    </datatype>
+
     <datatype>
       <name name="block_cipher_without_iv"/>
       <name name="ecb_cipher"/>
-- 
cgit v1.2.3