feat(data-masking): add custom mask functionalities

[anafalcao]

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.

• Meet tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

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.

[anafalcao]

Hi @leandrodamascena ! Can I have your help here with mypy? Thanks!

[anafalcao]

Hi @leandrodamascena!
I just converted to Ready for review. I've been having issues regarding Incompatible types in assignment with mypy. Can you take a look?
I also created some tests for the new functionalities, but I also may need to implement some more after fixing this types issues

[sonarqubecloud]

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud