Releasing version 2.53.1

oracle · Dec 21, 2021 · 716219c · 716219c
1 parent 84b33fb
commit 716219c
Show file tree

Hide file tree

Showing 13 changed files with 548 additions and 13 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -3,6 +3,14 @@ Change Log
 All notable changes to this project will be documented in this file.
 
 The format is based on `Keep a Changelog <http://keepachangelog.com/>`_.
+====================
+2.53.1 - 2021-12-21
+====================
+
+Fixed
+-----
+* Fixes the potential data corruption issue as described in https://github.com/oracle/oci-python-sdk/issues/410. Customers using FIPS compliant openssl versions are advised to enable FIPS with the ways described in https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/fips-libraries.html.
+
 ====================
 2.53.0 - 2021-12-14
 ====================

diff --git a/docs/fips-libraries.rst b/docs/fips-libraries.rst
@@ -28,9 +28,10 @@ Setting the Environment Variables
 
 If you do not want to run ``enable_fips_mode()`` for every session, you can set an environment variable so that the SDK uses the library every time.
 
-Set the following environment variable to the path to the libcrypto library:
+Set the one of the following environment variables to the path to the libcrypto library, listed according to priority:
 
 - FIPS_LIBCRYPTO_PATH
+- OCI_PYTHON_SDK_FIPS_LIBCRYPTO_PATH
 
 Verifying the Configuration
 ---------------------------

diff --git a/docs/index.rst b/docs/index.rst
@@ -6,6 +6,10 @@
             window.location.href = 'https://oracle-bare-metal-cloud-services-python-sdk.readthedocs.io/en/latest/deprecation-notice.html';
         }
     </script>
+
+.. warning::
+    Potential data corruption with Python SDK on UploadManager.upload_stream() in FIPS mode and Cloud Shell (versions 2.53.0 and below), for more information please see :ref:`Known Issues<known-issues>` section.
+
 .. warning::
     Potential data corruption with Python SDK on binary upload in versions 2.8.0 and below, for more information please see :ref:`Known Issues<known-issues>` section.
 

diff --git a/docs/known-issues.rst b/docs/known-issues.rst
@@ -4,6 +4,14 @@ Known Issues
 ~~~~~~~~~~~~~~~~~~~~~~
 These are the current known issues for the Python SDK.
 
+Potential data corruption with Python SDK on UploadManager.upload_stream() in FIPS mode and Cloud Shell (versions 2.53.0 and below)
+===================================================================================================================================
+**Details:** When using the Python SDK to perform stream upload operations you may encounter an issue with data corruption if you are using UploadManager.upload_stream. This issue is known to affect the customers using FIPS mode and Cloud Shell.
+
+**Impacted Versions:** v2.53.0 and below
+
+**Direct link to this issue:** `Potential data corruption issue for multipart stream upload for OCI Python SDK <https://github.com/oracle/oci-python-sdk/issues/410>`_
+
 Performance regression in oci v2.38.4 and above
 ===============================================
 In OCI Python SDK version 2.38.4 and later versions, you may encounter performance regressions when using the SDK with some OCI services. The regression surfaces itself as a 3-second increase in latency in SDK operations made to some OCI services. This issue has been confirmed to impact the OCI Streaming service, and likely impacts the following services:

diff --git a/docs/upload-manager.rst b/docs/upload-manager.rst
@@ -16,5 +16,8 @@ The Object Storage service supports multipart uploads to make large object uploa
 
 The `UploadObject <https://github.com/oracle/oci-python-sdk/blob/master/examples/multipart_object_upload.py>`_ example shows how :py:class:`~oci.object_storage.UploadManager` can be used to upload files to object storage.
 
+.. warning::
+    Potential data corruption with Python SDK on UploadManager.upload_stream() in FIPS mode and Cloud Shell (versions 2.53.0 and below), for more information please see :ref:`Known Issues<known-issues>` section.
+
 .. warning::
     Potential data corruption with Python SDK on binary upload in versions 2.8.0 and below, for more information please see :ref:`Known Issues<known-issues>` section.