Blowfish

[![npm package][npm-badge]][npm]

[npm-badge]: https://img.shields.io/npm/v/egoroof-blowfish.svg?style=flat-square
[npm]: https://www.npmjs.com/package/egoroof-blowfish

Blowfish>) encryption library for browsers and Node.js.

Find the changelog in CHANGELOG.md

Table of Contents

- Installation
- JS modules
- Usage
- Example
- Block cipher mode of operation
- Padding
- Return type

Installation

Take latest version here or with npm:

``
npm install egoroof-blowfish --save
`

$3

The library is only deployed in native JS modules, so in browsers you have to use script with type module:

`html

`

Or bundle the library to your code.

In Nodejs it imports easily:

`js
import { Blowfish } from 'egoroof-blowfish';
`

Usage

All input data including key, IV, plaintext and ciphertext should be a String or ArrayBuffer / Buffer.
Strings support all unicode including emoji ✨.

$3

`js
import { Blowfish } from 'egoroof-blowfish';

const bf = new Blowfish('super key', Blowfish.MODE.ECB, Blowfish.PADDING.NULL); // only key isn't optional
bf.setIv('abcdefgh'); // optional for ECB mode; bytes length should be equal 8

const encoded = bf.encode('input text even with emoji 🎅');
const decoded = bf.decode(encoded, Blowfish.TYPE.STRING); // type is optional
`

$3

https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation

`js
Blowfish.MODE.ECB; // (default) Electronic Codebook
Blowfish.MODE.CBC; // Cipher Block Chaining
`

$3

http://www.di-mgt.com.au/cryptopad.html

`js
Blowfish.PADDING.PKCS5; // (default) Pad with bytes all of the same value as the number of padding bytes
Blowfish.PADDING.ONE_AND_ZEROS; // Pad with 0x80 followed by zero bytes
Blowfish.PADDING.LAST_BYTE; // Pad with zeroes except make the last byte equal to the number of padding bytes
Blowfish.PADDING.NULL; // Pad with zero (null) characters
Blowfish.PADDING.SPACES; // Pad with spaces
`

$3

Which type of data should return method decode:

`js
Blowfish.TYPE.STRING; // (default) String
Blowfish.TYPE.UINT8_ARRAY; // Uint8Array
``