Skip to content

Commit

Permalink
readme tidy
Browse files Browse the repository at this point in the history
  • Loading branch information
Contra committed Sep 5, 2011
1 parent 68b4475 commit c611baf
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Expand Up @@ -12,7 +12,8 @@ Please see [the examples folder](http://github.com/wearefractal/fusker/blob/mast

You think you're one raw dog? [fusker.nodester.com](http://fusker.nodester.com/) Come at me bro.

## List of included HTTP detection modules (detectives)
## HTTP Configuration
### List of included HTTP detection modules (detectives)
```
csrf - Detects cross-site request forgery in incoming http requests
xss - Detects common XSS attacks in incoming http requests
Expand All @@ -21,7 +22,7 @@ lfi - Detects common LFI attacks in incoming http requests
404 - Punishes people who like to snoop around. Only use with single page applications
```

## List of included HTTP payload modules
### List of included HTTP payload modules
```
blacklist - Blacklists IP from HTTP server for specified amount of time (banLength in config)
fake-report - Alerts attacker that they have been reported to ic3 and displays DOJ logo
Expand All @@ -37,41 +38,42 @@ raggedyann - Redirects attacker to extreme speaker rape. (WARNING: Harmful to sp
crews - Displays Terry Crews nipple dance rainbow b& page
```

## Adding HTTP detectives
### Adding HTTP detectives

Add a .js or .coffee file to the 'http-detectives' directory of the module.

## Adding HTTP payloads
### Adding HTTP payloads

Add a .js or .coffee file to the 'http-payloads' directory of the module.

## List of included SocketIO detection modules (detectives)
## Socket.io Configuration
### List of included SocketIO detection modules (detectives)
```
xss - Detects common XSS attacks in incoming socket messages
sqli - Detects SQLi attempts in incoming socket messages
lfi - Detects common LFI attacks in incoming socket messages
```

## List of included SocketIO payload modules
### List of included SocketIO payload modules
```
blacklist - Blacklists IP from SocketIO server for specified amount of time (banLength in config)
```

## Adding SocketIO detectives
### Adding SocketIO detectives

Add a .js or .coffee file to the 'socket-detectives' directory of the module.

## Adding SocketIO payloads
### Adding SocketIO payloads

Add a .js or .coffee file to the 'socket-payloads' directory of the module.

## Express Middleware
## Other Configuration
### Express Middleware
Please see [this](http://github.com/wearefractal/fusker/blob/master/examples/express-test.coffee) for a working express example.
It's as easy as ```app.use(fusker.express.check);```
Detectives/payloads are the same as they would be for the fusker HTTP server. Make sure fusker is the first piece of middleware added.

## PROTIPS

### PROTIPS
Setting config.silent to true will turn off all logging
Setting config.verbose to true will turn on a ton of logging

Expand Down

0 comments on commit c611baf

Please sign in to comment.