Skip to content

Latest commit

 

History

History

koa3

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

@contrast/koa-test-bench

An intentionally vulnerable koa application.

Running Locally

Make sure you have Node.js installed or install a version of Node from nvm.

git clone https://github.com/Contrast-Security-OSS/NodeTestBenches.git # or clone your own fork
cd NodeTestBenches/koa
npm install
npm start

Your app should now be running on localhost:3000.

Running with Contrast

Installation

See our documentation for installation instructions.

After installation, the agent can be run with npm run contrast. For more information on configuration and which technologies the agent supports, see our documentation.

Adding a shared vulnerability

Once you have added shared functionality to @contrast/test-bench-utils, you are ready to add an endpoint in the test bench application.

Create a routes/ruleName.js file and call the controllerFactory method:

const controllerFactory = require('../../utils/controllerFactory');
module.exports = controllerFactory('ruleName');

Check the documentation for controllerFactory under utils/controllerFactory.js usage information.

Add a view/ruleName.js file that includes the shared template from @contrast/test-bench-utils:

<% include ../node_modules/@contrast/test-bench-utils/public/views/ruleName.ejs %>

Now run the app and make sure everything works as expected!