nestjs-security-cli 2.0.0 → 2.0.1

package/README.md

@@ -29,7 +29,23 @@ import { SecurityModule, BlacklistedIp, BlacklistedIpSchema, SecurityMiddleware
 			useFactory: () => ({
 				enableDatabase: true,
 				defaultBlockDurationHours: 24,
-				enableAutoBlocking: true
+				enableAutoBlocking: true,
+				// example of customizing the suspicious patterns
+				suspiciousPatterns: [
+					{ pattern: '/vendor', name: 'Composer Attempt' },
+					{ pattern: '/phpunit', name: 'PHPUnit Attempt' },
+					{ pattern: '/lib', name: 'Lib Attempt' },
+					{ pattern: '/laravel', name: 'Laravel Attempt' },
+					{ pattern: '/www', name: 'WWW Attempt' },
+					{ pattern: '/ws', name: 'Web Socket Attempt' },
+					{ pattern: '/yii', name: 'Yii Attempt' },
+					{ pattern: '/zend', name: 'Zend Attempt' },
+					{ pattern: '/test', name: 'Test Attempt' },
+					{ pattern: '/tests', name: 'Tests Attempt' },
+					{ pattern: '/testing', name: 'Testing Attempt' },
+					{ pattern: '/cms', name: 'CMS Attempt' },
+					{ pattern: '/crm', name: 'CRM Attempt' }
+				]
 			}),
 			imports: [ MongoDbModule ],
 			providers: [ ...IpBlockerProvider ]
@@ -37,11 +53,6 @@ import { SecurityModule, BlacklistedIp, BlacklistedIpSchema, SecurityMiddleware
 	]
 } )
 export class AppModule {
-	configure(consumer: MiddlewareConsumer): void {
-		consumer
-			.apply( SecurityMiddleware )
-			.forRoutes( { path: '*', method: RequestMethod.ALL } )
-	}
 }
 ```
 
@@ -85,13 +96,7 @@ import { SecurityModule, BlacklistedIp, BlacklistedIpSchema } from 'nestjs-secur
 export class AppModule {
 }
 
-export class AppModule {
-	configure(consumer: MiddlewareConsumer): void {
-		consumer
-			.apply( SecurityMiddleware )
-			.forRoutes( { path: '*', method: RequestMethod.ALL } )
-	}
-}
+export class AppModule {}
 ```
 
 ## Cache-Only Mode (No Database)
@@ -111,13 +116,7 @@ import { SecurityModule } from 'nestjs-security-cli'
 		} )
 	]
 } )
-export class AppModule {
-	configure(consumer: MiddlewareConsumer): void {
-		consumer
-			.apply( SecurityMiddleware )
-			.forRoutes( { path: '*', method: RequestMethod.ALL } )
-	}
-}
+export class AppModule {}
 ````
 
 ## SecurityService
@@ -127,8 +126,7 @@ IpBlockerProvider, it will automatically register the model. More on this down b
 
 ## Clean up cron
 
-There's a cron that runs to clean up old blocks. By default, it runs every 10 minutes. You can change this by setting
-the
+There's a cron that runs to clean up old blocks. By default, it runs every day at midnight.
 `CLEANUP_CRON` environment variable.
 
 ```text
@@ -152,28 +150,19 @@ export type Role = 'Admin' | 'User' | 'Moderator' | 'Guest'
 ```
 
 ## Register the IpBlacklistGuard globally
-
-```typescript
-import { Module, APP_GUARD } from '@nestjs/common'
-/* other imports */
-import { IpBlacklistGuard } from 'nestjs-security-cli'
-
-@Module( {
-	imports: [
-		/* other imports */
-	],
-	providers: [
-		{
-			provide: APP_GUARD,
-			useClass: IpBlacklistGuard // Register globally
-		}
-	]
-} )
-export class AppModule {
+### this is no longer needed, since the SecurityModule is now registered globally by default
+All you have to do is apply the guard to your controllers.
+```
+@UseGuards(IpBlacklistGuard) // add this to any, or all controller endpoints
+@Controller()
+export class AppController {
+	@Get()
+	someEndpoint(): object {
+		return { message: 'Hello World!' }
+	}
 }
 ```
 
-And then in your controllers simply use the `@UseGuards(IpBlacklistGuard)` decorator.
 
 ## Admin & Roles guards
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "nestjs-security-cli",
-	"version": "2.0.0",
+	"version": "2.0.1",
 	"description": "Advanced IP blocking, role-based security, and attack detection for NestJS applications",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",