sourcesecret

Documentation

Index

• Constants
• func Generate(options Options) (*manifestgen.Manifest, error)
• func GenerateDockerConfigJson(url, username, password string) ([]byte, error)
• func LoadKeyPair(privateKey []byte, password string) (*ssh.KeyPair, error)
• func LoadKeyPairFromPath(path, password string) (*ssh.KeyPair, error)
• func ScanHostKey(host string) ([]byte, error)
• type DockerConfig
• type DockerConfigEntry
• type DockerConfigJSON
• type Options
  • func MakeDefaultOptions() Options
• type PrivateKeyAlgorithm
• type VerificationCrt

Constants

const (
	AddressSecretKey    = "address"
	UsernameSecretKey   = "username"
	PasswordSecretKey   = "password"
	CACrtSecretKey      = "ca.crt"
	TLSCrtSecretKey     = "tls.crt"
	TLSKeySecretKey     = "tls.key"
	PrivateKeySecretKey = "identity"
	PublicKeySecretKey  = "identity.pub"
	KnownHostsSecretKey = "known_hosts"
	BearerTokenKey      = "bearerToken"
	TrustPolicyKey      = "trustpolicy.json"

	// Deprecated: Replaced by CACrtSecretKey, but kept for backwards
	// compatibility with deprecated TLS flags.
	CAFileSecretKey = "caFile"
	// Deprecated: Replaced by TLSCrtSecretKey, but kept for backwards
	// compatibility with deprecated TLS flags.
	CertFileSecretKey = "certFile"
	// Deprecated: Replaced by TLSKeySecretKey, but kept for backwards
	// compatibility with deprecated TLS flags.
	KeyFileSecretKey = "keyFile"
)

Functions

func Generate

func Generate(options Options) (*manifestgen.Manifest, error)

func GenerateDockerConfigJson

func GenerateDockerConfigJson(url, username, password string) ([]byte, error)

func LoadKeyPair

func LoadKeyPair(privateKey []byte, password string) (*ssh.KeyPair, error)

func LoadKeyPairFromPath

func LoadKeyPairFromPath(path, password string) (*ssh.KeyPair, error)

func ScanHostKey

func ScanHostKey(host string) ([]byte, error)

Types

type DockerConfig

type DockerConfig map[string]DockerConfigEntry

DockerConfig represents the config file used by the docker CLI. This config that represents the credentials that should be used when pulling images from specific image repositories.

type DockerConfigEntry

type DockerConfigEntry struct {
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
	Email    string `json:"email,omitempty"`
	Auth     string `json:"auth,omitempty"`
}

DockerConfigEntry holds the user information that grant the access to docker registry

type DockerConfigJSON

type DockerConfigJSON struct {
	Auths DockerConfig `json:"auths"`
}

DockerConfigJSON represents a local docker auth config file for pulling images.

type Options

type Options struct {
	Name                string
	Namespace           string
	Labels              map[string]string
	Registry            string
	SSHHostname         string
	PrivateKeyAlgorithm PrivateKeyAlgorithm
	RSAKeyBits          int
	ECDSACurve          elliptic.Curve
	Keypair             *ssh.KeyPair
	Username            string
	Password            string
	CACrt               []byte
	TLSCrt              []byte
	TLSKey              []byte
	TargetPath          string
	ManifestFile        string
	BearerToken         string
	VerificationCrts    []VerificationCrt
	TrustPolicy         []byte
	Address             string
}

func MakeDefaultOptions

func MakeDefaultOptions() Options

type PrivateKeyAlgorithm

type PrivateKeyAlgorithm string

const (
	RSAPrivateKeyAlgorithm     PrivateKeyAlgorithm = "rsa"
	ECDSAPrivateKeyAlgorithm   PrivateKeyAlgorithm = "ecdsa"
	Ed25519PrivateKeyAlgorithm PrivateKeyAlgorithm = "ed25519"
)

type VerificationCrt

type VerificationCrt struct {
	Name  string
	CACrt []byte
}