1.0.1 • Published 6 years ago

ngx-simple-crypt v1.0.1

Weekly downloads
175
License
ISC
Repository
github
Last release
6 years ago

ngx-simple-crypt

Javascript module (compatible with any angular version, but not limited to angular) for encryption through XOR cipher method.

Useful for hiding non sensitive informations, like code obfuscations, QR code datas, etc...

Import

npm i ngx-simple-crypt

or

yarn add ngx-simple-crypt

Usage

No module import needed, you can use anywhere:

import {SimpleCrypt} from "ngx-simple-crypt";
let simpleCrypt = new SimpleCrypt();

let encodedString = simpleCrypt.encode("my-key","You are not supposed to read this");
console.log(encodedString);// "NBZYSwQLCFlDBBFZHgxdGwoKCB0NHwpZHxxMD0UNBRBe"

let decodedString = simpleCrypt.decode("my-key",encodedString);
console.log(decodedString);// "You are not supposed to read this"

You can also use the static methods for encoding/decoding Objects directly:

let encodedObjectAsString:string = SimpleCrypt.encodeDefault("my-key", {data:'very important stuff'});
let object:{} = SimpleCrypt.decodeDefault("my-key", encodedObjectAsString);

From wikipedia:
The XOR operator is extremely common as a component in more complex ciphers. By itself, using a constant repeating key, a simple XOR cipher can trivially be broken using frequency analysis. If the content of any message can be guessed or otherwise known then the key can be revealed. Its primary merit is that it is simple to implement, and that the XOR operation is computationally inexpensive. A simple repeating XOR (i.e. using the same key for xor operation on the whole data) cipher is therefore sometimes used for hiding information in cases where no particular security is required.