A package for secure logging
Project description
SecureLog
SecureLog is a Python library designed to enhance the security of logging by preventing the leakage of sensitive information. It checks log messages for secrets and prints them securely, ensuring that sensitive data is not exposed in logs.
Features
- Secure Logging: Automatically checks log messages for secrets and prints them securely.
- Environment-Specific Configuration: Allows disabling console logging based on the environment variable value.
- Warning or Exit: Can be configured to either issue a warning or exit the process when a secret is detected.
Installation
To install SecureLog, use pip:
pip install secure-log==0.1.1
Usage
Basic Usage
To use SecureLog, simply import the SecureLog
class and create an instance:
from secure_log import SecureLog
from secure_log import SecureLog
print = SecureLog().secure_print
You can override the default print
function with secure_print
or use secure_print
directly for printing.
Configuration
You can configure SecureLog by passing an OptionsDict
to the constructor. The OptionsDict
can include the following keys:
disableOn
: The environment variable value on which console logging should be disabled. This checks the value ofPYTHON_ENV
. Expected type:str
.warnOnly
: IfTrue
, only a warning is issued when a secret is detected in the log message. Otherwise, the process exits. Expected type:bool
.
Example:
options = {
"disableOn": "production",
"warnOnly": True
}
secure_log = SecureLog(options=options)
secure_log.secure_print("This is a secure log message.")
Handling Potential Secrets Leak
If a secret is detected in a log message, SecureLog can either issue a warning or exit the process, depending on the warnOnly
option.
secure_log.secure_print("This message contains a secret: SECRET_KEY")
Contributing
Contributions are welcome! Please read the contributing guidelines before getting started.
License
SecureLog is released under the MIT License.
Contact
For any questions or concerns, please open an issue on GitHub.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file secure_log-0.1.1.tar.gz
.
File metadata
- Download URL: secure_log-0.1.1.tar.gz
- Upload date:
- Size: 3.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | aafcc0c1fb1bb1d6f0202609a2b442d1d74e27b776849db86224863c8b2af106 |
|
MD5 | 3482cdef4ab7df05789860096b761c1c |
|
BLAKE2b-256 | 8a9dc668cd35d40a802bd5e29d0c1f03ad148dafa83bb0044b556dd9214bab6f |
File details
Details for the file secure_log-0.1.1-py3-none-any.whl
.
File metadata
- Download URL: secure_log-0.1.1-py3-none-any.whl
- Upload date:
- Size: 4.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 327a0a906e70465c0eae86b8d2568c3aaf899e48d2f37fb93a5a5f0d6fe8338c |
|
MD5 | 10247fb8361344378a583b794e41a0a5 |
|
BLAKE2b-256 | ea8b86c3f8c2d82a0c235deb1fc75f3fe326b8d7ad644ee70d46865eb3ae9cb5 |