From 87d5455a393abc3e4a339a6693c2c273f9d4aa16 Mon Sep 17 00:00:00 2001 From: Vadim Voitenko Date: Fri, 17 May 2024 16:00:43 +0300 Subject: [PATCH] doc: Roadmap on the main page and hash func info --- docs/built_in_transformers/transformation_engines.md | 7 +++++++ docs/index.md | 1 + 2 files changed, 8 insertions(+) diff --git a/docs/built_in_transformers/transformation_engines.md b/docs/built_in_transformers/transformation_engines.md index efed693e..3cf35497 100644 --- a/docs/built_in_transformers/transformation_engines.md +++ b/docs/built_in_transformers/transformation_engines.md @@ -4,6 +4,13 @@ The greenmask provides two engines `random` and `hash`. Most of the transformers by default is set to `random`. Use `hash` engine when you need to generate deterministic data - the same input will always produce the same output. +!!! info + + Greenmask employs the `SHA-3` algorithm to hash input values. While this function is cryptographically secure, it does + exhibit lower performance. We plan to introduce additional hash functions in the future to offer a balance between + security and performance. For example, `SipHash`, which provides a good trade-off between security and performance, is + currently in development and is expected to be included in the stable `v0.2` release of Greenmask. + !!! warning The hash engine does not guarantee the uniqueness of generated values. Although transformers such as `Hash`, diff --git a/docs/index.md b/docs/index.md index ed87f610..db8012b4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -59,6 +59,7 @@ Greenmask is ideal for various scenarios, including: ## Links +* [Greenmask Roadmap](https://github.com/orgs/GreenmaskIO/projects/6) * [Email](mailto:support@greenmask.io) * [Twitter](https://twitter.com/GreenmaskIO) * [Telegram](https://t.me/greenmask_community)