JavaScript request filter - MySQL

The JavaScript request filter is the most flexible of all request filters. It can potentially be called for any packet type, and can modify traffic in any way it sees fit.

Parameters

• Packet types : optional. If specified, a comma-separated list of packet types for which this filter should be called, for instance:  Parse,Bind,Close. Spaces are ignored.

• Client IPs: optional. If specified, a comma-separated (or line break separated) list of IP4 or IP6 addresses or regular expressions for IP addresses.

• Users: optional. If specified, a comma-separated (or line break separated) list of user names or regular expressions for user names.

Context

The following variables will always be defined when your JavaScript executes:

• log : the log object

• context : contains all the variables you'll commonly use:

  • packet : the packet being filtered

  • result : the result object, used to cancel the current packet if desired

  • filterContext: an object containing variables attached to this filter. Any changes to this object will be visible to all invocations of this filter.

  • connectionContext: an object containing variables attached to the connection. Any changes to this object will be visible to all filters defined on this connection.

Example

When connecting, it's common for a database client to issue the command show databases (MySQL documentation). We could restrict this with the following filter (appropriately configured) for Query packets:

let sql = context.packet.sql;
if (sql.trim().toLowerCase().startsWith("show databases")) {
    log.info("Changing show databases");
    context.packet.sql = "show databases like 'public_%'";
}