Skip to content

[Sandbox] SOPS #28

Closed
Closed
@hiddeco

Description

@hiddeco

Application contact emails

dnazer@mozilla.com
hidde@weave.works
ablock@redhat.com

Project Summary

SOPS (Secrets OPerationS) is an editor in the form of a command-line tool and SDK designed to help manage encrypted files in a variety of structured (YAML, JSON, ENV, INI) and BINARY formats using a one of the supported Key Management Systems (KMS), PGP, or age.

Project Description

SOPS (Secrets OPerationS) is an editor in the form of a command-line tool and SDK designed to help manage sensitive content stored within structured files. Various formats, including YAML, JSON, ENV and binary, are supported and their content is managed by encrypting only the values portion of a key/value pair to maintain their readability as it lies at rest.

The encryption/decryption process is facilitated by one of the several popular KMS services including AWS, GCP, Azure Key Vault and HashiCorp Vault or more traditional methods, such as PGP or age.

SOPS features a robust set of capabilities to manage complex workflows including support for multiple operational environments and the ability to leverage multiple encryption backends deterministically. Beyond the basics, support is also available to perform key rotation to re-encrypt encrypted contents as well as auditing each activity that is performed to satisfy both day one and day two requirements.

Org repo URL

N/A

Project repo URL

https://github.com/mozilla/sops

Additional repos

https://github.com/mozilla/sotp

Website URL

https://github.com/mozilla/sops

Roadmap

N/A

Roadmap context

While contributions from the community continue to be submitted to the project, until a long term direction is determined, no active development will occur. Once those primary hurdles have been resolved, the short term roadmap focuses on producing a new release of the project, the first in over nine (9) months (v3.7.3 - May 2022).

Given the popularity of the project (12k stars and still growing), its future is bright. To support a evolving the project forward, long term goals could include:

Expanding the set of supported encryption providers
Providing more native support for the ecosystem seeking to integrate the project within their tooling. Several externally managed tools do exist which provide these integrations, but they are developed and maintained by individual contributors instead of being associated with either this project or for the target tool.

Contributing Guide

https://github.com/mozilla/sops/blob/master/CONTRIBUTING.md

Code of Conduct (CoC)

https://github.com/mozilla/sops/blob/master/CODE_OF_CONDUCT.md

Adopters

No response

Contributing or Sponsoring Org

https://mozilla.org

Maintainers file

N/A (beyond git-log)

IP Policy

  • If the project is accepted, I agree the project will follow the CNCF IP Policy

Under review by Mozilla/CNCF legal but not expected to be blocking for further entry.

Trademark and accounts

  • If the project is accepted, I agree to donate all project trademarks and accounts to the CNCF

Under review by Mozilla/CNCF legal but not expected to be blocking for further entry.

Why CNCF?

The maintainers of the SOPS project have approached several maintainers and contributors of CNCF projects to take stewardship of this project, which has been agreed to in principle. This proposal represents a tangible first step towards this desired goal.
Aside from providing a home for the SOPS project, there currently is a void as it relates to tooling dedicated for the purpose of managing sensitive resources within the CNCF. There are a couple of other libraries of limited scope, but there is no major focus compared to other domains (eg) OpenTelemetry.

By SOPS becoming a CNCF sponsored project, it represents not only a need for this type of tooling, but the desire for additional dialog and the establishment of recommended practices when working with sensitive assets to be leveraged by the community to ultimately provide a more secure operating environment.

The big picture here is that all cloud native applications need better support, patterns, tools, apis. SOPS is just one set of patterns but could help create focus and momentum for more solutions and community work.

Benefit to the Landscape

Managing sensitive assets is a fundamental task when working with any cloud native technology so their values can be safely used in practice as well as stored at rest. By establishing SOPS as a CNCF project, it represents a clear indication that secrets management is an important concept and that practices must be established to not only provide approaches when working with sensitive resources, but for tooling to be available to facilitate the safe storage, retrieval and interoperability with existing systems.

Cloud Native 'Fit'

SOPS itself is not tied to a specific cloud native technology or project. However, it is not only applicable to help satisfy key security, compliance and auditing requirements, but integrations are available (see below) to support the usage within other cloud native solutions

In addition, by being available as a simple Command Line based utility with a limited number of dependencies and requirements, end users can begin protecting their sensitive assets in no time enabling a safer operating experience and promoting recommended security practices.

Cloud Native 'Integration'

Several cloud native technologies and associated projects have already included native support or are leveraging a third party integration to enable SOPS within their project.

The list of projects include:

  • Flux (CNCF graduated) offers extensive native integration
  • Argo CD (CNCF graduated) offers support through its plugin model which is enabled by several third party plugins
  • Helm (CNCF graduated) offers support through its plugin model which is enabled by several third party plugins
  • Automation tooling (Ansible / Terraform) through third party plugins

