aiwaf-js 0.0.8 → 0.0.9

package/package.json

@@ -1,8 +1,19 @@
 {
     "name": "aiwaf-js",
-    "version": "0.0.8",
+    "version": "0.0.9",
     "description": "Adaptive Web Application Firewall middleware for Node.js (Express, Fastify, Hapi, Next.js)",
     "main": "index.js",
+    "files": [
+        "index.js",
+        "bin/",
+        "lib/",
+        "resources/",
+        "utils/",
+        "train.js",
+        "README.md",
+        "INSTALLATION.md",
+        "LICENSE"
+    ],
     "bin": {
         "aiwaf": "bin/aiwaf.js"
     },
@@ -64,6 +75,10 @@
         "middleware",
         "ml"
     ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/aiwaf/aiwaf-js"
+    },
     "author": "Aayush Gauba",
     "license": "MIT"
 }

package/.dockerignore

@@ -1,6 +0,0 @@
-node_modules
-**/node_modules
-dist
-build
-npm-debug.log
-*.log

package/.github/workflows/node.js.yml

@@ -1,31 +0,0 @@
-# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
- # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
- 
- name: Node.js CI
- 
- on:
-   push:
-     branches: [ "main" ]
-   pull_request:
-     branches: [ "main" ]
- 
- jobs:
-   build:
- 
-     runs-on: ubuntu-latest
- 
-     strategy:
-       matrix:
-         node-version: [18.x, 20.x, 22.x]
-         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
- 
-     steps:
-     - uses: actions/checkout@v4
-     - name: Use Node.js ${{ matrix.node-version }}
-       uses: actions/setup-node@v4
-       with:
-         node-version: ${{ matrix.node-version }}
-         cache: 'npm'
-     - run: npm install
-     - run: npm run build --if-present
-     - run: npm test

package/.github/workflows/npm-publish.yml

@@ -1,27 +0,0 @@
-name: Publish to npm
-
-on:
-  release:
-    types: [created]
-  workflow_dispatch:
-
-jobs:
-  build-and-publish:
-    runs-on: ubuntu-latest
-    environment: npm-publish
-
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          registry-url: https://registry.npmjs.org/
-
-      - run: npm install
-      - run: npm test
-      - run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/examples/sandbox/README.md

@@ -1,95 +0,0 @@
-# AIWAF-JS + OWASP Juice Shop Sandbox
-
-This sandbox runs AIWAF-JS as a proxy in front of OWASP Juice Shop.
-
-## Run
-
-From `examples/sandbox/`:
-
-```bash
-docker compose up --build
-```
-
-Then open:
-
-- AIWAF-protected: `http://localhost:3000`
-- AIWAF-protected (Fastify): `http://localhost:3002`
-- AIWAF-protected (Hapi): `http://localhost:3003`
-- AIWAF-protected (Koa): `http://localhost:3004`
-- AIWAF-protected (NestJS): `http://localhost:3005`
-- AIWAF-protected (Next.js): `http://localhost:3006`
-- AIWAF-protected (AdonisJS): `http://localhost:3007`
-- Direct Juice Shop: `http://localhost:3001`
-
-## Test
-
-```bash
-curl http://localhost:3000
-curl http://localhost:3000/admin.php
-curl http://localhost:3000/../../etc/passwd
-curl -A "sqlmap/1.0" http://localhost:3000
-```
-
-Check logs in the `aiwaf_logs` volume (JSONL).
-
-## Attack Suite
-
-Run against direct Juice Shop:
-
-```bash
-node attack-suite.js http://localhost:3001 direct
-```
-
-Run against AIWAF-protected Juice Shop:
-
-```bash
-node attack-suite.js http://localhost:3000 protected
-```
-
-Run against AIWAF-protected Juice Shop (Fastify):
-
-```bash
-node attack-suite.js http://localhost:3002 protected_fastify
-```
-
-Run against AIWAF-protected Juice Shop (Hapi):
-
-```bash
-node attack-suite.js http://localhost:3003 protected_hapi
-```
-
-Run against AIWAF-protected Juice Shop (Koa):
-
-```bash
-node attack-suite.js http://localhost:3004 protected_koa
-```
-
-Run against AIWAF-protected Juice Shop (NestJS):
-
-```bash
-node attack-suite.js http://localhost:3005 protected_nest
-```
-
-Run against AIWAF-protected Juice Shop (Next.js):
-
-```bash
-node attack-suite.js http://localhost:3006 protected_next
-```
-
-Run against AIWAF-protected Juice Shop (AdonisJS):
-
-```bash
-node attack-suite.js http://localhost:3007 protected_adonis
-```
-
-Compare results:
-
-```bash
-node compare-results.js results_direct_*.json results_protected_*.json results_protected_fastify_*.json results_protected_hapi_*.json results_protected_koa_*.json results_protected_nest_*.json results_protected_next_*.json results_protected_adonis_*.json
-```
-
-Or run the full suite + comparison in one command:
-
-```bash
-node run-and-compare.js
-```

