Intelligent http proxy Express middleware. 

Intelligent http proxy Express middleware

dvonlehman

express-request-proxy

Error

Ignore

Warn

License

Maintenance

Miscellaneous

Quality

Supply chain risk

Vulnerability

Admins only

Organization members

Dashboard

<upgradeLink>Upgrade</upgradeLink> to access this feature

About

Blog

Socket CLI

Customers

Socket Dependency Search

Docs

Socket for GitHub

Love

Impersonation Mode Active

Update your browser to the latest version for the best experience.

Your web browser is outdated

Use another browser for the best experience.

Your web browser is unsupported

{{count, number}} commits last two months

{{count, number}} critical severity alert

{{count, number}} critical severity alerts

{{count, number}} dependency vulnerability

{{count, number}} dependency vulnerabilities

{{count, number}} development dependencies

{{count, number}} transitive dependencies

{{count, number}} version published last month

{{count, number}} versions published last month

{{count, number}} version published in last two months

{{count, number}} versions published in last two months

{{count, number}} version published last week

{{count, number}} versions published last week

{{count, number}} version published last year

{{count, number}} versions published last year

Socket undergoes annual SOC2 Type II audits. Socket customers can request a copy of the full SOC2 Type II report.

Allows organization owners and admins to access detailed records of actions taken by members of their organization, complete with timestamps.

Prevent compromised packages from infiltrating your supply chain by monitoring for changes in real-time.

Join our Discord community to get help from Socket engineers and other Socket users.

Compare millions of open source packages on socket.dev

Detect malicious code and risky behavior (e.g. network) in your dependencies using "deep package inspection"

All data is encrypted in transit and at rest using industry standard encryption algorithms.

Get a dedicated Socket account manager and access to Socket’s Customer Success team.

Get dedicated support from Socket engineers via email and Slack.

"Shift left" with the Socket Chrome extension and give intervene early, before developers choose risky or low quality dependencies.

Catch developers using risky dependencies and give them a "speed bump" to encourage good behavior

Install the Socket GitHub app to receive real-time dependency scanning and reports with every pull request.

Integrate Socket into your GitHub SCM to prevent risky dependencies from being installed.

Socket scans for vulnerabilities in your dependencies, including CVEs, security advisories, and more.

Socket supports dependencies in many languages, with most popular ecosystems coming in 2024. We've got you covered no matter what languages you use.

Enforce license policies across your organization

Receive a Microsoft Teams message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Get help migrating from Socket's free plan to Socket's paid plans.

Run Socket on-premises or in your own cloud environment.

Query for any dependency (at any version) across your entire organization

Integrate Socket into your CI/CD pipeline to prevent risky dependencies from being deployed to production.

Analyze an entire project to find supply chain risks

Tag projects to organize and filter your projects

Restrict access based on the roles of individual users within an organization.

Receive a Slack message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket is SOC2 Type II compliant and undergoes annual audits.

The Socket CLI allows teams to prevent risky dependencies from being installed, and to get dependency insights from the command line.

Socket supports SAML SSO for single sign-on and identity management.

Integrate Socket into your VS Code IDE to prevent risky dependencies from being installed.

Get a POST request anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket will analyzed your SBOMs up to a maximum number of dependencies.

API that allows you to analyze a project, lookup package scores and alerts, and more.

Create API tokens to authenticate with the Socket API and CLI.

The number of developers in your team. A developer is someone who made a commit to your organization's repositories scanned by Socket in the past month.

Use Socket to protect your private repositories.

Socket is always free for open source projects.

Socket retains all reporting data for 3 months, 1 year, or a custom term of your choice.

Access the threat feed that powers Socket.

Unlimited scale, self-hosting, and priority support for large teams.

For open-source projects, individuals, and small teams.

For growing teams with enhanced scale, security, and support.

There is a package with a similar name that is downloaded much more often.

There are packages with similar names that are downloaded much more often.

This may not be the package you want!

Instance

Alert Locations

Package

The {{ecosystem}} package {{- packageName}} receives a total of <strong>{{numWeeklyDownloadCount, number}}</strong> weekly downloads. As such, {{- packageName}} popularity was classified as <strong>{{popularity}}</strong>.

Is {{- packageName}} popular?

Is {{- packageName}} safe to use?

Is {{- packageName}} well maintained?

What is {{- packageName}}?

{{packageDescription}}Version: {{versionString}} was published by {{publisherName}}. Start using Socket to analyze {{- packageName}} and its {{dependencyCount, number}} dependencies to secure your app from supply chain attacks.

Sorry, it seems this package was removed from the registry

