oceanbase 0.0.1

package/lib/packets/execute.js

@@ -0,0 +1,214 @@
+'use strict';
+
+const CursorType = require('../constants/cursor');
+const CommandCodes = require('../constants/commands');
+const Types = require('../constants/types');
+const Packet = require('../packets/packet');
+const CharsetToEncoding = require('../constants/charset_encodings.js');
+
+function isJSON(value) {
+  return (
+    Array.isArray(value) ||
+    value.constructor === Object ||
+    (typeof value.toJSON === 'function' && !Buffer.isBuffer(value))
+  );
+}
+
+/**
+ * Converts a value to an object describing type, String/Buffer representation and length
+ * @param {*} value
+ */
+function toParameter(value, encoding, timezone) {
+  let type = Types.VAR_STRING;
+  let length;
+  let writer = function (value) {
+    // eslint-disable-next-line no-invalid-this
+    return Packet.prototype.writeLengthCodedString.call(this, value, encoding);
+  };
+  if (value !== null) {
+    switch (typeof value) {
+      case 'undefined':
+        throw new TypeError('Bind parameters must not contain undefined');
+
+      case 'number':
+        type = Types.DOUBLE;
+        length = 8;
+        writer = Packet.prototype.writeDouble;
+        break;
+
+      case 'boolean':
+        value = value | 0;
+        type = Types.TINY;
+        length = 1;
+        writer = Packet.prototype.writeInt8;
+        break;
+
+      case 'object':
+        if (Object.prototype.toString.call(value) === '[object Date]') {
+          type = Types.DATETIME;
+          length = 12;
+          writer = function (value) {
+            // eslint-disable-next-line no-invalid-this
+            return Packet.prototype.writeDate.call(this, value, timezone);
+          };
+        } else if (isJSON(value)) {
+          value = JSON.stringify(value);
+          type = Types.JSON;
+        } else if (Buffer.isBuffer(value)) {
+          length = Packet.lengthCodedNumberLength(value.length) + value.length;
+          writer = Packet.prototype.writeLengthCodedBuffer;
+        }
+        break;
+
+      default:
+        value = value.toString();
+    }
+  } else {
+    value = '';
+    type = Types.NULL;
+  }
+  if (!length) {
+    length = Packet.lengthCodedStringLength(value, encoding);
+  }
+  return { value, type, length, writer };
+}
+
+class Execute {
+  constructor(id, parameters, charsetNumber, timezone) {
+    this.id = id;
+    this.parameters = parameters;
+    this.encoding = CharsetToEncoding[charsetNumber];
+    this.timezone = timezone;
+  }
+
+  static fromPacket(packet, encoding) {
+    const stmtId = packet.readInt32();
+    const flags = packet.readInt8();
+    const iterationCount = packet.readInt32();
+
+    let i = packet.offset;
+    while (i < packet.end - 1) {
+      if (
+        (packet.buffer[i + 1] === Types.VAR_STRING ||
+          packet.buffer[i + 1] === Types.NULL ||
+          packet.buffer[i + 1] === Types.DOUBLE ||
+          packet.buffer[i + 1] === Types.TINY ||
+          packet.buffer[i + 1] === Types.DATETIME ||
+          packet.buffer[i + 1] === Types.JSON) &&
+        packet.buffer[i] === 1 &&
+        packet.buffer[i + 2] === 0
+      ) {
+        break;
+      } else {
+        packet.readInt8();
+      }
+      i++;
+    }
+
+    const types = [];
+
+    for (let i = packet.offset + 1; i < packet.end - 1; i++) {
+      if (
+        (packet.buffer[i] === Types.VAR_STRING ||
+          packet.buffer[i] === Types.NULL ||
+          packet.buffer[i] === Types.DOUBLE ||
+          packet.buffer[i] === Types.TINY ||
+          packet.buffer[i] === Types.DATETIME ||
+          packet.buffer[i] === Types.JSON) &&
+        packet.buffer[i + 1] === 0
+      ) {
+        types.push(packet.buffer[i]);
+        packet.skip(2);
+      }
+    }
+
+    packet.skip(1);
+
+    const values = [];
+    for (let i = 0; i < types.length; i++) {
+      if (types[i] === Types.VAR_STRING) {
+        values.push(packet.readLengthCodedString(encoding));
+      } else if (types[i] === Types.DOUBLE) {
+        values.push(packet.readDouble());
+      } else if (types[i] === Types.TINY) {
+        values.push(packet.readInt8());
+      } else if (types[i] === Types.DATETIME) {
+        values.push(packet.readDateTime());
+      } else if (types[i] === Types.JSON) {
+        values.push(JSON.parse(packet.readLengthCodedString(encoding)));
+      }
+      if (types[i] === Types.NULL) {
+        values.push(null);
+      }
+    }
+
+    return { stmtId, flags, iterationCount, values };
+  }
+
+  toPacket() {
+    // TODO: don't try to calculate packet length in advance, allocate some big buffer in advance (header + 256 bytes?)
+    // and copy + reallocate if not enough
+    // 0 + 4 - length, seqId
+    // 4 + 1 - COM_EXECUTE
+    // 5 + 4 - stmtId
+    // 9 + 1 - flags
+    // 10 + 4 - iteration-count (always 1)
+    let length = 14;
+    let parameters;
+    if (this.parameters && this.parameters.length > 0) {
+      length += Math.floor((this.parameters.length + 7) / 8);
+      length += 1; // new-params-bound-flag
+      length += 2 * this.parameters.length; // type byte for each parameter if new-params-bound-flag is set
+      parameters = this.parameters.map((value) =>
+        toParameter(value, this.encoding, this.timezone)
+      );
+      length += parameters.reduce(
+        (accumulator, parameter) => accumulator + parameter.length,
+        0
+      );
+    }
+    const buffer = Buffer.allocUnsafe(length);
+    const packet = new Packet(0, buffer, 0, length);
+    packet.offset = 4;
+    packet.writeInt8(CommandCodes.STMT_EXECUTE);
+    packet.writeInt32(this.id);
+    packet.writeInt8(CursorType.NO_CURSOR); // flags
+    packet.writeInt32(1); // iteration-count, always 1
+    if (parameters) {
+      let bitmap = 0;
+      let bitValue = 1;
+      parameters.forEach((parameter) => {
+        if (parameter.type === Types.NULL) {
+          bitmap += bitValue;
+        }
+        bitValue *= 2;
+        if (bitValue === 256) {
+          packet.writeInt8(bitmap);
+          bitmap = 0;
+          bitValue = 1;
+        }
+      });
+      if (bitValue !== 1) {
+        packet.writeInt8(bitmap);
+      }
+      // TODO: explain meaning of the flag
+      // afaik, if set n*2 bytes with type of parameter are sent before parameters
+      // if not, previous execution types are used (TODO prooflink)
+      packet.writeInt8(1); // new-params-bound-flag
+      // Write parameter types
+      parameters.forEach((parameter) => {
+        packet.writeInt8(parameter.type); // field type
+        packet.writeInt8(0); // parameter flag
+      });
+      // Write parameter values
+      parameters.forEach((parameter) => {
+        if (parameter.type !== Types.NULL) {
+          parameter.writer.call(packet, parameter.value);
+        }
+      });
+    }
+    return packet;
+  }
+}
+
+module.exports = Execute;

