https://github.com/reloadly/http-firewall

Lightweight Http Firewall to protect against common threats
https://github.com/reloadly/http-firewall

Last synced: about 7 hours ago
JSON representation

Lightweight Http Firewall to protect against common threats

• Host: GitHub
• URL: https://github.com/reloadly/http-firewall
• Owner: Reloadly
• License: apache-2.0
• Created: 2023-01-22T02:35:46.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-16T09:18:13.000Z (almost 2 years ago)
• Last Synced: 2025-01-08T12:59:27.253Z (5 days ago)
• Language: TypeScript
• Size: 67.4 KB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![Build Status](https://github.com/Reloadly/http-firewall/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/Reloadly/http-firewall/actions/workflows/build.yml)

[![codecov](https://codecov.io/gh/Reloadly/http-firewall/branch/main/graph/badge.svg?token=E605JYZ763)](https://codecov.io/gh/Reloadly/http-firewall)

[![Issues](https://img.shields.io/github/issues/Reloadly/http-firewall.svg)](https://github.com/Reloadly/http-firewall/issues)

[![Latest Release](https://img.shields.io/github/v/release/Reloadly/http-firewall?include_prereleases&sort=semver)](https://github.com/Reloadly/http-firewall/releases)

# http-firewall

Lightweight Http Firewall to protect against common threats.

This is a direct port of

the [Spring Security HttpFirewall](https://docs.spring.io/spring-security/reference/servlet/exploits/firewall.html).

- This library is a middleware for Express Server.

- Its highly recommended not to disable firewall rules, since its extremely risky to do so. You can however provided

  your own overrides that gives you the options of disable rules or provide your own constraints.

- If a threat is detected, a HTTP status code 403 is returned to the caller, and no further processing happens.

- Calls which pass the firewall rules, will process as normal.

## Examples ##

The firewall can be configured as shown below:

### TypeScript Usage ###

```typescript

import express, { Request, Response } from 'express';

import { HttpFirewallOptions, Predicate, httpFirewall } from '@prizemates/http-firewall';

const app = express();

const port = 3000;

// This middleware must be added before adding any other routes

app.use(httpFirewall())

// Or, you can customize the behaviour by providing options. See HttpFirewallOptions

// app.use(httpFirewall({logToConsole : true}));

app.get('/', (req: Request, res: Response) => {

  res.send('Http Firewall Demo running');

});

app.listen(port, () => {

  console.log(`⚡️[server]: Server is running at http://localhost:${port}`);

});

```

### Javascript Usage ###

```javascript

const express = require("express");

const { httpFirewall } = require("@prizemates/http-firewall");

const app = express();

const port = 3000;

app.use(httpFirewall())

// Or, you can customize the behaviour by providing options. See HttpFirewallOptions

// app.use(httpFirewall({logToConsole : true}));

app.get('/', (req: Request, res: Response) => {

  res.send('Http Firewall Demo running');

});

app.listen(port, () => {

  console.log(`⚡️[server]: Server is running at http://localhost:${port}`);

});

```