oracledb 5.4.0 → 6.0.0

package/lib/thin/protocol/utils.js

@@ -0,0 +1,88 @@
+// Copyright (c) 2022, 2023, 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 constants = require('./constants');
+const crypto = require('crypto');
+
+class OutOfPacketsError extends Error { }
+
+function _convertBase64(result, value, size, offset) {
+  for (let i = 0;i < size;i++) {
+    result[offset + size - i - 1] = constants.TNS_BASE64_ALPHABET_ARRAY[value & 0x3f];
+    value = value >> 6;
+  }
+  return offset + size;
+}
+
+function encodeRowID(rowID) {
+  let offset = 0;
+  if (rowID.rba !== 0 || rowID.partitionID !== 0 || rowID.blockNum !== 0 || rowID.slotNum != 0) {
+    let result = Buffer.alloc(constants.TNS_MAX_ROWID_LENGTH);
+    offset = _convertBase64(result, rowID.rba, 6, offset);
+    offset = _convertBase64(result, rowID.partitionID, 3, offset);
+    offset = _convertBase64(result, rowID.blockNum, 6, offset);
+    _convertBase64(result, rowID.slotNum, 3, offset);
+    return result.toString('utf8');
+  }
+}
+
+// obfuscate value and clear memory for Buffers as they are from Buffer pool
+// and are possible to stay longer
+function setObfuscatedValue(value) {
+  const buf = crypto.randomBytes(Buffer.byteLength(value));
+  const bytes = Buffer.from(value, 'utf8');
+  const len = Buffer.byteLength(value);
+
+  let arr = [];
+  for (let i = 0; i < len; i++) {
+    arr.push(buf[i] ^ bytes[i]);
+  }
+  bytes.fill(0);
+  return {obfuscatedValue : buf, value : arr};
+}
+
+// returns the Deobfuscated value, after removing the obfuscation
+// and clear memory of temporary Buffers coming from Buffer pool
+function getDeobfuscatedValue(value, obfuscatedValue) {
+  const arr = [];
+  for (let i = 0; i < value.length; i++) {
+    arr.push(value[i] ^ obfuscatedValue[i]);
+  }
+  const buf = Buffer.from(arr);
+  arr.fill(0);
+  const retVal = buf.toString();
+  buf.fill(0);
+  return retVal;
+}
+
+module.exports = {
+  encodeRowID,
+  getDeobfuscatedValue,
+  OutOfPacketsError,
+  setObfuscatedValue
+};

package/lib/thin/resultSet.js

