vault12 / glow.ts

Client library for interacting with Zax Cryptographic Relay

glow.ts

Glow.ts is a client library for interacting with Zax Cryptographic Relay, a NaCl-based Cryptographic Relay. This reference implementation is written in TypeScript. The original deprecated implementation in CoffeeScript can be found there.

Installation

Glow can be easily installed via npm, which is included when you install Node.js. In a terminal, navigate to the directory in which you'd like to install Glow and type the following:

npm install glow.ts

The built version of Glow will be available in node_modules/glow.ts/dist subdirectory, packaged as both CommonJS and ESM library.

Dashboard app

Glow.ts powers a test Dashboard app to provide a user-friendly access point to encrypted Mailboxes on a given relay.

We maintain a live Test Server that runs the stable build of Zax Dashboard. For testing purposes expiration of any communication on that relay is set to 30 minutes.

You can also check the latest build of master branch on Github Pages.

Running tests

Unit tests are powered by Jest. The engine runs all the tests in each describe section serially in the order they are described in the .spec.ts file. By default, unit tests connect to a remote Zax Cryptographic Relay Server on https://z.vault12.com. You may also run tests on a local or any other test server by modifying the code in the tests helper.

Ecosystem

Project	Description
Zax	NaCl-based Cryptographic Relay
Zax Dashboard	Sample dashboard app for Zax Cryptographic Relay
TrueEntropy	High volume thermal entropy generator

License

Glow is released under the MIT License.

Legal Reminder

Exporting/importing and/or use of strong cryptography software, providing cryptography hooks, or even just communicating technical details about cryptography software is illegal in some parts of the world. If you import this software to your country, re-distribute it from there or even just email technical suggestions or provide source patches to the authors or other people you are strongly advised to pay close attention to any laws or regulations which apply to you. The authors of this software are not liable for any violations you make - it is your responsibility to be aware of and comply with any laws or regulations which apply to you.