@chienchheung/request-ip

A tiny Node.js module for retrieving a request's IP address.

Resolves issue: https://github.com/pbojinov/request-ip/issues/75 PR: https://github.com/pbojinov/request-ip/pull/76

Installation

Yarn

yarn add @chienchheung/request-ip

npm

npm install @chienchheung/request-ip --save

Getting Started

const requestIp = require('request-ip');

// inside middleware handler
const ipMiddleware = function (req, res, next) {
  const clientIp = requestIp.getClientIp(req);
  next();
};

// on localhost you'll see 127.0.0.1 if you're using IPv4
// or ::1, ::ffff:127.0.0.1 if you're using IPv6

As Connect Middleware

const requestIp = require('request-ip');
app.use(requestIp.mw());

app.use(function (req, res) {
  const ip = req.clientIp;
  res.end(ip);
});

To see a full working code for the middleware, check out the examples folder.

The connect-middleware also supports retrieving the ip address under a custom attribute name, which also works as a container for any future settings.

How It Works

It looks for specific headers in the request and falls back to some defaults if they do not exist.

The user ip is determined by the following order:

1. X-Client-IP
2. X-Forwarded-For (Header may return multiple IP addresses in the format: "client IP, proxy 1 IP, proxy 2 IP", so we take the first one.)
3. CF-Connecting-IP (Cloudflare)
4. Fastly-Client-Ip (Fastly CDN and Firebase hosting header when forwared to a cloud function)
5. True-Client-Ip (Akamai and Cloudflare)
6. X-Real-IP (Nginx proxy/FastCGI)
7. X-Cluster-Client-IP (Rackspace LB, Riverbed Stingray)
8. X-Forwarded, Forwarded-For and Forwarded (Variations of #2)
9. appengine-user-ip (Google App Engine)
10. req.connection.remoteAddress
11. req.socket.remoteAddress
12. req.connection.socket.remoteAddress
13. req.info.remoteAddress
14. Cf-Pseudo-IPv4 (Cloudflare fallback)
15. request.raw (Fastify)

If an IP address cannot be found, it will return null.

However you can add your priority if you dont want to go by the above order. Example if you are behind CloudFlare proxy:

const requestIp = require('request-ip');
app.use(requestIp.mw(), {
  prioritize: ['cf-connecting-ip', 'x-real-ip'],
});

app.use(function (req, res) {
  const ip = req.clientIp;
  res.end(ip);
});

Samples Use Cases

• Getting a user's IP for geolocation.

Running the Tests

Make sure you have the necessary dev dependencies needed to run the tests:

npm install

Run the integration tests

npm test

Building

Compiles the current ES6 code to ES5 using Babel.

npm build

Release Notes

See the wonderful changelog

To generate a new changelog, install github-changelog-generator then run npm run changelog. This will require being on Ruby >= 3

Contributors

Thank you to all the contributors!

License

The MIT License (MIT) - 2022