Adds ChangeLog and Migration guide entry
Commit adds relevant entry to the
ChangeLog and to the
Migration guide.
Signed-off-by: Thomas Daubney <thomas.daubney@arm.com>
diff --git a/ChangeLog.d/remove-rsa-mode-parameter.txt b/ChangeLog.d/remove-rsa-mode-parameter.txt
new file mode 100644
index 0000000..7ee3adb
--- /dev/null
+++ b/ChangeLog.d/remove-rsa-mode-parameter.txt
@@ -0,0 +1,6 @@
+API changes
+ * Remove mode parameter from RSA functions. All encryption,
+ decryption, sign and verify functions are affected. Also
+ removes the RNG parameters from the RSA verify functions.
+ Existing user code which utilises these RSA functions must
+ remove the mode parameter.
diff --git a/docs/3.0-migration-guide.d/remove-rsa-mode-parameter.md b/docs/3.0-migration-guide.d/remove-rsa-mode-parameter.md
new file mode 100644
index 0000000..61100d3
--- /dev/null
+++ b/docs/3.0-migration-guide.d/remove-rsa-mode-parameter.md
@@ -0,0 +1,20 @@
+Remove the mode parameter from RSA functions
+--------------------------------------------
+
+This affects all users who use the RSA encryption, decryption, sign and
+verify APIs.
+
+If you were using the mode parameter to specify the wrong mode then
+this behaviour is no longer supported. You must delete the mode
+parameter from your RSA function calls.
+
+
+Remove the RNG parameter from RSA functions
+--------------------------------------------
+
+This affects all users who use the RSA verify functions.
+
+If you were using the RNG parameters then you must remove
+them from your function calls. Since usiong the wrong mode
+is no longer supported, the RNG parameters namely f_rng
+and p_rng are no longer needed.