package/lib/packets/handshake.js

@@ -0,0 +1,112 @@
+'use strict';
+
+const Packet = require('../packets/packet');
+const ClientConstants = require('../constants/client.js');
+
+// https://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::Handshake
+
+class Handshake {
+  constructor(args) {
+    this.protocolVersion = args.protocolVersion;
+    this.serverVersion = args.serverVersion;
+    this.capabilityFlags = args.capabilityFlags;
+    this.connectionId = args.connectionId;
+    this.authPluginData1 = args.authPluginData1;
+    this.authPluginData2 = args.authPluginData2;
+    this.characterSet = args.characterSet;
+    this.statusFlags = args.statusFlags;
+    this.authPluginName = args.authPluginName;
+  }
+
+  setScrambleData(cb) {
+    require('crypto').randomBytes(20, (err, data) => {
+      if (err) {
+        cb(err);
+        return;
+      }
+      this.authPluginData1 = data.slice(0, 8);
+      this.authPluginData2 = data.slice(8, 20);
+      cb();
+    });
+  }
+
+  toPacket(sequenceId) {
+    const length = 68 + Buffer.byteLength(this.serverVersion, 'utf8');
+    const buffer = Buffer.alloc(length + 4, 0); // zero fill, 10 bytes filler later needs to contain zeros
+    const packet = new Packet(sequenceId, buffer, 0, length + 4);
+    packet.offset = 4;
+    packet.writeInt8(this.protocolVersion);
+    packet.writeString(this.serverVersion, 'cesu8');
+    packet.writeInt8(0);
+    packet.writeInt32(this.connectionId);
+    packet.writeBuffer(this.authPluginData1);
+    packet.writeInt8(0);
+    const capabilityFlagsBuffer = Buffer.allocUnsafe(4);
+    capabilityFlagsBuffer.writeUInt32LE(this.capabilityFlags, 0);
+    packet.writeBuffer(capabilityFlagsBuffer.slice(0, 2));
+    packet.writeInt8(this.characterSet);
+    packet.writeInt16(this.statusFlags);
+    packet.writeBuffer(capabilityFlagsBuffer.slice(2, 4));
+    packet.writeInt8(21); // authPluginDataLength
+    packet.skip(10);
+    packet.writeBuffer(this.authPluginData2);
+    packet.writeInt8(0);
+    packet.writeString('mysql_native_password', 'latin1');
+    packet.writeInt8(0);
+    return packet;
+  }
+
+  static fromPacket(packet) {
+    const args = {};
+    args.protocolVersion = packet.readInt8();
+    args.serverVersion = packet.readNullTerminatedString('cesu8');
+    args.connectionId = packet.readInt32();
+    args.authPluginData1 = packet.readBuffer(8);
+    packet.skip(1);
+    const capabilityFlagsBuffer = Buffer.allocUnsafe(4);
+    capabilityFlagsBuffer[0] = packet.readInt8();
+    capabilityFlagsBuffer[1] = packet.readInt8();
+    if (packet.haveMoreData()) {
+      args.characterSet = packet.readInt8();
+      args.statusFlags = packet.readInt16();
+      // upper 2 bytes
+      capabilityFlagsBuffer[2] = packet.readInt8();
+      capabilityFlagsBuffer[3] = packet.readInt8();
+      args.capabilityFlags = capabilityFlagsBuffer.readUInt32LE(0);
+      if (args.capabilityFlags & ClientConstants.PLUGIN_AUTH) {
+        args.authPluginDataLength = packet.readInt8();
+      } else {
+        args.authPluginDataLength = 0;
+        packet.skip(1);
+      }
+      packet.skip(10);
+    } else {
+      args.capabilityFlags = capabilityFlagsBuffer.readUInt16LE(0);
+    }
+
+    const isSecureConnection =
+      args.capabilityFlags & ClientConstants.SECURE_CONNECTION;
+    if (isSecureConnection) {
+      const authPluginDataLength = args.authPluginDataLength;
+      if (authPluginDataLength === 0) {
+        // for Secure Password Authentication
+        args.authPluginDataLength = 20;
+        args.authPluginData2 = packet.readBuffer(12);
+        packet.skip(1);
+      } else {
+        // length > 0
+        // for Custom Auth Plugin (PLUGIN_AUTH)
+        const len = Math.max(13, authPluginDataLength - 8);
+        args.authPluginData2 = packet.readBuffer(len);
+      }
+    }
+
+    if (args.capabilityFlags & ClientConstants.PLUGIN_AUTH) {
+      args.authPluginName = packet.readNullTerminatedString('ascii');
+    }
+
+    return new Handshake(args);
+  }
+}
+
+module.exports = Handshake;

