proxy-addr

What is proxy-addr?

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.

What are proxy-addr's main functionalities?

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');

Other packages similar to proxy-addr

forwarded

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.

ipware

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

proxy-addr

Determine address of proxied request

Install

npm install proxy-addr

API

var proxyaddr = require('proxy-addr');

proxyaddr(req)

Return the address of the request. This returns the furthest-away address.

proxyaddr.all(req)

Return all the addresses of the request. This array is ordered from closest to furthest (i.e. arr[0] === req.connection.remoteAddress).

License

MIT