GPGME: support passphrase for prompt-less signing #1446

vrothberg · 2022-01-19T13:44:18Z

To support signing images via gpgme without user prompt, allow for
providing a passphrase via the copy options. Add a new *WithOptions API
to the signature package and extend its interface.

To prevent breaking the API, extend the signature API with an internal
type as has already been done for other types and interfaces in c/image.

Signed-off-by: Valentin Rothberg rothberg@redhat.com

vrothberg · 2022-01-19T13:44:32Z

Skopeo PR: containers/skopeo#1540

mtrmac

A process-wide environment variable shouldn’t be the only way to expose this (e.g. it is unusable from any multi-threaded server managing multiple private keys); a caller should be able to just pass a Go string to a NewGPGSigningMechanism$differentiator constructor. (Assuming $differentiator is WithOptions, should that just be a struct, or “functional options” with all that boilerplate? I don’t have a strong opinion at this point.)

Similarly, up the stack, the passphrase should come from copy.Options.

Afterwards, if passing this through the environment is a good idea (AFAIK it’s not unsafe but it might be unergonomic — notably the way containers/skopeo#1540 indiscriminately makes that available to all child processes immediately makes me pause), we can add a function to pkg/cli/environment.

mtrmac

See also the previous review — this should be configurable in Go.

signature/mechanism_gpgme.go

vrothberg · 2022-01-20T15:39:03Z

Good to go from my side. Had to do the usual *WithOptions dance.

TomSweeneyRedHat

LGTM
Documentation targeted towards somewhere in Podman and/or Buildah?

vrothberg · 2022-01-21T08:43:51Z

LGTM Documentation targeted towards somewhere in Podman and/or Buildah?

Skopeo for now. If needed, we can add the --sign-passphrase-file flag to Podman/Buildah as well. Would require some plumbing in c/common/libimage.

copy/copy.go

copy/sign.go

signature/mechanism.go

signature/mechanism_gpgme.go

signature/signature.go

vrothberg · 2022-01-24T10:57:00Z

@mtrmac, PTanotherL:

We're passing a passphrase only (no path) around
pkg/cli received a convenience function for parsing a passphrase file
added a new signature/internal/signature package to extend the interface without breaking the API

mtrmac

ACK to the overall approach.

signature/internal/signature/mechanism.go

signature/mechanism_openpgp.go

signature/mechanism_gpgme.go

signature/signature.go

pkg/cli/parse.go

@mtrmac

@mtrmac's fork was needed to allow for building on RHEL 7 which we do not target anymore. Moving to upstream allows for making use of more recent features and avoids diverging in the future. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>

signature/docker.go

mtrmac · 2022-01-25T10:40:49Z

@vrothberg I’d really like to have a test for the gpgmeSigningMechanism.SignWithPassphrase code. Are you working on one, or should I take that on?

signature/docker_test.go

To support signing images via gpgme without user prompt, allow for providing a passphrase via the copy options. Add a new *WithOptions API to the `signature` package and extend its interface. To prevent breaking the API, extend the signature API with an internal type as has already been done for other types and interfaces. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>

vrothberg force-pushed the passphrase branch from 9d28e9b to e8c65ad Compare January 19, 2022 13:52

mtrmac reviewed Jan 19, 2022

View reviewed changes

vrothberg force-pushed the passphrase branch from e8c65ad to 97d2bce Compare January 20, 2022 10:54

mtrmac reviewed Jan 20, 2022

View reviewed changes

signature/mechanism_gpgme.go Outdated Show resolved Hide resolved

signature/mechanism_gpgme.go Outdated Show resolved Hide resolved

signature/mechanism_gpgme.go Outdated Show resolved Hide resolved

vrothberg force-pushed the passphrase branch 3 times, most recently from b6b7545 to 65f47bf Compare January 20, 2022 15:36

vrothberg changed the title ~~WIP - GPGME: support passphrase env variable~~ GPGME: support passphrase env variable Jan 20, 2022

TomSweeneyRedHat reviewed Jan 20, 2022

View reviewed changes

mtrmac reviewed Jan 21, 2022

View reviewed changes

vrothberg force-pushed the passphrase branch from 65f47bf to 3598a65 Compare January 24, 2022 10:46

vrothberg changed the title ~~GPGME: support passphrase env variable~~ GPGME: support passphrase for prompt-less signing Jan 24, 2022

vrothberg force-pushed the passphrase branch from 3598a65 to 9c0b34e Compare January 24, 2022 10:50

mtrmac reviewed Jan 24, 2022

View reviewed changes

use github.com/proglottis/gpgme

beb2d5d

@mtrmac's fork was needed to allow for building on RHEL 7 which we do not target anymore. Moving to upstream allows for making use of more recent features and avoids diverging in the future. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>

vrothberg force-pushed the passphrase branch from 9c0b34e to 3c40015 Compare January 25, 2022 09:53

mtrmac reviewed Jan 25, 2022

View reviewed changes

signature/docker.go Show resolved Hide resolved

vrothberg force-pushed the passphrase branch from 3c40015 to bfd76d5 Compare January 25, 2022 10:36

vrothberg force-pushed the passphrase branch 2 times, most recently from e1aa665 to df2414e Compare January 25, 2022 12:18

mtrmac reviewed Jan 25, 2022

View reviewed changes

signature/docker_test.go Outdated Show resolved Hide resolved

signature/docker_test.go Outdated Show resolved Hide resolved

vrothberg force-pushed the passphrase branch 3 times, most recently from 82bd697 to 2c9ff81 Compare January 25, 2022 13:10

mtrmac reviewed Jan 25, 2022

View reviewed changes

signature/docker_test.go Show resolved Hide resolved

signature/docker_test.go Outdated Show resolved Hide resolved

vrothberg force-pushed the passphrase branch 3 times, most recently from 0557579 to 03ca304 Compare January 25, 2022 13:48

mtrmac reviewed Jan 25, 2022

View reviewed changes

signature/docker_test.go Outdated Show resolved Hide resolved

signature/docker_test.go Outdated Show resolved Hide resolved

signature/docker_test.go Outdated Show resolved Hide resolved

signature/docker_test.go Show resolved Hide resolved

vrothberg force-pushed the passphrase branch from 03ca304 to 844c921 Compare January 25, 2022 14:02

vrothberg force-pushed the passphrase branch from 844c921 to 2773109 Compare January 25, 2022 14:04

mtrmac approved these changes Jan 25, 2022

View reviewed changes

mtrmac merged commit bd97b58 into containers:main Jan 25, 2022

vrothberg deleted the passphrase branch January 25, 2022 14:32

mtrmac mentioned this pull request Jan 26, 2022

Unattended Image signing containers/podman#7705

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GPGME: support passphrase for prompt-less signing #1446

GPGME: support passphrase for prompt-less signing #1446

vrothberg commented Jan 19, 2022 •

edited

Loading

vrothberg commented Jan 19, 2022

mtrmac left a comment •

edited

Loading

mtrmac left a comment

vrothberg commented Jan 20, 2022

TomSweeneyRedHat left a comment

vrothberg commented Jan 21, 2022

vrothberg commented Jan 24, 2022

mtrmac left a comment

mtrmac commented Jan 25, 2022

GPGME: support passphrase for prompt-less signing #1446

GPGME: support passphrase for prompt-less signing #1446

Conversation

vrothberg commented Jan 19, 2022 • edited Loading

vrothberg commented Jan 19, 2022

mtrmac left a comment • edited Loading

Choose a reason for hiding this comment

mtrmac left a comment

Choose a reason for hiding this comment

vrothberg commented Jan 20, 2022

TomSweeneyRedHat left a comment

Choose a reason for hiding this comment

vrothberg commented Jan 21, 2022

vrothberg commented Jan 24, 2022

mtrmac left a comment

Choose a reason for hiding this comment

mtrmac commented Jan 25, 2022

vrothberg commented Jan 19, 2022 •

edited

Loading

mtrmac left a comment •

edited

Loading