package/lib/packets/handshake_response.js

@@ -0,0 +1,144 @@
+'use strict';
+
+const ClientConstants = require('../constants/client.js');
+const CharsetToEncoding = require('../constants/charset_encodings.js');
+const Packet = require('../packets/packet.js');
+
+const auth41 = require('../auth_41.js');
+
+class HandshakeResponse {
+  constructor(handshake) {
+    this.user = handshake.user || '';
+    this.database = handshake.database || '';
+    this.password = handshake.password || '';
+    this.passwordSha1 = handshake.passwordSha1;
+    this.authPluginData1 = handshake.authPluginData1;
+    this.authPluginData2 = handshake.authPluginData2;
+    this.compress = handshake.compress;
+    this.clientFlags = handshake.flags;
+    // TODO: pre-4.1 auth support
+    let authToken;
+    if (this.passwordSha1) {
+      authToken = auth41.calculateTokenFromPasswordSha(
+        this.passwordSha1,
+        this.authPluginData1,
+        this.authPluginData2
+      );
+    } else {
+      authToken = auth41.calculateToken(
+        this.password,
+        this.authPluginData1,
+        this.authPluginData2
+      );
+    }
+    this.authToken = authToken;
+    this.charsetNumber = handshake.charsetNumber;
+    this.encoding = CharsetToEncoding[handshake.charsetNumber];
+    this.connectAttributes = handshake.connectAttributes;
+  }
+
+  serializeResponse(buffer) {
+    const isSet = (flag) => this.clientFlags & ClientConstants[flag];
+    const packet = new Packet(0, buffer, 0, buffer.length);
+    packet.offset = 4;
+    packet.writeInt32(this.clientFlags);
+    packet.writeInt32(0); // max packet size. todo: move to config
+    packet.writeInt8(this.charsetNumber);
+    packet.skip(23);
+    const encoding = this.encoding;
+    packet.writeNullTerminatedString(this.user, encoding);
+    let k;
+    if (isSet('PLUGIN_AUTH_LENENC_CLIENT_DATA')) {
+      packet.writeLengthCodedNumber(this.authToken.length);
+      packet.writeBuffer(this.authToken);
+    } else if (isSet('SECURE_CONNECTION')) {
+      packet.writeInt8(this.authToken.length);
+      packet.writeBuffer(this.authToken);
+    } else {
+      packet.writeBuffer(this.authToken);
+      packet.writeInt8(0);
+    }
+    if (isSet('CONNECT_WITH_DB')) {
+      packet.writeNullTerminatedString(this.database, encoding);
+    }
+    if (isSet('PLUGIN_AUTH')) {
+      // TODO: pass from config
+      packet.writeNullTerminatedString('mysql_native_password', 'latin1');
+    }
+    if (isSet('CONNECT_ATTRS')) {
+      const connectAttributes = this.connectAttributes || {};
+      const attrNames = Object.keys(connectAttributes);
+      let keysLength = 0;
+      for (k = 0; k < attrNames.length; ++k) {
+        keysLength += Packet.lengthCodedStringLength(attrNames[k], encoding);
+        keysLength += Packet.lengthCodedStringLength(
+          connectAttributes[attrNames[k]],
+          encoding
+        );
+      }
+      packet.writeLengthCodedNumber(keysLength);
+      for (k = 0; k < attrNames.length; ++k) {
+        packet.writeLengthCodedString(attrNames[k], encoding);
+        packet.writeLengthCodedString(
+          connectAttributes[attrNames[k]],
+          encoding
+        );
+      }
+    }
+    return packet;
+  }
+
+  toPacket() {
+    if (typeof this.user !== 'string') {
+      throw new Error('"user" connection config property must be a string');
+    }
+    if (typeof this.database !== 'string') {
+      throw new Error('"database" connection config property must be a string');
+    }
+    // dry run: calculate resulting packet length
+    const p = this.serializeResponse(Packet.MockBuffer());
+    return this.serializeResponse(Buffer.alloc(p.offset));
+  }
+  static fromPacket(packet) {
+    const args = {};
+    args.clientFlags = packet.readInt32();
+    function isSet(flag) {
+      return args.clientFlags & ClientConstants[flag];
+    }
+    args.maxPacketSize = packet.readInt32();
+    args.charsetNumber = packet.readInt8();
+    const encoding = CharsetToEncoding[args.charsetNumber];
+    args.encoding = encoding;
+    packet.skip(23);
+    args.user = packet.readNullTerminatedString(encoding);
+    let authTokenLength;
+    if (isSet('PLUGIN_AUTH_LENENC_CLIENT_DATA')) {
+      authTokenLength = packet.readLengthCodedNumber(encoding);
+      args.authToken = packet.readBuffer(authTokenLength);
+    } else if (isSet('SECURE_CONNECTION')) {
+      authTokenLength = packet.readInt8();
+      args.authToken = packet.readBuffer(authTokenLength);
+    } else {
+      args.authToken = packet.readNullTerminatedString(encoding);
+    }
+    if (isSet('CONNECT_WITH_DB')) {
+      args.database = packet.readNullTerminatedString(encoding);
+    }
+    if (isSet('PLUGIN_AUTH')) {
+      args.authPluginName = packet.readNullTerminatedString(encoding);
+    }
+    if (isSet('CONNECT_ATTRS')) {
+      const keysLength = packet.readLengthCodedNumber(encoding);
+      const keysEnd = packet.offset + keysLength;
+      const attrs = {};
+      while (packet.offset < keysEnd) {
+        attrs[packet.readLengthCodedString(encoding)] =
+          packet.readLengthCodedString(encoding);
+      }
+      args.connectAttributes = attrs;
+    }
+    return args;
+  }
+}
+
+module.exports = HandshakeResponse;

