feat(normalize-hash): Add support for normalizing hashes - Githubissues

47ng / prisma-field-encryption

Transparent field-level encryption at rest for Prisma

https://github.com/franky47/prisma-field-encryption-sandbox

MIT License

223 stars 27 forks source link

feat(normalize-hash): Add support for normalizing hashes #110

Closed martijn-dev closed 2 weeks ago

martijn-dev commented 2 weeks ago

What's changed:

I've added support for a ?normalize flag on the hash tag in the Prisma model.
Currently lowercase, uppercase, trim, spaces and diacritics sanitizing are supported. More could be added quite easy.
Normalizing takes place in the hashing function. This means that new values, as well as values that you use to query will be sanitized.
Normalize options can be combined.
Integration tests have been added.

Potential Risks / Breaking changes

The feature is an addition. There are no breaking changes involved.
As discussed normalizing hashes could give conflict in combination with unique. I've added a disclaimer in the README.

Text from the README:

You can normalize a hash before creation and querying. This might be useful in case you would like to find a User with the name of François with a query input of francois.

There are several normalize options:

/// @encryption:hash(email)?normalize=lowercase  <- lowercase hash
/// @encryption:hash(email)?normalize=uppercase  <- uppercase hash
/// @encryption:hash(email)?normalize=trim       <- trim start and end of hash
/// @encryption:hash(email)?normalize=spaces     <- remove spaces in hash
/// @encryption:hash(email)?normalize=diacritics <- remove diacritics like ç or é in hash

You can also combine the normalize options:

/// @encryption:hash(email)?normalize=lowercase&normalize=trim&normalize=trim&normalize=diacritics

Be aware: Using the normalize hash feature in combination with unique could cause conflicts. Example: Users with the name François and francois result in the same hash which could result in a database conflict.

Questions?

Let me know what you think! Always open to discussion. I hope you see this feature as a catalyst to expand support for searching in encrypted db values. Cheers, Martijn

Fixes #109

coveralls commented 2 weeks ago

Pull Request Test Coverage Report for Build 9660461861

Details

27 of 31 (87.1%) changed or added relevant lines in 4 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-0.6%) to 80.1%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/dmmf.ts	6	7	85.71%
src/errors.ts	1	2	50.0%
src/hash.ts	14	16	87.5%
<!--	Total:	27	31	87.1%	-->

Totals
Change from base Build 7807229309:	-0.6%
Covered Lines:	269
Relevant Lines:	318

💛 - Coveralls

coveralls commented 2 weeks ago

Pull Request Test Coverage Report for Build 9660494463

Details

27 of 31 (87.1%) changed or added relevant lines in 4 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-0.6%) to 80.1%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/dmmf.ts	6	7	85.71%
src/errors.ts	1	2	50.0%
src/hash.ts	14	16	87.5%
<!--	Total:	27	31	87.1%	-->

Totals
Change from base Build 7807229309:	-0.6%
Covered Lines:	269
Relevant Lines:	318

💛 - Coveralls

coveralls commented 2 weeks ago

Pull Request Test Coverage Report for Build 9662361328

Details

27 of 33 (81.82%) changed or added relevant lines in 4 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-1.5%) to 79.242%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/dmmf.ts	6	8	75.0%
src/errors.ts	1	3	33.33%
src/hash.ts	14	16	87.5%
<!--	Total:	27	33	81.82%	-->

Totals
Change from base Build 7807229309:	-1.5%
Covered Lines:	269
Relevant Lines:	320

💛 - Coveralls

coveralls commented 2 weeks ago

Pull Request Test Coverage Report for Build 9662382333

Details

27 of 33 (81.82%) changed or added relevant lines in 4 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-1.5%) to 79.242%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/dmmf.ts	6	8	75.0%
src/errors.ts	1	3	33.33%
src/hash.ts	14	16	87.5%
<!--	Total:	27	33	81.82%	-->

Totals
Change from base Build 7807229309:	-1.5%
Covered Lines:	269
Relevant Lines:	320

💛 - Coveralls

coveralls commented 2 weeks ago

Pull Request Test Coverage Report for Build 9662247468

Details

27 of 33 (81.82%) changed or added relevant lines in 4 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-1.5%) to 79.242%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/dmmf.ts	6	8	75.0%
src/errors.ts	1	3	33.33%
src/hash.ts	14	16	87.5%
<!--	Total:	27	33	81.82%	-->

Totals
Change from base Build 7807229309:	-1.5%
Covered Lines:	269
Relevant Lines:	320

💛 - Coveralls

franky47 commented 2 weeks ago

This has been released in 1.6.0-beta.1, if you want to give it a spin.