Skip to main content

Automatically mask sensitive values (API keys, passwords, tokens) in logs and print output

Project description

philiprehberger-masked-print

Tests PyPI version License

Automatically mask sensitive values (API keys, passwords, tokens) in logs and print output.

Install

pip install philiprehberger-masked-print

Usage

from philiprehberger_masked_print import mask, mask_dict, MaskedFormatter

# Mask a single string
masked = mask("sk-abc123secret456xyz")
# "sk-a*************xyz"

Mask dictionaries

config = {
    "host": "localhost",
    "password": "super-secret-value",
    "database": {
        "connection_string": "postgres://admin:pass@localhost/db",
    },
}

safe = mask_dict(config)
# {
#     "host": "localhost",
#     "password": "supe***********lue",
#     "database": {
#         "connection_string": "post*****************/db",
#     },
# }

Auto-mask log output

import logging
from philiprehberger_masked_print import MaskedFormatter

handler = logging.StreamHandler()
handler.setFormatter(MaskedFormatter("%(levelname)s: %(message)s"))

logger = logging.getLogger("app")
logger.addHandler(handler)
logger.setLevel(logging.DEBUG)

logger.info("Using key sk-proj-abc123def456ghi789jkl012mno")
# INFO: Using key sk-p*************************mno

API

Function / Class Description
mask(value, *, show_first=4, show_last=3, mask_char="*") Mask a string, keeping the first and last N characters visible
mask_dict(data, *, sensitive_keys=None, show_first=4, show_last=3) Recursively mask sensitive key values in a dictionary
MaskedFormatter(fmt) Logging formatter that auto-redacts secret patterns (sk-..., eyJ..., AKIA..., URL credentials)

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

philiprehberger_masked_print-0.1.2.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

philiprehberger_masked_print-0.1.2-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file philiprehberger_masked_print-0.1.2.tar.gz.

File metadata

File hashes

Hashes for philiprehberger_masked_print-0.1.2.tar.gz
Algorithm Hash digest
SHA256 9a564a4276e532901110f3c0c6fa9404d666e8b8855b2fa39faa6e252d90ab7f
MD5 8e482fed2cb6e29e0707cfaf1f9d294c
BLAKE2b-256 435e21fdd679db9331c446039fe902e5f54537c87e8bbffa564a4df7a1c2143e

See more details on using hashes here.

File details

Details for the file philiprehberger_masked_print-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for philiprehberger_masked_print-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 aadffad80396c9ba1bc6b5fd1a0bd1c3cecbd4be7260177ecff86943a8c6f247
MD5 f26b45effc61c2b0e9482a7bbdfaa5df
BLAKE2b-256 b7f2d5ae60b7dcf301a18b445035a8ad3a5b3ad73b8d8a92aebf9ad523280fcb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page