@depup/mysql2 3.19.0-depup.0

package/lib/commands/server_handshake.js

@@ -0,0 +1,202 @@
+'use strict';
+
+const CommandCode = require('../constants/commands.js');
+const Errors = require('../constants/errors.js');
+
+const Command = require('./command.js');
+const Packets = require('../packets/index.js');
+
+class ServerHandshake extends Command {
+  constructor(args) {
+    super();
+    this.args = args;
+    /*
+    this.protocolVersion = args.protocolVersion || 10;
+    this.serverVersion   = args.serverVersion;
+    this.connectionId    = args.connectionId,
+    this.statusFlags     = args.statusFlags,
+    this.characterSet    = args.characterSet,
+    this.capabilityFlags = args.capabilityFlags || 512;
+    */
+  }
+
+  start(packet, connection) {
+    const serverHelloPacket = new Packets.Handshake(this.args);
+    this.serverHello = serverHelloPacket;
+    serverHelloPacket.setScrambleData((err) => {
+      if (err) {
+        connection.emit('error', new Error('Error generating random bytes'));
+        return;
+      }
+      connection.writePacket(serverHelloPacket.toPacket(0));
+    });
+    return ServerHandshake.prototype.readClientReply;
+  }
+
+  readClientReply(packet, connection) {
+    // check auth here
+    const clientHelloReply = Packets.HandshakeResponse.fromPacket(packet);
+    // TODO check we don't have something similar already
+    connection.clientHelloReply = clientHelloReply;
+    if (this.args.authCallback) {
+      this.args.authCallback(
+        {
+          user: clientHelloReply.user,
+          database: clientHelloReply.database,
+          address: connection.stream.remoteAddress,
+          authPluginData1: this.serverHello.authPluginData1,
+          authPluginData2: this.serverHello.authPluginData2,
+          authToken: clientHelloReply.authToken,
+        },
+        (err, mysqlError) => {
+          // if (err)
+          if (!mysqlError) {
+            connection.writeOk();
+          } else {
+            // TODO create constants / errorToCode
+            // 1045 = ER_ACCESS_DENIED_ERROR
+            connection.writeError({
+              message: mysqlError.message || '',
+              code: mysqlError.code || 1045,
+            });
+            connection.close();
+          }
+        }
+      );
+    } else {
+      connection.writeOk();
+    }
+    return ServerHandshake.prototype.dispatchCommands;
+  }
+
+  _isStatement(query, name) {
+    const firstWord = query.split(' ')[0].toUpperCase();
+    return firstWord === name;
+  }
+
+  dispatchCommands(packet, connection) {
+    // command from client to server
+    let knownCommand = true;
+    const encoding = connection.clientHelloReply.encoding;
+    const commandCode = packet.readInt8();
+    switch (commandCode) {
+      case CommandCode.STMT_PREPARE:
+        if (connection.listeners('stmt_prepare').length) {
+          const query = packet.readString(undefined, encoding);
+          connection.emit('stmt_prepare', query);
+        } else {
+          connection.writeError({
+            code: Errors.HA_ERR_INTERNAL_ERROR,
+            message: 'No query handler for prepared statements.',
+          });
+        }
+        break;
+      case CommandCode.STMT_EXECUTE:
+        if (connection.listeners('stmt_execute').length) {
+          const { stmtId, flags, iterationCount, values } =
+            Packets.Execute.fromPacket(packet, encoding);
+          connection.emit(
+            'stmt_execute',
+            stmtId,
+            flags,
+            iterationCount,
+            values
+          );
+        } else {
+          connection.writeError({
+            code: Errors.HA_ERR_INTERNAL_ERROR,
+            message: 'No query handler for execute statements.',
+          });
+        }
+        break;
+      case CommandCode.QUIT:
+        if (connection.listeners('quit').length) {
+          connection.emit('quit');
+        } else {
+          connection.stream.end();
+        }
+        break;
+      case CommandCode.INIT_DB:
+        if (connection.listeners('init_db').length) {
+          const schemaName = packet.readString(undefined, encoding);
+          connection.emit('init_db', schemaName);
+        } else {
+          connection.writeOk();
+        }
+        break;
+      case CommandCode.QUERY:
+        if (connection.listeners('query').length) {
+          const query = packet.readString(undefined, encoding);
+          if (
+            this._isStatement(query, 'PREPARE') ||
+            this._isStatement(query, 'SET')
+          ) {
+            connection.emit('stmt_prepare', query);
+          } else if (this._isStatement(query, 'EXECUTE')) {
+            connection.emit('stmt_execute', null, null, null, null, query);
+          } else connection.emit('query', query);
+        } else {
+          connection.writeError({
+            code: Errors.HA_ERR_INTERNAL_ERROR,
+            message: 'No query handler',
+          });
+        }
+        break;
+      case CommandCode.FIELD_LIST:
+        if (connection.listeners('field_list').length) {
+          const table = packet.readNullTerminatedString(encoding);
+          const fields = packet.readString(undefined, encoding);
+          connection.emit('field_list', table, fields);
+        } else {
+          connection.writeError({
+            code: Errors.ER_WARN_DEPRECATED_SYNTAX,
+            message:
+              'As of MySQL 5.7.11, COM_FIELD_LIST is deprecated and will be removed in a future version of MySQL.',
+          });
+        }
+        break;
+      case CommandCode.PING:
+        if (connection.listeners('ping').length) {
+          connection.emit('ping');
+        } else {
+          connection.writeOk();
+        }
+        break;
+      default:
+        knownCommand = false;
+    }
+    if (connection.listeners('packet').length) {
+      connection.emit('packet', packet.clone(), knownCommand, commandCode);
+    } else if (!knownCommand) {
+      console.log('Unknown command:', commandCode);
+    }
+    return ServerHandshake.prototype.dispatchCommands;
+  }
+}
+
+module.exports = ServerHandshake;
+
+// TODO: implement server-side 4.1 authentication
+/*
+4.1 authentication: (http://bazaar.launchpad.net/~mysql/mysql-server/5.5/view/head:/sql/password.c)
+
+  SERVER:  public_seed=create_random_string()
+           send(public_seed)
+
+  CLIENT:  recv(public_seed)
+           hash_stage1=sha1("password")
+           hash_stage2=sha1(hash_stage1)
+           reply=xor(hash_stage1, sha1(public_seed,hash_stage2)
+
+           // this three steps are done in scramble()
+
+           send(reply)
+
+
+  SERVER:  recv(reply)
+           hash_stage1=xor(reply, sha1(public_seed,hash_stage2))
+           candidate_hash2=sha1(hash_stage1)
+           check(candidate_hash2==hash_stage2)
+
+server stores sha1(sha1(password)) ( hash_stag2)
+*/

