npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@lemonce3/mitm

v0.8.2

Published

HTTP/HTTPS man in the middle proxy server

Downloads

17

Readme

Mitm

Mitm is a fully configurable proxy base on Node.js, which can handle HTTP, HTTPS, WS or WSS request correctly.

Feature

  • work as HTTP, HTTPS, WS or WSS proxy
  • when working as https or wss proxy, Mitm could intercept https requests for any domain without complaint by browser (If you trusted its root CA)

Installing

mitm is available via npm:

$ npm install @lemonce/mitm

Get Started

Create a mitm instance by functions. Basic usage with default options. For Example.

const mitm = require('@lemonce/mitm');
const mitmServer = mitm.createServer();

API Referrence

Options

Instantiates Mitm Server using the supplied options. This section will discuss each of the options.

| Name | Type | Description | | -- | -- | -- |
| strategy | Object | Strategy options. | | socket | Object | Socket options. | | certificate | Object | Root cerificate and its storage method. | | onError | Function | Handle the Mitm error. |

parameters for strategy

According to your needs, you can set up interception strategy. Using the following parameters.

| Name | Type | Description | | -- | -- | -- | | sslConnect | Function | SSL supported. The default value is false. | | websocket | Function | WebSocket supported. The default value is supported. | | request | Function | Request options. The default method is forward. | | response | Function | Response options. The default method is respond. |

parameters for socket

| Name | Type | Description | | -- | -- | -- | | path | String | Socket path. | | getName | Function | Return a socket store path. |

parameters for certificate

When you need to intercept the HTTPS request, the root certifiacate information and the self-made certificate storage method should be provided. Using the following parameters.

| Name | Type | Description | | -- | -- | -- | | cert | String | Root certificate's cert. | | key | String | Root certificate's RAS private key. | | store | Function | Certificate storage methods. |

Using

Intercepting HTTP requests

With the following options, the mitm server will intercept HTTP requests, the response page will display 'hello, world' and status message will show 'test'.

const mitm = require('@lemonce/mitm');

const options = {
	strategy: {
		request(context, respond, forward) {
			context.response.body = 'hello, world';
			context.response.headers = {};
			context.response.statusCode = 200;
			context.response.statusMessage = 'test';
			respond();
		},
		response(context, respond) {
			respond();
		}
	},
	socket: {
		path: path.resolve(__dirname, './socketStore'),
		getName(protocol, hostname, port) {
			return `${protocol}-${hostname}-${port}`;
		}
	},
	onError(type, message) {
		console.log('error type', type);
		console.log('error message', message);
	}
}

const mitmServer = mitm.createServer(options);
mitmServer.listen(9000);

Intercept HTTPS requests

With the following options, the mitm server will intercept HTTPS requests.

const mitm = require('@lemonce/mitm');
const rootCA = {
	key: '',
	cert: ''
}
const options = {
	sslConnect() {
		return true;
	},
	strategy: {
		request(context, respond, forward) {
			context.response.body = 'hello, world';
			context.response.headers = {};
			context.response.statusCode = 200;
			context.response.statusMessage = 'test';
			respond();
		},
		response(context, respond) {
			respond();
		}
	},
	socket: {
		path: path.resolve(__dirname, './socketStore'),
		getName(protocol, hostname, port) {
			return `${protocol}-${hostname}-${port}`;
		}
	},
	certicate: {
		cert: rootCA.cert,
		key: rootCA.key,
		store: {
			get(hostname) {
				return certificateStore[hostname];
			},
			set(hostname, certKeyPair) {
				return certicateStore[hostname] = certKeyPair;
			}
		}
	},
	onError(type, message) {
		console.log('error type', type);
		console.log('error message', message);
	}
}

const mitmServer = mitm.createServer(options);
mitmServer.listen(9000);

Intercept WS/WSS requests

const mitm = require('@lemonce/mitm');
const certicateStore = {};
const rootCA = {
	key: '',
	cert: ''
}

const options = {
	strategy: {
		sslConnect() {
			return true;
		},
		websocket(clientSocket, proxySocket) {
			clientSocket.pipe(proxySocket);
			proxySocket.pipe(clientSocket);
		},
		request(context, respond, forward) {
			context.response.body = 'hello, world';
			context.response.headers = {};
			context.response.statusCode = 200;
			context.response.statusMessage = 'test';
			respond();
		},
		response(context, respond) {
			respond();
		}
	},
	socket: {
		path: path.resolve(__dirname, './socketStore'),
		getName(protocol, hostname, port) {
			return `${protocol}-${hostname}-${port}`;
		}
	},
	certicate: {
		cert: rootCA.cert,
		key: rootCA.key,
		store: {
			get(hostname) {
				return certificateStore[hostname];
			},
			set(hostname, certKeyPair) {
				return certicateStore[hostname] = certKeyPair;
			}
		}
	},
	onError(type, message) {
		console.log('error type', type);
		console.log('error message', message);
	}
}
const mitmServer = mitm.createServer(options);
mitmServer.listen(9000);

About

Thanks to node-mitmproxy for the inspiration for this project. Due to the node-mitmproxy was stopped, we developed the Mitm base on it for our requirement.

License

MIT License

Copyright (c) 2019 lc3

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.