nestjs-ip-filter 0.1.0

package/.eslintrc.js

@@ -0,0 +1,29 @@
+// eslint-disable-next-line no-undef
+module.exports = {
+  root: true,
+  env: {
+    node: true,
+    es2017: true,
+  },
+  extends: [
+    'google',
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 8,
+    sourceType: 'module',
+    tsconfigRootDir: __dirname,
+  },
+  plugins: ['@typescript-eslint'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 0,
+    '@typescript-eslint/explicit-function-return-type': 0,
+    '@typescript-eslint/explicit-module-boundary-types': 0,
+    '@typescript-eslint/no-explicit-any': 0,
+    'new-cap': 0,
+    'require-jsdoc': 0,
+  },
+};

package/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

package/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "editor.tabSize": 2
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Deokgyu Yang <secugyu@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,190 @@
+# NestJS IP Filter
+
+Now we can filter the incoming requests by setting the whitelist and the blacklist IP addresses.
+
+It will work using the built-in feature in NestJS, **Guard**, so it works like a charm as it should be and as much as it should do.
+
+## How to install
+
+Simply, install using NPM by the following command.
+
+```bash
+npm install nestjs-ip-filter
+```
+
+## Usage
+
+### Use Regex for the IP list
+
+You can use Regex format string for the IP ranges.
+
+For a simple example, if you want to allow the private network hosts in `192.168.0.1/16`, you can write the Regex string like the below.
+
+```bash
+# 192.168.0.0 ~ 192.168.255.255
+(^192.168.)
+```
+
+Check the other use cases.
+
+```bash
+# 192.168.0.100 ~ 192.168.0.110
+(^192.168.0.1[0-1]0)
+
+# 172.16.16.10, 172.16.17.10, 172.16.18.10
+(^172.16.1[6-8].10)
+
+# 110~119.*
+(^11[0-9].*)
+```
+
+And, writing in this way also works on this pacakge.
+
+But be aware of that you should write the Regex string very carefully to avoid allowing unwanted incoming IP addresses.
+
+### Baisc usage for Whitelist
+
+You can initialize the dedicated Guard using non-async or async mode, as like the other NestJS packages support.
+
+Use `forRoot` for the static IP address list.
+
+```typescript
+IpFilter.forRoot({
+  whitelist: [
+    '(^::1)',
+    '(^192.168.)',
+    '127.0.0.1',
+  ],
+}),
+```
+
+Or, use `forRootAsync` for the provided IP addresses from the other Provider, such as ConfigModule or RepositoryModule for your database.
+
+```typescript
+// If it would like to get the whitelist IPs from a config file,
+// and if MyConfigModule provides that
+
+IpFilter.forRootAsync({
+  imports: [ MyConfigModule ],
+  inject: [ MyConfigService ],
+  useFactory: async (myConfigService: MyConfigService) => ({
+    whitelist: myConfigService.getWhitelist(),
+  }),
+}),
+```
+
+Yeah, you can use your method to provide some async data.
+
+After setting up the `IpFilter` module with the `forRoot*` method, this will accept only the incoming requests for the given whitelist IP addresses.
+
+### Blacklist
+
+You can deny the requests that are from the blacklist IPs.
+
+Use `blacklist` option to let the Guart know the list.
+
+```typescript
+// If it would like to get the whitelist IPs from a config file,
+// and if MyConfigModule provides that
+
+IpFilter.forRootAsync({
+  imports: [ MyConfigModule ],
+  inject: [ MyConfigService ],
+  useFactory: async (myConfigService: MyConfigService) => ({
+    whitelist: myConfigService.getWhitelist(),
+    blacklist: myConfigService.getBlacklist(),
+  }),
+}),
+```
+
+Then its NestJS Guard will deny all the IPs which are from the blacklist.
+
+### Use IpFilterDenyException when denying a request
+
+You can handle the denial condition by catching the HTTP exception.
+
+If you want to throw that `IpFilterDenyException` when denial, set the option `useDenyException` to `true`.
+
+```typescript
+// If it would like to get the whitelist IPs from a config file,
+// and if MyConfigModule provides that
+
+IpFilter.forRootAsync({
+  imports: [ MyConfigModule ],
+  inject: [ MyConfigService ],
+  useFactory: async (myConfigService: MyConfigService) => ({
+    whitelist: myConfigService.getWhitelist(),
+    blacklist: myConfigService.getBlacklist(),
+    useDenyException: true,
+  }),
+}),
+```
+
+Then it will throw `IpFilterDenyException` when the request is denied for the given whitelist or the blacklist.
+
+So that, you can handle the denied request and can send a custom response on that handler, using NestJS **Exception Filter**.
+
+When the Guard throws an exception, it will also carry some informative data like the incoming IP address, current whitelist and blacklist.
+
+### Inject IpFilterService
+
+If you want, you can inject `IpFilterService` into your code and can see current options you put when you initilize it. And, you can set the whitelist and the blacklist too.
+
+Inject the service using the `IPFILTER_TOKEN` module.
+
+```typescript
+@Injectable()
+export class SomeService {
+  constructor(
+    @inject(IPFILTER_TOKEN)
+    private readonly ipFilterService: IpFilterService
+  ) {}
+  // ...
+}
+```
+
+Then you can edit the whitelist, blacklist IP addresses dynamically.
+
+```typescript
+this.ipFilterService.whitelist = [ {NEW_WHITELIST} ];
+this.ipFilterService.blacklist = [ {NEW_BLACKLIST} ];
+```
+
+## Example project
+
+This repository contains an example project of this `nestjs-ip-filter` package.
+
+Move to `example` directory and run the following commands.
+
+```bash
+npm ci
+npm start:debug
+```
+
+Then, the example project will run in **3001** port.
+
+With the `curl` command, you can do a simple test for the project.
+
+```bash
+curl -X GET -H "Content-Type: application/json" http://localhost:3001/ipfilter
+```
+
+It will result like the below, if your localhost IP is accepted for the whitelist.
+
+```bash
+{"whitelist":["(^::1)","(^192.168.)","127.0.0.1"],"blacklist":[]}
+```
+
+If it denies, it will result like the below. Check the `ipFilterData` field.
+
+```bash
+{"statusCode":403,"timestamp":"2022-06-13T09:29:40.452Z","ipFilterData":{"clientIp":"::ffff:127.0.0.1","whitelist":["(^::1)","(^192.168.)"],"blacklist":[]},"path":"/ipfilter"}
+```
+
+[Our exception filter](example/src/exception/ipfilter-exception-filter.exception.ts) put that additional field on the typical HttpException results.
+
+You can test the projects with your local host IP address, [by editing the whitelist and the blacklist](example/src/ip-repository/ip-repository.service.ts).
+
+## License
+
+It follows the [MIT license](LICENSE).

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export * from './ipfilter-core.module';
+export * from './ipfilter-deny.exception';
+export * from './ipfilter.constants';
+export * from './ipfilter.guard';
+export * from './ipfilter.interface';
+export * from './ipfilter.module';
+export * from './ipfilter.providers';
+export * from './ipfilter.service';

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ipfilter-core.module"), exports);
+__exportStar(require("./ipfilter-deny.exception"), exports);
+__exportStar(require("./ipfilter.constants"), exports);
+__exportStar(require("./ipfilter.guard"), exports);
+__exportStar(require("./ipfilter.interface"), exports);
+__exportStar(require("./ipfilter.module"), exports);
+__exportStar(require("./ipfilter.providers"), exports);
+__exportStar(require("./ipfilter.service"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAAuC;AACvC,4DAA0C;AAC1C,uDAAqC;AACrC,mDAAiC;AACjC,uDAAqC;AACrC,oDAAkC;AAClC,uDAAqC;AACrC,qDAAmC"}

package/dist/ipfilter-core.module.d.ts

@@ -0,0 +1,24 @@
+import { Provider, Type } from '@nestjs/common';
+import { IpFilterModuleAsyncOptions, IpFilterModuleOptions } from './ipfilter.interface';
+import { IpFilterGuard } from './ipfilter.guard';
+export declare class IpFilterCoreModule {
+    static forRoot(options: IpFilterModuleOptions): {
+        module: typeof IpFilterCoreModule;
+        providers: (Provider<any> | {
+            provide: string;
+            useClass: typeof IpFilterGuard;
+        })[];
+        exports: Provider<any>[];
+    };
+    static forRootAsync(options: IpFilterModuleAsyncOptions): {
+        module: typeof IpFilterCoreModule;
+        imports: (Type<any> | import("@nestjs/common").DynamicModule | Promise<import("@nestjs/common").DynamicModule> | import("@nestjs/common").ForwardReference<any>)[];
+        providers: (Provider<any> | {
+            provide: string;
+            useClass: typeof IpFilterGuard;
+        })[];
+        exports: import("@nestjs/common").FactoryProvider<any>[];
+    };
+    private static createAsyncProviders;
+    private static createAsyncOptionsProvider;
+}

package/dist/ipfilter-core.module.js

@@ -0,0 +1,87 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var IpFilterCoreModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IpFilterCoreModule = void 0;
+const common_1 = require("@nestjs/common");
+const ipfilter_constants_1 = require("./ipfilter.constants");
+const ipfilter_providers_1 = require("./ipfilter.providers");
+const ipfilter_service_1 = require("./ipfilter.service");
+const core_1 = require("@nestjs/core");
+const ipfilter_guard_1 = require("./ipfilter.guard");
+let IpFilterCoreModule = IpFilterCoreModule_1 = class IpFilterCoreModule {
+    static forRoot(options) {
+        const ipFilterServiceProvider = (0, ipfilter_providers_1.createIpFilterProviders)(options);
+        const ipFilterGuardProvider = {
+            provide: core_1.APP_GUARD,
+            useClass: ipfilter_guard_1.IpFilterGuard,
+        };
+        return {
+            module: IpFilterCoreModule_1,
+            providers: [ipFilterGuardProvider, ipFilterServiceProvider],
+            exports: [ipFilterServiceProvider],
+        };
+    }
+    static forRootAsync(options) {
+        const provider = {
+            inject: [ipfilter_constants_1.IPFILTER_MODULE_OPTIONS],
+            provide: ipfilter_constants_1.IPFILTER_TOKEN,
+            useFactory: (options) => new ipfilter_service_1.IpFilterService(options),
+        };
+        const ipFilterGuardProvider = {
+            provide: core_1.APP_GUARD,
+            useClass: ipfilter_guard_1.IpFilterGuard,
+        };
+        return {
+            module: IpFilterCoreModule_1,
+            imports: options.imports,
+            providers: [
+                ...this.createAsyncProviders(options),
+                ipFilterGuardProvider,
+                provider,
+            ],
+            exports: [provider],
+        };
+    }
+    static createAsyncProviders(options) {
+        if (options.useExisting || options.useFactory) {
+            return [this.createAsyncOptionsProvider(options)];
+        }
+        const useClass = options.useClass;
+        return [
+            this.createAsyncOptionsProvider(options),
+            {
+                provide: useClass,
+                useClass,
+            },
+        ];
+    }
+    static createAsyncOptionsProvider(options) {
+        if (options.useFactory) {
+            return {
+                inject: options.inject || [],
+                provide: ipfilter_constants_1.IPFILTER_MODULE_OPTIONS,
+                useFactory: options.useFactory,
+            };
+        }
+        const inject = [
+            (options.useClass || options.useExisting),
+        ];
+        return {
+            provide: ipfilter_constants_1.IPFILTER_MODULE_OPTIONS,
+            useFactory: async (optionsFactory) => await optionsFactory.createIpFilterModuleOptions(),
+            inject,
+        };
+    }
+};
+IpFilterCoreModule = IpFilterCoreModule_1 = __decorate([
+    (0, common_1.Global)(),
+    (0, common_1.Module)({})
+], IpFilterCoreModule);
+exports.IpFilterCoreModule = IpFilterCoreModule;
+//# sourceMappingURL=ipfilter-core.module.js.map

package/dist/ipfilter-core.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipfilter-core.module.js","sourceRoot":"","sources":["../lib/ipfilter-core.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAgE;AAMhE,6DAA+E;AAC/E,6DAA+D;AAC/D,yDAAqD;AACrD,uCAAyC;AACzC,qDAAiD;AAIjD,IAAa,kBAAkB,0BAA/B,MAAa,kBAAkB;IAC7B,MAAM,CAAC,OAAO,CAAC,OAA8B;QAC3C,MAAM,uBAAuB,GAAG,IAAA,4CAAuB,EAAC,OAAO,CAAC,CAAC;QACjE,MAAM,qBAAqB,GAAG;YAC5B,OAAO,EAAE,gBAAS;YAClB,QAAQ,EAAE,8BAAa;SACxB,CAAC;QAEF,OAAO;YACL,MAAM,EAAE,oBAAkB;YAC1B,SAAS,EAAE,CAAC,qBAAqB,EAAE,uBAAuB,CAAC;YAC3D,OAAO,EAAE,CAAC,uBAAuB,CAAC;SACnC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,OAAmC;QACrD,MAAM,QAAQ,GAAa;YACzB,MAAM,EAAE,CAAC,4CAAuB,CAAC;YACjC,OAAO,EAAE,mCAAc;YACvB,UAAU,EAAE,CAAC,OAA8B,EAAE,EAAE,CAC7C,IAAI,kCAAe,CAAC,OAAO,CAAC;SAC/B,CAAC;QACF,MAAM,qBAAqB,GAAG;YAC5B,OAAO,EAAE,gBAAS;YAClB,QAAQ,EAAE,8BAAa;SACxB,CAAC;QAEF,OAAO;YACL,MAAM,EAAE,oBAAkB;YAC1B,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,SAAS,EAAE;gBACT,GAAG,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC;gBACrC,qBAAqB;gBACrB,QAAQ;aACT;YACD,OAAO,EAAE,CAAC,QAAQ,CAAC;SACpB,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,oBAAoB,CACjC,OAAmC;QAEnC,IAAI,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,UAAU,EAAE;YAC7C,OAAO,CAAC,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC,CAAC;SACnD;QAED,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAwC,CAAC;QAElE,OAAO;YACL,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC;YACxC;gBACE,OAAO,EAAE,QAAQ;gBACjB,QAAQ;aACT;SACF,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,0BAA0B,CACvC,OAAmC;QAEnC,IAAI,OAAO,CAAC,UAAU,EAAE;YACtB,OAAO;gBACL,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;gBAC5B,OAAO,EAAE,4CAAuB;gBAChC,UAAU,EAAE,OAAO,CAAC,UAAU;aAC/B,CAAC;SACH;QAED,MAAM,MAAM,GAAG;YACb,CAAC,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,WAAW,CAAiC;SAC1E,CAAC;QAEF,OAAO;YACL,OAAO,EAAE,4CAAuB;YAChC,UAAU,EAAE,KAAK,EAAE,cAAsC,EAAE,EAAE,CAC3D,MAAM,cAAc,CAAC,2BAA2B,EAAE;YACpD,MAAM;SACP,CAAC;IACJ,CAAC;CACF,CAAA;AA/EY,kBAAkB;IAF9B,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,kBAAkB,CA+E9B;AA/EY,gDAAkB"}

package/dist/ipfilter-deny.exception.d.ts

@@ -0,0 +1,4 @@
+import { HttpException } from '@nestjs/common';
+export declare class IpFilterDenyException extends HttpException {
+    constructor(response: string | Record<string, any>, status: number);
+}

package/dist/ipfilter-deny.exception.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IpFilterDenyException = void 0;
+const common_1 = require("@nestjs/common");
+class IpFilterDenyException extends common_1.HttpException {
+    constructor(response, status) {
+        super(response, status);
+    }
+}
+exports.IpFilterDenyException = IpFilterDenyException;
+//# sourceMappingURL=ipfilter-deny.exception.js.map

package/dist/ipfilter-deny.exception.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipfilter-deny.exception.js","sourceRoot":"","sources":["../lib/ipfilter-deny.exception.ts"],"names":[],"mappings":";;;AAAA,2CAA+C;AAE/C,MAAa,qBAAsB,SAAQ,sBAAa;IACtD,YAAY,QAAsC,EAAE,MAAc;QAChE,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC1B,CAAC;CACF;AAJD,sDAIC"}

package/dist/ipfilter.constants.d.ts

@@ -0,0 +1,2 @@
+export declare const IPFILTER_MODULE_OPTIONS: unique symbol;
+export declare const IPFILTER_TOKEN: unique symbol;

package/dist/ipfilter.constants.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IPFILTER_TOKEN = exports.IPFILTER_MODULE_OPTIONS = void 0;
+exports.IPFILTER_MODULE_OPTIONS = Symbol('IpFilterModuleOptions');
+exports.IPFILTER_TOKEN = Symbol('IpFilterToken');
+//# sourceMappingURL=ipfilter.constants.js.map

package/dist/ipfilter.constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipfilter.constants.js","sourceRoot":"","sources":["../lib/ipfilter.constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,uBAAuB,GAAG,MAAM,CAAC,uBAAuB,CAAC,CAAC;AAC1D,QAAA,cAAc,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC"}

package/dist/ipfilter.guard.d.ts

@@ -0,0 +1,8 @@
+import { CanActivate, ExecutionContext } from '@nestjs/common';
+import { Observable } from 'rxjs';
+import { IpFilterService } from './ipfilter.service';
+export declare class IpFilterGuard implements CanActivate {
+    private readonly ipFilterService;
+    constructor(ipFilterService: IpFilterService);
+    canActivate(context: ExecutionContext): Promise<boolean> | Observable<boolean> | boolean;
+}

package/dist/ipfilter.guard.js

@@ -0,0 +1,57 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IpFilterGuard = void 0;
+const common_1 = require("@nestjs/common");
+const requestIp = require("@supercharge/request-ip");
+const ipfilter_service_1 = require("./ipfilter.service");
+const ipfilter_constants_1 = require("./ipfilter.constants");
+const ipfilter_deny_exception_1 = require("./ipfilter-deny.exception");
+let IpFilterGuard = class IpFilterGuard {
+    constructor(ipFilterService) {
+        this.ipFilterService = ipFilterService;
+    }
+    canActivate(context) {
+        const request = context.switchToHttp().getRequest();
+        const ipAddress = requestIp.getClientIp(request);
+        const whitelist = this.ipFilterService.whitelist;
+        const blacklist = this.ipFilterService.blacklist;
+        let approved = false;
+        if (whitelist.length > 0) {
+            approved = whitelist.some((item) => {
+                return new RegExp(item).test(ipAddress);
+            });
+        }
+        if (blacklist.length > 0) {
+            approved = !blacklist.some((item) => {
+                return new RegExp(item).test(ipAddress);
+            });
+        }
+        if (!approved && this.ipFilterService.useDenyException) {
+            throw new ipfilter_deny_exception_1.IpFilterDenyException({
+                clientIp: ipAddress,
+                whitelist: whitelist,
+                blacklist: blacklist,
+            }, 403);
+        }
+        return approved;
+    }
+};
+IpFilterGuard = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Inject)(ipfilter_constants_1.IPFILTER_TOKEN)),
+    __metadata("design:paramtypes", [ipfilter_service_1.IpFilterService])
+], IpFilterGuard);
+exports.IpFilterGuard = IpFilterGuard;
+//# sourceMappingURL=ipfilter.guard.js.map

