p0vidl0/nestjs-real-ip

A concise decorator for retrieving an IP address from http request with Nest.js controller method.

Nest.js real ip decorator

A concise decorator for retrieving an IP address from http request with Nest.js controller method.

Installation

# Install the upstream version for projects based on NestJS v8 and above
npm install nestjs-real-ip

# Or use the version 1.0.3 for projects based on NestJS v7
npm install [email protected]

Example controller

import { RealIP } from 'nestjs-real-ip';

@Controller('/')
class TestController {
  @Get('my-ip')
  get(@RealIP() ip: string): string {
    return ip;
  }
}

Under the hood

Based on the tiny module @supercharge/request-ip. It supports a wide list of request headers and properties to get working in almost any environment. See the request-ip module description for details.

Also, see the decorator's tests.

License

The code is under MIT license. See the LICENSE file for details.

Development

# Update code, commit and push with git
npm version [ major | minor | patch ]
npm publish

nestjs-real-ip's Issues

Access through proxy or load balancer

Hello, Thank you for creating an impressive library!

Is it possible to identify the IP correctly even when the client accesses through a proxy or load balancer?

const ip = req.headers['x-forwarded-for'] || req.connection.remoteAddress;

RealIp returns ::1

Hi!
I have trouble with RealIp decorator it returns ::1.
What can it be?

Usage in Guards

Hi @p0vidl0

Can I use it in my guards ?

peer dependencies support v10 of NestJS

As far as we know v10 has just released however this is now causing errors for the package to be added.

Could you update peer dependencies of the package? would of been appreciated.

Note that they no longer support typescript below 4.8
https://docs.nestjs.com/migration-guide#cli-plugins-and-typescript--48

How to use in NestInterceptor?

Working fine on controller,
But, I am using LoggingInterceptor to log requests, how to use @RealIP() in NestInterceptor?

constructor(
    @Inject(WINSTON_MODULE_PROVIDER) private readonly logger: Logger,
  ) {}
  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
    const startAt = Date.now();
    const req = context.switchToHttp().getRequest<Request>();

   // How to get real ip address from request here to log

});

Fastify deprecation warning [FSTDEP005]

When using the Fastify adapter for NestJS and running the app without a reverse proxy (i.e. locally for development), upon each request with the @RealIP decorator, the following warning is printed:

[FSTDEP005] FastifyDeprecation: You are accessing the deprecated "request.connection" property. Use "request.socket" instead.

It seems that the underlying request-ip library attempts to read the remote address form request.connection before trying to do so from request.socket. Given the fact that the request-ip library maintenance status appears to be rather stale, I propose swapping that dependency for https://github.com/supercharge/request-ip, which has already addressed that issue: supercharge/request-ip#5

Some client are providing IPv6 address

Hello!
I found that some client are providing IPv6 address and some client are IPv4.
How could I get IPv4 only?
Thank you!

request-ip as peerDependencies

Hello,

It looks like the dependency to request IPs have been changed from request-ip to @supercharge/request-ip. Unfortunately, the old one is still requested in peerDependencies.

Ref:

nestjs-real-ip/package.json

Line 58 in eff99b4

"request-ip": "^2.1.3"