Struct MasterKey

gcpkms/keysource.go:58–86

MasterKey is a GCP KMS key used to encrypt and decrypt the SOPS data key.

// MasterKey is a GCP KMS key used to encrypt and decrypt the SOPS
// data key.
type MasterKey struct {
	// ResourceID is the resource id used to refer to the gcp kms key.
	// It can be retrieved using the `gcloud` command.
	ResourceID string
	// EncryptedKey is the string returned after encrypting with GCP KMS.
	EncryptedKey string
	// CreationDate is the creation timestamp of the MasterKey. Used
	// for NeedsRotation.
	CreationDate time.Time

	// tokenSource contains the oauth2.TokenSource used by the GCP client.
	// It can be injected by a (local) keyservice.KeyServiceServer using
	// TokenSource.ApplyToMasterKey.
	// If nil, the remaining authentication methods are attempted.
	tokenSource oauth2.TokenSource
	// credentialJSON is the Service Account credentials JSON used for
	// authenticating towards the GCP KMS service.
	credentialJSON []byte
	// grpcConn can be used to inject a custom GCP client connection.
	// Mostly useful for testing at present, to wire the client to a mock
	// server.
	grpcConn *grpc.ClientConn
	// grpcDialOpts are the gRPC dial options used to create the gRPC connection.
	grpcDialOpts []grpc.DialOption
	// useRESTClient indicates whether to use the REST client for GCP KMS.
	useRESTClient bool
	// clientOpts are the client options used to create the GCP KMS client.
	clientOpts []option.ClientOption
}

// NewMasterKeyFromResourceID creates a new MasterKey with the provided resource
// ID.