Abstraction for retrieving ip address information from a Node.js connection. Searches for proxy headers before degrading req.address. 

Abstraction for retrieving ip address information from a Node.js connection. Searches for proxy headers before degrading req.address

3rdeden

swaagie

davedoesdev

jcrugzz

lpinca

forwarded-for

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

 * @param {Boolean} secured The connection was secured.

 * List of possible proxy headers that should be checked for the original client

    port: 'fastly-client-port', // Estimated guess, no standard header available.

    port: 'z-forwarded-port',   // Estimated guess, no standard header available.

    proto: 'z-forwarded-proto'  // Estimated guess, no standard header available.

    proto: 'forwarded-proto'    // Estimated guess, no standard header available.

    port: 'x-real-port',        // Estimated guess, no standard header available.

    proto: 'x-real-proto'       // Estimated guess, no standard header available.

 * Search the headers for a possible match against a known proxy header.

 * @param {Object} headers The received HTTP headers.

 * @param {Array} whitelist White list of proxies that should be checked.

 * @returns {String|Undefined} A IP address or nothing.

  var ports, port, ips, ip, length = proxies.length, i = 0;

  var ports, port, proto, ips, ip, length = proxies.length, i = 0;

    if (!(proxies[i].ip in headers)) continue;

    ports = (headers[proxies[i].port] || '').split(',');

    ips = (headers[proxies[i].ip] || '').split(',');

    proto = (headers[proxies[i].proto] || 'http');

    // As these headers can potentially be set by a 1337H4X0R we need to ensure

    // that all supplied values are valid IP addresses. If we receive a none

    // IP value inside the IP header field we are going to assume that this

    // header has been compromised and should be ignored

    if (!ips.length || !ips.every(net.isIP)) return;

    port = ports.shift();   // Extract the first port as it's the "source" port.

    ip = ips.shift();       // Extract the first IP as it's the "source" IP.

    // If we were given a white list, we need to ensure that the proxies that

    // we're given are known and allowed.

    if (whitelist && whitelist.length && !ips.every(function every(ip) {

      return ~whitelist.indexOf(ip.trim());

    // We've gotten a match on a HTTP header, we need to parse it further as it

    // could consist of multiple hops. The pattern for multiple hops is:

    //   client, proxy, proxy, proxy, etc.

    // So extracting the first IP should be sufficient.

    // So extracting the first IP should be sufficient. There are SSL

    // terminators like the once's that is used by `fastly.com` which set their

    // HTTPS header to `1` as an indication that the connection was secure.

    return new Forwarded(ip, port, proto === '1' || proto === 'https');

 * @param {Object} obj A socket like object that could contain a `remoteAddress`.

module.exports = function parse(obj, headers, whitelist) {

  var proxied = forwarded(headers, whitelist)

  // We should always be testing for HTTP headers as remoteAddress would point

  // Check for the property on our given object.

    // Edge case for Socket.IO and SockJS.

    if ('address' in obj && 'port' in obj) {

  if ('object' === typeof connection && 'remoteAddress' in connection) {

  if ('object' === typeof socket && 'remoteAddress' in socket) {

  "description": "Abstraction for retrieving ip address information from a Node.js connection. Searches for proxy headers before degrading req.address",

    "test": "echo \"Error: no test specified\" && exit 1"

    "url": "git://github.com/primus/forwarded-for.git"

    "url": "https://github.com/primus/forwarded-for/issues"

  "homepage": "https://github.com/primus/forwarded-for"

When you are hosting your applications behind a reverse load balancer the

incoming requests will no longer have the IP address of your user but of the

load balancer as it forwards the request to your node instance. Most load

balancers allow you to modify the headers of the request and add original

This module makes it easier to find the correct IP address of your connection by

detecting these headers that load balancers set and it will gracefully fall down

to the original `req.address` that contained the IP address of the request

inside node.js. In addition to gracefully degrading to the original request we

also for other known locations of the address (which are usually set by

frameworks such as SockJS and Socket.IO etc.)

The module is released in the npm registry:

Let's start out with including the module in to your application:

var forwarded = require('forwarded-for');

The `forwarded` variable will now contain the function which parses out the

request information for you in to a really simple object. This object contains

- `port` The remote port. It defaults to `0`.

- `ip` The string representation of the remoteAddress. It defaults to '127.0.0.1'.

When we fail to parse or detect an IP address we will use the default values to

construct the object. To correctly parse the data the function requires the

- `obj` The socket like object that probably contains the remoteAddress

- `headers` A reference to the HTTP headers of the request

- `whitelist`, _optional_ A white list of IP addresses of your load balancers so

  people cannot make fake requests with `x-forwarded-for` headers.

So with all the information combined, it would look something like this:

require('http').createServer(function (req, res) {

  var address = forwarded(req, req.headers);

  res.end('Your ip address is '+ address.ip);

		@@ -28,2 +28,7 @@ 'use strict';
		{
		ip: 'fastly-client-ip',
		port: 'fastly-client-port', // Estimated guess, no standard header available.
		proto: 'fastly-ssl'
		},
		{
		ip: 'x-forwarded-for',
		@@ -56,3 +61,3 @@ port: 'x-forwarded-port',
		function forwarded(headers, whitelist) {
		var ports, port, ips, ip, length = proxies.length, i = 0;
		var ports, port, proto, ips, ip, length = proxies.length, i = 0;

		@@ -64,2 +69,3 @@ for (; i < length; i++) {
		ips = (headers[proxies[i].ip] \|\| '').split(',');
		proto = (headers[proxies[i].proto] \|\| 'http');

		@@ -91,5 +97,8 @@ //
		//
		// So extracting the first IP should be sufficient.
		// So extracting the first IP should be sufficient. There are SSL
		// terminators like the once's that is used by `fastly.com` which set their
		// HTTPS header to `1` as an indication that the connection was secure.
		// (This reduces bandwidth)
		//
		return new Forwarded(ip, port);
		return new Forwarded(ip, port, proto === '1' \|\| proto === 'https');
		}
		@@ -127,3 +136,4 @@ }
		obj.remoteAddress,
		obj.remotePort
		obj.remotePort,
		obj.encrypted
		);
		@@ -136,3 +146,4 @@ }
		obj.address,
		obj.port
		obj.port,
		obj.encrypted
		);
		@@ -145,3 +156,4 @@ }
		connection.remoteAddress,
		connection.remotePort
		connection.remotePort,
		connection.encrypted
		);
		@@ -153,3 +165,4 @@ }
		socket.remoteAddress,
		socket.remoteAddress
		socket.remoteAddress,
		socket.encrypted
		);
		@@ -156,0 +169,0 @@ }

		{
		"name": "forwarded-for",
		"version": "0.0.1",
		"version": "0.0.2",
		"description": "Abstraction for retrieving ip address information from a Node.js connection. Searches for proxy headers before degrading req.address",
		@@ -14,10 +14,14 @@ "main": "index.js",
		"keywords": [
		"x-forwarded-for",
		"address",
		"client ip",
		"fastly",
		"forwarded-for",
		"ip",
		"address",
		"original ip",
		"parser",
		"ssl-terminator",
		"x-forwarded-for",
		"x-forwarded-proto",
		"z-forwarded-for",
		"x-real-ip"
		"x-real-ip",
		"z-forwarded-for"
		],
		@@ -24,0 +28,0 @@ "author": "Arnout Kazemier",

		@@ -53,3 +53,3 @@ # forwarded-for
		```js
		'use stict';
		'use strict';

		@@ -56,0 +56,0 @@ var forwarded = require('forwarded-for');

Improved metrics