package/examples/sandbox/aiwaf-adonis-proxy/Dockerfile

@@ -1,16 +0,0 @@
-FROM node:20-bullseye
-
-WORKDIR /workspace
-COPY . /workspace
-
-RUN apt-get update && apt-get install -y python3 make g++ \
-  && rm -rf /var/lib/apt/lists/*
-
-RUN npm_config_build_from_source=true npm install
-
-WORKDIR /workspace/examples/sandbox/aiwaf-adonis-proxy
-
-RUN npm_config_build_from_source=true npm install
-
-EXPOSE 3007
-CMD ["npm", "start"]

package/examples/sandbox/aiwaf-adonis-proxy/package.json

@@ -1,13 +0,0 @@
-{
-  "name": "aiwaf-adonis-proxy-sandbox",
-  "version": "1.0.0",
-  "private": true,
-  "type": "commonjs",
-  "scripts": {
-    "start": "node server.js"
-  },
-  "dependencies": {
-    "aiwaf-js": "file:../../..",
-    "http-proxy-middleware": "^3.0.0"
-  }
-}

package/examples/sandbox/aiwaf-adonis-proxy/server.js

@@ -1,71 +0,0 @@
-const { createProxyMiddleware } = require('http-proxy-middleware');
-const aiwaf = require('aiwaf-js');
-
-const PORT = process.env.PORT || 3007;
-const TARGET_BASE_URL = process.env.TARGET_BASE_URL || 'http://localhost:3001';
-
-const proxy = createProxyMiddleware({
-  target: TARGET_BASE_URL,
-  changeOrigin: true,
-  ws: true,
-  logLevel: 'warn'
-});
-
-function createCtx(req, res) {
-  const response = {
-    response: res,
-    statusCode: res.statusCode || 200,
-    status(code) {
-      response.statusCode = code;
-      res.statusCode = code;
-      return response;
-    },
-    send(payload) {
-      res.end(payload);
-      return response;
-    },
-    json(payload) {
-      res.setHeader('content-type', 'application/json');
-      res.end(JSON.stringify(payload));
-      return response;
-    }
-  };
-
-  const request = {
-    request: req,
-    url: () => req.url,
-    headers: () => req.headers || {},
-    ip: () => (req.headers?.['x-forwarded-for'] || req.socket?.remoteAddress),
-    method: () => req.method
-  };
-
-  return { request, response };
-}
-
-const middleware = aiwaf.adonis({
-  staticKeywords: ['.php', '.env', '.git', '../'],
-  dynamicTopN: 5,
-  WINDOW_SEC: 10,
-  MAX_REQ: 25,
-  FLOOD_REQ: 50,
-  HONEYPOT_FIELD: 'hp_field',
-  AIWAF_METHOD_POLICY_ENABLED: true,
-  AIWAF_ALLOWED_METHODS: ['GET', 'POST', 'HEAD', 'OPTIONS'],
-  AIWAF_HEADER_VALIDATION: true,
-  AIWAF_REQUIRED_HEADERS: [],
-  AIWAF_MIDDLEWARE_LOGGING: true,
-  AIWAF_MIDDLEWARE_LOG_PATH: process.env.AIWAF_MIDDLEWARE_LOG_PATH || 'logs/aiwaf-requests.jsonl'
-});
-
-require('http')
-  .createServer(async (req, res) => {
-    console.log(`[sandbox-adonis] ${req.method} ${req.url}`);
-    const ctx = createCtx(req, res);
-    await middleware(ctx, () => new Promise(resolve => {
-      proxy(req, res, resolve);
-    }));
-  })
-  .listen(PORT, '0.0.0.0', () => {
-    console.log(`AIWAF Adonis sandbox proxy running on port ${PORT}`);
-    console.log(`Forwarding traffic to ${TARGET_BASE_URL}`);
-  });

package/examples/sandbox/aiwaf-fastify-proxy/Dockerfile

@@ -1,21 +0,0 @@
-FROM node:20-bullseye
-
-WORKDIR /workspace
-
-COPY . /workspace
-
-WORKDIR /workspace
-
-RUN apt-get update && apt-get install -y python3 make g++ && rm -rf /var/lib/apt/lists/*
-
-ENV npm_config_build_from_source=sqlite3
-
-RUN npm install
-
-WORKDIR /workspace/examples/sandbox/aiwaf-fastify-proxy
-
-RUN npm install
-
-EXPOSE 3002
-
-CMD ["npm", "start"]

package/examples/sandbox/aiwaf-fastify-proxy/package.json

@@ -1,16 +0,0 @@
-{
-  "name": "aiwaf-fastify-proxy-sandbox",
-  "version": "1.0.0",
-  "private": true,
-  "main": "server.js",
-  "type": "commonjs",
-  "scripts": {
-    "start": "node server.js"
-  },
-  "dependencies": {
-    "aiwaf-js": "file:../../..",
-    "fastify": "^4.29.1",
-    "@fastify/middie": "^8.0.0",
-    "http-proxy-middleware": "^3.0.0"
-  }
-}

package/examples/sandbox/aiwaf-fastify-proxy/server.js

@@ -1,42 +0,0 @@
-const fastify = require('fastify')({ logger: true });
-const aiwaf = require('aiwaf-js');
-const { createProxyMiddleware } = require('http-proxy-middleware');
-
-const PORT = process.env.PORT || 3002;
-const TARGET_BASE_URL = process.env.TARGET_BASE_URL || 'http://localhost:3001';
-
-fastify.register(aiwaf.fastify, {
-  staticKeywords: ['.php', '.env', '.git', '../'],
-  dynamicTopN: 5,
-  WINDOW_SEC: 10,
-  MAX_REQ: 25,
-  FLOOD_REQ: 50,
-  HONEYPOT_FIELD: 'hp_field',
-  AIWAF_METHOD_POLICY_ENABLED: true,
-  AIWAF_ALLOWED_METHODS: ['GET', 'POST', 'HEAD', 'OPTIONS'],
-  AIWAF_HEADER_VALIDATION: true,
-  AIWAF_REQUIRED_HEADERS: [],
-  AIWAF_MIDDLEWARE_LOGGING: true,
-  AIWAF_MIDDLEWARE_LOG_PATH: process.env.AIWAF_MIDDLEWARE_LOG_PATH || 'logs/aiwaf-requests.jsonl'
-});
-
-fastify.addHook('onRequest', async (request, reply) => {
-  fastify.log.info(`[sandbox-fastify] ${request.method} ${request.url}`);
-});
-
-fastify.register(require('@fastify/middie')).then(() => {
-  fastify.use(
-    '/',
-    createProxyMiddleware({
-      target: TARGET_BASE_URL,
-      changeOrigin: true,
-      ws: true,
-      logLevel: 'warn'
-    })
-  );
-});
-
-fastify.listen({ port: PORT, host: '0.0.0.0' }).then(() => {
-  fastify.log.info(`AIWAF Fastify sandbox proxy running on port ${PORT}`);
-  fastify.log.info(`Forwarding traffic to ${TARGET_BASE_URL}`);
-});

package/examples/sandbox/aiwaf-hapi-proxy/Dockerfile

@@ -1,16 +0,0 @@
-FROM node:20-bullseye
-
-WORKDIR /workspace
-COPY . /workspace
-
-RUN apt-get update && apt-get install -y python3 make g++ \
-  && rm -rf /var/lib/apt/lists/*
-
-RUN npm_config_build_from_source=true npm install
-
-WORKDIR /workspace/examples/sandbox/aiwaf-hapi-proxy
-
-RUN npm_config_build_from_source=true npm install
-
-EXPOSE 3003
-CMD ["npm", "start"]

package/examples/sandbox/aiwaf-hapi-proxy/package.json

@@ -1,15 +0,0 @@
-{
-  "name": "aiwaf-hapi-proxy-sandbox",
-  "version": "1.0.0",
-  "private": true,
-  "main": "server.js",
-  "type": "commonjs",
-  "scripts": {
-    "start": "node server.js"
-  },
-  "dependencies": {
-    "aiwaf-js": "file:../../..",
-    "@hapi/hapi": "^21.3.12",
-    "@hapi/h2o2": "^10.0.4"
-  }
-}

package/examples/sandbox/aiwaf-hapi-proxy/server.js

@@ -1,55 +0,0 @@
-const Hapi = require('@hapi/hapi');
-const H2o2 = require('@hapi/h2o2');
-const aiwaf = require('aiwaf-js');
-
-const PORT = process.env.PORT || 3003;
-const TARGET_BASE_URL = process.env.TARGET_BASE_URL || 'http://localhost:3001';
-
-async function start() {
-  const server = Hapi.server({ port: PORT, host: '0.0.0.0' });
-
-  await server.register(H2o2);
-  await server.register({
-    plugin: aiwaf.hapi,
-    options: {
-      staticKeywords: ['.php', '.env', '.git', '../'],
-      dynamicTopN: 5,
-      WINDOW_SEC: 10,
-      MAX_REQ: 25,
-      FLOOD_REQ: 50,
-      HONEYPOT_FIELD: 'hp_field',
-      AIWAF_METHOD_POLICY_ENABLED: true,
-      AIWAF_ALLOWED_METHODS: ['GET', 'POST', 'HEAD', 'OPTIONS'],
-      AIWAF_HEADER_VALIDATION: true,
-      AIWAF_REQUIRED_HEADERS: [],
-      AIWAF_MIDDLEWARE_LOGGING: true,
-      AIWAF_MIDDLEWARE_LOG_PATH: process.env.AIWAF_MIDDLEWARE_LOG_PATH || 'logs/aiwaf-requests.jsonl'
-    }
-  });
-
-  server.ext('onRequest', (request, h) => {
-    console.log(`[sandbox-hapi] ${request.method.toUpperCase()} ${request.url.pathname}`);
-    return h.continue;
-  });
-
-  server.route({
-    method: '*',
-    path: '/{path*}',
-    handler: {
-      proxy: {
-        uri: TARGET_BASE_URL,
-        passThrough: true,
-        xforward: true
-      }
-    }
-  });
-
-  await server.start();
-  console.log(`AIWAF Hapi sandbox proxy running on port ${PORT}`);
-  console.log(`Forwarding traffic to ${TARGET_BASE_URL}`);
-}
-
-start().catch(err => {
-  console.error(err);
-  process.exit(1);
-});

package/examples/sandbox/aiwaf-koa-proxy/Dockerfile

@@ -1,16 +0,0 @@
-FROM node:20-bullseye
-
-WORKDIR /workspace
-COPY . /workspace
-
-RUN apt-get update && apt-get install -y python3 make g++ \
-  && rm -rf /var/lib/apt/lists/*
-
-RUN npm_config_build_from_source=true npm install
-
-WORKDIR /workspace/examples/sandbox/aiwaf-koa-proxy
-
-RUN npm_config_build_from_source=true npm install
-
-EXPOSE 3004
-CMD ["npm", "start"]

package/examples/sandbox/aiwaf-koa-proxy/package.json

@@ -1,16 +0,0 @@
-{
-  "name": "aiwaf-koa-proxy-sandbox",
-  "version": "1.0.0",
-  "private": true,
-  "main": "server.js",
-  "type": "commonjs",
-  "scripts": {
-    "start": "node server.js"
-  },
-  "dependencies": {
-    "aiwaf-js": "file:../../..",
-    "koa": "^2.15.4",
-    "koa-bodyparser": "^4.4.1",
-    "koa-proxies": "^0.12.4"
-  }
-}

package/examples/sandbox/aiwaf-koa-proxy/server.js

@@ -1,41 +0,0 @@
-const Koa = require('koa');
-const bodyParser = require('koa-bodyparser');
-const proxy = require('koa-proxies');
-const aiwaf = require('aiwaf-js');
-
-const PORT = process.env.PORT || 3004;
-const TARGET_BASE_URL = process.env.TARGET_BASE_URL || 'http://localhost:3001';
-
-const app = new Koa();
-
-app.use(bodyParser());
-app.use((ctx, next) => {
-  console.log(`[sandbox-koa] ${ctx.method} ${ctx.url}`);
-  return next();
-});
-
-app.use(aiwaf.koa({
-  staticKeywords: ['.php', '.env', '.git', '../'],
-  dynamicTopN: 5,
-  WINDOW_SEC: 10,
-  MAX_REQ: 25,
-  FLOOD_REQ: 50,
-  HONEYPOT_FIELD: 'hp_field',
-  AIWAF_METHOD_POLICY_ENABLED: true,
-  AIWAF_ALLOWED_METHODS: ['GET', 'POST', 'HEAD', 'OPTIONS'],
-  AIWAF_HEADER_VALIDATION: true,
-  AIWAF_REQUIRED_HEADERS: [],
-  AIWAF_MIDDLEWARE_LOGGING: true,
-  AIWAF_MIDDLEWARE_LOG_PATH: process.env.AIWAF_MIDDLEWARE_LOG_PATH || 'logs/aiwaf-requests.jsonl'
-}));
-
-app.use(proxy('/', {
-  target: TARGET_BASE_URL,
-  changeOrigin: true,
-  logs: true
-}));
-
-app.listen(PORT, () => {
-  console.log(`AIWAF Koa sandbox proxy running on port ${PORT}`);
-  console.log(`Forwarding traffic to ${TARGET_BASE_URL}`);
-});

package/examples/sandbox/aiwaf-nest-proxy/Dockerfile

@@ -1,17 +0,0 @@
-FROM node:20-bullseye
-
-WORKDIR /workspace
-COPY . /workspace
-
-RUN apt-get update && apt-get install -y python3 make g++ \
-  && rm -rf /var/lib/apt/lists/*
-
-RUN npm_config_build_from_source=true npm install
-
-WORKDIR /workspace/examples/sandbox/aiwaf-nest-proxy
-
-RUN npm_config_build_from_source=true npm install
-RUN npm_config_build_from_source=true npm install http-proxy-middleware
-
-EXPOSE 3005
-CMD ["npm", "start"]

package/examples/sandbox/aiwaf-nest-proxy/main.js

@@ -1,55 +0,0 @@
-require('reflect-metadata');
-const { NestFactory } = require('@nestjs/core');
-const { Module } = require('@nestjs/common');
-const { createProxyMiddleware } = require('http-proxy-middleware');
-const aiwaf = require('aiwaf-js');
-
-const PORT = process.env.PORT || 3005;
-const TARGET_BASE_URL = process.env.TARGET_BASE_URL || 'http://localhost:3001';
-
-class AppModule {}
-
-Module({})(AppModule);
-
-async function bootstrap() {
-  const app = await NestFactory.create(AppModule);
-
-  app.use(aiwaf({
-    staticKeywords: ['.php', '.env', '.git', '../'],
-    dynamicTopN: 5,
-    WINDOW_SEC: 10,
-    MAX_REQ: 25,
-    FLOOD_REQ: 50,
-    HONEYPOT_FIELD: 'hp_field',
-    AIWAF_METHOD_POLICY_ENABLED: true,
-    AIWAF_ALLOWED_METHODS: ['GET', 'POST', 'HEAD', 'OPTIONS'],
-    AIWAF_HEADER_VALIDATION: true,
-    AIWAF_REQUIRED_HEADERS: [],
-    AIWAF_MIDDLEWARE_LOGGING: true,
-    AIWAF_MIDDLEWARE_LOG_PATH: process.env.AIWAF_MIDDLEWARE_LOG_PATH || 'logs/aiwaf-requests.jsonl'
-  }));
-
-  app.use((req, res, next) => {
-    console.log(`[sandbox-nest] ${req.method} ${req.originalUrl}`);
-    next();
-  });
-
-  app.use(
-    '/',
-    createProxyMiddleware({
-      target: TARGET_BASE_URL,
-      changeOrigin: true,
-      ws: true,
-      logLevel: 'warn'
-    })
-  );
-
-  await app.listen(PORT, '0.0.0.0');
-  console.log(`AIWAF NestJS sandbox proxy running on port ${PORT}`);
-  console.log(`Forwarding traffic to ${TARGET_BASE_URL}`);
-}
-
-bootstrap().catch(err => {
-  console.error(err);
-  process.exit(1);
-});

package/examples/sandbox/aiwaf-nest-proxy/package.json

@@ -1,20 +0,0 @@
-{
-  "name": "aiwaf-nest-proxy-sandbox",
-  "version": "1.0.0",
-  "private": true,
-  "main": "main.js",
-  "type": "commonjs",
-  "scripts": {
-    "start": "node main.js"
-  },
-  "dependencies": {
-    "aiwaf-js": "file:../../..",
-    "@nestjs/core": "^10.4.2",
-    "@nestjs/common": "^10.4.2",
-    "@nestjs/platform-express": "^10.4.2",
-    "http-proxy-middleware": "^3.0.0",
-    "reflect-metadata": "^0.1.14",
-    "rxjs": "^7.8.1",
-    "express": "^4.21.2"
-  }
-}

package/examples/sandbox/aiwaf-next-proxy/Dockerfile

@@ -1,16 +0,0 @@
-FROM node:20-bullseye
-
-WORKDIR /workspace
-COPY . /workspace
-
-RUN apt-get update && apt-get install -y python3 make g++ \
-  && rm -rf /var/lib/apt/lists/*
-
-RUN npm_config_build_from_source=true npm install
-
-WORKDIR /workspace/examples/sandbox/aiwaf-next-proxy
-
-RUN npm_config_build_from_source=true npm install
-
-EXPOSE 3006
-CMD ["npm", "start"]

package/examples/sandbox/aiwaf-next-proxy/package.json

@@ -1,16 +0,0 @@
-{
-  "name": "aiwaf-next-proxy-sandbox",
-  "version": "1.0.0",
-  "private": true,
-  "type": "commonjs",
-  "scripts": {
-    "start": "node server.js"
-  },
-  "dependencies": {
-    "aiwaf-js": "file:../../..",
-    "http-proxy-middleware": "^3.0.0",
-    "next": "^14.2.13",
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1"
-  }
-}

package/examples/sandbox/aiwaf-next-proxy/pages/index.js

@@ -1,3 +0,0 @@
-export default function Home() {
-  return <div>AIWAF Next.js sandbox proxy</div>;
-}