oracledb 6.8.0 → 6.9.0

package/{lib/configProviders/azure.js → plugins/configProviders/azure/index.js}

@@ -1,5 +1,4 @@
-// Copyright (c) 2024, Oracle and/or its affiliates.
-
+// Copyright (c) 2024, 2025, Oracle and/or its affiliates.
 //-----------------------------------------------------------------------------
 //
 // This software is dual-licensed to you under the Universal Permissive License
@@ -25,12 +24,11 @@
 //-----------------------------------------------------------------------------
 
 'use strict';
-
 let AppConfigurationClient;
 let ClientSecretCredential, ClientCertificateCredential, ChainedTokenCredential, ManagedIdentityCredential, EnvironmentCredential;
-const errors = require("../errors.js");
-const { base } = require("./base.js");
-
+const util = require('node:util');
+const { base } = require("../base.js");
+const oracledb = require('oracledb');
 class AzureProvider extends base {
   constructor(provider_arg, urlExtendedPart) {
     super(urlExtendedPart);
@@ -44,36 +42,16 @@ class AzureProvider extends base {
   //---------------------------------------------------------------------------
   init() {
     ({ AppConfigurationClient } = require("@azure/app-configuration"));
-    ({ ClientSecretCredential, ClientCertificateCredential, ChainedTokenCredential, ManagedIdentityCredential, EnvironmentCredential } = require("@azure/identity"));
-  }
-
-  //---------------------------------------------------------------------------
-  // _withChainedTokenCredential()
-  //
-  // Use of ChainedTokenCredential class which provides the ability to link
-  // together multiple credential instances to be tried sequentially when authenticating.
-  // Default authentication to try when no authentication parameter is given by the user
-  //---------------------------------------------------------------------------
-  _withChainedTokenCredential() {
-    const tokens = [];
-    if ((this.paramMap.get("azure_client_secret")))
-      tokens.push(new ClientSecretCredential(this.paramMap.get("azure_tenant_id"), this.paramMap.get("azure_client_id"), this.paramMap.get("azure_client_secret")));
-    if ((this.paramMap.get("azure_client_certificate_path")))
-      tokens.push(new ClientCertificateCredential(this.paramMap.get("azure_tenant_id"), this.paramMap.get("azure_client_id"), this.paramMap.get("azure_client_certificate_path")));
-    if ((this.paramMap.get('azure_managed_identity_client_id')))
-      tokens.push(this.paramMap.get('azure_managed_identity_client_id'));
-    tokens.push(new EnvironmentCredential());
-    const credential = new ChainedTokenCredential(...tokens);
-    return credential;
   }
 
   //---------------------------------------------------------------------------
-  // _returnCredential()
+  // returnCredential()
   //
   // Returns credential to access Azure Config Store on the basis of
   // authentication parameters given by the user.
   //---------------------------------------------------------------------------
-  _returnCredential() {
+  returnAzureCredential() {
+    ({ ClientSecretCredential, ClientCertificateCredential, ChainedTokenCredential, ManagedIdentityCredential, EnvironmentCredential } = require("@azure/identity"));
     let auth = null;
     if (this.paramMap.get('authentication')) {
       auth = this.paramMap.get('authentication').toUpperCase();
@@ -86,82 +64,98 @@ class AzureProvider extends base {
         else if (this.paramMap.get("azure_client_secret"))
           return new ClientSecretCredential(this.paramMap.get("azure_tenant_id"), this.paramMap.get("azure_client_id"), this.paramMap.get("azure_client_secret"));
         else
-          errors.throwErr(errors.ERR_AZURE_SERVICE_PRINCIPAL_AUTH_FAILED);
+          throw new Error('Azure service principal authentication requires either a client certificate path or a client secret string');
       } else if (auth == 'AZURE_MANAGED_IDENTITY') {
         return new ManagedIdentityCredential(this.paramMap.get('azure_managed_identity_client_id'));
       } else {
-        errors.throwErr(errors.ERR_AZURE_CONFIG_PROVIDER_AUTH_FAILED, auth);
+        const errmsg = util.format('Azure Authentication Failed: The authentication parameter value %s may be incorrect', auth);
+        throw new Error(errmsg);
       }
     } else {
       //return default token credential
       return this._withChainedTokenCredential();
     }
   }
-
   //---------------------------------------------------------------------------
-  // _getConfigurationSetting()
+  // _withChainedTokenCredential()
   //
-  // Get configuration setting from the config provider given a key
-  //and an optional label
+  // Use of ChainedTokenCredential class which provides the ability to link
+  // together multiple credential instances to be tried sequentially when authenticating.
+  // Default authentication to try when no authentication parameter is given by the user
   //---------------------------------------------------------------------------
-  async _getConfigurationSetting(client, key, label) {
-    return await client.getConfigurationSetting({ key: key, label: label });
-
+  _withChainedTokenCredential() {
+    const tokens = [];
+    if ((this.paramMap.get("azure_client_secret")))
+      tokens.push(new ClientSecretCredential(this.paramMap.get("azure_tenant_id"), this.paramMap.get("azure_client_id"), this.paramMap.get("azure_client_secret")));
+    if ((this.paramMap.get("azure_client_certificate_path")))
+      tokens.push(new ClientCertificateCredential(this.paramMap.get("azure_tenant_id"), this.paramMap.get("azure_client_id"), this.paramMap.get("azure_client_certificate_path")));
+    if ((this.paramMap.get('azure_managed_identity_client_id')))
+      tokens.push(this.paramMap.get('azure_managed_identity_client_id'));
+    tokens.push(new EnvironmentCredential());
+    const credential = new ChainedTokenCredential(...tokens);
+    return credential;
   }
-
   async returnConfig() {
     const configObject = {};
     const label = this.paramMap.get("label");
-    this.credential = this._returnCredential();
+    try {
+      this.credential =  await this.returnAzureCredential();
+    } catch (err) {
+      const errmsg = util.format('Azure Authentication Failed: The authentication parameter value %s may be incorrect', err.message);
+      throw new Error(errmsg);
+    }
     // azure config store
     const client = new AppConfigurationClient(
       "https://" + this.paramMap.get("appconfigname"), // ex: <https://<your appconfig resource>.azconfig.io>
       this.credential
     );
     // retrieve connect_description
-    configObject.connectString = (await this._getConfigurationSetting(client, this.paramMap.get("key") + 'connect_descriptor', label)).value;
-
+    configObject.connectString = (await this.retrieveParamValueFromAzureConfigurationProvider(client, label, 'connect_descriptor'));
     // retrieve node-oracledb parameters
-    try {
-      const params = (await this._getConfigurationSetting(client, this.paramMap.get("key") + 'node-oracledb', label)).value;
+    const params = (await this.retrieveParamValueFromAzureConfigurationProvider(client, label, 'njs'));
+    if (params) {
       const obj = JSON.parse(params);
       for (const key in obj) {
         var val = obj[key];
         configObject[key] = val;
       }
-    } catch {
-      configObject['node-oracledb'] = null;
-    }
-    try {
-      // retrieve user
-      configObject.user = (await this._getConfigurationSetting(client, this.paramMap.get("key") + 'user', label)).value;
-    } catch {
-      configObject.user = null;
+    } else {
+      configObject['njs'] = null;
     }
+    // retrieve user
+    configObject.user = (await this.retrieveParamValueFromAzureConfigurationProvider(client, label, 'user'));
+
     //retrieve password
-    configObject.password = await this.retrieveParamValueFromVault(client, label, 'password');
+    configObject.password = await this.retrieveParamValueFromAzureConfigurationProvider(client, label, 'password');
+
     // retrieve wallet_location
-    configObject.walletContent = await this.retrieveParamValueFromVault(client, label, 'wallet_location');
+    configObject.walletContent = await this.retrieveParamValueFromAzureConfigurationProvider(client, label, 'wallet_location');
+
     if (configObject.walletContent) {
       //only Pem file supported
       if (!this.isPemFile(configObject.walletContent))
-        errors.throwErr(errors.ERR_WALLET_TYPE_NOT_SUPPORTED);
+        throw new Error('Invalid wallet content format. Supported format is PEM');
     }
     return configObject;
   }
-  async retrieveParamValueFromVault(client, label, param) {
+  async retrieveParamValueFromAzureConfigurationProvider(client, label, param) {
     let paramJson = null;
     try {
-      paramJson = await this._getConfigurationSetting(client, this.paramMap.get("key") + param, label);
-    } catch {
+      paramJson = (await client.getConfigurationSetting({ key: this.paramMap.get("key") + param, label: label })).value;
+    } catch (err) {
+      // connect_descriptor must not be null
+      if (param == 'connect_descriptor') {
+        const errmsg = util.format('Failed to retrieve configuration from Centralized Configuration Provider:\n%s', err.message);
+        throw new Error(errmsg);
+      }
       return null;
     }
     if (paramJson) {
       let obj;
       try {
-        obj = JSON.parse(paramJson.value);
+        obj = JSON.parse(paramJson);
       } catch {
-        obj = paramJson.value;
+        obj = paramJson;
       }
       if (obj.uri) {
         const { SecretClient } = require("@azure/keyvault-secrets");
@@ -169,10 +163,23 @@ class AzureProvider extends base {
         const client1 = new SecretClient(vault_detail[0], this.credential);
         return  (await client1.getSecret(vault_detail[1])).value;
       } else {
-        return paramJson.value;
+        return paramJson;
       }
     }
-
   }
+} module.exports = AzureProvider;
+//---------------------------------------------------------------------------
+//  hookFn()
+//  hookFn will get registered to the driver while loading the plugins
+//---------------------------------------------------------------------------
+async function hookFn(args) {
+  const configProvider = new AzureProvider(args.provider_arg, args.urlExtendedPart);
+  try {
+    configProvider.init();
+  } catch (err) {
+    const errmsg = util.format('Centralized Config Provider failed to load required libraries. Please install the required libraries.\n %s', err.message);
+    throw new Error(errmsg);
+  }
+  return [await configProvider.returnConfig(), configProvider.credential];
 }
-module.exports = AzureProvider;
+oracledb.registerConfigurationProviderHook('azure', hookFn);

package/plugins/configProviders/azurevault/index.js

@@ -0,0 +1,84 @@
+// Copyright (c) 2025, Oracle and/or its affiliates.
+
+//-----------------------------------------------------------------------------
+//
+// This software is dual-licensed to you under the Universal Permissive License
+// (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
+// 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose
+// either license.
+//
+// If you elect to accept the software under the Apache License, Version 2.0,
+// the following applies:
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+//-----------------------------------------------------------------------------
+'use strict';
+
+const { base } = require("../base.js");
+const oracledb = require('oracledb');
+const util = require('node:util');
+
+let SecretClient;
+class azureVault extends base {
+  constructor(provider_arg, urlExtendedPart) {
+    super(urlExtendedPart);
+    if (provider_arg)
+      this._addParam("azuresecreturl", provider_arg);
+  }
+  init() {
+    ({SecretClient}  = require("@azure/keyvault-secrets"));
+  }
+  async returnConfig(credential) {
+    if (!credential) {
+      const azureClass = require('../azure');
+      var azureObject = new azureClass();
+      azureObject.paramMap = this.paramMap;
+      this.credential = await azureObject.returnAzureCredential();
+    } else
+      this.credential = credential;
+
+    const vault_detail = await this._parsePwd(this.paramMap.get('azuresecreturl'));
+    const client1 = new SecretClient(vault_detail[0], this.credential);
+    const resp = (await client1.getSecret(vault_detail[1])).value;
+
+    try {
+      this.obj = JSON.parse(resp);
+    } catch {
+      return resp; //when password is of type azurevault
+    }
+    const userAlias = this.paramMap.get('key'); // alias
+    if (userAlias) {
+      this.obj = this.obj[userAlias];
+    }
+    return this.obj;
+  }
+}
+//---------------------------------------------------------------------------
+//  hookFn()
+//   hookFn will get registered to the driver while loading the plugins
+//---------------------------------------------------------------------------
+async function hookFn(args) {
+  const configProvider = new azureVault(args.provider_arg, args.urlExtendedPart);
+  try {
+    configProvider.init();
+  } catch (err) {
+    const errmsg = util.format('Centralized Config Provider failed to load required libraries. Please install the required libraries.\n %s', err.message);
+    throw new Error(errmsg);
+  }
+  if (args.paramMap) {
+    configProvider.paramMap = args.paramMap;
+  }
+  return  [await configProvider.returnConfig(args.credential), configProvider.credential];
+}
+oracledb.registerConfigurationProviderHook('azurevault', hookFn);

package/{lib → plugins}/configProviders/base.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2024, Oracle and/or its affiliates.
+// // Copyright (c) 2024, 2025, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //
@@ -25,7 +25,6 @@
 //-----------------------------------------------------------------------------
 
 'use strict';
-
 const pemHeaders = [
   '-----BEGIN CERTIFICATE-----',
   '-----BEGIN PUBLIC KEY-----',
@@ -72,14 +71,25 @@ class base {
   // “uri”:“https://mykeyvault.vault.azure.net/secrets/secretkey”}
   //---------------------------------------------------------------------------
   _parsePwd(str) {
-    const vault_uri = new RegExp("(?<vault_url>https://[A-Za-z0-9._-]+)/secrets/(?<secretKey>[A-Za-z][A-Za-z0-9-]*)$", 'g');
+    const vault_uri = new RegExp("(?<vault_url>(^(https://))?[A-Za-z0-9._-]+)/secrets/(?<secretKey>[A-Za-z0-9][A-Za-z0-9-/]*)$", 'g');
     const vault_detail = [];
     for (const match of str.matchAll(vault_uri)) {
       vault_detail[0] = match.groups.vault_url;
       vault_detail[1] = match.groups.secretKey;
     }
+    if (!vault_detail[0].startsWith('https'))
+      vault_detail[0] = 'https://' + vault_detail[0];
     return vault_detail;
   }
 
+  //---------------------------------------------------------------------------
+  // retrieveRegion(objservername)
+  //
+  // returns region from the given objservername.
+  //---------------------------------------------------------------------------
+  retrieveRegion(objservername) {
+    const arr = objservername.split(".");
+    return arr[1].toUpperCase().replaceAll('-', '_');
+  }
 }
 module.exports = {base};

package/{lib/configProviders/ociobject.js → plugins/configProviders/ociobject/index.js}

@@ -1,4 +1,4 @@
-// Copyright (c) 2024, Oracle and/or its affiliates.
+// Copyright (c) 2024, 2025, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //
@@ -25,17 +25,20 @@
 //-----------------------------------------------------------------------------
 
 'use strict';
-const errors = require("../errors.js");
-const { base } = require("./base.js");
-const fs = require('fs');
 
+const { base } = require("../base.js");
+const oracledb = require('oracledb');
+const util = require('node:util');
+const fs = require('fs');
 const cloud_net_naming_pattern_oci = new RegExp("(?<objservername>[A-Za-z0-9._-]+)/n/" + "(?<namespace>[A-Za-z0-9._-]+)/b/" + "(?<bucketname>[A-Za-z0-9._-]+)/o/" + "(?<filename>[A-Za-z0-9._-]+)$");
 // object to store module references that will be populated by init()
 const oci = {};
 class OCIProvider extends base {
   constructor(provider_arg, urlExtendedPart) {
     super(urlExtendedPart);
-    const match = provider_arg.match(cloud_net_naming_pattern_oci);
+    let match;
+    if (provider_arg)
+      match = provider_arg.match(cloud_net_naming_pattern_oci);
     if (match) {
       this._addParam("objservername", match.groups.objservername);
       this._addParam("namespace", match.groups.namespace);
@@ -66,14 +69,14 @@ class OCIProvider extends base {
     }
     return Buffer.concat(chunks).toString("utf-8");
   }
-
   //---------------------------------------------------------------------------
-  // _returnCredential()
+  // returnOCICredential()
   //
-  // Returns credential to access OCI Object Store on the basis of
+  // Returns credential to access OCI Object Store/OCI Vault on the basis of
   // authentication parameters given by the user.
+  // Used in OCI/LOCALJSONFILE/OCIVAULT Config Providers
   //---------------------------------------------------------------------------
-  async _returnCredential() {
+  async returnOCICredential() {
     let provider = null;
     let auth = null;
     if (this.paramMap.get('authentication')) {
@@ -82,11 +85,13 @@ class OCIProvider extends base {
     // authentication parameter given and its not OCI_DEFAULT
     if (auth && !(auth == 'OCI_DEFAULT')) {
       if (auth == 'OCI_INSTANCE_PRINCIPAL') {
-        provider = await new oci.common.InstancePrincipalsAuthenticationDetailsProviderBuilder().build();
+        provider = await oci.common.InstancePrincipalsAuthenticationDetailsProviderBuilder().build();
       } else if (auth == 'OCI_RESOURCE_PRINCIPAL') {
         provider = await new oci.common.ResourcePrincipalAuthenticationDetailsProvider.builder();
-      } else
-        errors.throwErr(errors.ERR_OCIOBJECT_CONFIG_PROVIDER_AUTH_FAILED, auth);
+      } else {
+        const errmsg = util.format('OCI authentication failed: The authentication parameter value %s may be incorrect', auth);
+        throw new Error(errmsg);
+      }
     } else {
       // default authentication
       try {
@@ -102,14 +107,18 @@ class OCIProvider extends base {
         }
         // authentication parameters are directly given in the connectString
         const publicKey = fs.readFileSync(this.paramMap.get('oci_key_file'), { encoding: "utf8" });
-        const region = this.retrieveRegion(this.paramMap.get('objservername'));
+        let region;
+        if (this.paramMap.get('objectservername'))
+          region = this.retrieveRegion(this.paramMap.get('objservername'));
+        else
+          region = oci.common.Region[(this.paramMap.get("region").replace(/-/g, '_')).toUpperCase()];
         provider = new oci.common.SimpleAuthenticationDetailsProvider(
           this.paramMap.get("oci_tenancy"),
           this.paramMap.get("oci_user"),
           this.paramMap.get("oci_fingerprint"),
           publicKey,
           undefined,
-          oci.common.Region[region]
+          region
         );
       }
     }
@@ -123,8 +132,7 @@ class OCIProvider extends base {
   // parses and gets password field stored in OCI/Azure Vault
   //---------------------------------------------------------------------------
   async returnConfig() {
-    const configObject = {};
-    this.credential = await this._returnCredential();
+    this.credential = await this.returnOCICredential();
     // oci object store
     const client_oci = new (oci.objectstorage).ObjectStorageClient({
       authenticationDetailsProvider: this.credential
@@ -142,70 +150,27 @@ class OCIProvider extends base {
     if (userAlias) {
       this.obj = this.obj[userAlias];
     }
-    const pmSection = 'node-oracledb';
-    const params = this.obj[pmSection];
-    for (const key in params) {
-      var val = params[key];
-      configObject[key] = val;
-    }
-    configObject.connectString = this.obj.connect_descriptor;
-    configObject.user = this.obj.user;
-    if (this.obj.password) {
-      configObject.password = await this.retrieveParamValueFromVault('password');
-    }
-    if (this.obj.wallet_location) {
-      // retrieve wallet_location
-      configObject.walletContent = await this.retrieveParamValueFromVault('wallet_location');
-      //only Pem file supported
-      if (!this.isPemFile(configObject.walletContent))
-        errors.throwErr(errors.ERR_WALLET_TYPE_NOT_SUPPORTED);
-    }
-    return configObject;
+    return this.obj;
   }
+}module.exports = OCIProvider;
 
-  //---------------------------------------------------------------------------
-  // retrieveRegion(objservername)
-  //
-  // returns region from the given objservername.
-  //---------------------------------------------------------------------------
-  retrieveRegion(objservername) {
-    const arr = objservername.split(".");
-    return arr[1].toUpperCase().replaceAll('-', '_');
+//---------------------------------------------------------------------------
+//  hookFn()
+//  hookFn will get registered to the driver while loading the plugins
+//---------------------------------------------------------------------------
+async function hookFn(args) {
+  const configProvider = new OCIProvider(args.provider_arg, args.urlExtendedPart);
+  try {
+    configProvider.init();
+  } catch (err) {
+    const errmsg = util.format('Centralized Config Provider failed to load required libraries. Please install the required libraries.\n %s', err.message);
+    throw new Error(errmsg);
   }
-
-  async retrieveParamValueFromVault(param) {
-    if (this.obj[param].type == "azurevault") {
-      if (this.obj[param].authentication) {
-        const { SecretClient } = require("@azure/keyvault-secrets");
-        const {ClientSecretCredential, ClientCertificateCredential} = require("@azure/identity");
-        if (this.obj[param].authentication.azure_client_secret)
-          this.credential = new ClientSecretCredential(this.obj[param].authentication.azure_tenant_id, this.obj[param].authentication.azure_client_id, this.obj[param].authentication.azure_client_secret);
-        else if (this.obj[param].authentication.azure_client_certificate_path)
-          this.credential = new ClientCertificateCredential(this.obj[param].authentication.azure_tenant_id, this.obj[param].authentication.azure_client_id, this.obj[param].authentication.azure_client_certificate_path);
-        else
-          errors.throwErr(errors.ERR_AZURE_VAULT_AUTH_FAILED);
-        const vault_detail = await this._parsePwd(this.obj[param].value);
-        const client1 = new SecretClient(vault_detail[0], this.credential);
-        return (await client1.getSecret(vault_detail[1])).value;
-      } else {
-        errors.throwErr(errors.ERR_AZURE_VAULT_AUTH_FAILED);
-      }
-    } else if (this.obj[param].type == "ocivault") {
-      const secrets = require('oci-secrets');
-      const secretClientOci =  new secrets.SecretsClient({
-        authenticationDetailsProvider: this.credential
-      });
-      const getSecretBundleRequest = {
-        secretId: this.obj[param].value
-      };
-      const getSecretBundleResponse = await secretClientOci.getSecretBundle(getSecretBundleRequest);
-      const base64content = getSecretBundleResponse.secretBundle.secretBundleContent.content;
-      // decode base64 content
-      const returnVal = Buffer.from(base64content, "base64").toString("utf-8");
-      return returnVal;
-    }  else {
-      return this.obj[param];
-    }
+  try {
+    return [await configProvider.returnConfig(), configProvider.credential];
+  } catch (err) {
+    const errmsg = util.format('Failed to retrieve configuration from Centralized Configuration Provider:\n %s', err.message);
+    throw new Error(errmsg);
   }
 }
-module.exports = OCIProvider;
+oracledb.registerConfigurationProviderHook('ociobject', hookFn);

package/plugins/configProviders/ocivault/index.js

@@ -0,0 +1,100 @@
+// Copyright (c) 2025, Oracle and/or its affiliates.
+
+//-----------------------------------------------------------------------------
+//
+// This software is dual-licensed to you under the Universal Permissive License
+// (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
+// 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose
+// either license.
+//
+// If you elect to accept the software under the Apache License, Version 2.0,
+// the following applies:
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+//-----------------------------------------------------------------------------
+'use strict';
+
+const { base } = require("../base.js");
+const oracledb = require('oracledb');
+const util = require('node:util');
+const oci = {};
+class ociVault extends base {
+  constructor(provider_arg, urlExtendedPart) {
+    super(urlExtendedPart);
+    if (provider_arg)
+      this._addParam("ocidvault", provider_arg);
+  }
+  init() {
+    oci.secrets = require('oci-secrets');
+    oci.common = require('oci-common');
+  }
+
+  //---------------------------------------------------------------------------
+  // returnConfig()
+  //
+  // Returns config stored in the OCI Vault
+  // parses it and gets password field stored in OCI/Azure Vault
+  //---------------------------------------------------------------------------
+  async returnConfig(credential) {
+    if (!credential) {
+      const ociObjectClass = require('../ociobject');
+      const ociObject = new ociObjectClass();
+      ociObject.paramMap = this.paramMap;
+      ociObject.paramMap.set('authentication', '');
+      ociObject.init();
+      this.credential = await ociObject.returnOCICredential();
+    } else
+      this.credential = credential;
+
+    const secretClientOci =  new oci.secrets.SecretsClient({
+      authenticationDetailsProvider: this.credential
+    });
+    const getSecretBundleRequest = {
+      secretId: this.paramMap.get("ocidvault")
+    };
+    const getSecretBundleResponse = await secretClientOci.getSecretBundle(getSecretBundleRequest);
+    const base64content = getSecretBundleResponse.secretBundle.secretBundleContent.content;
+    // decode base64 content
+    const resp = Buffer.from(base64content, "base64").toString("ascii");
+    // Entire object we get from OCI Vault
+    try {
+      this.obj = JSON.parse(resp);
+    } catch {
+      return resp;  // when password is of type ocivault
+    }
+    const userAlias = this.paramMap.get('key'); // alias
+    if (userAlias) {
+      this.obj = this.obj[userAlias];
+    }
+    return this.obj;
+  }
+}
+//---------------------------------------------------------------------------
+//  hookFn()
+//  hookFn will get registered to the driver while loading the plugins
+//---------------------------------------------------------------------------
+async function hookFn(args) {
+  const configProvider = new ociVault(args.provider_arg, args.urlExtendedPart);
+  try {
+    configProvider.init();
+  } catch (err) {
+    const errmsg = util.format('Centralized Config Provider failed to load required libraries. Please install the required libraries.\n %s', err.message);
+    throw new Error(errmsg);
+  }
+  if (args.paramMap) {
+    configProvider.paramMap = args.paramMap;
+  }
+  return  [await configProvider.returnConfig(args.credential), configProvider.credential];
+}
+oracledb.registerConfigurationProviderHook('ocivault', hookFn);