package/dist/ipfilter.guard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipfilter.guard.js","sourceRoot":"","sources":["../lib/ipfilter.guard.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAKwB;AAExB,qDAAqD;AACrD,yDAAqD;AACrD,6DAAsD;AACtD,uEAAkE;AAGlE,IAAa,aAAa,GAA1B,MAAa,aAAa;IACxB,YAEmB,eAAgC;QAAhC,oBAAe,GAAf,eAAe,CAAiB;IAChD,CAAC;IAEJ,WAAW,CACT,OAAyB;QAEzB,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;QACpD,MAAM,SAAS,GAAW,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAEzD,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC;QACjD,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC;QAEjD,IAAI,QAAQ,GAAG,KAAK,CAAC;QAErB,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;YACxB,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBACjC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;SACJ;QAED,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;YACxB,QAAQ,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBAClC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;SACJ;QAED,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,eAAe,CAAC,gBAAgB,EAAE;YACtD,MAAM,IAAI,+CAAqB,CAC7B;gBACE,QAAQ,EAAE,SAAS;gBACnB,SAAS,EAAE,SAAS;gBACpB,SAAS,EAAE,SAAS;aACrB,EACD,GAAG,CACJ,CAAC;SACH;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF,CAAA;AA1CY,aAAa;IADzB,IAAA,mBAAU,GAAE;IAGR,WAAA,IAAA,eAAM,EAAC,mCAAc,CAAC,CAAA;qCACW,kCAAe;GAHxC,aAAa,CA0CzB;AA1CY,sCAAa"}

