scratch-certification (SCTF)

An NPM module to verify third-party Scratch extensions.

Installation

// Using NPM
npm install scratch-certification

// Using Yarn
yarn add scratch-certification

Requiring Module

// Using Node.js
const sctf = require('scratch-certification');

// Using React.js
import 'scratch-certification';

Concept

This module has a system of hashes and codes. A hash is a random unique string to initialize the Scratch connection, and a code as a password to log into your Scratch connnection.

Pros

• It's a module, meaning it grants developers more flexability and customization for usage of their choice
• The code system allows users to have a more memorable login method, and a partial account-based system
• It solves the web exploit problem in existing modules, by having flexability to require a username to login via a login/sign in system.

Example Code / Usage

createHash

Functionalities: Creates a warning with a random crypto generated string.

Parameters:

• site - The name of the site being used, or an abbreviation. - Mandatory
• owner - The Scratcher who owns the site being used. - Mandatory
• length - The length of the hash (Leave blank for a default of 45) - Optional

Example Code:

const sctf = require('scratch-certification'); // Require SCTF

const myHash = sctf.createHash('site', 'griffpatch', 40); // Create hash with a length of 40 

console.log(myHash); 
/* -> To prevent man in the middle attacks, make sure this code is from site and is owned by griffpatch, otherwise 
DO NOT TRUST THIS CODE: lprdosugypqvuxlsetnjzuktmcvmefooydigppzb 
- Delete this code after verifying.
*/

Notes:

• There are no notes for this function.

checkHash

Functionalities: Checks the user's Scratch profile for the hash, returns HTTP status code depending on what it finds

Parameters:

• Hash - The hash to check for (generated with createHash() or your own generated hash (not recommended)) - Mandatory
• User - The Scratch profile username that the module checks for the hash on - Mandatory

Example Code:

const sctf = require('scratch-certification'); // Require SCTF

sctf.checkHash(hash, 'griffpatch').then((res) => {
  if (res === 302) { // Hash found
    console.log('Hash found!');
  } else if (res === 404) { // Hash not found
    console.log('Hash not found');
  } else if (res === 400) { // Error
    console.log('Error');
  }
});

Notes:

• Returns a promise, requiring usage of .then or an asynchronous function expression
• Returns HTTP status codes to indicate whether a hash was found. See a list of HTTP status codes here

createCode

Functionalities: Takes a password (recommended user input), and adds random characters at the end to make a code.

Parameters:

• Password - The password to secure and return - Mandatory
• Length - The amount of characters to add when securing the password. Leave blank for a default of 5 - Optional

Example Code:

const sctf = require('scratch-certification'); // Require SCTF

const code = sctf.createCode('unicorn', 10);

console.log(code); // -> unicorn`)0~$$6+|!

Notes:

• There are no notes for this function.

Contact

b1048546: Contact b1048546 on Scratch here.

LilJuiceBox491: Contact LilJuiceBox491 on Scratch here.