From 384087351ef213b72495ec1fda1900ec369566c0 Mon Sep 17 00:00:00 2001 From: Sharad Chandran R Date: Mon, 15 Jul 2024 13:13:11 +0530 Subject: [PATCH] Documentation updates for 6.6 features --- doc/src/api_manual/oracledb.rst | 20 ++++++++++++++++ doc/src/release_notes.rst | 14 +++++------ doc/src/user_guide/connection_handling.rst | 28 +++++++++++++++++++--- 3 files changed, 52 insertions(+), 10 deletions(-) diff --git a/doc/src/api_manual/oracledb.rst b/doc/src/api_manual/oracledb.rst index db0cb2e6d..0c5cfd484 100644 --- a/doc/src/api_manual/oracledb.rst +++ b/doc/src/api_manual/oracledb.rst @@ -2128,6 +2128,16 @@ Oracledb Methods For node-oracledb Thick mode, use an :ref:`Easy Connect string ` or a :ref:`Connect Descriptor string ` instead. .. versionadded:: 6.0 + * - ``walletContent`` + - String + - Thin + - .. _createpoolpoolattrswalletcontent: + + The security credentials required to establish a mutual TLS (mTLS) connection to Oracle Database. This property can be used to directly specify the security credentials instead of storing and reading the credentials from the ``ewallet.pem`` file specified in the ``walletLocation`` property. + + The value of the ``walletContent`` property overrides the ``walletLocation`` value and the ``WALLET_LOCATION`` parameter in the connection string. + + .. versionadded:: 6.6 * - ``edition`` - String - Thick @@ -2836,6 +2846,16 @@ Oracledb Methods For node-oracledb Thick mode, use an :ref:`Easy Connect string ` or a :ref:`Connect Descriptor string ` instead. .. versionadded:: 6.0 + * - ``walletContent`` + - String + - Thin + - .. _getconnectiondbattrswalletcontent: + + The security credentials required to establish a mutual TLS (mTLS) connection to Oracle Database. This property can be used to directly specify the security credentials instead of storing and reading the credentials from the ``ewallet.pem`` file specified in the ``walletLocation`` property. + + The value of the ``walletContent`` property overrides the ``walletLocation`` value and the ``WALLET_LOCATION`` parameter in the connection string. + + .. versionadded:: 6.6 * - ``edition`` - String - Thick diff --git a/doc/src/release_notes.rst b/doc/src/release_notes.rst index 93d71b478..7febe8ea0 100644 --- a/doc/src/release_notes.rst +++ b/doc/src/release_notes.rst @@ -18,9 +18,9 @@ Common Changes configuration information from the supported provider and uses it to connect to the database. -#) Added support for ``oracledb.DB_TYPE_BFILE`` data type. +#) Added support for ``oracledb.DB_TYPE_BFILE`` data type. -#) Test and documentation updates. +#) Test and documentation updates. Thin Mode Changes +++++++++++++++++ @@ -30,7 +30,7 @@ Thin Mode Changes wallet content directly instead of storing and reading it up from a file. See `Issue #1671 `__. - + #) Added support to use ``IFILE`` parameter to embed custom network configuration files in the :ref:`tnsnames.ora ` file. @@ -47,7 +47,7 @@ Thin Mode Changes provided for `Issue #1565 `__. -#) Added :ref:`Two-Phase Commits ` support. +#) Added :ref:`Two-Phase Commits ` support. Thick Mode Changes +++++++++++++++++++ @@ -57,9 +57,9 @@ Thick Mode Changes #) Added binary for the macOS ARM64 platform. -#) Corrected memory leak when dequeuing messages with JSON payloads - (`ODPI-C change - `__). +#) Corrected memory leak when dequeuing messages with JSON payloads + (`ODPI-C change `__). node-oracledb `v6.5.1 `__ (23 May 2024) --------------------------------------------------------------------------------------------------------- diff --git a/doc/src/user_guide/connection_handling.rst b/doc/src/user_guide/connection_handling.rst index aa5d2a620..5fd78e864 100644 --- a/doc/src/user_guide/connection_handling.rst +++ b/doc/src/user_guide/connection_handling.rst @@ -3760,6 +3760,17 @@ connect as the ADMIN user using the ``cjdb1_high`` connection string: walletPassword: wp }); +Instead of storing and reading the content from the ``ewallet.pem`` file which +is specified in the ``walletLocation`` property, you can use the +:ref:`walletContent ` property to directly +specify the security credentials required to establish a mutual TLS connection +to Oracle Database. This property was introduced in node-oracledb 6.6 and can +be used with the :meth:`oracledb.getConnection()` and +:meth:`oracledb.createPool()` methods. The value of this property takes +precedence and overrides the ``walletLocation`` property value of +:meth:`oracledb.getConnection()`, or the ``WALLET_LOCATION`` parameter +in the connection string. + **In node-oracledb Thick Mode** For node-oracledb in Thick mode, only these files from the zip are needed: @@ -3961,9 +3972,20 @@ example, using OpenSSL:: openssl pkcs12 -in ewallet.p12 -out wallet.pem Once the PEM file has been created, you can use it by passing its directory -location as the ``walletLocation`` parameter to :meth:`oracledb.getconnection()` or -:meth:`oracledb.createPool()`. These methods also accept a ``walletPassword`` -parameter, which can be the passphrase that was specified when the above +location as the ``walletLocation`` property to +:meth:`oracledb.getconnection()` or :meth:`oracledb.createPool()`. Instead of +storing and reading the content from the ``ewallet.pem`` file which is +specified in the ``walletLocation`` property, you can use the +``walletContent`` property to directly specify the security credentials +required to establish a mutual TLS connection to Oracle Database. The +``walletContent`` property was introduced in node-oracledb 6.6 and can be used +with :meth:`~oracledb.getConnection()` and :meth:`~oracledb.createPool()`. The +value of this property takes precedence and overrides the ``walletLocation`` +value set in :meth:`~oracledb.getConnection()` or +:meth:`~oracledb.createPool()`, or the ``WALLET_LOCATION`` parameter in the +connection string. The :meth:`~oracledb.getConnection()` and +:meth:`~oracledb.createPool()` methods also accept a ``walletPassword`` +property, which can be the passphrase that was specified when the above openSSL command was run. See :ref:`connectionadbmtls`. .. _connmultiwallets: