sops icon indicating copy to clipboard operation
sops copied to clipboard

sops filestatus should return an different JSON when creation_rules do not apply

Open red-lichtie opened this issue 9 months ago • 2 comments

When using sops filestatus <filename> the response is either {"encrypted":true} or {"encrypted":false}.

There is no indication as to whether or not it would have an encryption applied or not based on creation_rules defined in .sops.yaml.

If the file is not encrypted and it doesn't match any of the creation_rules then filestatus should return either an empty response {} or some other flag, e.g. {"ignored":true}.

This would make linting extremely easy and not require an external function trying to emulate the sops logic.

red-lichtie avatar Feb 15 '25 22:02 red-lichtie

If the file is not encrypted, encrypted should always be false. Not returning that would be a breaking change. Adding additional information based on .sops.yaml would be possible, but not emitting encrypted is not acceptable.

felixfontein avatar Feb 15 '25 22:02 felixfontein

Agreed, a breaking change would be bad, then something like {"encrypted":false,"ignored":true} or {"encrypted":false,"encryption_required":false} would be a possible solution.

red-lichtie avatar Feb 15 '25 22:02 red-lichtie