package/lib/packets/index.js

@@ -0,0 +1,152 @@
+// This file was modified by Oracle on June 1, 2021.
+// A utility method was introduced to generate an Error instance from a
+// binary server packet.
+// Modifications copyright (c) 2021, Oracle and/or its affiliates.
+
+// This file was modified by Oracle on September 21, 2021.
+// The new AuthNextFactor packet is now available.
+// Modifications copyright (c) 2021, Oracle and/or its affiliates.
+
+'use strict';
+
+const process = require('process');
+
+const AuthNextFactor = require('./auth_next_factor');
+const AuthSwitchRequest = require('./auth_switch_request');
+const AuthSwitchRequestMoreData = require('./auth_switch_request_more_data');
+const AuthSwitchResponse = require('./auth_switch_response');
+const BinaryRow = require('./binary_row');
+const BinlogDump = require('./binlog_dump');
+const ChangeUser = require('./change_user');
+const CloseStatement = require('./close_statement');
+const ColumnDefinition = require('./column_definition');
+const Execute = require('./execute');
+const Handshake = require('./handshake');
+const HandshakeResponse = require('./handshake_response');
+const PrepareStatement = require('./prepare_statement');
+const PreparedStatementHeader = require('./prepared_statement_header');
+const Query = require('./query');
+const RegisterSlave = require('./register_slave');
+const ResultSetHeader = require('./resultset_header');
+const SSLRequest = require('./ssl_request');
+const TextRow = require('./text_row');
+
+const ctorMap = {
+  AuthNextFactor,
+  AuthSwitchRequest,
+  AuthSwitchRequestMoreData,
+  AuthSwitchResponse,
+  BinaryRow,
+  BinlogDump,
+  ChangeUser,
+  CloseStatement,
+  ColumnDefinition,
+  Execute,
+  Handshake,
+  HandshakeResponse,
+  PrepareStatement,
+  PreparedStatementHeader,
+  Query,
+  RegisterSlave,
+  ResultSetHeader,
+  SSLRequest,
+  TextRow,
+};
+Object.entries(ctorMap).forEach(([name, ctor]) => {
+  module.exports[name] = ctor;
+  // monkey-patch it to include name if debug is on
+  if (process.env.NODE_DEBUG) {
+    if (ctor.prototype.toPacket) {
+      const old = ctor.prototype.toPacket;
+      ctor.prototype.toPacket = function () {
+        const p = old.call(this);
+        p._name = name;
+        return p;
+      };
+    }
+  }
+});
+
+// simple packets:
+const Packet = require('./packet');
+exports.Packet = Packet;
+
+class OK {
+  static toPacket(args, encoding) {
+    args = args || {};
+    const affectedRows = args.affectedRows || 0;
+    const insertId = args.insertId || 0;
+    const serverStatus = args.serverStatus || 0;
+    const warningCount = args.warningCount || 0;
+    const message = args.message || '';
+
+    let length = 9 + Packet.lengthCodedNumberLength(affectedRows);
+    length += Packet.lengthCodedNumberLength(insertId);
+
+    const buffer = Buffer.allocUnsafe(length);
+    const packet = new Packet(0, buffer, 0, length);
+    packet.offset = 4;
+    packet.writeInt8(0);
+    packet.writeLengthCodedNumber(affectedRows);
+    packet.writeLengthCodedNumber(insertId);
+    packet.writeInt16(serverStatus);
+    packet.writeInt16(warningCount);
+    packet.writeString(message, encoding);
+    packet._name = 'OK';
+    return packet;
+  }
+}
+
+exports.OK = OK;
+
+// warnings, statusFlags
+class EOF {
+  static toPacket(warnings, statusFlags) {
+    if (typeof warnings === 'undefined') {
+      warnings = 0;
+    }
+    if (typeof statusFlags === 'undefined') {
+      statusFlags = 0;
+    }
+    const packet = new Packet(0, Buffer.allocUnsafe(9), 0, 9);
+    packet.offset = 4;
+    packet.writeInt8(0xfe);
+    packet.writeInt16(warnings);
+    packet.writeInt16(statusFlags);
+    packet._name = 'EOF';
+    return packet;
+  }
+}
+
+exports.EOF = EOF;
+
+class Error {
+  static toPacket(args, encoding) {
+    const length = 13 + Buffer.byteLength(args.message, 'utf8');
+    const packet = new Packet(0, Buffer.allocUnsafe(length), 0, length);
+    packet.offset = 4;
+    packet.writeInt8(0xff);
+    packet.writeInt16(args.code);
+    // TODO: sql state parameter
+    packet.writeString('#_____', encoding);
+    packet.writeString(args.message, encoding);
+    packet._name = 'Error';
+    return packet;
+  }
+
+  static fromPacket(packet) {
+    packet.readInt8(); // marker
+    const code = packet.readInt16();
+    packet.readString(1, 'ascii'); // sql state marker
+    // The SQL state of the ERR_Packet which is always 5 bytes long.
+    // https://dev.mysql.com/doc/dev/mysql-server/8.0.11/page_protocol_basic_dt_strings.html#sect_protocol_basic_dt_string_fix
+    packet.readString(5, 'ascii'); // sql state (ignore for now)
+    const message = packet.readNullTerminatedString('utf8');
+    const error = new Error();
+    error.message = message;
+    error.code = code;
+    return error;
+  }
+}
+
+exports.Error = Error;