toxy
Advanced tools
Readme
toxy is a fully programmatic and hackable HTTP proxy to simulate server failure scenarios and unexpected network conditions, built for node.js/io.js.
It was mainly designed for fuzzing/evil testing purposes, toxy becomes particulary useful to cover fault tolerance and resiliency capabilities of a system, especially in service-oriented architectures, where toxy may act as intermediate proxy among services.
toxy allows you to plug in poisons, optionally filtered by rules, which essentially can intercept and alter the HTTP flow as you need, performing multiple evil actions in the middle of that process, such as limiting the bandwidth, delaying TCP packets, injecting network jitter latency or replying with a custom error or status code.
toxy can be fluently used programmatically or via HTTP API. It's compatible with connect/express, and it was built on top of rocky, a full-featured middleware-oriented HTTP proxy.
Requires node.js +0.12 or io.js +1.6
There're some other similar solutions like toxy in the market, but most of them do not provide a proper programmatic control and usually are not easy to hack, configure and/or extend. Additionally, most of the those solutions only operate at TCP level stack instead of providing high-level abstraction to cover common requirements of the specific domain and nature of the HTTP protocol, like toxy does.
toxy provides a powerful hackable and extensible solution with a convenient abstraction, but also a low-level interface and programmatic capabilities exposed as a simple, concise and fluent API, with the implicit power, simplicity and fun of node.js.
toxy introduces two core directives that you can plug in the proxy and should knowing before using: poisons and rules.
Poisons are the specific logic to infect an incoming or outgoing HTTP flow (e.g: injecting a latency, replying with an error). HTTP flow can be poisoned by one or multiple poisons, and poisons can be plugged to infect both global or route level incoming traffic.
Rules are a kind of validation filters that can be reused and applied to global incoming HTTP traffic, route level traffic or into a specific poison. Their responsability is to determine, via inspecting each incoming HTTP request, if the registered poisons should be enabled or not, and therefore infecting or not the HTTP traffic (e.g: match headers, query params, method, body...).
↓ ( Incoming request ) ↓
↓ ||| ↓
↓ ---------------- ↓
↓ | Toxy Router | ↓ --> Match the incoming request
↓ ---------------- ↓
↓ ||| ↓
↓ ---------------- ↓
↓ | Exec Rules | ↓ --> Apply configured rules for the request
↓ ---------------- ↓
↓ ||| ↓
↓ ---------------- ↓
↓ | Exec Poisons | ↓ --> If all rules passed, then poison the HTTP flow
↓ ---------------- ↓
↓ / \ ↓
↓ \ / ↓
↓ ------------------- ↓
↓ | HTTP dispatcher | ↓ --> Proxy the HTTP traffic, either poisoned or not
↓ ------------------- ↓
npm install toxy
See examples directory for more use cases.
var toxy = require('toxy')
var poisons = toxy.poisons
var rules = toxy.rules
// Create a new toxy proxy
var proxy = toxy()
// Default server to forward incoming traffic
proxy
.forward('http://httpbin.org')
// Register global poisons and rules
proxy
.poison(poisons.latency({ jitter: 500 }))
.rule(rules.probability(25))
// Register multiple routes
proxy
.get('/download/*')
.forward('http://files.myserver.net')
.poison(poisons.bandwidth({ bps: 1024 }))
.withRule(rules.headers({'Authorization': /^Bearer (.*)$/i }))
proxy
.get('/image/*')
.poison(poisons.bandwidth({ bps: 512 }))
proxy
.all('/api/*')
.poison(poisons.rateLimit({ limit: 10, threshold: 1000 }))
.withRule(rules.method(['POST', 'PUT', 'DELETE']))
// And use a different more permissive poison for GET requests
.poison(poisons.rateLimit({ limit: 50, threshold: 1000 }))
.withRule(rules.method('GET'))
// Handle the rest of the traffic
proxy
.all('/*')
.poison(poisons.slowClose({ delay: 1000 }))
.poison(poisons.slowRead({ bps: 128 }))
.withRule(rules.probability(50))
proxy.listen(3000)
console.log('Server listening on port:', 3000)
console.log('Test it:', 'http://localhost:3000/image/jpeg')
Poisons host specific logic which intercepts and mutates, wraps, modify and/or cancel an HTTP transaction in the proxy server. Poisons can be applied to incoming or outgoing, or even both traffic flows.
Poisons can be composed and reused for different HTTP scenarios. They are executed in FIFO order and asynchronously.
Name: latency
Infects the HTTP flow injecting a latency jitter in the response
Arguments:
object
number - Jitter value in milisecondsnumber - Random jitter maximum valuenumber - Random jitter minimum valuetoxy.poison(toxy.poisons.latency({ jitter: 1000 }))
// Or alternatively using a random value
toxy.poison(toxy.poisons.latency({ max: 1000, min: 100 }))
Name: inject
Injects a custom response, intercepting the request before sending it to the target server. Useful to inject errors originated in the server.
Arguments:
object
number - Response HTTP status codeobject - Optional headers to sendmixed - Optional body data to sendstring - Body encoding. Default to utf8toxy.poison(toxy.poisons.inject({
code: 503,
body: '{"error": "toxy injected error"}',
headers: {'Content-Type': 'application/json'}
}))
Name: bandwidth
Limits the amount of bytes sent over the network in outgoing HTTP traffic for a specific threshold time frame.
This poison is basically an alias to throttle.
Arguments:
object
number - Bytes per second. Default to 1024number - Limit time frame in miliseconds. Default 1000toxy.poison(toxy.poisons.bandwidth({ bps: 512 }))
Name: rateLimit
Limits the amount of requests received by the proxy in a specific threshold time frame. Designed to test API limits. Exposes typical X-RateLimit-* headers.
Note that this is very simple rate limit implementation, indeed limits are stored in-memory, therefore are completely volalite. There're a bunch of featured and consistent rate limiter implementations in npm that you can plug in as poison. You might also interested in token bucket algorithm.
Arguments:
object
number - Total amount of request. Default to 10number - Limit threshold time frame in miliseconds. Default to 1000string - Optional error message when limit reached.number - HTTP status code when limit reached. Default to 429.toxy.poison(toxy.poisons.rateLimit({ limit: 5, threshold: 10 * 1000 }))
Name: slowRead
Reads incoming payload data packets slowly. Only valid for non-GET request.
Arguments:
object
number - Packet chunk size in bytes. Default to 1024number - Limit threshold time frame in miliseconds. Default to 1000toxy.poison(toxy.poisons.slowRead({ chunk: 2048, threshold: 1000 }))
Name: slowOpen
Delays the HTTP connection ready state.
Arguments:
object
number - Delay connection in miliseconds. Default to 1000toxy.poison(toxy.poisons.slowOpen({ delay: 2000 }))
Name: slowClose
Delays the HTTP connection close signal (EOF).
Arguments:
object
number - Delay time in miliseconds. Default to 1000toxy.poison(toxy.poisons.slowClose({ delay: 2000 }))
Name: throttle
Restricts the amount of packets sent over the network in a specific threshold time frame.
Arguments:
object
number - Packet chunk size in bytes. Default to 1024object - Limit threshold time frame in miliseconds. Default to 100toxy.poison(toxy.poisons.slowRead({ chunk: 2048, threshold: 1000 }))
Name: abort
Aborts the TCP connection. From the low-level perspective, this will destroy the socket on the server, operating only at TCP level without sending any specific HTTP application level data.
Arguments:
object
number - Socket destroy delay in miliseconds. Default to 0toxy.poison(toxy.poisons.abort())
Name: timeout
Defines a response timeout. Useful when forward to potentially slow servers.
Arguments:
number - Timeout limit in milisecondstoxy.poison(toxy.poisons.timeout(5000))
Poisons are implemented as standalone middleware (like in connect/express).
Here's a simple example of a server latency poison:
function latency(delay) {
/**
* We name the function since toxy uses it as identifier to get/disable/remove it in the future
*/
return function latency(req, res, next) {
var timeout = setTimeout(clean, delay)
req.once('close', onClose)
function onClose() {
clearTimeout(timeout)
next('client connection closed')
}
function clean() {
req.removeListener('close', onClose)
next()
}
}
}
// Register and enable the poison
toxy
.get('/foo')
.poison(latency(2000))
For featured real example, take a look to the built-in poisons implementation.
Rules are simple validation filters which inspect an HTTP request and determine, given a certain rules (e.g: method, headers, query params), if the HTTP transaction should be poisoned or not.
Rules are useful to compose, decouple and reuse logic among different scenarios of poisoning. Rules can be applied to the global, route or even poison scope.
Rules are executed in FIFO order. Their evaluation logic is equivalent to Array#every() in JavaScript: all the rules must pass in order to proceed with the poisoning.
Enables the rule by a random probabilistic. Useful for random poisioning.
Arguments:
number - Percentage of filtering. Default 50var rule = toxy.rules.probability(85)
toxy.rule(rule)
Filters by HTTP method.
Arguments:
string|array - Method or methods to filter.var method = toxy.rules.method(['GET', 'POST'])
toxy.rule(method)
Filter by certain headers.
Arguments:
object - Headers to match by key-value pair. value can be a string, regexp, boolean or function(headerValue, headerName) => booleanvar matchHeaders = {
'content-type': /^application/\json/i,
'server': true, // meaning it should be present,
'accept': function (value, key) {
return value.indexOf('text') !== -1
}
}
var rule = toxy.rules.headers(matchHeaders)
toxy.rule(rule)
Filters by content type header. It should be present
Arguments:
string|regexp - Header value to match.var rule = toxy.rules.contentType('application/json')
toxy.rule(rule)
Match incoming body payload data by string, regexp or custom filter function
Arguments:
string|regexp|function - Body content to matchstring - Optional. Body limit in human size. E.g: 5mbstring - Body encoding. Default to utf8number - Body length. Default taken from Content-Length headervar rule = toxy.rules.body('"hello":"world"')
toxy.rule(rule)
// Or using a filter function returning a boolean
var rule = toxy.rules.body(function (body) {
return body.indexOf('hello') !== -1
})
toxy.rule(rule)
Rules are simple middleware functions that resolve asyncronously with a boolean value to determine if a given HTTP transaction should be ignored when poisoning.
Your rule must resolve with a boolean param calling the next(err, shouldIgnore) function in the middleware, passing a true value if the rule has not matches and should not apply the poisioning, and therefore continuing with the next middleware stack.
Here's an example of a simple rule matching the HTTP method to determine if:
function method(matchMethod) {
/**
* We name the function since it's used by toxy to identify the rule to get/disable/remove it in the future
*/
return function method(req, res, next) {
var shouldIgnore = req.method !== matchMethod
next(null, shouldIgnore)
}
}
// Register and enable the rule
toxy
.get('/foo')
.rule(method('GET'))
.poison(/* ... */)
For featured real examples, take a look to the built-in rules implementation
toxy API is completely built on top the rocky API. In other words, you can use any of the methods, features and middleware layer natively provided by rocky.
Create a new toxy proxy.
For supported options, please see rocky documentation
var toxy = require('toxy')
toxy({ forward: 'http://server.net', timeout: 30000 })
toxy
.get('/foo')
.poison(toxy.poisons.latency(1000))
.withRule(toxy.rules.contentType('json'))
.forward('http://foo.server')
toxy
.post('/bar')
.poison(toxy.poisons.bandwidth({ bps: 1024 }))
.withRule(toxy.rules.probability(50))
.forward('http://bar.server')
toxy.all('/*')
Return: ToxyRoute
Register a new route for GET method.
Return: ToxyRoute
Register a new route for POST method.
Return: ToxyRoute
Register a new route for PUT method.
Return: ToxyRoute
Return: ToxyRoute
Register a new route for DELETE method.
Return: ToxyRoute
Register a new route for HEAD method.
Return: ToxyRoute
Register a new route for any method.
=> ObjectExposes a map with the built-in poisons. Prototype alias to toxy.poisons
=> ObjectExposes a map with the built-in poisons. Prototype alias to toxy.rules
Define a URL to forward the incoming traffic received by the proxy.
Forward to multiple servers balancing among them.
For more information, see the rocky docs
Define a new replay server. You can call this method multiple times to define multiple replay servers.
For more information, see the rocky docs
Plug in a custom middleware.
For more information, see the rocky docs.
Plug in a response outgoing traffic middleware.
For more information, see the rocky docs.
Plug in a replay traffic middleware.
For more information, see the rocky docs
Return a standard middleware to use with connect/express.
Starts the built-in HTTP server, listening on a specific TCP port.
Closes the HTTP server.
Alias: usePoison
Register a new poison.
Alias: useRule
Register a new rule.
Aliases: poisonRule, poisonFilter
Apply a new rule for the latest registered poison.
Enable a poison by name identifier
Disable a poison by name identifier
Return: boolean
Remove poison by name identifier.
Return: boolean
Checks if a poison is enabled by name identifier.
Alias: disablePoisons
Disable all the registered poisons.
Return: Directive|null
Searchs and retrieves a registered poison in the stack by name identifier.
Return: array<Directive>
Return an array of registered poisons wrapped as Directive.
Alias: flushPoisons
Remove all the registered poisons.
Enable a rule by name identifier.
Disable a rule by name identifier.
Return: boolean
Remove a rule by name identifier.
Disable all the registered rules.
Return: boolean
Checks if the given rule is enabled by name identifier.
Return: Directive|null
Searchs and retrieves a registered rule in the stack by name identifier.
Return: array<Directive>
Returns and array with the registered rules wrapped as Directive.
Remove all the rules.
=> ObjectExposes a map with the built-in poisons.
=> ObjectExposes a map with the built-in rules.
=> StringCurrent toxy semantic version.
Toxy route has, indeed, the same interface as Toxy global interface, it just adds some route level additional methods.
Further actions you perform againts the ToxyRoute API will only be applicable at route-level (nested). In other words: you already know the API.
This example will probably clarify possible doubts:
var toxy = require('toxy')
var proxy = toxy()
// Now using the global API
proxy
.forward('http://server.net')
.poison(toxy.poisons.bandwidth({ bps: 1024 }))
.rule(toxy.rules.method('GET'))
// Now create a route
var route = proxy
.get('/foo')
.toPath('/bar') // Route-level API method
.host('server.net') // Route-level API method
.forward('http://new.server.net')
// Now using the ToxyRoute interface
route
.poison(toxy.poisons.bandwidth({ bps: 512 }))
.rule(toxy.rules.contentType('json'))
A convenient wrapper internally used for poisons and rules.
Normally you don't need to know this interface, but for hacking purposes or more low-level actions might be useful.
Return: boolean
Return: boolean
Return: boolean
Alias: filter
Return: function(req, res, next)
The toxy HTTP API follows the JSON API conventions, including resouce based hypermedia linking.
const toxy = require('toxy')
// Create the toxy admin server
var admin = toxy.admin()
admin.listen(9000)
// Create the toxy proxy
var proxy = toxy()
proxy.listen(3000)
// Add the toxy instance to be managed by the admin server
admin.manage(proxy)
console.log('toxy proxy listening on port:', 3000)
console.log('toxy admin server listening on port:', 9000)
For more details about the admin programmatic API, see below.
The HTTP API can be protected to unauthorized clients.
Authorized clients must define the API key token via API-Key or Authorization HTTP headers.
To enable it, you should simple pass the following options to toxy admin server:
const toxy = require('toxy')
const opts = { apiKey: 's3cr3t' }
var admin = toxy.admin(opts)
admin.listen(9000)
console.log('protected toxy admin server listening on port:', 9000)
Hierarchy:
toxy instances
Accepts: application/json
Example payload:
{
"name": "method",
"options": "GET"
}
Accepts: application/json
Example payload:
{
"name": "latency",
"options": { "jitter": 1000 }
}
Accepts: application/json
Example payload:
{
"name": "method",
"options": "GET"
}
Accepts: application/json
Example payload:
{
"path": "/foo", // Required
"method": "GET", // use ALL for all the methods
"forward": "http://my.server", // Optional custom forward server URL
}
Accepts: application/json
Example payload:
{
"name": "method",
"options": "GET"
}
Accepts: application/json
Example payload:
{
"name": "latency",
"options": { "jitter": 1000 }
}
Accepts: application/json
Example payload:
{
"name": "method",
"options": "GET"
}
The built-in HTTP admin server also provides a simple interface open to extensibility and hacking purposes. For instance, you can plug in additional middleware to the admin server, or register new routes.
Returns: Admin
Supported options:
Start listening on the network.
Manage a toxy server instance.
Find a toxy instance. Accepts toxy server ID or toxy instance.
Stop managing a toxy instance.
Register a middleware.
Register a param middleware.
Register a GET route.
Register a POST route.
Register a PUT route.
Register a DELETE route.
Register a PATCH route.
Register a route accepting any HTTP method.
Middleware to plug in with connect/express.
Stop the server.
MIT - Tomas Aparicio
FAQs
Hackable HTTP proxy to simulate server failure scenarios and network conditions
The npm package toxy receives a total of 550 weekly downloads. As such, toxy popularity was classified as not popular.
We found that toxy demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team has identified a malicious Python package that is typosquatting the popular crytic-compile utility, frequently used in popular toolkits and development environments for smart contracts and crypto applications.
Security News
NIST updates on the NVD backlog after media reports that over 50% of KEVs were unenriched since mid-February. They've contracted additional support and partnered with CISA to clear the backlog by fiscal year-end.
Security News
A hospital in Mobile, Alabama, agreed to a settlement in a landmark ransomware death lawsuit, but is now reportedly reconsidering the agreement and refusing to pay.