soc-faker 用于生成假数据,供安全运营中心、信息安全专业人员、产品团队等使用。
soc-faker 适用于 Python 3.6 或更高版本。您可以通过 pip 安装 soc-faker,也可以直接克隆此仓库。
在撰写本文档时,soc-faker 能够为以下主要类别生成假数据。您可以通过点击下面的链接查看每个类别的具体详情:
pip install soc-faker --user
git clone https://github.com/swimlane/soc-faker.git
cd soc-faker
python setup.py install
以下库是 soc-faker 所必需并随其一起安装的:
requests==2.23.0
pendulum==2.1.2
ipaddress==1.0.23
bs4==0.0.1
xmltodict==0.12.0
netaddr==0.7.20
fire==0.3.1
soc-faker 是一个 Python 包,可以导入使用,也可以通过命令行工具来生成与安全工具、产品以及通用安全相关的假数据。
在您通过源码或使用 pip 安装 soc-faker 后,可以像下面这样导入并实例化它:
from socfaker import SocFaker
sc = SocFaker()
一旦实例化了 soc-faker 对象,您就可以根据需求访问任何可用的不同属性和方法。如果您想查看 soc-faker 的实际运行效果,请参阅仓库 bin 文件夹下的 bin/test.py 脚本,该脚本展示了所有可用的属性和方法。
此外,请阅读文档以获取每个可用属性和方法的更多详情。
安装 soc-faker 后,它会自动创建一个命令行工具供您使用。您只需在您选择的 shell 中输入 soc-faker 即可访问该工具。
要查看 soc-faker 的帮助信息,请输入:
soc-faker
# 或
soc-faker --help
您可以像在库中一样访问每个属性,唯一的区别是属性之间的点(.)需要替换为空格。例如,如果您想快速获取一些随机生成的 hashes,可以运行:
soc-faker file hashes
这将向您的 shell 返回以下内容:
md5: aa3150ac34ee6a5911e61ab6a5052a6d
sha1: de5c15f64d979ed84bac340c334a63d94401059d
sha256: 118a9f9de8f3dd6471ef113959485ecbaf66368dea16758eab4e22da182d0e9f
如果您遇到任何问题,只需输入您认为正确的命令,内置帮助将引导您了解 soc-faker 中每个数据点的所有可用组、命令等。
您可以使用提供的 Dockerfile 来搭建 soc-faker 的开发和测试环境。
要使用 Dockerfile,请切换到该仓库的目录并运行:
docker build --force-rm -t socfaker .
构建完成后,运行 Docker 容器:
docker run -p 7001:7001 -ti socfaker
运行此命令将调用 bin\test.py 中的测试 Python 文件。您可以修改此文件以进行额外的测试和开发。
本项目中的测试应涵盖所有可用的属性和方法。随着项目的增长,测试将变得更加健壮,但目前我们只测试它们是否存在并能返回输出。
请阅读 CONTRIBUTING.md 了解我们的行为准则以及提交拉取请求的流程。
我们使用 SemVer 进行版本控制。
请阅读 CHANGELOG.md 了解特定版本 soc-faker 的功能详情。
另请参阅参与此项目的贡献者列表。
本项目采用 MIT 许可证 - 详情请参阅 LICENSE 文件。
soc-faker 是一个 Swimlane 开源项目;我们相信通过分享我们为应用程序构建的一些项目来回馈开源社区。Swimlane 是一个自动化的网络安全运营和事件响应平台,使网络安全团队能够利用威胁情报、加快事件响应速度并实现安全操作自动化。
SecOps Hub 是一个开放、与产品无关的在线社区,供安全专业人员分享想法、用例、最佳实践和事件响应策略。