如何使用MaskerLogger防止敏感数据发生泄露

关于MaskerLogger

MaskerLogger是一款功能强大的记录工具，该工具可以有效防止敏感数据泄露的发生。

   

  MaskerLogger旨在掩护目标体系的日子安全，此格式化程序可确保你的日志安全并防止敏感数据泄露。比方使用此格式化程序，打印下列数据：

1. logger.info(f'Dont Give Your {secrets} away')

复制代码

输出结果如下所示：

1. Dont Give Your ****** away

复制代码

功能介绍

此格式化程序使用标准logging.Formatter模块。
在将每条记录打印到任何目标（文件、标准输出等）之前，它会确保敏感数据用星号屏蔽，以防止泄露。
工具要求

   Python3
  工具安装

由于该工具基于Python 3开发，因此我们首先需要在当地装备上安装并设置好最新版本的Python 3环境。
源码获取

广大研究人员可以直接使用下列命令将该项目源码克隆至当地：

1. git clone https://github.com/oxsecurity/MaskerLogger.git

复制代码

pip安装

1. pip install maskerlogger

复制代码

工具使用

与任何格式化程序一样 - 只需使用 MaskerLogger 格式化程序初始化你的记录器处理程序即可：

1. from maskerlogger import MaskerFormatter
3. logger = logging.getLogger('logger')
5. logger.setLevel(logging.DEBUG)
7. handler = logging.StreamHandler()
9. handler.setFormatter(
11.     MaskerFormatter("%(asctime)s %(name)s %(levelname)s %(message)s"))
13. logger.addHandler(handler)

复制代码

如果由于某种缘故原由，你想要禁用特定日志行上的屏蔽，请使用该SKIP_MASK（“隐蔽跳过”）机制：

1. from masker_formatter import MaskerFormatter, SKIP_MASK
3. ...
5. ...
7. logger.info('Line you want to skip', extra=SKIP_MASK)

复制代码

如果你盼望仅屏蔽敏感数据的其中一部分（而不是其全部长度），则可以在格式化程序中设置redact参数，该redact参数可以指定要屏蔽的机密的百分比。
以下是如何使用它的示例：

1. handler.setFormatter(
3.     MaskerFormatter("%(asctime)s %(name)s %(levelname)s %(message)s",
5.                     redact=30))

复制代码

在此示例中，30% 的敏感数据将被屏蔽。请根据需要调解redact的值以满意你的要求。
使用自界说设置文件

要创建和使用本身的设置文件，请在初始化格式化程序时设置路径：

1. handler.setFormatter(
3.     MaskerFormatter("%(asctime)s %(name)s %(levelname)s %(message)s",
5.                     regex_config_path="your/config/gitleaks.toml"))

复制代码

许可证协议

本项目的开发与发布依照MIT开源许可协议。
项目地点

MaskerLogger：【GitHub传送门】
参考资料

   https://www.ox.security/

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。