@casual-simulation/crypto-browser

Crypto Browser

Installation

npm install @casual-simulation/crypto-browser

Usage

// ES6-style imports are required.
// If you are running in an environment that does not support ES Modules,
// then use Webpack or Babel to transpile to the format you want. (like CommonJS)
import { BrowserSigningCryptoImpl } from '@casual-simulation/crypto-browser';

// Async is optional. Every method returns a promise.
async function demo() {
    // Currently ECDSA-SHA256-NISTP256 is the only supported
    // algorithm.
    let algorithm = 'ECDSA-SHA256-NISTP256';
    let crypto = new BrowserSigningCryptoImpl(algorithm);

    console.log('Crypto Supported: ', crypto.supported());

    // Generate a public-private key pair.
    let [publicKey, privateKey] = await crypto.generateKeyPair();

    // You can export the public and private keys to
    // share them with other devices. (But really only share the public key)
    let exportedPubKey = await crypto.exportKey(publicKey);
    let exportedPrivateKey = await crypto.exportKey(privateKey);

    // You can import keys that were exported using exportKey()
    // via the importPrivateKey() and importPublicKey() methods.

    console.log('Public Key: ', exportedPubKey);
    console.log('Private Key: ', exportedPrivateKey);
    // TODO: Save/share keys

    // Any ArrayBuffer will work
    let data = new Int32Array(100);

    // If you're using webpack, enable the Buffer polyfil.
    // This will let you convert strings to ArrayBuffer compatible
    // objects using Buffer.from(str).
    // Read More: https://webpack.js.org/configuration/node/

    // Fill with pseudo-random data.
    for (let i = 0; i < data.length; i++) {
        data[i] = Math.floor(Math.random() * 100);
    }

    // Sign the data
    let signature = crypto.sign(privateKey, data);

    // TODO: Send or store the signature and data

    // Verify the signature.
    // Note that the data must be provided as well.
    // This is because the signature does not store the data
    // in a usable format.
    let valid = crypto.verify(publicKey, signature, data);
    console.log('Valid: ', valid);
}

demo();

Changelog

V0.11.20

Date: 1/13/2020

Changes:

• Breaking Changes
  • Renamed context to dimension.
    • All the auxContext* tags have been renamed to auxDimension*.
    • Listeners like @onDrop, @onModDrop, @onClick, etc. now have a dimension property in the data argument instead of context.
    • The @onPlayerEnterContext listener has been renamed to @onPlayerEnterDimension.
    • The _auxUserContext, _auxUserMenuContext, _auxUserInventoryContext, and _auxUserChannelsContext have been renamed to use dimension instead of context.
  • Renamed channel to universe.
    • All the auxChannel* tags have been renamed to auxUniverse*.
    • The _auxUserChannelsContext tag has been renamed to _auxUserUniversesDimension.
    • The _auxUserChannel tag has been renamed to _auxUserUniverse.
    • The player.setupChannel() function has been renamed to player.setupUniverse().
    • The player.loadChannel() and player.unloadChannel() functions have been renamed to player.loadUniverse() and player.unloadUniverse().
    • The player.getCurrentChannel() function has been renamed to player.getCurrentUniverse().
    • The setup_channel action type has been renamed to setup_universe.
    • The @onChannel* listen tags have been renamed to @onUniverse*.
      • Also the channel property in the data argument has been renamed to universe.
  • Renamed the auxDimensionRotation (auxContextRotation) tags to auxDimensionOrientation.
  • You no longer need to define a dimension bot (context bot) in order to view a dimension in auxPlayer.
    • You can still configure a dimension using the auxDimensionConfig tag (renamed from auxContext).
  • Channel Designer is no more!
    • It has been replaced with the "sheet dimension" (bot table).
    • You can show any dimension in the sheet by putting a * in front of the dimension name in the URL.
      • e.g. https://auxplayer.com/*home/example if you wanted to view the home dimension in the sheet from the example universe.
      • Going to just * will show all bots in the universe in the sheet. (which is very slow at the moment)
    • You can also jump directly into auxPlayer by using the "Open dimension in auxPlayer" button that is next to the tag filters.
  • Removed the player.isDesigner() function.
  • Renamed auxShape to auxForm.
  • Renamed auxImage to auxFormAddress.
• Improvements
  • Added the player.showChat() and player.hideChat() functions.
    • These show/hide the chat bar in auxPlayer.
    • Typing in the chat bar will trigger a @onChatUpdated shout with the text in the chat bar.
    • Pressing Enter or clicking the send button on the chat bar will trigger a @onChatEnter shout with the text in the chat bar.
  • Added the @onChat shout listener.
    • Triggered when the user sends a message using the chat bar.
    • that is an object with the following properties:
      • message - The message that was sent.
  • Added the @onChatTyping shout listener.
    • Triggered when the user edits the text in the chat bar.
    • that is an object with the following properties:
      • message - The message that is in the chat bar after the user edited it.
  • Added the player.run(script) function.
    • script is the script text that should be executed.
    • Works by sending a run_script action. This allows @onUniverseAction() listener to intercept and prevent scripts.
  • Added the ability to click a tag in the bot table to teleport to that dimension.
  • Added a play button to the right side of the code editor to run scripts for quick debugging.
  • Added the player.downloadBots(bots, filename) function.
    • The first parameter is an array of bots that should be downloaded.
    • The second parameter is the name of the file that is downloaded.
  • Added the player.showUploadUniverse() function.
    • Shows a dialog that lets the user upload .aux files.
• Other Changes
  • Changed the "AUX Player" and "Channel Designer" tab titles to "auxPlayer".
  • Removed the colored dots from tag labels in the bot table.
• Bug Fixes
  • auxIframe now supports URLs with * characters in them.
  • Fixed an issue with the menu dimension that would cause items to remain even though a different dimension should be visible.