@arcjet/ip

@arcjet/ip

Arcjet utilities for finding the originating IP of a request.

Installation

npm install -S @arcjet/ip

Example

import ip from "@arcjet/ip";

// Some Request-like object, such as node's `http.IncomingMessage` or next.js'
// `NextRequest`
const request = new NextRequest();
// A `Headers` object, which is passed separately for cases where it needs to be
// constructed or sanitized
const headers = new Headers();

// Returns the first non-private IP address detected
const globalIp = ip(request, headers);
console.log(globalIp);

Considerations

The IP should not be trusted as it can be spoofed in most cases, especially when loaded via the Headers object.

In non-production environments (NODE_ENV !== "production"), we allow private/internal addresses so that the SDKs work correctly locally.

Implementation

The implementation of this library is based on the Parser, global ipv4 comparisons, and global ipv6 comparisons in the Rust stdlib and the header lookups in the request-ip package. Both licensed MIT with licenses included in our source code.

We've chosen the approach of porting Rust's IP Parser because capturing RegExps can be the source of ReDoS attacks, which we need to avoid. We also wanted to keep our implementation as close to Rust as possible because we will be relying on the Rust stdlib implementation in the future, with a fallback to this implementation. As such, we'll need to track changes in Rust's implementation, even though it seems to change infrequently.

License

Licensed under the Apache License, Version 2.0.

Changelog

1.0.0-alpha.6 (2023-12-18)

⚠ BREAKING CHANGES

• Pass ArcjetContext to rules (#65)

🚀 New Features

• Pass ArcjetContext to rules (#65) (c043f15)

🪲 Bug Fixes

• next: Avoid appending ? if querystring is empty (#71) (16ca958)
• next: Stop using NextUrl to avoid type conflict across version (#62) (294540a)
• Wrap timeout default ternary so timeout option takes effect (#66) (d49ebd2)

🧹 Miscellaneous Chores

• Add pre and post logging to remote client (#70) (46fd6b3)
• deps-dev: Bump the dev-dependencies group with 2 updates (#55) (94839f3)
• deps: Bump the dependencies group with 2 updates (#54) (9c68aa2)
• Disallow configuring timeout for report (#67) (ae8f1b7)
• examples: Add Next 13 wrap example (294540a)
• rollup: Fail compilation on type check failure (#68) (b9a373b)

✅ Continuous Integration

• Setup release workflow (#74) (53b5b63)