@@ -0,0 +1,122 @@
+// Copyright (c) 2022, 2023, 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 ResultSetImpl = require('../impl/resultset.js');
+const ExecuteMessage = require('./protocol/messages/execute.js');
+const FetchMessage = require('./protocol/messages/fetch.js');
+
+class ThinResultSetImpl extends ResultSetImpl {
+
+  //---------------------------------------------------------------------------
+  // _fetchMoreRows()
+  //
+  // Fetches more rows from the database. This is done by means of the full
+  // OAL8 RPC if needed; otherwise, the simpler OFETCH RPC is used.
+  //---------------------------------------------------------------------------
+  async _fetchMoreRows(options) {
+    const cls = (this.statement.requiresFullExecute) ? ExecuteMessage : FetchMessage;
+    const message = new cls(this.connection, this.statement, options, this);
+    await this.connection._protocol._processMessage(message);
+    this.statement.requiresFullExecute = false;
+  }
+
+  //---------------------------------------------------------------------------
+  // Set the metadata info for a new resultSet object
+  //---------------------------------------------------------------------------
+  _resultSetNew(connection, statement, options) {
+    this.connection = connection;
+    this.statement = statement;
+    this._nestedCursorIndices = [];
+    this.options = options;
+    this.prefetchRowsProcessed = false;
+    this.statement.bufferRowIndex = 0;
+  }
+
+  //---------------------------------------------------------------------------
+  // Returns the statement to cache so that it can be used later
+  //---------------------------------------------------------------------------
+  close() {
+    this.connection._returnStatement(this.statement);
+  }
+
+  //---------------------------------------------------------------------------
+  // Returns rows fetched to the common layer in array format
+  //---------------------------------------------------------------------------
+  _processRows(numRowsFetched) {
+    let rows = [];
+    let bufferRowIndex = this.statement.bufferRowIndex;
+    for (let row = bufferRowIndex; row < bufferRowIndex + numRowsFetched; row++) {
+      let rowObj = [];
+      for (let col = 0; col < this.statement.numQueryVars; col++) {
+        rowObj.push(this.statement.queryVars[col].values[row]);
+      }
+      rows.push(rowObj);
+    }
+    this.statement.bufferRowIndex += numRowsFetched;
+    if (this.statement.bufferRowIndex === this.statement.bufferRowCount) {
+      this.statement.bufferRowCount = 0;
+      this.statement.bufferRowIndex = 0;
+    }
+    return rows;
+  }
+
+  //---------------------------------------------------------------------------
+  // getRows()
+  //
+  // Fetches the specified number of rows from the database and returns them to
+  // the common layer for processing.
+  //---------------------------------------------------------------------------
+  async getRows(numRows, options) {
+    options.fetchArraySize = numRows || this.options.fetchArraySize;
+    options.prefetchRows = this.options.prefetchRows;
+    if (this.statement.bufferRowCount - this.statement.bufferRowIndex >= options.fetchArraySize) {
+      return this._processRows(options.fetchArraySize);
+    } else {
+      // We fetch for the required number of row
+      options.fetchArraySize = options.fetchArraySize - (this.statement.bufferRowCount - this.statement.bufferRowIndex);
+      let prevBufferRowCount = this.statement.bufferRowCount;
+      if (this.statement.moreRowsToFetch && options.fetchArraySize > 0) {
+        await this._fetchMoreRows(options);
+      }
+      options.fetchArraySize = numRows || this.options.fetchArraySize;
+      if (prevBufferRowCount === this.statement.bufferRowCount) {
+        let numRowsFetched = this.statement.bufferRowCount - this.statement.bufferRowIndex;
+        this.statement.bufferRowCount = 0;
+        if (numRowsFetched > 0) {
+          return this._processRows(numRowsFetched);
+        }
+        return [];
+      }
+    }
+    let numRowsFetched = this.statement.bufferRowCount - this.statement.bufferRowIndex;
+    return this._processRows(numRowsFetched);
+  }
+
+}
+
+module.exports = ThinResultSetImpl;

package/lib/thin/sqlnet/connStrategy.js

