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
What is this?SOPS (Secrets OPerationS) is an editor for encrypted files that supports YAML, JSON, ENV, INI and BINARY formats, encrypting values with AWS KMS, GCP KMS, Azure Key Vault, HuaweiCloud KMS, age, or PGP.
Is this a library or a standalone CLI tool?It's a standalone command-line tool you run directly on your secret files; it isn't a library you import into code.
How do I start encrypting files with it?Install the sops binary and run it against a YAML/JSON/ENV/INI/binary file, pointing it at a key from a supported provider (KMS, Azure Key Vault, age, or PGP) to encrypt or edit the file in place.
Do I need a cloud account or can I use it fully offline with age/PGP keys?No cloud account is required: besides AWS KMS, GCP KMS, Azure Key Vault and HuaweiCloud KMS, sops also supports age and PGP keys, which work entirely locally without any cloud provider.
Does the project have a security disclosure process?Security issues should be reported privately via GitHub's advisory form rather than in public issues.
What inspired SOPS?The project was inspired by hiera-eyaml, credstash, sneaker, pass (password store) and years of manually managing PGP-encrypted files.
Where can I find the full documentation?The SOPS documentation is hosted on getsops.io under the Docs section.
Creator
getsops
Size
141.8 MB
Stars
23.4K
Age
11y
Commits · 90 Days