Skip to content
/ Zenroom Public

Embedded no-code VM executing human-like language to manipulate data and process cryptographic operations.

License

Notifications You must be signed in to change notification settings

dyne/Zenroom

Zenroom crypto VM

Zenroom logo

Zenroom is a secure language interpreter of the domain-specific Zencode, making it easy to execute fast cryptographic operations on any data structure.

The Zenroom VM is very small, has no external dependency, is fully deterministic and is ready to run end-to-end encryption on any platform: desktop, embedded mobile, cloud micro-services, and web browsers. Zenroom works inside applications written in Javascript, Python3, Rust or Golang.

Zencode has a no-code approach. It is a domain-specific language (DSL) similar to human language. One can process large data structures through complex cryptographic and logical transformations.

Zencode helps developers to empower people who know what to do with data: one can write and review business logic and data-sensitive operations without learning to code.

software by Dyne.org

Timeline

  • 2017 - Proof of Concept
  • 2018 - Prototype and Alpha release series
  • 2019 - Stable release series v1 (now EOL)
  • 2022 - Stable release series v2 until LTS v2.22.1
  • 2023 - Stable release series v3 until LTS v3.23.4
  • 2024 - Current stable v4 (latest HEAD)

This software has zero dependencies. If you chose to use it in your project be assured that we intend to support the same code to still run in 20 years from now on any target platform.

Links

Continue to the developer website

or

Read the Zencode whitepaper

or

Visit the product website for a friendly introduction to the love we put in craftsmanship.

For many quick running examples visit the ApiRoom online IDE powered by Zenroom.

Zenroom is licensed as AGPLv3; we are open to grant exceptions on a commercial basis.

Applications

Many applications already include Zenroom and use the Zencode language.

Getting Started

To quickly try out Zenroom using the Zencode language with some examples navigate to ApiRoom and start typing into the browser.

The Zenroom VM runs locally in your browser (needs WASM) and ApiRoom provides various examples to show operational crypto flows.

ApiRoom is also an IDE (Integrated Development Environment) and by signing in with a username and password you can save your contracts and download them as a Dockerfile micro-service ready to deploy.

Tutorials

Build

Dependencies: makefile, cmake, gcc, libreadline-dev, xxd

Optional: musl-libc, emscripten for wasm builds

Use this command sequence:

git clone https://github.com/dyne/zenroom
cd zenroom
make linux

to create the CLI executable in src/zenroom

make linux-lib

to create the shared library in src/libzenroom-x86_64.so

make

to list more available targets

Meson + Ninja

Practical build scripts for GNU/Linux are provided using Meson + Ninja

make meson

Will produce a zenroom executable and a libzenroom shared lib in zenroom/build.

License

Copyright (C) 2017-2023 Dyne.org foundation

Designed and written by Denis "Jaromil" Roio with the help of Puria Nafisi Azizi and Andrea D'Intino.

Includes code contributions by Alberto Lerda, Matteo Cristino, Danilo Spinella, Luca Di Domenico and Rebecca Selvaggini.

Reviews and suggestions contributed by: Richard Stallman, Daniele Lacamera, Enrico Zimuel, Sofía Celi, Sebastian Blichfeld, Adam Burns, Thomas Fuerstner and Jürgen Eckel.

Zenroom complies with the REUSE license specification and redistributes:

  • Lua 5.4 - Copyright © 1994–2023 Lua.org, PUC-Rio.
  • Apache Milagro Crypto Library (AMCL)
  • Various Lua libraries released under Apache/MIT license

Special thanks to our colleagues in the DECODE project whose research has inspired the birth of this project: Francesca Bria, George Danezis, Ola Bini, Mark de Villiers, Ivan Jelincic, Alberto Sonnino, Jim Barritt, Christian Espinoza, Samuel Mulube and Nina Boelsums.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.