package/dist/ipfilter.interface.d.ts

@@ -0,0 +1,18 @@
+import { ModuleMetadata, Type } from '@nestjs/common';
+export declare type IpFilterModuleOptions = {
+    whitelist?: string[];
+    blacklist?: string[];
+    useDenyException?: boolean;
+};
+export interface IpFilterDenyHandler {
+    handle(): boolean;
+}
+export interface IpFilterOptionsFactory {
+    createIpFilterModuleOptions(): Promise<IpFilterModuleOptions> | IpFilterModuleOptions;
+}
+export interface IpFilterModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
+    inject?: any[];
+    useClass?: Type<IpFilterOptionsFactory>;
+    useExisting?: Type<IpFilterOptionsFactory>;
+    useFactory?: (...args: any[]) => Promise<IpFilterModuleOptions> | IpFilterModuleOptions;
+}

package/dist/ipfilter.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ipfilter.interface.js.map

package/dist/ipfilter.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipfilter.interface.js","sourceRoot":"","sources":["../lib/ipfilter.interface.ts"],"names":[],"mappings":""}

package/dist/ipfilter.module.d.ts

@@ -0,0 +1,6 @@
+import { DynamicModule } from '@nestjs/common';
+import { IpFilterModuleAsyncOptions, IpFilterModuleOptions } from './ipfilter.interface';
+export declare class IpFilter {
+    static forRoot(options: IpFilterModuleOptions): DynamicModule;
+    static forRootAsync(options: IpFilterModuleAsyncOptions): DynamicModule;
+}

