Skip to content
This repository has been archived by the owner on Apr 4, 2023. It is now read-only.

Latest commit

 

History

History
102 lines (80 loc) · 4.08 KB

readme.md

File metadata and controls

102 lines (80 loc) · 4.08 KB
Raw

noise-c.wasm Travis CI

rweather/noise-c compiled to WebAssembly using Emscripten and optimized for small size.

Noise protocol implementation that works both in Node.js and in modern browsers.

Supported Patterns and Algorithms

The same as in noise-c: https://rweather.github.io/noise-c/index.html#algorithms

About this project

This project basically does 2 things:

  • compiles upstream noise-c C library into WebAssembly
  • wraps plain functions into OOP interface close to what is specified in the spec (including functions names)

How to install

npm install noise-c.wasm

How to use

Node.js:

var createNoise = require('noise-c.wasm');

createNoise(function (noise) {
    // Do stuff
});

Browser:

requirejs(['noise-c.wasm'], function (createNoise) {
    createNoise(function (noise) {
        // Do stuff
    });
});

API

createNoise(options, callback)

Creates a new instance of Noise library

  • options - Options object that will be passed to underlying Emscripten module (optional)
  • callback - Callback function that receives library instance as the first argument, it is called when WebAssembly is loaded and library is ready for use

noise.constants

A bunch of constants that are needed for certain calls or for identifying errors. In most cases only NOISE_ROLE_INITIATOR and NOISE_ROLE_RESPONDER will be used directly, but others are used in OOP wrapper and/or in tests.

Check src/constants.ls for complete list of available constants.

noise.CreateKeyPair(curve_id): Uint8Array[]

Convenient method for generating new Ed25519 or X448 keypair, takes noise.constants.NOISE_DH_CURVE448 or noise.constants.NOISE_DH_CURVE448 as an argument. Returns [private, public] array of private and public part of keypair.

noise.CipherState(cipher)

CipherState object as in specification, has following methods:

  • InitializeKey(key)
  • HasKey()
  • SetNonce(nonce)
  • EncryptWithAd(ad, plaintext)
  • DecryptWithAd(ad, ciphertext)
  • Rekey()
  • free()

Take a look at src/index.ls for JsDoc sections with arguments and return types as well as methods description, look at tests/CipherState.ls for usage examples.

noise.SymmetricState(protocol_name)

SymmetricState object as in specification, has following methods:

  • MixKey(input_key_material)
  • MixHash(data)
  • MixKeyAndHash(input_key_material)
  • EncryptAndHash(plaintext)
  • DecryptAndHash(ciphertext)
  • Split()
  • free()

Take a look at src/index.ls for JsDoc sections with arguments and return types as well as methods description, look at tests/SymmetricState.ls for usage examples.

noise.HandshakeState(protocol_name, role)

HandshakeState object as in specification, has following methods:

  • Initialize(prologue = null, s = null, rs = null, psk = null)
  • GetAction()
  • FallbackTo(pattern_id = noise.constants.NOISE_PATTERN_XX_FALLBACK)
  • WriteMessage(payload = null)
  • ReadMessage(message, payload_needed = false, fallback_supported = false)
  • GetHandshakeHash()
  • GetRemotePublicKey()
  • Split()
  • free()

Take a look at src/index.ls for JsDoc sections with arguments and return types as well as methods description, look at tests/HandshakeState.ls for usage examples.

Contribution

Feel free to create issues and send pull requests (for big changes create an issue first and link it from the PR), they are highly appreciated!

When reading LiveScript code make sure to configure 1 tab to be 4 spaces, otherwise code might be hard to read.

License

Free Public License 1.0.0 / Zero Clause BSD License

https://opensource.org/licenses/FPL-1.0.0

https://tldrlegal.com/license/bsd-0-clause-license