Package was removed

This package version has been unpublished, mostly likely due to security reasons

Package version was removed

Provide a detailed description of the malware...

Socket fights vulnerabilities and provides visibility, defense-in-depth, and proactive supply chain protection for JavaScript, Python, and Go dependencies.

Socket - Secure your dependencies. Ship with confidence.

Compare versions

{{- packageName}} - npm Package Compare versions

  debug = require('debug')('express-request-proxy:proxy'),

  requestOptions = require('./request-options'),

// Headers from the original API response that should be preserved and sent along

var headersToPreserveInCache = ['content-type'];

  // Allow discarding response headers to be configurable

  var discardApiResponseHeaders = options.discardApiResponseHeaders || ['set-cookie', 'content-length'];

    cacheHttpHeader: 'Express-Request-Proxy-Cache',

    var method = req.method.toUpperCase();

    // Allow for a global cache to be specified on the parent Express app

      options.cache = req.app.settings.cache;

    req.ext.requestHandler = 'express-request-proxy';

    if (options.ensureAuthenticated === true) {

      // Look for the isAuthenticated function which PassportJS defines. Some other authentication

      // method can be used, but it needs to define the isAuthenicated function.

      if (req.ext.isAuthenticated !== true) {

        debug('user is not authenticated');

        return next(Error.http(401, 'User must be authenticated to invoke this API endpoint'));

    if (method.toUpperCase() === 'GET' && options.cache && options.cacheMaxAge > 0) {

      if (!options.cache) return next(new Error('No cache provider configured'));

      return proxyViaCache(req, res, next);

      apiRequestOptions = requestOptions(req, options);

      debug('error building request options %s', err.stack);

      return next(Error.http(400, err.message));

    debug('making %s call to %s', apiRequestOptions.method, apiRequestOptions.url);

    // If the req has a body, pipe it into the proxy request

      debug('piping req body to remote http endpoint');

      apiRequest = req.pipe(request(apiRequestOptions));

      originalApiRequest = request(apiRequestOptions);

      apiRequest = req.pipe(originalApiRequest);

      apiRequest = request(apiRequestOptions);

    // Abort api request if client close its connection

    apiRequest.on('error', function(err) {

    // Defer piping the response until the response event so we can

    apiRequest.on('response', function(resp) {

      // Do not attempt to apply transforms to error responses

        debug('Received error %s from %s', resp.statusCode, apiRequestOptions.url);

      if (_.isArray(options.transforms)) {

        apiRequest = applyTransforms(apiRequest, options.transforms, resp.headers);

      // Need to explicitly passthrough headers, otherwise they will get lost

        if (_.includes(discardApiResponseHeaders, key) === false) {

          res.set(key, resp.headers[key]);

  function proxyViaCache(req, res, next) {

    if (_.isFunction(options.cacheKeyFn)) {

      cacheKey = options.cacheKeyFn(req, apiRequestOptions);

    debug('checking if key %s exists in cache', cacheKey);

    options.cache.exists(cacheKey, function(err, exists) {

      debug('api response exists in cache=%s', exists);

        debug('api response exists in cache');

        return pipeToResponseFromCache(cacheKey, req, res, next);

      debug('key %s not in cache', cacheKey);

      res.set('Cache-Control', 'max-age=' + options.cacheMaxAge);

      res.set(options.cacheHttpHeader, 'miss');

      debug('making %s request to %s', apiRequestOptions.method, apiRequestOptions.url);

      var apiRequest = request(apiRequestOptions);

      apiRequest.on('error', function(_err) {

      // Defer piping the response until the response event so we can

      apiRequest.on('response', function(resp) {

        // Don't cache error responses. Just pipe the response right on out.

        // If the api response is gzip encoded, unzip it before attempting

        if (resp.headers['content-encoding'] === 'gzip') {

          apiRequest = apiRequest.pipe(zlib.createGunzip());

        // Store the headers as a separate cache entry

        var headersToKeep = _.pick(resp.headers, headersToPreserveInCache);

        if (_.isArray(options.transforms)) {

          apiRequest = applyTransforms(apiRequest, options.transforms, headersToKeep);

        // This needs to happen after the call to applyTransforms so transforms

        // have the opportunity to modify the contentType.

        _.forOwn(headersToKeep, function(value, key) {

          debug('setting header %s to %s', key, value);

        if (_.isEmpty(headersToKeep) === false) {

          debug('writing original headers to cache');

          options.cache.setex(cacheKey + '__headers',

  "description": "Intelligent http proxy Express middleware",

    "test": "mocha --reporter spec --bail --check-leaks test/",

    "test": "mocha --reporter spec --bail --exit --check-leaks test/",

    "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --reporter dot --check-leaks test/",

    "test-travis": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --reporter spec --check-leaks test/",

    "test-travis": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --reporter spec --exit --check-leaks test/",

    "lint": "eslint --cache ./lib index.js"

    "url": "https://github.com/dvonlehman/express-request-proxy"

  "author": "David Von Lehman (https://github.com/dvonlehman)",

    "url": "https://github.com/dvonlehman/express-request-proxy/issues"

  "homepage": "https://github.com/dvonlehman/express-request-proxy",

[![NPM Downloads][downloads-image]][downloads-url]

[![Build Status][travis-image]][travis-url]

[![Test Coverage][coveralls-image]][coveralls-url]

High performance streaming http request reverse proxy for [Express](http://expressjs.com) based on the [request http client](https://www.npmjs.com/package/request). Supports caching, custom routes, server-side injection of sensitive keys, authentication, and response transformations.

var requestProxy = require("express-request-proxy");

    url: "https://someapi.com/api/:resource/:id",

      secret_key: process.env.SOMEAPI_SECRET_KEY

      "X-Custom-Header": process.env.SOMEAPI_CUSTOM_HEADER

String representing the url of the remote endpoint to proxy to. Can contain named route parameters. Query parameters can be appended with the `query` option. This is the only required option.

An object containing properties to substitute for named route parameters in the remote URL. Named parameters are declared using the same conventions as Express routes, i.e. `/pathname/:param1/:param2`. The path portion of the `url` is parsed using the [path-to-regexp](https://www.npmjs.com/package/path-to-regexp) module. Defaults to `{}`.

An object of parameters to be appended to the querystring of the specified `url`. This is a good way to append sensitive parameters that are stored as environment variables on the server avoiding the need to expose them to the client. Any parameters specified here will override an identically named parameter in the `url` or on the incoming request to the proxy. Defaults to `{}`.

		@@ -81,9 +81,17 @@ var _ = require('lodash'),
		var apiRequest;
		var originalApiRequest;
		if (is.hasBody(req)) {
		debug('piping req body to remote http endpoint');
		apiRequest = req.pipe(request(apiRequestOptions));
		originalApiRequest = request(apiRequestOptions);
		apiRequest = req.pipe(originalApiRequest);
		} else {
		apiRequest = request(apiRequestOptions);
		originalApiRequest = apiRequest;
		}

		// Abort api request if client close its connection
		req.on('close', function() {
		originalApiRequest.abort();
		});

		apiRequest.on('error', function(err) {
		@@ -90,0 +98,0 @@ unhandledApiError(err, next);

		{
		"name": "express-request-proxy",
		"version": "2.1.1",
		"version": "2.2.0",
		"description": "Intelligent http proxy Express middleware",
		"main": "index.js",
		"scripts": {
		"test": "mocha --reporter spec --bail --check-leaks test/",
		"test": "mocha --reporter spec --bail --exit --check-leaks test/",
		"test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --reporter dot --check-leaks test/",
		"test-travis": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --reporter spec --check-leaks test/",
		"test-travis": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --reporter spec --exit --check-leaks test/",
		"lint": "eslint --cache ./lib index.js"
		@@ -45,2 +45,3 @@ },
		"compression": "^1.7.2",
		"coveralls": "^3.0.2",
		"dash-assert": "^1.3.1",
		@@ -47,0 +48,0 @@ "eslint": "^4.19.1",

		@@ -120,5 +120,4 @@ # express-request-proxy
		```js
		app.all(
		"/api/protected/:resource",
		requestProxy({
		app.all("/api/protected/:resource", function(req, res, next) {
		var proxy = requestProxy({
		url: "http://remoteapi.com/api",
		@@ -128,4 +127,5 @@ query: {
		}
		})
		);
		});
		proxy(req, res, next);
		});
		```
		@@ -265,5 +265,5 @@
		[travis-url]: https://travis-ci.org/dvonlehman/express-request-proxy
		[coveralls-image]: https://img.shields.io/coveralls/4front/express-request-proxy.svg?style=flat
		[coveralls-image]: https://img.shields.io/coveralls/dvonlehman/express-request-proxy.svg?style=flat
		[coveralls-url]: https://coveralls.io/r/dvonlehman/express-request-proxy?branch=master
		[downloads-image]: https://img.shields.io/npm/dm/express-request-proxy.svg?style=flat
		[downloads-url]: https://npmjs.org/package/express-request-proxy

Improved metrics

Worsened metrics