package/dist/ipfilter.module.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IpFilter = void 0;
+const common_1 = require("@nestjs/common");
+const ipfilter_core_module_1 = require("./ipfilter-core.module");
+(0, common_1.Module)({});
+class IpFilter {
+    static forRoot(options) {
+        return {
+            module: IpFilter,
+            imports: [ipfilter_core_module_1.IpFilterCoreModule.forRoot(options)],
+        };
+    }
+    static forRootAsync(options) {
+        return {
+            module: IpFilter,
+            imports: [ipfilter_core_module_1.IpFilterCoreModule.forRootAsync(options)],
+        };
+    }
+}
+exports.IpFilter = IpFilter;
+//# sourceMappingURL=ipfilter.module.js.map

package/dist/ipfilter.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipfilter.module.js","sourceRoot":"","sources":["../lib/ipfilter.module.ts"],"names":[],"mappings":";;;AAAA,2CAAuD;AACvD,iEAA4D;AAM5D,IAAA,eAAM,EAAC,EAAE,CAAC,CAAC;AACX,MAAa,QAAQ;IACnB,MAAM,CAAC,OAAO,CAAC,OAA8B;QAC3C,OAAO;YACL,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,CAAC,yCAAkB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SAC/C,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,OAAmC;QACrD,OAAO;YACL,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,CAAC,yCAAkB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;SACpD,CAAC;IACJ,CAAC;CACF;AAdD,4BAcC"}

