The OWASP NodeGoat project provides an environment to learn how OWASP Top 10 security risks apply to web applications developed using Node.js and how to effectively address them.
HTML JavaScript
Latest commit dd340c3 Sep 14, 2016 @ckarande ckarande committed on GitHub Merge pull request #78 from binarymist/masterForUpstream-DockerNonRoo…
…tUser

Docker as non root user. docker-compose build now succeeds.

README.md

NodeGoat

Being lightweight, fast, and scalable, Node.js is becoming a widely adopted platform for developing web applications. This project provides an environment to learn how OWASP Top 10 security risks apply to web applications developed using Node.js and how to effectively address them.

Getting Started

OWASP Top 10 for Node.js web applications:

Know it!

Tutorial Guide explaining how each of the OWASP Top 10 vulnerabilities can manifest in Node.js web apps and how to prevent it.

Do it!

A Vulnerable Node.js App for Ninjas to exploit, toast, and fix. You may like to set up your own copy of the app to fix and test vulnerabilities. Hint: Look for comments in the source code.

Default user accounts

The database comes pre-populated with these user accounts created as part of the seed data -

  • Admin Account - u:admin p:Admin_123
  • User Accounts (u:user1 p:User1_123), (u:user2 p:User2_123)
  • New users can also be added using the sign-up page.

How to Setup Your Copy of NodeGoat

OPTION 1 - One click install on Heroku

The the quickest way to get running with NodeGoat is to click the button below to deploy it on Heroku.

Even though it is not essential, but recommended that you fork this repository and deploy the forked repo. This would allow you to fix vulnerabilities in your own forked version, and deploy and test it on heroku.

Deploy

This Heroku instance uses Free ($0/month) node server and MongoLab add-on.

OPTION 2 - Run NodeGoat on your machine

If you do not wish to run NodeGoat on Heroku, please follow these steps to setup and run it locally -

  • Install Node.js - NodeGoat requires Node v4.4 or above

  • Clone the github repository

git clone https://github.com/OWASP/NodeGoat.git
  • Install node modules
npm install
  • Create Mongo DB: You can create a remote MongoDB instance or use local mongod installation

    • A. Using Remote MongoDB
      • Create a sandbox mongoDB instance (free) at MongoLab
      • Create a new database.
      • Create a user.
      • Update the db property in file config/env/development.js to reflect your DB setup. (in format: mongodb://<username>:<password>@<databasename>)
    • OR B.Using local MongoDB
      • If using local Mongo DB instance, start mongod.
      • Update the db property in file config/env/development.js to reflect your DB setup. (in format: mongodb://localhost:27017/<databasename>)
  • Populate MongoDB with seed data required for the app

    • Run grunt task below to populate the DB with seed data required for the application. Pass the desired environment as argument. If not passed, "development" is the default:
grunt db-reset:development
npm start

OPTION 3 - Run NodeGoat on Docker

You need to install docker and docker compose to be able to use this option

The repo includes the Dockerfile and docker-compose.yml necessary to setup the app and the db instance then connect them together.

  • Change the db config in config/env/development.js to point to the respective Docker container.
db: "mongodb://mongo:27017/nodegoat",
  • Build the images:
docker-compose build
  • Run the app:
docker-compose up

Customizing the Default Application Configuration

The default application settings (database url, http port, etc.) can be changed by updating the config file.

Report bugs, Feedback, Comments

  • Open a new issue or contact team by joining chat at Slack or Join the chat at https://gitter.im/OWASP/NodeGoat

Contributing

Contributions from community are key to make NodeGoat a high quality comprehensive resource. Lets make NodeGoat awesome together!

Ways to Contribute

Depending on your preference, you can contribute in various ways. Here are tasks planned for upcoming release. You can also open an issue, sending a PR, or get in touch on Gitter Chat or Slack

If sending PR, once code is ready to commit, run:

grunt precommit

This command uses js-beautifier to indent the code and verifies these coding standards using jsHint. Please resolve all jsHint errors before committing the code.

Contributors

Here are the amazing contributors to the NodeGoat project.

Supports

JetBrains

  • Thanks to JetBrains for providing licenses to fantastic WebStorm IDE to build this project.

License

Code licensed under the Apache License v2.0.