package/lib/compressed_protocol.js

@@ -0,0 +1,153 @@
+'use strict';
+
+// connection mixins
+// implementation of http://dev.mysql.com/doc/internals/en/compression.html
+
+const zlib = require('zlib');
+const PacketParser = require('./packet_parser.js');
+
+class Queue {
+  constructor() {
+    this._queue = [];
+    this._running = false;
+  }
+
+  push(fn) {
+    this._queue.push(fn);
+    if (!this._running) {
+      this._running = true;
+      process.nextTick(() => this._next());
+    }
+  }
+
+  _next() {
+    const task = this._queue.shift();
+    if (!task) {
+      this._running = false;
+      return;
+    }
+    task({
+      done: () => process.nextTick(() => this._next()),
+    });
+  }
+}
+
+function handleCompressedPacket(packet) {
+  // eslint-disable-next-line consistent-this, no-invalid-this
+  const connection = this;
+  const deflatedLength = packet.readInt24();
+  const body = packet.readBuffer();
+
+  if (deflatedLength !== 0) {
+    connection.inflateQueue.push((task) => {
+      zlib.inflate(body, (err, data) => {
+        if (err) {
+          connection._handleNetworkError(err);
+          return;
+        }
+        connection._bumpCompressedSequenceId(packet.numPackets);
+        connection._inflatedPacketsParser.execute(data);
+        task.done();
+      });
+    });
+  } else {
+    connection.inflateQueue.push((task) => {
+      connection._bumpCompressedSequenceId(packet.numPackets);
+      connection._inflatedPacketsParser.execute(body);
+      task.done();
+    });
+  }
+}
+
+function writeCompressed(buffer) {
+  // http://dev.mysql.com/doc/internals/en/example-several-mysql-packets.html
+  // note: sending a MySQL Packet of the size 2^24−5 to 2^24−1 via compression
+  // leads to at least one extra compressed packet.
+  // (this is because "length of the packet before compression" need to fit
+  // into 3 byte unsigned int. "length of the packet before compression" includes
+  // 4 byte packet header, hence 2^24−5)
+  const MAX_COMPRESSED_LENGTH = 16777210;
+  let start;
+  if (buffer.length > MAX_COMPRESSED_LENGTH) {
+    for (start = 0; start < buffer.length; start += MAX_COMPRESSED_LENGTH) {
+      writeCompressed.call(
+        // eslint-disable-next-line no-invalid-this
+        this,
+        buffer.slice(start, start + MAX_COMPRESSED_LENGTH)
+      );
+    }
+    return;
+  }
+
+  // eslint-disable-next-line no-invalid-this, consistent-this
+  const connection = this;
+
+  let packetLen = buffer.length;
+  const compressHeader = Buffer.allocUnsafe(7);
+
+  // seqqueue is used here because zlib async execution is routed via thread pool
+  // internally and when we have multiple compressed packets arriving we need
+  // to assemble uncompressed result sequentially
+  (function (seqId) {
+    connection.deflateQueue.push((task) => {
+      zlib.deflate(buffer, (err, compressed) => {
+        if (err) {
+          connection._handleFatalError(err);
+          return;
+        }
+        let compressedLength = compressed.length;
+
+        if (compressedLength < packetLen) {
+          compressHeader.writeUInt8(compressedLength & 0xff, 0);
+          compressHeader.writeUInt16LE(compressedLength >> 8, 1);
+          compressHeader.writeUInt8(seqId, 3);
+          compressHeader.writeUInt8(packetLen & 0xff, 4);
+          compressHeader.writeUInt16LE(packetLen >> 8, 5);
+          connection.writeUncompressed(compressHeader);
+          connection.writeUncompressed(compressed);
+        } else {
+          // http://dev.mysql.com/doc/internals/en/uncompressed-payload.html
+          // To send an uncompressed payload:
+          //   - set length of payload before compression to 0
+          //   - the compressed payload contains the uncompressed payload instead.
+          compressedLength = packetLen;
+          packetLen = 0;
+          compressHeader.writeUInt8(compressedLength & 0xff, 0);
+          compressHeader.writeUInt16LE(compressedLength >> 8, 1);
+          compressHeader.writeUInt8(seqId, 3);
+          compressHeader.writeUInt8(packetLen & 0xff, 4);
+          compressHeader.writeUInt16LE(packetLen >> 8, 5);
+          connection.writeUncompressed(compressHeader);
+          connection.writeUncompressed(buffer);
+        }
+        task.done();
+      });
+    });
+  })(connection.compressedSequenceId);
+  connection._bumpCompressedSequenceId(1);
+}
+
+function enableCompression(connection) {
+  connection._lastWrittenPacketId = 0;
+  connection._lastReceivedPacketId = 0;
+
+  connection._handleCompressedPacket = handleCompressedPacket;
+  connection._inflatedPacketsParser = new PacketParser((p) => {
+    connection.handlePacket(p);
+  }, 4);
+  connection._inflatedPacketsParser._lastPacket = 0;
+  connection.packetParser = new PacketParser((packet) => {
+    connection._handleCompressedPacket(packet);
+  }, 7);
+
+  connection.writeUncompressed = connection.write;
+  connection.write = writeCompressed;
+
+  connection.inflateQueue = new Queue();
+  connection.deflateQueue = new Queue();
+}
+
+module.exports = {
+  enableCompression: enableCompression,
+  Queue: Queue,
+};

