@vafast/ip

Get the client ip address in Tirne. It works with Bun, Cloudflare, Fastly and other runtimes.

Please consider starring the repository to show your ❤️ and support.

Installation

Requires Bun v1.0.4 or above. Requires Tirne v1.0.9 or above.

bun a @vafast/ip

Documentation

Introduction

This middleware adds an ip property to the context object. It contains the client ip address.

Usage

import { Server, json } from "tirne";
import { ip } from "@vafast/ip";

const ipMiddleware = ip();

const routes = [
  {
    method: "GET",
    path: "/",
    handler: (request: Request, context: any) => {
      return json({ ip: context.ip });
    },
    middleware: [ipMiddleware],
  },
];

const server = new Server(routes);

export default {
  fetch: (req: Request) => server.fetch(req),
};

How does it work?

For Bun runtime, We use server.requestIP introduced in Bun v1.0.4 to get the client ip address and early return it.

It relies on headers for runtimes other than Bun. Cloudflare and other providers send back specific headers, containing the IP address. For example CF-Connecting-IP for Cloudflare and Fastly-Client-IP for Fastly.

We also add support for X-Forwarded-For header (de-facto standard header) and other various headers.

Priority list:

1. User specified
2. X-Forwarded-For (de-facto standard header)
3. X-Real-IP (Apache)
4. X-Client-IP (Nginx)
5. CF-Connecting-IP (Cloudflare)
6. Fastly-Client-IP (Fastly)
7. X-Cluster-Client-IP (GCP)
8. X-Forwarded (RFC 7239)
9. Forwarded-For (RFC 7239)
10. Forwarded (RFC 7239)
11. appengine-user-ip (GCP)
12. true-client-ip (Akamai and Cloudflare)
13. cf-pseudo-ipv4 (Cloudflare)

You can even specify your own headers if you want to as following

import { Server, json } from "tirne";
import { ip } from "@vafast/ip";

const ipMiddleware = ip({ checkHeaders: ["X-Forwarded-For", "X-Real-IP"] });

const routes = [
  {
    method: "GET",
    path: "/",
    handler: (request: Request, context: any) => {
      return json({ ip: context.ip });
    },
    middleware: [ipMiddleware],
  },
];

or

import { Server, json } from "tirne";
import { ip } from "@vafast/ip";

const ipMiddleware = ip({ checkHeaders: "X-Forwarded-For" });

const routes = [
  {
    method: "GET",
    path: "/",
    handler: (request: Request, context: any) => {
      return json({ ip: context.ip });
    },
    middleware: [ipMiddleware],
  },
];

You can also switch to Headers only mode by setting headersOnly to true. This will only check headers and not the server.requestIP property.

import { Server, json } from "tirne";
import { ip } from "@vafast/ip";

const ipMiddleware = ip({ headersOnly: true });

const routes = [
  {
    method: "GET",
    path: "/",
    handler: (request: Request, context: any) => {
      return json({ ip: context.ip });
    },
    middleware: [ipMiddleware],
  },
];

Debugging

Please use run the command setting environment variable NODE_DEBUG to either * or @vafast/ip

License

MIT

Author

Copyright (c) 2023 Gaurish Sethia, All Rights Reserved.