Skip to main content

Centralized logging and masking for Kavach security suite

Project description

Kavach Logger

Zero-dependency logging helpers for Kavach packages and security-sensitive apps.

Install

pip install kavach-logger

For local development:

pip install -e .

What It Provides

  • DefaultLogger: simple stderr logger.
  • MaskedLogger: masks common secrets before logging.
  • get_logger(name="kavach", masked=True): create a logger instance.
  • mask_sensitive_data(text): mask a string manually.
  • BaseLogger: interface for custom loggers.
  • LoggerManager / set_custom_logger: optional singleton-style logger storage.

Quick Use

from kavach_logger import get_logger, mask_sensitive_data

logger = get_logger("api", masked=True)
logger.info("Using key sk-12345678901234567890")

plain = get_logger("debug", masked=False)
plain.info("This message is not modified")

safe_text = mask_sensitive_data("password: secret123")

Masked Patterns

MaskedLogger currently masks:

  • AKIA..., sk-..., and api_key... style values.
  • Bearer/token values.
  • 16-digit card-like numbers.
  • password, passwd, access_key, and secret fields.

Masking is best-effort. Treat it as a safety layer, not a replacement for avoiding secrets in logs.

Custom Logger

from kavach_logger import DefaultLogger, LoggerManager, set_custom_logger

class AppLogger(DefaultLogger):
    def info(self, msg, **kwargs):
        super().info(f"[APP] {msg}", **kwargs)

set_custom_logger(AppLogger("app"))
logger = LoggerManager().get_logger()
logger.info("custom logger from manager")

Logger methods accept a message and optional keyword data:

logger.info("security event", tool="db_query")
logger.warning("policy warning", rule="sql-injection")
logger.error("blocked request", user_id="u_123")
logger.debug("scanner details")

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

kavach_logger-0.0.3.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

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

kavach_logger-0.0.3-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file kavach_logger-0.0.3.tar.gz.

File metadata

  • Download URL: kavach_logger-0.0.3.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for kavach_logger-0.0.3.tar.gz
Algorithm Hash digest
SHA256 556c5d20179e557b9b19da52927888b45a14ee44b41ed9c7232eec77b1094998
MD5 5aa3e3ae6c53fc91e50fb1ffd9148cbf
BLAKE2b-256 0337c5754410a85ec96100d8e0643c661e4cfab1ba527daff381281f6ec4eb18

See more details on using hashes here.

Provenance

The following attestation bundles were made for kavach_logger-0.0.3.tar.gz:

Publisher: upload_python_package.yml on shivamnamdeo0101/kavach-agent-ecosystem

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kavach_logger-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: kavach_logger-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for kavach_logger-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d9b310eafb94eecdcf1ee046d11471d30aea6de4fa9e186c0a7bc493ec4fda50
MD5 170f49878a71da93e848cad5e228b1d3
BLAKE2b-256 dbd0e1d1c265a9c132412f9cd479ec1e2c138c14cc13bf54dba2fa7ecb18520b

See more details on using hashes here.

Provenance

The following attestation bundles were made for kavach_logger-0.0.3-py3-none-any.whl:

Publisher: upload_python_package.yml on shivamnamdeo0101/kavach-agent-ecosystem

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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