sops README

The project's README from github.com/getsops/sops. As one markdown file: README.md.

SOPS: Secrets OPerationS

SOPS is an editor of encrypted files that supports YAML, JSON, ENV, INI and BINARY formats and encrypts with AWS KMS, GCP KMS, Azure Key Vault, HuaweiCloud KMS, age, and PGP. (demo <https://www.youtube.com/watch?v=YTEVyLXFiq0>_)

.. image:: https://i.imgur.com/X0TM5NI.gif


.. image:: https://pkg.go.dev/badge/github.com/getsops/sops/v3.svg :target: https://pkg.go.dev/github.com/getsops/sops/v3

Documentation

You can find the SOPS documentation on getsops.io <https://getsops.io/>_ under "Docs" <https://getsops.io/docs/>_.

Security

Please report any security issues privately using GitHub's advisory form <https://github.com/getsops/sops/security/advisories>_.

License

Mozilla Public License Version 2.0

Authors

SOPS was initially launched as a project at Mozilla in 2015 and has been graciously donated to the CNCF as a Sandbox project in 2023, now under the stewardship of a new group of maintainers <https://github.com/getsops/community/blob/main/MAINTAINERS.md>_.

The original authors of the project were:

Furthermore, the project has been carried for a long time by AJ Bahnken @ajvb, and had not been possible without the contributions of numerous contributors <https://github.com/getsops/sops/graphs/contributors>_.

Credits

SOPS was inspired by hiera-eyaml <https://github.com/TomPoulton/hiera-eyaml>, credstash <https://github.com/LuminalOSS/credstash>, sneaker <https://github.com/codahale/sneaker>, password store <http://www.passwordstore.org/> and too many years managing PGP encrypted files by hand...


.. image:: docs/images/cncf-color-bg.svg :width: 400 :alt: CNCF Sandbox Project

We are a Cloud Native Computing Foundation <https://cncf.io>_ sandbox project.

sops (getsops/sops)

Searching Database…

23.4K ·GitHub
这是什么?SOPS(Secrets OPerationS)是一款加密文件编辑工具,支持 YAML、JSON、ENV、INI 和 BINARY 格式,可使用 AWS KMS、GCP KMS、Azure Key Vault、HuaweiCloud KMS、age 或 PGP 加密其中的值。
这是库还是独立的命令行工具?它是一款独立的命令行工具,直接在你的机密文件上运行;它不是可以导入代码中使用的库。
我该如何开始用它加密文件?安装 sops 可执行文件,对 YAML/JSON/ENV/INI/二进制文件运行它,并指定来自受支持提供方(KMS、Azure Key Vault、age 或 PGP)的密钥,直接在原文件上加密或编辑。
我需要云账户吗?还是可以仅用 age/PGP 密钥完全离线使用?不需要云账户:除了 AWS KMS、GCP KMS、Azure Key Vault 和 HuaweiCloud KMS 之外,sops 还支持 age 和 PGP 密钥,这些密钥完全在本地运行,无需任何云服务提供商。
这个项目有安全漏洞披露流程吗?安全问题应通过 GitHub 的安全公告表单私下报告,而不是在公开的 Issue 中提交。
SOPS 的灵感来自哪里?该项目的灵感来源于 hiera-eyaml、credstash、sneaker、pass(password store),以及多年手动管理 PGP 加密文件的经验。
在哪里可以找到完整文档?SOPS 文档托管在 getsops.io 的 Docs 栏目下。
Creator
getsops
Size
141.8 MB
Stars
23.4K
Age
11y
Commits · 90 Days