Skip to content

Commit 687291e

Browse files
committed
fix(README): udpated README to correct GMC typo
1 parent 0970be7 commit 687291e

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
[![unit test](https://github.com/limplash/string-cipher/actions/workflows/unit-test.yml/badge.svg)](https://github.com/limplash/string-cipher/actions/workflows/unit-test.yml)
44
[![eslint](https://github.com/limplash/string-cipher/actions/workflows/eslint.yml/badge.svg)](https://github.com/limplash/string-cipher/actions/workflows/eslint.yml)
55

6-
Simple set of crypto function for encrypting and decrypting UTF-8/ACSII strings. The module uses AES-GMC (128, 192 and 256) bases on Node crypto module. Solution used is based on this [gist](https://gist.github.com/AndiDittrich/4629e7db04819244e843). By using GMC encryption chiper text is authenticated as well. Base of this module are the make functions that generate desired encrypt and decrypt functions.
6+
Simple set of crypto function for encrypting and decrypting UTF-8/ACSII strings. The module uses AES-GCM (128, 192 and 256) bases on Node crypto module. Solution used is based on this [gist](https://gist.github.com/AndiDittrich/4629e7db04819244e843). By using AES-GCM encryption chiper text is authenticated as well. Base of this module are the make functions that generate desired encrypt and decrypt functions.
77

8-
Written in Typescript as an ES6 module, all functions are provided in Sync and Async versions. In order to imporve over all security scheme, user supplied `Password` and random `Salt` is used to drive a key using pbkdf2 (with default iterations of 1, for speed but this can be changed using options). The key length depends on the AES-GMC version (128/192/256 use 16/24/32 bit keys) other values are defaulted to values specified by [RFC 5288](https://tools.ietf.org/html/rfc5288)
8+
Written in Typescript as an ES6 module, all functions are provided in Sync and Async versions. In order to imporve over all security scheme, user supplied `Password` and random `Salt` is used to drive a key using pbkdf2 (with default iterations of 1, for speed but this can be changed using options). The key length depends on the AES-GCM version (128/192/256 use 16/24/32 bit keys) other values are defaulted to values specified by [RFC 5288](https://tools.ietf.org/html/rfc5288)
99

1010
## Contents
1111

0 commit comments

Comments
 (0)