Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ecollect/node-fe1-fpe
Node.js implementation of the FE1 Format Preserving Encryption algorithm.
https://github.com/ecollect/node-fe1-fpe
backend encryption format-preserving-encryption javascript node-fe1-fpe node-js server
Last synced: about 4 hours ago
JSON representation
Node.js implementation of the FE1 Format Preserving Encryption algorithm.
- Host: GitHub
- URL: https://github.com/ecollect/node-fe1-fpe
- Owner: eCollect
- License: mit
- Created: 2017-06-16T14:36:22.000Z (over 7 years ago)
- Default Branch: v1.0
- Last Pushed: 2021-04-04T06:54:53.000Z (over 3 years ago)
- Last Synced: 2024-09-27T08:37:33.749Z (about 1 month ago)
- Topics: backend, encryption, format-preserving-encryption, javascript, node-fe1-fpe, node-js, server
- Language: JavaScript
- Homepage:
- Size: 55.7 KB
- Stars: 18
- Watchers: 7
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-fe1-fpe ( beta )
A ~~dependency-free~~ Node.js implementation of Format Preserving Encryption.
[](https://travis-ci.org/eCollect/node-fe1-fpe) [](https://badge.fury.io/js/node-fe1-fpe) [](https://coveralls.io/github/eCollect/node-fe1-fpe?branch=master) [](https://snyk.io/test/github/eCollect/node-fe1-fpe) [](LICENSE)
### Theory
Format preserving encryption (FPE) refers to a set of techniques for encrypting data such that the ciphertext has the same format as the plaintext. For instance, you can use FPE to encrypt credit card numbers with valid checksums such that the ciphertext is also an credit card number with a valid checksum, or similarly for bank account numbers, US Social Security numbers, or even more general mappings like English words onto other English words.
To encrypt an arbitrary value using FE1, you need to use a ranking method. Basically, the idea is to assign an integer to every value you might encrypt. For instance, a 16 digit credit card number consists of a 15 digit code plus a 1 digit checksum. So to encrypt a credit card number, you first remove the checksum, encrypt the 15 digit value modulo 1015, and then calculate what the checksum is for the new (ciphertext) number. Or, if you were encrypting words in a dictionary, you could rank the words by their lexicographical order, and choose the modulus to be the number of words in the dictionary.
### Implementation
Current implementation uses the FE1 scheme from the paper ["Format-Preserving Encryption" by Bellare, Rogaway, et al](http://eprint.iacr.org/2009/251).
Ported from [java-fpe](https://github.com/Worldpay/java-fpe) which was ported from
[DotFPE](https://dotfpe.codeplex.com/) which was ported from [Botan Library](http://botan.randombit.net).
## Installation
```node
npm install --save node-fe1-fpe
```
## Basic usage
```javascript
const fe1 = require('node-fe1-fpe');
// in possible values of 0-10000 encrypt the value of 1.
const encryptedValue = fe1.encrypt(10001, 1, 'my-secret-key', 'my-non-secret-tweak'); // 4984
const decryptedValue = fe1.decrypt(10001, encryptedValue, 'my-secret-key', 'my-non-secret-tweak'); // 1
```
Alternatively you could pass a buffer instance instead of string key (this allows reading the keys from files).
```javascript
const fe1 = require('node-fe1-fpe');
// just an example, buffer would ideally come file.
const secretKeyBuffer = Buffer.from('my-secret-key', 'utf16le');
// in possible values of 0-10000 encrypt the value of 1.
const encryptedValue = fe1.encrypt(10001, 1, secretKeyBuffer, 'my-non-secret-tweak'); // 4984
const decryptedValue = fe1.decrypt(10001, encryptedValue, secretKeyBuffer, 'my-non-secret-tweak'); // 1
```
## Considerations
The implementation is as stable as a rock for a modulus up to 10 000 000. It is designed this way because of speed concerns. For larger range, the matter needs to be discussed with the corresponding developers.
## Todo
- [X] Proper tests
- [X] Documentation
- [X] Speed optimizations
## License
Copyright © 2017-8 eCollect AG.
Licensed under the [MIT](LICENSE) license.