# ffencrypt

> rsa decryption for FFPG.Checkout

Latest version **1.0.0** (published 2018-04-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install ffencrypt
pnpm add ffencrypt
yarn add ffencrypt
bun add ffencrypt
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-04-10 |
| First published | 2018-04-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 369 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | finflow |
| Maintainers | ffencrypt |

## Links

- npm: https://www.npmjs.com/package/ffencrypt
- npm.io page: https://npm.io/package/ffencrypt

## Dependencies (3)

- [fs](https://npm.io/package/fs.md) 0.0.1-security
- [jsencrypt](https://npm.io/package/jsencrypt.md) ^3.0.0-beta.1
- [node-jsencrypt](https://npm.io/package/node-jsencrypt.md) ^1.0.0

## Recent versions

- 1.0.0 (latest) — 2018-04-10

## README

# FFEncrypt
This library may be used for generating cryptograms, which can be used for the FF checkout Script or payment widget.

There are easy steps to get connected with:
  - Add ffEncrypt.js to the head of your page
  - Call FFEncrypt() function to get cryptogram

## How to make your own build
1. Clone this repository from npm;
```sh
npm install ffEncrypt
```
2. Install the dependencies and devDependencies.
```sh
npm install
```
3. Make FFEncrypt script build deending on your need.
```sh
npm run build
```
```sh
npm run watch
```

## How to make your own call?
Call FFEncrypt() with next parameters: publicKey, textToEncrypt, keySize.
Key Size are not required parameter, by default it'll be set to 2048 bytes.

##### Where I can get publicKey?
Basically you can gei it from the FFPG.oAuthServer. For the description read relevant documentation.
This library are not generate Public Key.

Example of the call:
```sh
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Test page title</title>
    <script src="js/ffencrypt.js"></script>
</head>
<body>
    <script>
        let publicKey = '-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxAlUxO5xx2TvzjwpfnlD\n/FI7Yqb0DootVe8pBW2FQmbPfodFsjujlNK/r3mW/czcd6xb3XGs6PcB6MnFq2tu\nmplnn7dP48OUTU7kJ2QfrJOy7VQtIWXOP0nxQo1KosNlywS3cT7p+DiXXXWGPGUG\ncww0c6wbc1f8xm5eajf36LCRDC4wqexgLQsAHmAMlsvwq5zsMp03Tk8nzLOiMaRO\ngyRaok0c19Hg0NB3Tu9QYkCU/4dO/FCXOLPlhQqvLcu0oc+Wzx5adz9aRDlffMqo\nt1KCDOyEZ3evvFoML97UEfZ06NaFpSE+XMM+/Di7VGXUU8anmeD2N2bSlZebVwcZ\n7QIDAQAB\n-----END PUBLIC KEY-----'
        ffEncrypt(publicKeyGlobal, 'text');
        // eqvivalent to ffEncrypt(publicKeyGlobal, 'text', 2048);
    </script>
</body>
</html>
```

## Dependencies
This package based on jsEncrypt library.

## License
MIT

---
_Source: https://npm.io/package/ffencrypt · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
