!ReqWeb Logo
---

ReqWeb - Web Application Firewall (WAF)

ReqWeb is a lightweight and customizable Web Application Firewall (WAF) for Node.js. It provides IP-based filtering, request rate limiting, and logging, helping to protect your web applications from malicious traffic and unauthorized access.

Features

- IP Filtering: Block or allow specific IPs or CIDR ranges.
- Rate Limiting: Control the frequency of requests to prevent abuse.
- Request Blocking: Define custom rules to block unwanted requests.
- Logging: Detailed request logging to monitor security events.
- Easy Integration: Drop-in middleware for Express.js or any Node.js application.

Installation

To install ReqWeb, simply run the following command:

``bash
npm install reqweb
`

Usage

$3

1. Import the package:
First, require ReqWeb in your application:

`javascript

const express = require('express');
const reqweb = require('reqweb');
const apiRoutes = require('./web/public/routes/api');
const ipFilter = require('reqweb/src/middlewares/ipFilter');
const ruleEngine = require('reqweb/src/middlewares/ruleEngine');
const logger = require('reqweb/src/middlewares/logger');

`

2. Load Configuration:
ReqWeb allows you to customize your configuration by loading a userConfig.json file. Here’s an example of how to load it:

`javascript
/*user defined rules and configs currently not implementet and
working on an interface for easy config*/
const config = configLoader('reqweb/src/config/usertConfig.json');
`
Using default config
`javascript
const config = configLoader('reqweb/src/config/defaultConfig.json');
`

3. Apply the Middlewares:
Add the IP filtering middleware to your Express app:

`javascript
const app = express();

// Apply WAF middlewares
app.use(logger(config)); // Logging middleware
app.use(ipFilter(config)); // IP filtering middleware
app.use(rateLimiter(config)); // Rate limiting middleware
app.use(ruleEngine(config)); // Rule-based request blocking

//adding WAF web interface
app.use('/reqweb/api', apiRoutes);

app.get('/', (req, res) => {
res.send('Welcome to Homelab!');
});

//running your app with WAF web interface enabled
reqweb.startInterface(app, 3000);
`

Accessing ReqWeb web interface

with the above setup you will have access to your waf web configuration interface at the following address:
http://localhost:3000/reqweb/api/web

$3

In the userConfig.json file, you can define the list of blocked and allowed IPs:

`json
{
"blockedIPs": ["192.168.1.100", "203.0.113.0/24"],
"allowedIPs": ["127.0.0.1", "::1"]
}
`

$3

You can modify or extend the behavior of ReqWeb by tweaking the ipFilter.js middleware or adding your own custom rules.

---

Configuration Options

- blockedIPs: Array of IP addresses or CIDR ranges to block (e.g., ["192.168.1.100", "203.0.113.0/24"]).
- allowedIPs: (Optional) Array of IP addresses or CIDR ranges that are allowed even if the blockedIPs list would block them (e.g., ["127.0.0.1", "::1"]).

Advanced Features

- Rate Limiting: Set up rate limiting to avoid abusive requests.
- Logging: Enable logging using winston for better monitoring of requests and events.

$3

You can extend ReqWeb to add rate-limiting by combining it with other libraries like express-rate-limit.

---

Development & Testing

$3

To run tests, use Mocha and Chai for testing:

`bash
npm test
`

$3

If you're using TypeScript or want to transpile code, you can build the project like this:

`bash
npm run build
`

---

Contributing

Contributions are welcome! If you have suggestions, bug fixes, or improvements, feel free to submit a pull request.

1. Fork the repository.
2. Create your feature branch (git checkout -b feature-name).
3. Commit your changes (git commit -am 'Add new feature').
4. Push to the branch (git push origin feature-name`).
5. Create a new pull request.

---

License

This project is licensed under the Apache License 2.0 License - see the LICENSE file for details.

---