drone-yaml/yaml/secret.go

54 lines
1.4 KiB
Go

// Copyright (c) 2019, Drone IO Inc.
// Copyright (c) 2021, Robert Kaussow <mail@thegeeklab.de>
package yaml
import "errors"
type (
// Secret is a resource that provides encrypted data
// and pointers to external data (i.e. from vault).
Secret struct {
Version string `json:"version,omitempty"`
Kind string `json:"kind,omitempty"`
Type string `json:"type,omitempty"`
Name string `json:"name,omitempty"`
Data string `json:"data,omitempty"`
Get SecretGet `json:"get,omitempty"`
}
// SecretGet defines a request to get a secret from
// an external service at the specified path, or with the
// specified name.
SecretGet struct {
Path string `json:"path,omitempty"`
Name string `json:"name,omitempty"`
Key string `json:"key,omitempty"`
}
// ExternalData defines the path and name of external
// data located in an external or remote storage system.
ExternalData struct {
Path string `json:"path,omitempty"`
Name string `json:"name,omitempty"`
}
)
var ErrInvalidSecret = errors.New("yaml: invalid secret resource")
// GetVersion returns the resource version.
func (s *Secret) GetVersion() string { return s.Version }
// GetKind returns the resource kind.
func (s *Secret) GetKind() string { return s.Kind }
// Validate returns an error if the secret is invalid.
func (s *Secret) Validate() error {
if len(s.Data) == 0 && len(s.Get.Path) == 0 && len(s.Get.Name) == 0 {
return ErrInvalidSecret
}
return nil
}