package/lib/connection.js

@@ -0,0 +1,12 @@
+'use strict';
+
+const BaseConnection = require('./base/connection.js');
+
+class Connection extends BaseConnection {
+  promise(promiseImpl) {
+    const PromiseConnection = require('./promise/connection.js');
+    return new PromiseConnection(this, promiseImpl);
+  }
+}
+
+module.exports = Connection;

package/lib/connection_config.js

@@ -0,0 +1,293 @@
+// This file was modified by Oracle on September 21, 2021.
+// New connection options for additional authentication factors were
+// introduced.
+// Multi-factor authentication capability is now enabled if one of these
+// options is used.
+// Modifications copyright (c) 2021, Oracle and/or its affiliates.
+
+'use strict';
+
+const { URL } = require('url');
+const ClientConstants = require('./constants/client');
+const Charsets = require('./constants/charsets');
+const { version } = require('../package.json');
+let SSLProfiles = null;
+
+const validOptions = {
+  authPlugins: 1,
+  authSwitchHandler: 1,
+  bigNumberStrings: 1,
+  charset: 1,
+  charsetNumber: 1,
+  compress: 1,
+  connectAttributes: 1,
+  connectTimeout: 1,
+  database: 1,
+  dateStrings: 1,
+  debug: 1,
+  decimalNumbers: 1,
+  enableKeepAlive: 1,
+  flags: 1,
+  host: 1,
+  insecureAuth: 1,
+  infileStreamFactory: 1,
+  isServer: 1,
+  keepAliveInitialDelay: 1,
+  localAddress: 1,
+  maxPreparedStatements: 1,
+  multipleStatements: 1,
+  namedPlaceholders: 1,
+  nestTables: 1,
+  password: 1,
+  // with multi-factor authentication, the main password (used for the first
+  // authentication factor) can be provided via password1
+  password1: 1,
+  password2: 1,
+  password3: 1,
+  passwordSha1: 1,
+  pool: 1,
+  port: 1,
+  queryFormat: 1,
+  rowsAsArray: 1,
+  socketPath: 1,
+  ssl: 1,
+  stream: 1,
+  stringifyObjects: 1,
+  supportBigNumbers: 1,
+  timezone: 1,
+  trace: 1,
+  typeCast: 1,
+  uri: 1,
+  user: 1,
+  disableEval: 1,
+  // These options are used for Pool
+  connectionLimit: 1,
+  maxIdle: 1,
+  idleTimeout: 1,
+  Promise: 1,
+  queueLimit: 1,
+  waitForConnections: 1,
+  jsonStrings: 1,
+  gracefulEnd: 1,
+};
+
+class ConnectionConfig {
+  constructor(options) {
+    if (typeof options === 'string') {
+      options = ConnectionConfig.parseUrl(options);
+    } else if (options && options.uri) {
+      const uriOptions = ConnectionConfig.parseUrl(options.uri);
+      for (const key in uriOptions) {
+        if (!Object.prototype.hasOwnProperty.call(uriOptions, key)) continue;
+        if (options[key]) continue;
+        options[key] = uriOptions[key];
+      }
+    }
+    for (const key in options) {
+      if (!Object.prototype.hasOwnProperty.call(options, key)) continue;
+      if (validOptions[key] !== 1) {
+        // REVIEW: Should this be emitted somehow?
+        console.error(
+          `Ignoring invalid configuration option passed to Connection: ${key}. This is currently a warning, but in future versions of MySQL2, an error will be thrown if you pass an invalid configuration option to a Connection`
+        );
+      }
+    }
+    this.isServer = options.isServer;
+    this.stream = options.stream;
+    this.host = options.host || 'localhost';
+    this.port =
+      (typeof options.port === 'string'
+        ? parseInt(options.port, 10)
+        : options.port) || 3306;
+    this.localAddress = options.localAddress;
+    this.socketPath = options.socketPath;
+    this.user = options.user || undefined;
+    // for the purpose of multi-factor authentication, or not, the main
+    // password (used for the 1st authentication factor) can also be
+    // provided via the "password1" option
+    this.password = options.password || options.password1 || undefined;
+    this.password2 = options.password2 || undefined;
+    this.password3 = options.password3 || undefined;
+    this.passwordSha1 = options.passwordSha1 || undefined;
+    this.database = options.database;
+    this.connectTimeout = isNaN(options.connectTimeout)
+      ? 10 * 1000
+      : options.connectTimeout;
+    this.insecureAuth = options.insecureAuth || false;
+    this.infileStreamFactory = options.infileStreamFactory || undefined;
+    this.supportBigNumbers = options.supportBigNumbers || false;
+    this.bigNumberStrings = options.bigNumberStrings || false;
+    this.decimalNumbers = options.decimalNumbers || false;
+    this.dateStrings = options.dateStrings || false;
+    this.debug = options.debug;
+    this.trace = options.trace !== false;
+    this.stringifyObjects = options.stringifyObjects || false;
+    this.enableKeepAlive = options.enableKeepAlive !== false;
+    this.keepAliveInitialDelay = options.keepAliveInitialDelay;
+    if (
+      options.timezone &&
+      !/^(?:local|Z|[ +-]\d\d:\d\d)$/.test(options.timezone)
+    ) {
+      // strictly supports timezones specified by mysqljs/mysql:
+      // https://github.com/mysqljs/mysql#user-content-connection-options
+
+      console.error(
+        `Ignoring invalid timezone passed to Connection: ${options.timezone}. This is currently a warning, but in future versions of MySQL2, an error will be thrown if you pass an invalid configuration option to a Connection`
+      );
+      // SqlStrings falls back to UTC on invalid timezone
+      this.timezone = 'Z';
+    } else {
+      this.timezone = options.timezone || 'local';
+    }
+    this.queryFormat = options.queryFormat;
+    this.pool = options.pool || undefined;
+    this.ssl =
+      typeof options.ssl === 'string'
+        ? ConnectionConfig.getSSLProfile(options.ssl)
+        : options.ssl || false;
+    this.multipleStatements = options.multipleStatements || false;
+    this.rowsAsArray = options.rowsAsArray || false;
+    this.namedPlaceholders = options.namedPlaceholders || false;
+    this.nestTables =
+      options.nestTables === undefined ? undefined : options.nestTables;
+    this.typeCast = options.typeCast === undefined ? true : options.typeCast;
+    this.disableEval = Boolean(options.disableEval);
+    if (this.timezone[0] === ' ') {
+      // "+" is a url encoded char for space so it
+      // gets translated to space when giving a
+      // connection string..
+      this.timezone = `+${this.timezone.slice(1)}`;
+    }
+    if (this.ssl) {
+      if (typeof this.ssl !== 'object') {
+        throw new TypeError(
+          `SSL profile must be an object, instead it's a ${typeof this.ssl}`
+        );
+      }
+      // Default rejectUnauthorized to true
+      this.ssl.rejectUnauthorized = this.ssl.rejectUnauthorized !== false;
+    }
+    this.maxPacketSize = 0;
+    this.charsetNumber = options.charset
+      ? ConnectionConfig.getCharsetNumber(options.charset)
+      : options.charsetNumber || Charsets.UTF8MB4_UNICODE_CI;
+    this.compress = options.compress || false;
+    this.authPlugins = options.authPlugins;
+    this.authSwitchHandler = options.authSwitchHandler;
+    this.clientFlags = ConnectionConfig.mergeFlags(
+      ConnectionConfig.getDefaultFlags(options),
+      options.flags || ''
+    );
+    // Default connection attributes
+    // https://dev.mysql.com/doc/refman/8.0/en/performance-schema-connection-attribute-tables.html
+    const defaultConnectAttributes = {
+      _client_name: 'Node-MySQL-2',
+      _client_version: version,
+    };
+    this.connectAttributes = {
+      ...defaultConnectAttributes,
+      ...(options.connectAttributes || {}),
+    };
+    this.maxPreparedStatements = options.maxPreparedStatements || 16000;
+    this.jsonStrings = options.jsonStrings || false;
+    this.gracefulEnd = options.gracefulEnd || false;
+  }
+
+  static mergeFlags(default_flags, user_flags) {
+    let flags = 0x0,
+      i;
+    if (!Array.isArray(user_flags)) {
+      user_flags = String(user_flags || '')
+        .toUpperCase()
+        .split(/\s*,+\s*/);
+    }
+    // add default flags unless "blacklisted"
+    for (i in default_flags) {
+      if (user_flags.indexOf(`-${default_flags[i]}`) >= 0) {
+        continue;
+      }
+      flags |= ClientConstants[default_flags[i]] || 0x0;
+    }
+    // add user flags unless already already added
+    for (i in user_flags) {
+      if (user_flags[i][0] === '-') {
+        continue;
+      }
+      if (default_flags.indexOf(user_flags[i]) >= 0) {
+        continue;
+      }
+      flags |= ClientConstants[user_flags[i]] || 0x0;
+    }
+    return flags;
+  }
+
+  static getDefaultFlags(options) {
+    const defaultFlags = [
+      'LONG_PASSWORD',
+      'FOUND_ROWS',
+      'LONG_FLAG',
+      'CONNECT_WITH_DB',
+      'ODBC',
+      'LOCAL_FILES',
+      'IGNORE_SPACE',
+      'PROTOCOL_41',
+      'IGNORE_SIGPIPE',
+      'TRANSACTIONS',
+      'RESERVED',
+      'SECURE_CONNECTION',
+      'MULTI_RESULTS',
+      'TRANSACTIONS',
+      'SESSION_TRACK',
+      'CONNECT_ATTRS',
+    ];
+    if (options && options.multipleStatements) {
+      defaultFlags.push('MULTI_STATEMENTS');
+    }
+    defaultFlags.push('PLUGIN_AUTH');
+    defaultFlags.push('PLUGIN_AUTH_LENENC_CLIENT_DATA');
+
+    return defaultFlags;
+  }
+
+  static getCharsetNumber(charset) {
+    const num = Charsets[charset.toUpperCase()];
+    if (num === undefined) {
+      throw new TypeError(`Unknown charset '${charset}'`);
+    }
+    return num;
+  }
+
+  static getSSLProfile(name) {
+    if (!SSLProfiles) {
+      SSLProfiles = require('./constants/ssl_profiles.js');
+    }
+    const ssl = SSLProfiles[name];
+    if (ssl === undefined) {
+      throw new TypeError(`Unknown SSL profile '${name}'`);
+    }
+    return ssl;
+  }
+
+  static parseUrl(url) {
+    const parsedUrl = new URL(url);
+    const options = {
+      host: decodeURIComponent(parsedUrl.hostname),
+      port: parseInt(parsedUrl.port, 10),
+      database: decodeURIComponent(parsedUrl.pathname.slice(1)),
+      user: decodeURIComponent(parsedUrl.username),
+      password: decodeURIComponent(parsedUrl.password),
+    };
+    parsedUrl.searchParams.forEach((value, key) => {
+      try {
+        // Try to parse this as a JSON expression first
+        options[key] = JSON.parse(value);
+      } catch {
+        // Otherwise assume it is a plain string
+        options[key] = value;
+      }
+    });
+    return options;
+  }
+}
+
+module.exports = ConnectionConfig;