@@ -0,0 +1,175 @@
+// Copyright (c) 2022, 2023, 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 { NavAddress, NavAddressList, NavDescription, NavDescriptionList } = require("./navNodes.js");
+const { createNVPair } = require("./nvStrToNvPair.js");
+
+
+
+/**
+ * Class that holds all possible attributes under Description
+ */
+class ConnectDescription {
+  constructor() {
+    this.cOpts = new Array();
+  }
+
+  addConnectOption(opt) {
+    this.cOpts.push(opt);
+  }
+
+  getConnectOptions() {
+    return this.cOpts;
+  }
+
+}
+
+/**
+ * Class that holds a list of possible connection options.
+ */
+class ConnStrategy {
+  constructor() {
+    this.nextOptToTry = 0;
+    this.retryCount = 0;
+    this.lastRetryCounter = 0;
+    this.lastRetryConnectDescription = 0;
+    this.currentDescription = null;
+    this.descriptionList = new Array();
+    this.sBuf = new Array();
+  }
+
+  hasMoreOptions() {
+    let cOptsSize = 0;
+
+    for (let i = 0; i < this.descriptionList.length; ++i) {
+      cOptsSize += this.descriptionList[i].getConnectOptions().length;
+    }
+    return (this.nextOptToTry < cOptsSize);
+  }
+
+  newConnectionDescription() {
+    this.currentDescription = new ConnectDescription();
+    return this.currentDescription;
+  }
+
+  getcurrentDescription() {
+    return this.currentDescription;
+  }
+
+  closeDescription() {
+    this.descriptionList.push(this.currentDescription);
+    this.currentDescription = null;
+  }
+  /**
+  * Execute the Connection Options from the array.  When a refuse packet is received from
+  * server this method is called again and the next connect option is tried.
+  */
+  async execute(config) {
+    /* Check for retryCount in the config if no retryCount exists in the description string */
+    if (config != null) {
+      if (this.retryCount == 0 && config.retryCount > 0) {
+        this.retryCount = config.retryCount;
+      }
+    }
+    /* We try the address list at least once and upto (1 + retryCount) times */
+    for (let d = this.lastRetryConnectDescription; d < this.descriptionList.length; d++) {
+      let desc = this.descriptionList[d];
+      let cOpts = new Array();
+      cOpts = desc.getConnectOptions();
+      let delay = desc.delayInMillis;
+      /* check for retryDelay in config if it doesn't exist in description string */
+      if (config != null) {
+        if ((delay == 0 || delay == undefined) && config.retryDelay > 0) {
+          delay = config.retryDelay * 1000;
+        }
+      }
+      for (let i = this.lastRetryCounter; i <= this.retryCount; ++i) {
+        while (this.nextOptToTry < cOpts.length) {
+          let copt = cOpts[this.nextOptToTry];
+          this.lastRetryCounter = i;
+          this.lastRetryConnectDescription = d;
+          this.nextOptToTry++;
+          return copt;
+        }
+        this.nextOptToTry = 0;
+        // if we reached here then we are retrying other descriptor
+        if (delay > 0 && i < this.retryCount) {
+          await sleep(delay);
+        }// end of (delay > 0)
+
+      }// end of for(lastRetryCounter..retryCount)
+      this.lastRetryCounter = 0; // reset after one description is completed
+    }
+    // if we get here, all options were tried and none are valid
+    this.nextOptToTry = 1000;
+    this.lastRetryCounter = 1000;
+    throw new Error("All options tried");
+  }
+  // sleep time expects milliseconds
+
+
+}
+function sleep(time) {
+  return new Promise((resolve) => setTimeout(resolve, time));
+}
+
+
+/**
+ * create different nodes (schemaobject) as per the given input.
+ * @param {string} str - input description string
+ * @returns {object} - returns a connection strategy object.
+ */
+async function createNode(str) {
+  let nvpair;
+  if (typeof str === 'string')
+    nvpair = createNVPair(str);
+  else
+    nvpair = str; //Already a NVPair
+
+  let arg = nvpair.name.toUpperCase();
+  let navobj = null;
+  switch (arg) {
+    case "ADDRESS":
+      navobj = new NavAddress();
+      break;
+    case "ADDRESS_LIST":
+      navobj = new NavAddressList();
+      break;
+    case "DESCRIPTION":
+      navobj = new NavDescription();
+      break;
+    case "DESCRIPTION_LIST":
+      navobj = new NavDescriptionList();
+      break;
+  }
+  navobj.initFromNVPair(nvpair);
+  let cs = new ConnStrategy();
+  await navobj.navigate(cs);
+  return cs;
+}
+module.exports = { createNode };

package/lib/thin/sqlnet/constants.js

