oracledb 6.6.0 → 6.7.1

package/lib/thin/sqlnet/navNodes.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2022, 2023, Oracle and/or its affiliates.
+// Copyright (c) 2022, 2024, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //
@@ -315,6 +315,7 @@ class Description {
       }
     }
   }
+
   toString() {
     let s = new String(""), child ;
 
@@ -428,9 +429,6 @@ class DescriptionList {
 }
 
 
-
-
-
 /**
  * Class that contains information about a possible connection.
  */
@@ -453,6 +451,7 @@ const NavSchemaObject = {
 const options = {
   all: true,
 };
+
 /**
  * Class that navigates the address node in the tree.
  */
@@ -460,16 +459,17 @@ class NavAddress extends Address {
   constructor() {
     super();
   }
+
   /**
    * Set the connection option to this address.
    * @param {object} cs
    */
   async navigate(cs) {
     let addresses;
-    let nullHost = 0;
+    let nullHost = false;
     let needToCloseDescription = false;
     if (!this.host) {
-      nullHost = 1;
+      nullHost = true;
       this.host = os.hostname();
       try {
         await dnsPromises.lookup(this.host, options);
@@ -495,7 +495,7 @@ class NavAddress extends Address {
           co.httpsProxyPort = this.httpsProxyPort;
           co.desc = cs.getcurrentDescription();
           co.CNdata.push(cs.sBuf.join(""));
-          if (nullHost == 1)
+          if (nullHost)
             co.CNdata.push('(address=(protocol=' + this.prot + ')(host=' + this.host + ')(port=' + this.port + '))');
           else
             co.CNdata.push(this.toString());
@@ -505,6 +505,8 @@ class NavAddress extends Address {
         }
       } catch {
         // do nothing
+        // Any error in the try block is ignored, because we want to try
+        // the next address
       }
     } else {
       const co = new ConnOption();
@@ -527,8 +529,6 @@ class NavAddress extends Address {
 
   }
 
-
-
   /**
    * AddToString is used to construct a string representation of the TNS
    * Address. Constructing a string is mainly needed when source route is ON.
@@ -557,10 +557,10 @@ class NavAddressList extends AddressList {
   }
 
   /**
- * Method decides how to traverse and sets the active children based on
- * the loadbalancing, failover values.
- * @param {object} cs
- */
+   * Method decides how to traverse and sets the active children based on
+   * the loadbalancing, failover values.
+   * @param {object} cs
+   */
   async navigate(cs) {
     await this.navigate2(cs, 0);
   }
@@ -592,6 +592,7 @@ class NavAddressList extends AddressList {
     cs.sBuf.length = this.sBuflength;
 
   }
+
   addToString(cs) {
     const NVString = this.toString();
     let cOpts = new Array();
@@ -604,7 +605,6 @@ class NavAddressList extends AddressList {
     }
   }
 
-
   getChildrenSize() {
     let size = 0;
     for (let i = 0; i < this.activeChildren.length; i++) {
@@ -762,7 +762,6 @@ class NavDescription extends Description {
   }
 
   closeNVPair(cs) {
-
     if (cs.getcurrentDescription() == null)
       return;
     let cOpts = new Array();
@@ -777,8 +776,20 @@ class NavDescription extends Description {
       if (this.connectData == null) {
         this.connectData = "(SERVICE_NAME=)";
       }
-      const pgmName = "\"'" + cInfo.program + "'\"";
-      const cid = `(CID=(PROGRAM=${pgmName})(HOST=${cInfo.hostName})(USER=${cInfo.userName}))`;
+
+      let pgmName = cInfo.program;
+      if (cs.program) {
+        pgmName = cs.program;
+      }
+      let hostName = cInfo.hostName;
+      if (cs.machine) {
+        hostName = cs.machine;
+      }
+      let userName = cInfo.userName;
+      if (cs.osUser) {
+        userName = cs.osUser;
+      }
+      const cid = `(CID=(PROGRAM=${pgmName})(HOST=${hostName})(USER=${userName}))`;
       cOpts[i].CNdata.push(NavSchemaObject.CD);
       cOpts[i].CNdata.push(this.connectData);
       cOpts[i].CNdata.push(cid);
@@ -800,11 +811,9 @@ class NavDescription extends Description {
   }
 
   getIntValue(stringInt, defaultValue) {
-    try {
+    if (/^\d+$/.test(stringInt))
       return parseInt(stringInt);
-    } catch (exception) {
-      return defaultValue;
-    }
+    return defaultValue;
   }
 
 }
@@ -872,7 +881,5 @@ class NavDescriptionList extends DescriptionList {
 
   }
 
-
-
 }
 module.exports = {NavAddress, NavAddressList, NavDescription, NavDescriptionList};

package/lib/thin/sqlnet/networkSession.js

@@ -46,7 +46,7 @@ const downHostInstance = require("./connStrategy.js").SOLE_INST_DHCACHE;
 
 async function getConnectionInfo(userConfig) {
   const connStr = await resolveConnectStr(userConfig.connectString, userConfig.configDir);
-  const addressNode = await createNode(connStr);
+  const addressNode = await createNode(connStr, userConfig);
   let nvpair;
   if (typeof connStr === 'string')
     nvpair = createNVPair(connStr);
@@ -97,9 +97,9 @@ async function resolveConnectStr(connectString, configDir) {
 
 }
 
-async function resolveAddress(connStr, configDir) {
-  const connstr = await resolveConnectStr(connStr, configDir);
-  return createNode(connstr);
+async function resolveAddress(connStr, userConfig) {
+  const connstr = await resolveConnectStr(connStr, userConfig.configDir);
+  return createNode(connstr, userConfig);
 }
 
 /**
@@ -143,6 +143,7 @@ class NetworkSession {
   async getAddress(addressNode, userConfig) {
     /* Get the next address */
     const address = await addressNode.execute(userConfig);
+
     /* Prepare connection attributes */
     const uuid = this.sAtts ? this.sAtts.uuid : null;
     this.sAtts = new SessionAtts(uuid);
@@ -196,10 +197,12 @@ class NetworkSession {
   }
 
   /**
-   * Establish network session .Make transport level connection, send NSPTCN(connect packet) and read the response.
-   * @returns NetError.(connection successfully established(NetError.CONNECTED) or reason for failure)
+   * Establish network session. Make transport level connection, send
+   * NSPTCN(connect packet) and read the response. @returns NetError.
+   * (connection successfully established(NetError.CONNECTED)
+   * or reason for failure)
    */
-  async connect2(address) {
+  async connect2(address, userConfig) {
     /* Sanitise SDU */
     if (this.sAtts.sdu) {
       if (this.sAtts.sdu > constants.NSPABSSDULN) {
@@ -269,7 +272,7 @@ class NetworkSession {
           redirConnData = this.cData;
         }
 
-        const redirAddressNode = await resolveAddress(adrStr);
+        const redirAddressNode = await resolveAddress(adrStr, userConfig);
         const host = address.hostname;
         address = await redirAddressNode.execute();
         if (address.desc)
@@ -314,10 +317,10 @@ class NetworkSession {
     do {
       try {
         if (this.sAtts.connectTimeout) {
-          const asyncPromise = this.connect2(address);
+          const asyncPromise = this.connect2(address, userConfig);
           connected = await timeout(asyncPromise, this.sAtts.connectTimeout, "connectTimeout", address, this.sAtts.connectionId);
         } else {
-          connected = await this.connect2(address);
+          connected = await this.connect2(address, userConfig);
         }
       } catch (err) {
         if (err.message.startsWith('NJS-510') && !this.ntAdapter.connected) {
@@ -528,14 +531,14 @@ class NetworkSession {
       addressNode = userConfig._connInfo[5];
       addressNode.reset();
     } else {
-      addressNode = await resolveAddress(connStr, userConfig.configDir);
+      addressNode = await resolveAddress(connStr, userConfig);
     }
     let address;
     try {
       address = await this.getAddress(addressNode, userConfig);
     } catch (err) {
-      if (err.message == "All options tried") /* Not even one valid Address */
-        errors.throwErr(errors.ERR_INVALID_CONNECT_STRING_PARAMETERS, "Ensure the ADDRESS parameters have been entered correctly, the most likely incorrect parameter is the host name");
+      if (err.message == "All options tried") /* Not even one valid address */
+        errors.throwErr(errors.ERR_HOST_NOT_FOUND);
       else
         errors.throwErr(errors.ERR_INVALID_CONNECT_STRING_PARAMETERS, err.message);
     }
@@ -617,7 +620,8 @@ class NetworkSession {
   /**
    * receive inband notification
    * @param {Object} obj Return the notification into user provided object
-   * @returns Error number sent from server, or error on the connection. returns 0 if healthy connection
+   * @returns Error number sent from server, or error on the connection.
+   * returns 0 if healthy connection
    */
   recvInbandNotif() {
     let error = 0;

package/lib/thin/sqlnet/ntTcp.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2022, 2023, Oracle and/or its affiliates.
+// Copyright (c) 2022, 2024, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //
@@ -72,7 +72,7 @@ class NTTCP {
   }
 
   /**
-   * DN matching funciton(used with TLS)
+   * DN matching function(used with TLS)
    */
   dnMatch(serverName, cert) {
     if (this.atts.sslServerDNMatch && this.doDNMatch) {
@@ -211,7 +211,7 @@ class NTTCP {
 
     try {
       await this.ntConnect(address);
-      if (this.atts.expireTime || this.atts.enableDCD) {  /* Set Keep alives */
+      if (this.atts.expireTime || this.atts.enableDCD) {  /* Set KeepAlives */
         if (this.atts.expireTime) {
           this.stream.setKeepAlive(true, this.atts.expireTime);
         } else {
@@ -234,7 +234,7 @@ class NTTCP {
             ca: this.atts.wallet,
           });
         } catch (err) {
-          errors.throwErr(errors.ERR_TLS_INIT_FAILURE);
+          errors.throwErr(errors.ERR_TLS_INIT_FAILURE, err.message);
         }
         await this.tlsConnect(secureContext, this.stream);
       }
@@ -248,7 +248,7 @@ class NTTCP {
   /**
    * Disconnect Network Transoprt
    * @param {int} type
-   * @returns Proimise
+   * @returns Promise
    */
   disconnect(type) {   /* Disconnect function for TCP sockets */
     if (this.connected && !this.err) {
@@ -470,8 +470,9 @@ class NTTCP {
    * @returns Promise
    */
   async renegTLS() {
+    let initTLSDone = false;
+    this.checkErr();
     try {
-      this.checkErr();
       this.doDNMatch = true;
       const secureContext = tls.createSecureContext({
         cert: this.atts.wallet,
@@ -479,7 +480,12 @@ class NTTCP {
         passphrase: this.atts.walletPassword,
         ca: this.atts.wallet,
       });
+      initTLSDone = true;
       await this.tlsConnect(secureContext, this.connStream);
+    } catch (err) {
+      if (!initTLSDone)
+        errors.throwErr(errors.ERR_TLS_INIT_FAILURE, err.message);
+      else throw err;
     } finally {
       this.setupEventHandlers();
     }

package/lib/thin/sqlnet/nvStrToNvPair.js

@@ -68,6 +68,9 @@ class NVPair {
     this.listType = LIST_REGULAR;
     this.rhsType = RHS_NONE;
   }
+  /**
+   * @param {string} atom - input atom string literal
+   */
   set setAtom(atom) {
     if (this._containsComment(atom)) {
       errors.throwErr(errors.ERR_INVALID_CONNECT_STRING_SYNTAX);
@@ -122,7 +125,7 @@ class NVPair {
   }
   /**
      * adds a nvpair to the existing one.
-     * @param {nvpair} pair
+     * @param {NVPair} pair
      */
   addListElement(pair) {
     if (this.list == null) {
@@ -147,11 +150,11 @@ class NVPair {
     }
   }
   /**
-    * Returns an empty string with the number specified in the argument. Used for
-     * indentation of multi-level NVPairs as they are stored
-     *
-     * @param count
-     *          Number of spaces required in the blank string.
+    * Returns an empty string with the number specified in the argument. Used
+    * for indentation of multi-level NVPairs as they are stored
+    *
+    * @param count
+    *          Number of spaces required in the blank string.
     */
   _space(count) {
     var blank_str = "";
@@ -274,9 +277,9 @@ const TKN_LF_VALUE = '\n';
 const TKN_CR_VALUE = '\r';
 
 /**
- * The NVTokens class is used to help break NVStrings apart into tokens, such as
- * TKN_LPAREN or TKN_LITERAL - this helps simplify the task of building NVPairs
- * from an NVString.
+ * The NVTokens class is used to help break NVStrings apart into tokens, such
+ * as TKN_LPAREN or TKN_LITERAL - this helps simplify the task of building
+ * NVPairs from an NVString.
 */
 class NVTokens {
 
@@ -435,9 +438,8 @@ class NVTokens {
     return true;
   }
   /**
-   * Returns current token. Throws Error if no string has
-   * been parsed, or if there are no tokens left. Does NOT advance
-   * the token position.
+   * Returns current token. Throws Error if no string has been parsed,
+   * or if there are no tokens left. Does NOT advance the token position.
    */
   getToken() {
     if (this.tkType == null) { // nothing parsed
@@ -451,9 +453,8 @@ class NVTokens {
   }
 
   /**
-   * Returns current token. Throws Error if no string has
-   * been parsed, or if there are no tokens left. DOES advance the
-   * token position.
+   * Returns current token. Throws Error if no string has been parsed,
+   * or if there are no tokens left. DOES advance the token position.
    */
   popToken() {
     let token = TKN_NONE;
@@ -470,9 +471,8 @@ class NVTokens {
   }
   /**
    * Returns literal for current token. If current token is NOT a TKN_LITERAL,
-   * it returns a string representation of the current token. Throws
-   * Error if no string has been parsed, or
-   * if there are no tokens left.
+   * it returns a string representation of the current token. Throws Error
+   * if no string has been parsed, or if there are no tokens left.
    *
    * DOES NOT advance the token position.
    */
@@ -492,9 +492,8 @@ class NVTokens {
 
   /**
    * Returns literal for current token. If current token is NOT a TKN_LITERAL,
-   * it returns a string representation of the current token. Throws
-   * Error if no string has been parsed, or
-   * if there are no tokens left.
+   * it returns a string representation of the current token. Throws Error
+   * if no string has been parsed, or if there are no tokens left.
    *
    * DOES advance the token position.
    */
@@ -547,8 +546,6 @@ class NVTokens {
 }
 
 
-
-
 /**
  * The NVFactory class is used to help interpret the tokens generated by
  * NVTokens from an NVString.
@@ -696,7 +693,7 @@ function readNVList(nvt, parent) {
 
 /**
   * Returns a NVPair whose name matches (ignoring case) the specified
-  * name.  This function does search recursively through all descendents
+  * name.  This function does search recursively through all descendants
   * of the specified NVPair.
   * @param  nvp  NVPair to search through
   * @param  name  name to match (ignoring case)
@@ -726,8 +723,8 @@ function findNVPairRecurse(nvp, name) {
 }
 
 /**
-  * Returns a NVPair whose name matches (ignoring case) the specified
-  * name. This functions only searches the direct descendants of specified NVPair
+  * Returns a NVPair whose name matches (ignoring case) the specified name.
+  * This functions only searches the direct descendants of specified NVPair
   * @param  nvp  NVPair to search through
   * @param  name  name to match (ignoring case)
   */

package/lib/thin/sqlnet/paramParser.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2022, 2023, Oracle and/or its affiliates.
+// Copyright (c) 2022, 2024, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //
@@ -26,7 +26,7 @@
 
 'use strict';
 
-const {createNVPair, findValue} = require("./nvStrToNvPair.js");
+const {createNVPair} = require("./nvStrToNvPair.js");
 const fs = require('fs');
 const process = require('process');
 const readline = require('readline');
@@ -59,12 +59,21 @@ function tnsnamesFilePath(configDir) {
     return filePathVal;
   }
 }
+//Structure for each tnsnames.ora file
+class tnsnamesElement {
 
+  constructor() {
+    this.readInProgress = false;
+    this.waiters = [];
+    this.aliasht = new Map(); // It will have key as alias and value as its aliases value
+    this.modTime = new Map(); // It will have tnsnames filename and also all its ifile and its modified time
+  }
+}
 class NLParamParser {
 
   constructor() {
-    this.waiters = [];
-    this.readInProgress = false;
+  // key as tnsnames.ora(file_name) and value will be tnsnamesStruct<ht(alias key and value), modTime>
+    this.tnsnamesHT = new Map();
   }
   /**
  * Reads the given file line by line and stores the
@@ -73,29 +82,35 @@ class NLParamParser {
  * @returns {Promise}
  */
   async initializeNlpa(file_path) {
-    if (this.readInProgress) {
+    let tnsFileStruct;
+    if (this.tnsnamesHT.has(file_path))
+      tnsFileStruct = this.tnsnamesHT.get(file_path);
+    else
+      tnsFileStruct = new tnsnamesElement();
+    if (tnsFileStruct.readInProgress) {
       await new Promise((resolve) => {
-        this.waiters.push(resolve);
+        tnsFileStruct.waiters.push(resolve);
       });
     }
-    if (!this.checkModfTime()) {
+    /* check modification time of all files in the cache
+       including the file_path */
+    if (!this.checkModfTime(tnsFileStruct)) {
       /* No File has been modified */
-      return this.ht;
+      return tnsFileStruct.aliasht;
     }
-    this.ht = new Map();
-    this.modTime = new Map(); //stores modified time of each IFile
-    this.readInProgress = true;
-    await this.start(file_path, 0); //start with 0 depth (tnsnames.ora)
-    return this.ht;
+    tnsFileStruct.readInProgress = true;
+    await this.start(file_path, 0, tnsFileStruct); //start with 0 depth (tnsnames.ora)
+    this.tnsnamesHT.set(file_path, tnsFileStruct);
+    return tnsFileStruct.aliasht;
   }
 
-  async start(file_path, depth) {
+  async start(file_path, depth, tnsFileStruct) {
 
     if (depth > MAX_IFILE_DEPTH)
       return; //ignore after max depth
     const stat = fs.statSync(file_path);
     // store file path and its modified time.
-    this.modTime.set(file_path, stat.mtime);
+    tnsFileStruct.modTime.set(file_path, stat.mtime);
     // Creating a readable stream from file
     // readline module reads line by line
     // but from a readable stream only.
@@ -129,7 +144,7 @@ class NLParamParser {
           nvElem = nvElem + line;
 
         } else if (nvElem.length != 0) {
-          await this.addNLPListElement(nvElem, depth); // Add Parameter to Hashtable
+          await this.addNLPListElement(nvElem, depth, tnsFileStruct); // Add Parameter to Hashtable
           nvElem = ""; // Clear first, before storing current line
 
           line = this.checkNLPforComments(line);
@@ -138,12 +153,12 @@ class NLParamParser {
       }
     }
     if (nvElem.length != 0) { // at eof, still one more parameter to read
-      await this.addNLPListElement(nvElem, depth);
+      await this.addNLPListElement(nvElem, depth, tnsFileStruct);
       nvElem = "";      // clear nvElem buffer after added
     }
-    this.readInProgress = false;
+    tnsFileStruct.readInProgress = false;
     let waiter;
-    while ((waiter = this.waiters.pop())) {
+    while ((waiter = tnsFileStruct.waiters.pop())) {
       waiter();
     }
   }
@@ -173,9 +188,11 @@ class NLParamParser {
     return str1.join('');
   }
   // check if any of the IFiles has been changed
-  checkModfTime() {
-    if (this.modTime) {
-      for (const [key, value] of this.modTime) {
+  checkModfTime(tnsFileStruct) {
+    // There may be multiple tnsnames.ora files. So check if the tnsnames.ora
+    // in question is already cached
+    if (tnsFileStruct.modTime.size != 0) {
+      for (const [key, value] of tnsFileStruct.modTime) {
         if (fs.existsSync(key)) {
           const stat = fs.statSync(key);
           if ((stat.mtime - value > 0)) {
@@ -193,7 +210,7 @@ class NLParamParser {
     * adds name value pairs from the input buffer into the hash table.
     * @param {string} ibuf
     */
-  async addNLPListElement(ibuf, depth) {
+  async addNLPListElement(ibuf, depth, tnsFileStruct) {
     const res = ibuf.split(/\r?\n/).filter(element => element);
     for (let i = 0; i < res.length; i++) {
       if (res[i].charAt(0) != '(') {
@@ -205,33 +222,15 @@ class NLParamParser {
       nvp.name = uname;
       // support for ifile
       if (uname == 'IFILE') {
-        await this.start(nvp.atom, depth + 1);
+        await this.start(nvp.atom, depth + 1, tnsFileStruct);
       } else {
         const unames = uname.split(","); //multiple aliases (alias1, alias2, alias3)
         for (let i = 0; i < unames.length; i++) {
-          this.ht.set(unames[i], nvp);
+          tnsFileStruct.aliasht.set(unames[i], nvp);
         }
       }
     }
   }
-  toString() {
-    let out = "";
-    this.ht.forEach((value) => {
-      out = out + value.toString() + "\n";
-    });
-    return out;
-  }
-  /**
-    * if key is address/port then it returns the port value from the
-    * address NVPAIR.
-    * @param {string} key
-    * @returns {string}
-   */
-  findValueOf(key) {
-    const myarr = key.split('/');
-    return (findValue(this.ht.get(myarr[0].toUpperCase()), myarr));
-  }
-
 }
 
 module.exports = {

package/lib/thin/sqlnet/sessionAtts.js

@@ -168,7 +168,7 @@ class SessionAtts {
     }
 
     if (!this.connectTimeout && !this.transportConnectTimeout)
-      this.transportConnectTimeout = 60 * 1000; /* Default to 60 secs */
+      this.transportConnectTimeout = constants.DEFAULT_TRANSPORT_CONNECT_TIMEOUT; /* Default to 20 secs */
   }
 
 }

package/lib/thin/util.js

@@ -29,6 +29,7 @@
 const constants = require('../constants');
 const errors = require('../errors.js');
 const os = require('os');
+const nodbUtil = require('../util.js');
 
 //---------------------------------------------------------------------------
 // populateClientInfo()
@@ -36,15 +37,15 @@ const os = require('os');
 // Populates client process information
 //---------------------------------------------------------------------------
 function populateClientInfo() {
-  this.program = process.argv0;
+  this.program = nodbUtil.sanitize(process.argv0);
   this.terminal = "unknown";
   this.pid = process.pid.toString();
   try {
-    this.userName = os.userInfo().username;
+    this.userName = nodbUtil.sanitize(os.userInfo().username);
   } catch {
     this.userName = "unknown";
   }
-  this.hostName = os.hostname();
+  this.hostName = nodbUtil.sanitize(os.hostname());
 }
 // Initialize client data on startup.
 const CLIENT_INFO = new populateClientInfo();