Git Product home page Git Product logo

csrfprotection's Introduction

csrfProtection

This is csrf protection with re-usability at it's core. It includes generating tokens on server and client side and also validating these to allow us access to the loggedin.html page.

Instructions

  1. Make sure jQuery is available to use in your project.
  2. Include the js/auth/csrf-token.auth.js file in your project.
  3. Inlcude the js/index.js file or the code from it in your project
  4. Give every form that needs csrf protection a class of 'csrf-token'.
  5. Give the button to be used an id of 'submitButton'
  6. Call function csrfTokenGenerate(pathToServerScript, inputClass, callBackFunction)
  7. When you want to check tokens call function csrfTokenCheck(token, pathToServerScript, callBackFunction).

csrfTokenGenerate Parameters

pathToServerScript: Path from file html file tocsrfToken.auth.php

inputClass: Name of the class given to the input that we want hte token to appear in

callBackFunction: Name of the callback function we will use

csrfTokenCheck Parameters

token: the token that is in the hidden input

pathToServerScript: Path from file html file tocsrfToken.auth.php

callBackFunction: Name of the callback function we will use

Example

            $(document).ready(function(){

                //generate and render token
                csrfTokenGenerate('php/auth/csrfToken.auth.php', 'csrf-token', generateTokenCallBack);

                //generate call back
                function generateTokenCallBack(result){
                    //result boolean check.. result == true: csrf token is confirmed
                    if(result){
                        //do something here
                    }else{

                        //do something here like redirecting the user with an error message
                    }
                }

                //check call back function
                function checkTokenCallBack(result){

                    //result boolean check.. result == true: csrf token is confirmed
                    if(result){
                        //DO SOME AWESOME STUFF HERE LIKE CHECKING ALL INPUTS ARE FILLED IN... inputChecker available here: https://github.com/nialloc9/inputChecker
                        console.log('csrf token confirmed');
                        $('#someTextForm').submit();
                    }else{
                        //DO SOME AWESOME STUFF HERE LIKE ADDING AN INFO MESSAGE... addInfoMessage available here: https://github.com/nialloc9/addInfoMessage
                        console.log('error confirming csrf token');
                    }
                }

                //check token
                $('#myButton').click(function() {
                    tokenCheck = $('#csrfToken').val();
                    csrfTokenCheck(tokenCheck, 'php/auth/csrfToken.auth.php', checkTokenCallBack)
                });
            });

NB

If you want to change the id of the button or the class name of the csrf-token input don't forget to update the code that came from js/index.js

csrfprotection's People

Contributors

nialloc9 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.