@blackcube/vanilla-powshield
TypeScript icon, indicating that this package has built-in type declarations

2.0.1 • Public • Published

Blackcube VanillaJS Powshield

This toolkit allows easy setup of Powshield.

Install

Package is available on npm

Then you can install the package:

npm install @blackcube/vanilla-powshield

usage

Howto

Process is simple:

  1. Fetch a new challenge from the API
  2. Solve the challenge to get a solution
  3. Verify the solution with the API
  4. If the solution is correct, you can submit your form
  5. Check the solution serverside to avoid any issue

API

In order to be mst robust, you should limit the use of a challenge For example, you can limit the use of a challenge to 2 times:

  • First time to allow validation by the JS (frontend)
  • Second time to allow validation by the server (backend)

encrypt and decrypt functions should be symmetric to allow the server to encrypt/decrypt the timestamp and validate the challenge

PseudoCode to generate a challenge

// app constants
key = 'your-secret'

// generate a random string of 12 characters
salt = generateRandomString(12)

// generate a random number between 0 and 50000
// values 0 and 50000 can be tuned to your needs
secretNumber = random_int(0, 50000)

algorithm = 'SHA-256'
// algorithm can be SHA-1, SHA-256, SHA-512

timestamp = time()
cypheredTimestamp = base64_encode(encrypt(timestamp, key))

challenge = hash(algorithm, concat(salt, secretNumber, cypheredTimestamp)
signature = hash_hmac(algorithm, challenge, key);


result = base64_encode(json_encode({
    'algorithm': algorithm,
    'timestamp': cypheredTimestamp,
    'challenge': challenge,
    'salt': salt,
    'signature': $signature,
    'start': 0,
    'max': maxIterations,
}));
// return the result as a base64 encoded JSON object

PseudoCode to verify a solution

// app constants
key = 'your-secret'
timeValidity = 300 // 5 minutes

// received payload
payload = json_decode(base64_decode($payload))

algorithm = payload.algorithm
cypheredTimestamp = base64_decode(payload.timestamp)
challenge = payload.challenge
number = payload.number
salt = payload.salt
signature = payload.signature

checkChallenge = hash(algorithm, concat(salt, secretNumber, cypheredTimestamp)
checkSignature = hash_hmac(algorithm, challenge, key)

timestamp = decrypt(base64_decode(cypheredTimestamp), key)

validityOk = time < timestamp + timeValidity
challengeOk = hash_equals(checkChallenge, challenge)
signatureOk = hash_equals(checkSignature, signature)

verfied = challengeOk and signatureOk;

Javascript usage

1. Fetch a new challenge from the API

import { Powshield } from '@blackcube/vanilla-powshield';
,
// Fetch a new challenge from API
Powshield.getChallenge('/powshield/generate-challenge')
    .then((challenge) => {
        console.log(challenge);
    });

2. Solve a challenge

import { Powshield } from '@blackcube/vanilla-powshield';

// Solve a challenge previously fetched
Powshield.solveChallenge(challenge)
    .then((solution) => {
        console.log(solution);
    });

3. Verify a solution

import { Powshield } from '@blackcube/vanilla-powshield';

// Verify a solution previously solved
Powshield.verifySolution('/powshield/verify-solution', solution)
    .then((result) => {
        // true if ok, false if not
        console.log(result);
    });

Readme

Keywords

none

Package Sidebar

Install

npm i @blackcube/vanilla-powshield

Weekly Downloads

7

Version

2.0.1

License

BSD-3-Clause

Unpacked Size

19.4 kB

Total Files

18

Last publish

Collaborators

  • pgaultier