Simple symmetric XOR encryption library for Browser and Node.
npm install crypto-xorbash
npm install crypto-xor
`
Usage
Sample
`typescript
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
$3
- Install the latest version of pnpm globally
`bash
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
`bash
pnpm install
`
$3
`bash
pnpm run build
`
$3
`bash
pnpm run test
`
$3
`bash
pnpm run lint
`
Fix errors with:
`bash
pnpm run lint:fix
`
$3
`bash
pnpm run docs
`
Documentation is generated using TypeDoc.
$3
`bash
pnpm run upgrade:libs
`
$3
Run common tasks all-in-once:
- Dependencies install
- TypeScript check
- Lint fixes
- Tests
- Build
- Documentation
`bash
pnpm run integrate
`
Appendix
$3
`bash
pnpm run readme:toc
``