Determine the address of a proxied request
npm install @fastify/proxy-addr


Determine the address of a proxied request.
Forked from https://github.com/jshttp/proxy-addr to address https://github.com/jshttp/forwarded/pull/9.
``sh`
$ npm i @fastify/proxy-addr
`js`
const proxyaddr = require('@fastify/proxy-addr')
Return the address of the request, using the given trust parameter.
The trust argument is a function that returns true if you trustfalse
the address, if you don't. The closest untrusted address is
returned.
`js`
proxyaddr(req, function (addr) { return addr === '127.0.0.1' })
proxyaddr(req, function (addr, i) { return i < 1 })
The trust argument 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.
`js`
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).
`js`
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:
`js`
proxyaddr(req, 'loopback')
proxyaddr(req, ['loopback', 'fc00:ac:1ab5:fff::1/64'])
* loopback: IPv4 and IPv6 loopback addresses (like ::1 and127.0.0.1
).linklocal
* : IPv4 and IPv6 link-local addresses (likefe80::1:1:1:1
and 169.254.0.1).uniquelocal
* : IPv4 private addresses and IPv6 unique-localfc00:ac:1ab5:fff::1
addresses (like and 192.168.0.1).
When trust is specified as a function, it will be called for eachaddr
address to determine if it is a trusted address. The function is
given two arguments: and i, where addr is a string ofi
the address to check and is a number that represents the distance
from the socket address.
Return all the request addresses, optionally stopping at the
first untrusted. This array is ordered from closest to furthest
(i.e. arr[0] === req.connection.remoteAddress).
`js`
proxyaddr.all(req)
The optional trust argument takes the same arguments as trustproxyaddr(req, trust)
does in .
`js`
proxyaddr.all(req, 'loopback')
Compiles argument val into a trust function. This function takestrust
the same arguments as does in proxyaddr(req, trust) andproxyaddr(req, trust)
returns a function suitable for .
`js`
const trust = proxyaddr.compile('loopback')
const addr = proxyaddr(req, trust)
This function is meant to be optimized for use against every request.
It is recommended that a trust function be compiled up-front for the
trusted configuration and passed to proxyaddr(req, trust) for each request.
`sh`
$ npm test
`sh``
$ npm run bench
Licensed under MIT.