hortinstein / enkodo

A cross platform encryption and serialization library

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Gitpod Ready-to-Code

enkōdo

Enkodo is a cross platform encyption and serialization wrapper for monocypher written in nim, with compatibility targets in typescript and more planned in the future.

Building all targets

These are the nim instructions and what they do:

nimble buildall #creates all the libraries and helpers for all languages 

Usage

Nim

Below is a simple nim example of encypting, serializing and base64ing

import enkodo

let (a_secretKey, a_publicKey) = generateKeyPair()
let (b_secretKey, b_publicKey) = generateKeyPair()

let plaintext = cast[seq[byte]]("hello this is a test string")

let encObj = enc(a_secretKey,b_publicKey,plaintext)
let wrapped = wrap(encObj) //serialize and b64
let unwrapped = unwrap(wrapped) //unb64 and deserialize
let ptext = dec(b_secretKey,unwrapped)
doAssert(plaintext == ptext)

Typescript

Below is a simple typescript example of encypting, serializing and base64ing

import {
  enc,
  dec,
  generateKeyPair,
  unwrap,
  wrap
} from "https://deno.land/x/enkodo@v0.1.5/typescript/mod.ts";

const hello_world = new TextEncoder().encode("Hello World");
const [priv, pub] = generateKeyPair();
const [priv2, pub2] = generateKeyPair();

const enc_test = enc(priv, pub2, hello_world); //encrpyt
const wrapped = wrap(enc_test); //serialize and base64
const unwrapped = unwrap(wrapped); //de-serialize and unbase64
const plain = dec(priv2, unwrapped);

Nimble Test

Tests the encryption and serialization functions

nimble test 

Deno Test

Tests the encryption functions

deno test 
deno bench #runs the benchmark

Planned compatibility

About

A cross platform encryption and serialization library


Languages

Language:TypeScript 81.8%Language:JavaScript 17.9%Language:Nim 0.3%