Skip to content

Commit ced0a3d

Browse files
authored
docs(data-masking): add docs for data masking utility (#3186)
1 parent b784598 commit ced0a3d

File tree

73 files changed

+2709
-750
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+2709
-750
lines changed

Diff for: Makefile

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ dev:
88
pip install --upgrade pip pre-commit poetry
99
poetry config --local virtualenvs.in-project true
1010
@$(MAKE) dev-version-plugin
11-
poetry install --extras "all datamasking-aws-sdk redis"
11+
poetry install --extras "all redis"
1212
pre-commit install
1313

1414
dev-gitpod:
1515
pip install --upgrade pip poetry
1616
@$(MAKE) dev-version-plugin
17-
poetry install --extras "all datamasking-aws-sdk redis"
17+
poetry install --extras "all redis"
1818
pre-commit install
1919

2020
format:

Diff for: README.md

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Powertools for AWS Lambda (Python) is a developer toolkit to implement Serverles
3030
* **[Event source data classes](https://docs.powertools.aws.dev/lambda/python/latest/utilities/data_classes/)** - Data classes describing the schema of common Lambda event triggers
3131
* **[Parser](https://docs.powertools.aws.dev/lambda/python/latest/utilities/parser/)** - Data parsing and deep validation using Pydantic
3232
* **[Idempotency](https://docs.powertools.aws.dev/lambda/python/latest/utilities/idempotency/)** - Convert your Lambda functions into idempotent operations which are safe to retry
33+
* **[Data Masking](https://docs.powertools.aws.dev/lambda/python/latest/utilities/data_masking/)** - Protect confidential data with easy removal or encryption
3334
* **[Feature Flags](https://docs.powertools.aws.dev/lambda/python/latest/utilities/feature_flags/)** - A simple rule engine to evaluate when one or multiple features should be enabled depending on the input
3435
* **[Streaming](https://docs.powertools.aws.dev/lambda/python/latest/utilities/streaming/)** - Streams datasets larger than the available memory as streaming data.
3536

Diff for: aws_lambda_powertools/shared/functions.py

+10-2
Original file line numberDiff line numberDiff line change
@@ -96,10 +96,18 @@ def resolve_env_var_choice(
9696

9797
def base64_decode(value: str) -> bytes:
9898
try:
99-
logger.debug("Decoding base64 record item before parsing")
99+
logger.debug("Decoding base64 item to bytes")
100100
return base64.b64decode(value)
101101
except (BinAsciiError, TypeError):
102-
raise ValueError("base64 decode failed")
102+
raise ValueError("base64 decode failed - is this base64 encoded string?")
103+
104+
105+
def bytes_to_base64_string(value: bytes) -> str:
106+
try:
107+
logger.debug("Encoding bytes to base64 string")
108+
return base64.b64encode(value).decode()
109+
except TypeError:
110+
raise ValueError(f"base64 encoding failed - is this bytes data? type: {type(value)}")
103111

104112

105113
def bytes_to_string(value: bytes) -> str:

Diff for: aws_lambda_powertools/utilities/_data_masking/base.py

-174
This file was deleted.

Diff for: aws_lambda_powertools/utilities/_data_masking/constants.py

-5
This file was deleted.

Diff for: aws_lambda_powertools/utilities/_data_masking/provider/__init__.py

-5
This file was deleted.

Diff for: aws_lambda_powertools/utilities/_data_masking/provider/base.py

-34
This file was deleted.

Diff for: aws_lambda_powertools/utilities/_data_masking/provider/kms/__init__.py

-5
This file was deleted.

0 commit comments

Comments
 (0)