crypto-xor

crypto-xor

Simple symmetric XOR encryption library for Browser and Node.

No dependencies required

• Install
• Usage
• Development
  • Setup
  • Build library
  • Run tests
  • Run linting check
  • Generate library documentation
  • Update library dependencies
  • Integrate library
• Appendix
  • Update the table of content of this readme

Install

npm install crypto-xor

Usage

Sample

import { CryptoXor } from 'crypto-xor';

const symmetricKey = '5_Gk>V!q9umG-dx4GK*V;j!_';

const plainText = 'I have a secret for you !';

console.log('Plain Text: ' + plainText);

const cypherText = CryptoXor.encrypt(plainText, symmetricKey);

console.log('Encoded: ' + cypherText);

const decodedCypher = CryptoXor.decrypt(cypherText, symmetricKey);

console.log('Decoded: ' + decodedCypher);

Output

Plain Text: I have a secret for you !
Encoded: 7c7f2f0a48330110190608245f010c14212458764205547f14
Decoded: I have a secret for you !

Development

Setup

• Install the latest version of pnpm globally

npm uninstall -g pnpm
npm install -g pnpm@latest

Note: If you never installed pnpm before, you may need to reload your shell to access pnpm CLI.

• Then install the lib dependencies

pnpm install

Build library

pnpm run build

Run tests

pnpm run test

Run linting check

pnpm run lint

Fix errors with:

pnpm run lint:fix

Generate library documentation

pnpm run docs

Documentation is generated using TypeDoc.

Update library dependencies

pnpm run upgrade:libs

Integrate library

Run common tasks all-in-once:

• Dependencies install
• TypeScript check
• Lint fixes
• Tests
• Build
• Documentation

pnpm run integrate

Appendix

Update the table of content of this readme

pnpm run readme:toc