Cloud Native Overlap

No response

Similar projects

SOPS provides similar functionality as these other projects:

External Secrets Operator
Sealed Secrets

ESO has a complementary approach to SOPS and the projects could potentially help each other e.g. with shared libs for connectors to third party stores. (maybe under an umbrella org?)

Product or Service to Project separation

N/A

Project presentations

No response

Project champions

No response

Additional information

Proposed new maintainers:

Activity

amye

amye commented on May 9, 2023

@amye

/vote-sandbox

git-vote

git-vote commented on May 9, 2023

@git-vote

Vote created

@amye has called for a vote on [Sandbox] SOPS (#28).

The members of the following teams have binding votes:

Team
@cncf/cncf-toc

Non-binding votes are also appreciated as a sign of support!

How to vote

You can cast your vote by reacting to this comment. The following reactions are supported:

In favor Against Abstain
👍 👎 👀

Please note that voting for multiple options is not allowed and those votes won't be counted.

The vote will be open for 7days. It will pass if at least 66% of the users with binding votes vote In favor 👍. Once it's closed, results will be published here as a new comment.

hiddeco

hiddeco commented on May 10, 2023

@hiddeco
Author

/check-vote

amye

amye commented on May 10, 2023

@amye

/check-vote

git-vote

git-vote commented on May 10, 2023

@git-vote

Vote status

So far 15.38% of the users with binding vote are in favor (passing threshold: 66%).

Summary

In favor Against Abstain Not voted
2 0 0 11

Binding votes (2)

User Vote Timestamp
rochaporto In favor 2023-05-09 18:58:35.0 +00:00:00
TheFoxAtWork In favor 2023-05-09 20:19:30.0 +00:00:00

Non-binding votes (49)

User Vote Timestamp
netthier In favor 2023-05-09 16:10:21.0 +00:00:00
yasn77 In favor 2023-05-09 16:10:29.0 +00:00:00
nbjohnson In favor 2023-05-09 16:12:56.0 +00:00:00
makkes In favor 2023-05-09 16:13:56.0 +00:00:00
aryan9600 In favor 2023-05-09 16:15:52.0 +00:00:00
bo0tzz In favor 2023-05-09 16:19:11.0 +00:00:00
stefanprodan In favor 2023-05-09 16:21:07.0 +00:00:00
onedr0p In favor 2023-05-09 16:21:31.0 +00:00:00
hiddeco In favor 2023-05-09 16:22:24.0 +00:00:00
ruzickap In favor 2023-05-09 16:25:35.0 +00:00:00
hoegertn In favor 2023-05-09 16:27:25.0 +00:00:00
multani In favor 2023-05-09 16:38:59.0 +00:00:00
danmanners In favor 2023-05-09 16:39:21.0 +00:00:00
smbonn2005 In favor 2023-05-09 16:41:17.0 +00:00:00
JJGadgets In favor 2023-05-09 16:43:23.0 +00:00:00
Ryan-McD In favor 2023-05-09 16:44:46.0 +00:00:00
brian-arms In favor 2023-05-09 16:49:35.0 +00:00:00
mitar In favor 2023-05-09 16:55:58.0 +00:00:00
Pumba98 In favor 2023-05-09 17:09:35.0 +00:00:00
felixfontein In favor 2023-05-09 17:11:27.0 +00:00:00
LarsBingBong In favor 2023-05-09 17:31:58.0 +00:00:00
Havnevej In favor 2023-05-09 17:47:36.0 +00:00:00
squaremo In favor 2023-05-09 18:29:30.0 +00:00:00
brokenpip3 In favor 2023-05-09 18:49:04.0 +00:00:00
macedogm In favor 2023-05-09 18:49:57.0 +00:00:00
dbrennand In favor 2023-05-09 19:05:46.0 +00:00:00
adrianmoisey In favor 2023-05-09 19:07:10.0 +00:00:00
daniel-sampliner In favor 2023-05-09 19:30:03.0 +00:00:00
mbreitung In favor 2023-05-09 19:54:52.0 +00:00:00
sysdigkenneth In favor 2023-05-09 20:39:26.0 +00:00:00
jraeis In favor 2023-05-09 20:41:23.0 +00:00:00
nogweii In favor 2023-05-09 22:01:22.0 +00:00:00
budimanjojo In favor 2023-05-10 3:35:06.0 +00:00:00
madAndroid In favor 2023-05-10 4:44:05.0 +00:00:00
dudicoco In favor 2023-05-10 4:51:38.0 +00:00:00
hpdobrica In favor 2023-05-10 6:22:17.0 +00:00:00
LappleApple In favor 2023-05-10 7:40:22.0 +00:00:00
TheDukeDK In favor 2023-05-10 8:27:11.0 +00:00:00
alk-adong In favor 2023-05-10 8:29:32.0 +00:00:00
Moskovych In favor 2023-05-10 9:38:07.0 +00:00:00
gunnertwin In favor 2023-05-10 10:04:10.0 +00:00:00
nullishamy In favor 2023-05-10 11:36:18.0 +00:00:00
coder11235 In favor 2023-05-10 11:49:04.0 +00:00:00
rubyowo In favor 2023-05-10 12:10:37.0 +00:00:00
manveru In favor 2023-05-10 12:18:52.0 +00:00:00
William-LP In favor 2023-05-10 12:46:24.0 +00:00:00
andrijagulan In favor 2023-05-10 13:19:17.0 +00:00:00
iamhsa In favor 2023-05-10 16:28:56.0 +00:00:00
floweb In favor 2023-05-10 19:17:11.0 +00:00:00
sabre1041

sabre1041 commented on May 11, 2023

@sabre1041

/check-vote

git-vote

git-vote commented on May 11, 2023

@git-vote

Votes can only be checked once a day.

fabidick22

fabidick22 commented on May 11, 2023

@fabidick22

/check-vote

git-vote

git-vote commented on May 11, 2023

@git-vote

Votes can only be checked once a day.

25 remaining items

git-vote

git-vote commented on May 17, 2023

@git-vote

Vote closed

The vote passed! 🎉

90.91% of the users with binding vote were in favor (passing threshold: 66%).

Summary

In favor Against Abstain Not voted
10 0 0 1

Binding votes (10)

User Vote Timestamp
@kgamanji In favor 2023-05-15 16:08:07.0 +00:00:00
@erinaboyd In favor 2023-05-16 11:32:11.0 +00:00:00
@RichiH In favor 2023-05-15 8:20:38.0 +00:00:00
@cathyhongzhang In favor 2023-05-15 21:37:01.0 +00:00:00
@TheFoxAtWork In favor 2023-05-09 20:19:30.0 +00:00:00
@dzolotusky In favor 2023-05-12 13:34:19.0 +00:00:00
@mattfarina In favor 2023-05-15 14:00:26.0 +00:00:00
@mauilion In favor 2023-05-16 15:03:22.0 +00:00:00
@rochaporto In favor 2023-05-09 18:58:35.0 +00:00:00
@nikhita In favor 2023-05-12 4:14:48.0 +00:00:00

Non-binding votes (84)

User Vote Timestamp
@netthier In favor 2023-05-09 16:10:21.0 +00:00:00
@yasn77 In favor 2023-05-09 16:10:29.0 +00:00:00
@nbjohnson In favor 2023-05-09 16:12:56.0 +00:00:00
@makkes In favor 2023-05-09 16:13:56.0 +00:00:00
@aryan9600 In favor 2023-05-09 16:15:52.0 +00:00:00
@bo0tzz In favor 2023-05-09 16:19:11.0 +00:00:00
@stefanprodan In favor 2023-05-09 16:21:07.0 +00:00:00
@onedr0p In favor 2023-05-09 16:21:31.0 +00:00:00
@hiddeco In favor 2023-05-09 16:22:24.0 +00:00:00
@ruzickap In favor 2023-05-09 16:25:35.0 +00:00:00
@hoegertn In favor 2023-05-09 16:27:25.0 +00:00:00
@multani In favor 2023-05-09 16:38:59.0 +00:00:00
@danmanners In favor 2023-05-09 16:39:21.0 +00:00:00
@smbonn2005 In favor 2023-05-09 16:41:17.0 +00:00:00
@JJGadgets In favor 2023-05-09 16:43:23.0 +00:00:00
@ryan-mcd In favor 2023-05-09 16:44:46.0 +00:00:00
@brian-arms In favor 2023-05-09 16:49:35.0 +00:00:00
@mitar In favor 2023-05-09 16:55:58.0 +00:00:00
@Pumba98 In favor 2023-05-09 17:09:35.0 +00:00:00
@felixfontein In favor 2023-05-09 17:11:27.0 +00:00:00
@LarsBingBong In favor 2023-05-09 17:31:58.0 +00:00:00
@Havnevej In favor 2023-05-09 17:47:36.0 +00:00:00
@squaremo In favor 2023-05-09 18:29:30.0 +00:00:00
@brokenpip3 In favor 2023-05-09 18:49:04.0 +00:00:00
@macedogm In favor 2023-05-09 18:49:57.0 +00:00:00
@dbrennand In favor 2023-05-09 19:05:46.0 +00:00:00
@adrianmoisey In favor 2023-05-09 19:07:10.0 +00:00:00
@daniel-sampliner In favor 2023-05-09 19:30:03.0 +00:00:00
@mbreitung In favor 2023-05-09 19:54:52.0 +00:00:00
@sysdigkenneth In favor 2023-05-09 20:39:26.0 +00:00:00
@jraeis In favor 2023-05-09 20:41:23.0 +00:00:00
@nogweii In favor 2023-05-09 22:01:22.0 +00:00:00
@budimanjojo In favor 2023-05-10 3:35:06.0 +00:00:00
@madAndroid In favor 2023-05-10 4:44:05.0 +00:00:00
@dudicoco In favor 2023-05-10 4:51:38.0 +00:00:00
@hpdobrica In favor 2023-05-10 6:22:17.0 +00:00:00
@LappleApple In favor 2023-05-10 7:40:22.0 +00:00:00
@TheDukeDK In favor 2023-05-10 8:27:11.0 +00:00:00
@alk-adong In favor 2023-05-10 8:29:32.0 +00:00:00
@Moskovych In favor 2023-05-10 9:38:07.0 +00:00:00
@gunnertwin In favor 2023-05-10 10:04:10.0 +00:00:00
@nullishamy In favor 2023-05-10 11:36:18.0 +00:00:00
@coder11235 In favor 2023-05-10 11:49:04.0 +00:00:00
@rubyowo In favor 2023-05-10 12:10:37.0 +00:00:00
@manveru In favor 2023-05-10 12:18:52.0 +00:00:00
@William-LP In favor 2023-05-10 12:46:24.0 +00:00:00
@andrijagulan In favor 2023-05-10 13:19:17.0 +00:00:00
@iamhsa In favor 2023-05-10 16:28:56.0 +00:00:00
@voor In favor 2023-05-10 20:23:31.0 +00:00:00
@mrcalderon In favor 2023-05-10 22:27:10.0 +00:00:00
@devstein In favor 2023-05-10 23:04:23.0 +00:00:00
@sabre1041 In favor 2023-05-11 11:46:09.0 +00:00:00
@manselmi In favor 2023-05-11 11:47:36.0 +00:00:00
@sclausen In favor 2023-05-11 12:57:24.0 +00:00:00
@garritfra In favor 2023-05-11 12:58:42.0 +00:00:00
@ebdekock In favor 2023-05-11 14:35:30.0 +00:00:00
@olga-salesloft In favor 2023-05-11 14:37:10.0 +00:00:00
@mshepet In favor 2023-05-11 14:38:04.0 +00:00:00
@jeffmckune In favor 2023-05-11 14:38:05.0 +00:00:00
@fabidick22 In favor 2023-05-11 16:28:53.0 +00:00:00
@diegotony In favor 2023-05-11 17:27:19.0 +00:00:00
@TravisAbram In favor 2023-05-12 2:40:14.0 +00:00:00
@lheinlen In favor 2023-05-12 15:58:41.0 +00:00:00
@kashook In favor 2023-05-12 15:59:01.0 +00:00:00
@floweb In favor 2023-05-12 19:42:15.0 +00:00:00
@lucasfcnunes In favor 2023-05-13 0:13:23.0 +00:00:00
@bkreitch In favor 2023-05-13 7:40:04.0 +00:00:00
@bai In favor 2023-05-14 12:26:21.0 +00:00:00
@ghishadow In favor 2023-05-14 17:52:55.0 +00:00:00
@neverpanic In favor 2023-05-15 10:01:12.0 +00:00:00
@slimm609 In favor 2023-05-15 13:16:02.0 +00:00:00
@gabeio In favor 2023-05-15 21:42:17.0 +00:00:00
@pdf In favor 2023-05-15 22:49:46.0 +00:00:00
@astrolemonade In favor 2023-05-15 23:33:18.0 +00:00:00
@tchen In favor 2023-05-16 0:09:43.0 +00:00:00
@ryantate13 In favor 2023-05-16 0:36:12.0 +00:00:00
@sbmthakur In favor 2023-05-16 3:07:50.0 +00:00:00
@ifraixedes In favor 2023-05-16 9:15:14.0 +00:00:00
@giautm In favor 2023-05-16 12:33:17.0 +00:00:00
@erismaster In favor 2023-05-16 16:45:36.0 +00:00:00
@zchee In favor 2023-05-16 21:54:02.0 +00:00:00
@dotcarls In favor 2023-05-17 0:23:16.0 +00:00:00
@tobru In favor 2023-05-17 8:49:12.0 +00:00:00
@jrwhite17 In favor 2023-05-17 13:14:28.0 +00:00:00
moved this from 🏗 Upcoming to ✅ Done in Sandbox Application Board - next review TBDon May 17, 2023
added
ApprovedThis is an approved sandbox project.
on May 17, 2023
added a commit that references this issue on Sep 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    ✅ Done

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @caniszczyk@amye@floweb@RichiH@sabre1041

        Issue actions

          [Sandbox] SOPS · Issue #28 · cncf/sandbox