Installation

You can install the package via pip:

pip install microsoft-security-utilities-secret-masker

Usage

You can use the SecretMasker class to detect and mask sensitive data in your input. Here is an example:

from microsoft_security_utilities_secret_masker import SecretMasker, load_regex_patterns_from_json_file

# Load built-in detection rules
precisely_classified_regex_patterns = load_regex_patterns_from_json_file('PreciselyClassifiedSecurityKeys.json')
unclassified_regex_patterns = load_regex_patterns_from_json_file('UnclassifiedPotentialSecurityKeys.json')
# construct secret masker with chosen patterns
regex_patterns = precisely_classified_regex_patterns.union(unclassified_regex_patterns)
secret_masker = SecretMasker(regex_patterns)

input = "This is a sample input with no secrets"
detected_secrets = secret_masker.detect_secrets(input)
processed_input = secret_masker.mask_secrets(input)

License

Microsoft Security Utilities - Secret Masker (secret-masker)

Copyright (c) Microsoft Corporation
All rights reserved.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ""Software""), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.::

1.0.0b4

• Update regex patterns

1.0.0b3

• Minor fix

1.0.0b2

• Adopt confidence level patterns

1.0.0b1

• Initial release