package/dist/ipfilter.providers.d.ts

@@ -0,0 +1,3 @@
+import { Provider } from '@nestjs/common';
+import { IpFilterModuleOptions } from './ipfilter.interface';
+export declare function createIpFilterProviders(options: IpFilterModuleOptions): Provider;

package/dist/ipfilter.providers.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createIpFilterProviders = void 0;
+const ipfilter_constants_1 = require("./ipfilter.constants");
+const ipfilter_service_1 = require("./ipfilter.service");
+function createIpFilterProviders(options) {
+    return {
+        provide: ipfilter_constants_1.IPFILTER_TOKEN,
+        useValue: new ipfilter_service_1.IpFilterService(options),
+    };
+}
+exports.createIpFilterProviders = createIpFilterProviders;
+//# sourceMappingURL=ipfilter.providers.js.map

package/dist/ipfilter.providers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipfilter.providers.js","sourceRoot":"","sources":["../lib/ipfilter.providers.ts"],"names":[],"mappings":";;;AAEA,6DAAsD;AACtD,yDAAqD;AAErD,SAAgB,uBAAuB,CACrC,OAA8B;IAE9B,OAAO;QACL,OAAO,EAAE,mCAAc;QACvB,QAAQ,EAAE,IAAI,kCAAe,CAAC,OAAO,CAAC;KACvC,CAAC;AACJ,CAAC;AAPD,0DAOC"}

package/dist/ipfilter.service.d.ts

@@ -0,0 +1,12 @@
+import { IpFilterModuleOptions } from './ipfilter.interface';
+export declare class IpFilterService {
+    readonly options: IpFilterModuleOptions;
+    useDenyException: boolean;
+    private _whitelist;
+    private _blacklist;
+    constructor(options: IpFilterModuleOptions);
+    get whitelist(): string[];
+    set whitelist(whitelist: string[]);
+    get blacklist(): string[];
+    set blacklist(blacklist: string[]);
+}