Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Purpose readme contribution #78

Merged
merged 7 commits into from
May 12, 2016
Merged

Purpose readme contribution #78

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b77d5e3
Updated with part a submission
dnecklesportfolio Mar 27, 2016
ef03a23
What to Use Crumb for and When to Use It
michelrossier Mar 27, 2016
a1a02cb
specification of the usage example
michelrossier Apr 21, 2016
4d609ad
specification of the usage example
michelrossier Apr 21, 2016
8961608
specification of the usage example
michelrossier Apr 21, 2016
caeb243
Updated with minor changes
dnecklesportfolio Apr 22, 2016
bace4ce
Merge pull request #1 from michelrossier/alwayzambitious-patch-1
michelrossier Apr 22, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,20 @@ CSRF crumb generation and validation for [**hapi**](https://github.com/hapijs/ha

Lead Maintainer: [Marcus Stong](https://github.com/stongo)

## What to Use Crumb for and When to Use It

Crumb is used to diminish CSRF attacks using a random unique token that is validated on the server side.

Crumb may be used whenever you want to prevent malicious code to execute system commands, that are performed by HTTP requests. For example, if users are able to publish code on your website, malicious code added by a user could force every other user who opens the page, to load and execute code from a third party website e.g. via an HTML image tag. With Crumb implemented into your hapi.js application, you are able to verify requests with unique tokens and prevent the execution of malicious requests.

## CORS

Crumb has been refactored to securely work with CORS, as [OWASP](https://www.owasp.org/index.php/HTML5_Security_Cheat_Sheet#Cross_Origin_Resource_Sharing) recommends using CSRF protection with CORS.

**It is highly discouraged to have a production servers `cors.origin` setting set to "[\*]" or "true" with Crumb as it will leak the crumb token to potentially malicious sites**



## Plugin Options

The following options are available when registering the plugin
Expand Down