@@ -0,0 +1,199 @@
+// Copyright (c) 2022, 2023, 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.
+//
+//-----------------------------------------------------------------------------
+
+
+module.exports =  {
+  // TNS packet types
+  NSPTCN : 1,          // Connect
+  NSPTAC : 2,          // Accept
+  NSPTAK : 3,          // Acknowledge
+  NSPTRF : 4,          // Refuse
+  NSPTRD : 5,          // Redirect
+  NSPTDA : 6,          // Data
+  NSPTNL : 7,          // Null
+  NSPTAB : 9,          // Abort
+  NSPTRS : 11,         // Re-send
+  NSPTMK : 12,         // Marker
+  NSPTAT : 13,         // Attention
+  NSPTCNL : 14,        // Control information
+  NSPTDD  : 15,        // data descriptor
+  NSPTHI  : 19,        // Highest legal packet type
+
+  // Packet Header
+  NSPHDLEN  : 0,       // Packet length
+  NSPHDPSM  : 2,       // Packet checksum(deprecated in version 3.15 with large sdu support)
+  NSPHDTYP  : 4,       // Packet type
+  NSPHDFLGS : 5,       // Packet flags
+  NSPHDHSM  : 6,       // Header checksum
+  NSPSIZHD  : 8,       // Packet header size
+
+  /* Packet flags for NSPHDFLGS */
+  NSPFSID  : 0x01,     // SID is given
+  NSPFRDS  : 0x02,     // ReDirect Separation of cnda vs cndo
+  NSPFRDR  : 0x04,     // ReDiRected client Connect (NSPTCN)
+  NSPFLSD  : 0x20,     // packet with large sdu field
+  NO_HEADER_FLAGS : 0,
+  NSPFSRN  : 0x08,
+
+  // Connect Packet
+  NSPCNVSN   : 8,    // My version number
+  NSPCNLOV   : 10,   // Lowest version number I can be compatible with
+  NSPCNOPT   : 12,   // Global service options
+  NSPCNSDU   : 14,   // My SDU size
+  NSPCNTDU   : 16,   // Maximum TDU size
+  NSPCNNTC   : 18,   // NT characterstics
+  NSPCNTNA   : 20,   // Line turnaround value
+  NSPCNONE   : 22,   // The value '1' in my hardware byte order
+  NSPCNLEN   : 24,   // Length of connect data
+  NSPCNOFF   : 26,   // Offset to connect data
+  NSPCNMXC   : 28,   // Maximum connect data you can send me
+  NSPCNFL0   : 32,   // Connect flags
+  NSPCNFL1   : 33,
+  NSPCNTMO   : 50,   // local connection timeout val
+  NSPCNTCK   : 52,   // local tick size
+  NSPCNADL   : 54,
+  NSPCNAOF   : 56,   // offset to reconnect tns addr
+  NSPCNLSD   : 58,   // large sdu
+  NSPCNLTD   : 62,   // large tdu
+  NSPCNCFL   : 66,   // compression data
+  NSPCNCFL2  : 70,   // connect flag2
+  //  NSPCNV310DAT : (NSPCNTMO + 8), start of connect data, V3.10   packet
+  //  NSPCNV315DAT : (NSPCNCFL + 4),
+  NSPCNDAT : 74,      // Start connect data
+  NSPMXCDATA : 230,   // Maximum length of connect data
+  // Connect flags (Used mostly by NA)
+  NSINAWANTED               : 0x01, // Want to use NA
+  NSINAINTCHG               : 0x02, // Interchange involved
+  NSINADISABLEDFORCONNECTION: 0x04, // Disable NA
+  NSINANOSERVICES           : 0x08, // No NA services linked
+  NSINAREQUIRED             : 0x10, // NA is required
+  NSINAAUTHWANTED           : 0x20, // Authentication linked
+  NSISUPSECRENEG            : 0x80, // bkwrd comp: SUPport SECurity RE-NEG
+  // Connect options
+  NSGDONTCARE               : 0x0001, // "don't care"
+  NSGHDX                    : 0x0002, // half-duplex (w/ token management)
+  NSGFDX                    : 0x0004, // full-duplex
+  NSGHDRCHKSUM              : 0x0008, // checksum on packet header
+  NSGPAKCHKSUM              : 0x0010, // checksum on entire packet
+  NSGBROKEN                 : 0x0020, // provide broken connection notification
+  NSGUSEVIO                 : 0x0040, // can use Vectored I/O
+  NSGOSAUTHOK               : 0x0080, // use OS authentication
+  NSGSENDATTN               : 0x0200, // can send attention
+  NSGRECVATTN               : 0x0400, // can recv attention
+  NSGNOATTNPR               : 0x0800, // no attention processing
+  NSGRAW                    : 0x1000, // I/O is direct to/from transport
+  TNS_VERSION_DESIRED       : 319,
+  TNS_VERSION_MINIMUM       : 300,
+
+  /* Accept Packet */
+  NSPACVSN : 8,   // connection version
+  NSPACOPT : 10,  // global service options
+  NSPACSDU : 12,  // SDU size
+  NSPACTDU : 14,  // Maximum TDU
+  NSPACONE : 16,  // The value '1' in my hardware byte order
+  NSPACLEN : 18,  // connect data length
+  NSPACOFF : 20,  // offset to connect data
+  NSPACFL0 : 22,  // connect flags
+  NSPACFL1 : 23,
+  NSPACTMO : 24,  // connection pool timeout value
+  NSPACTCK : 26,  // local tick size
+  NSPACADL : 28,  // reconnect tns address length
+  NSPACAOF : 30,  // offset to reconnect tns addr
+  NSPACLSD : 32,  // Large sdu
+  NSPACLTD : 36,  // Large tdu
+  NSPACCFL : 40,  // compression flag
+  NSPACFL2 : 41,  // accept flag2 (4 bytes)
+  NSPACV310DAT : 32, /* start of accept data, V3.10     packet */
+  NSPACV315DAT : 41, // start of accept data, V3.15     packet
+
+  /* Refuse Packet */
+  NSPRFURS : 8,  // User (appliction) reason for refusal
+  NSPRFSRS : 9,  // System (NS) reason for
+  NSPRFLEN : 10, // Length of refuse data
+  NSPRFDAT : 12, // Start of connect data
+  // Compression flags
+  NSPACCFON : 0x80, // 1st MSB:  compression on/off
+  NSPACCFAT : 0x40, // 2nd MSB :   compression auto
+  NSPACCFNT : 0x02, // Second last LSB : compression for non-tcp protocol
+  // Accept flag2
+  NSPACOOB     : 0x00000001, // OOB support check at connection time
+  NSGPCHKSCMD  : 0x01000000, // Support for Poll and Check logic
+
+  /* Redirect packet */
+  NSPRDLEN : 8,   // Length of redirect data
+  NSPRDDAT : 10,  // Start of connect data
+
+  /* Data Packet */
+  NSPDAFLG  : 8,    // Data flags
+  NSPDADAT  : 10,   // Start of Data
+  NSPDAFEOF : 0x40, // "end of file"
+
+  /* Marker Packet */
+  NSPMKTYP : 8,     // marker type (see below)
+  NSPMKODT : 9,     // old (pre-V3.05) data byte
+  NSPMKDAT : 10,    // data byte
+  NSPMKTD0 : 0,     // data marker - 0 data bytes
+  NSPMKTD1 : 1,     // data marker - 1 data byte
+  NSPMKTAT : 2,     // Attention Marker
+  NIQBMARK : 1,     // Break marker
+  NIQRMARK : 2,     // Reset marker
+  NIQIMARK : 3,     // Interrupt marker
+
+  /* Control Packet */
+  NSPCTLCMD      : 8,  // Control Command length is 2 bytes
+  NSPCTLDAT      : 10, // Control Data length is specific to the Command type.
+  NSPCTL_SERR    : 8,  // Error Control Command Type
+  NSPCTL_CLRATTN : 9,  // Clear OOB option
+
+  /* OPTIONS */
+  NSPDFSDULN  : 8192,    // default SDU size
+  NSPABSSDULN : 2097152, // maximim SDU size
+  NSPMXSDULN  : 65535,   // maximim SDU size
+  NSPMNSDULN  : 512,     // minimum SDU size
+  NSPDFTDULN  : 2097152, // default TDU size
+  NSPMXTDULN  : 2097152, // maximum TDU size
+  NSPMNTDULN  : 255,     // minimum TDU size
+  NSFIMM      : 0x0040,  // immediate close
+
+  /* PARAMETERS */
+  DISABLE_OOB_STR      : 'DISABLE_OOB', // disable OOB parameter
+  EXPIRE_TIME          : 'EXPIRE_TIME', // expire Time
+  PEM_WALLET_FILE_NAME : 'ewallet.pem',
+
+  /* Get/Set options */
+  NT_MOREDATA : 1, // More Data in Transport available
+  NS_MOREDATA : 2, // More Data available to be read
+  SVCNAME     : 3, // Service name
+  SERVERTYPE  : 4, // Server type
+  REMOTEADDR  : 5, // Remote Address
+  HEALTHCHECK : 6, // Health check of connection
+  CONNCLASS   : 7, // Connection Class
+  PURITY      : 8, // Purity
+  SID         : 9, // SID
+
+  /* FLAGS */
+  NSNOBLOCK : 0x0001, // Do not block
+};