Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(data-masking): add custom mask functionalities #5837

Draft
wants to merge 9 commits into
base: develop
Choose a base branch
from

Conversation

anafalcao
Copy link
Collaborator

@anafalcao anafalcao commented Jan 7, 2025

Issue number:
#5826

Summary

dynamic_mask (bool): Enables custom masking behavior when set to True. This flag activates the use of advanced masking techniques such as pattern-based or regex-based masking. When False or not provided, the default masking behavior (replacing with "*****") is used.

custom_mask (str): Specifies a simple pattern for masking data. This pattern is applied directly to the input string, replacing all the original characters. For example, with a mask_pattern of "XX-XX" applied to "12345", the result would be "XX-XX".

regex_pattern (str): Defines a regular expression pattern used to identify parts of the input string that should be masked. This allows for more complex and flexible masking rules. It's used in conjunction with mask_format.

mask_format (str): Specifies the format to use when replacing parts of the string matched by regex_pattern. It can include placeholders (like \1, \2) to refer to captured groups in the regex pattern, allowing some parts of the original string to be preserved.

masking_rules(dict): Apply different rules (formats) for each data field.

Changes

Please provide a summary of what's being changed
TBD

User experience

Please share what the user experience looks like before and after this change

TBD

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 7, 2025
@github-actions github-actions bot added the feature New feature or functionality label Jan 7, 2025
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jan 8, 2025
@boring-cyborg boring-cyborg bot added the tests label Jan 9, 2025
Copy link

sonarqubecloud bot commented Jan 9, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature New feature or functionality size/L Denotes a PR that changes 100-499 lines, ignoring generated files. tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant