proxy-addr
Advanced tools
Package description
The proxy-addr npm package is used to determine the IP address of the client connected to your web server through an HTTP proxy or a load balancer. It provides functionality to derive the client's IP address considering the X-Forwarded-For header and other well-known headers that can be used to indicate the actual client IP address when proxying HTTP requests.
Determine client IP address from request
This feature allows you to get the client's IP address from an incoming HTTP request object, considering the list of addresses specified by the 'trust' parameter.
const proxyaddr = require('proxy-addr');
const requestIp = proxyaddr(req, trust);Compile trusted address list
This feature compiles an array of trusted addresses into a function, which can then be used to check if a given IP should be trusted.
const proxyaddr = require('proxy-addr');
const trust = proxyaddr.compile(['loopback', 'linklocal', 'uniquelocal']);Check if an address is trusted
This feature checks if a given IP address is in the list of trusted addresses.
const proxyaddr = require('proxy-addr');
const trust = proxyaddr.compile('10.0.0.1');
const trusted = trust('10.0.0.1');The 'forwarded' npm package parses the X-Forwarded-For header and returns an array of the addresses. It is similar to proxy-addr but does not provide the same level of control over which addresses are considered trustworthy.
The 'remoteaddr' npm package is another alternative that provides methods for retrieving the remote address of the request, considering proxies. It is less widely used and has fewer features compared to proxy-addr.
The 'ipware' npm package is designed to retrieve the user's IP address from the incoming request, supporting both IPv4 and IPv6. It offers functionality similar to proxy-addr but with a different API and additional features for IP address detection.
Readme
Determine address of proxied request
This is a Node.js module available through the
npm registry. Installation is done using the
npm install command:
$ npm install proxy-addr
var proxyaddr = require('proxy-addr')
Return the address of the request, using the given trust parameter.
The trust argument is a function that returns true if you trust
the address, false if you don't. The closest untrusted address is
returned.
proxyaddr(req, function (addr) { return addr === '127.0.0.1' })
proxyaddr(req, function (addr, i) { return i < 1 })
The trust arugment may also be a single IP address string or an
array of trusted addresses, as plain IP addresses, CIDR-formatted
strings, or IP/netmask strings.
proxyaddr(req, '127.0.0.1')
proxyaddr(req, ['127.0.0.0/8', '10.0.0.0/8'])
proxyaddr(req, ['127.0.0.0/255.0.0.0', '192.168.0.0/255.255.0.0'])
This module also supports IPv6. Your IPv6 addresses will be normalized
automatically (i.e. fe80::00ed:1 equals fe80:0:0:0:0:0:ed:1).
proxyaddr(req, '::1')
proxyaddr(req, ['::1/128', 'fe80::/10'])
This module will automatically work with IPv4-mapped IPv6 addresses
as well to support node.js in IPv6-only mode. This means that you do
not have to specify both ::ffff:a00:1 and 10.0.0.1.
As a convenience, this module also takes certain pre-defined names in addition to IP addresses, which expand into IP addresses:
proxyaddr(req, 'loopback')
proxyaddr(req, ['loopback', 'fc00:ac:1ab5:fff::1/64'])
loopback: IPv4 and IPv6 loopback addresses (like ::1 and
127.0.0.1).linklocal: IPv4 and IPv6 link-local addresses (like
fe80::1:1:1:1 and 169.254.0.1).uniquelocal: IPv4 private addresses and IPv6 unique-local
addresses (like fc00:ac:1ab5:fff::1 and 192.168.0.1).When trust is specified as a function, it will be called for each
address to determine if it is a trusted address. The function is
given two arguments: addr and i, where addr is a string of
the address to check and i is a number that represents the distance
from the socket address.
Return all the addresses of the request, optionally stopping at the
first untrusted. This array is ordered from closest to furthest
(i.e. arr[0] === req.connection.remoteAddress).
proxyaddr.all(req)
The optional trust argument takes the same arguments as trust
does in proxyaddr(req, trust).
proxyaddr.all(req, 'loopback')
Compiles argument val into a trust function. This function takes
the same arguments as trust does in proxyaddr(req, trust) and
returns a function suitable for proxyaddr(req, trust).
var trust = proxyaddr.compile('loopback')
var addr = proxyaddr(req, trust)
This function is meant to be optimized for use against every request.
It is recommend to compile a trust function up-front for the trusted
configuration and pass that to proxyaddr(req, trust) for each request.
$ npm test
$ npm run-script bench
FAQs
Determine address of proxied request
The npm package proxy-addr receives a total of 21,889,994 weekly downloads. As such, proxy-addr popularity was classified as popular.
We found that proxy-addr 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
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.