cred

package
v0.34.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 12, 2026 License: Apache-2.0 Imports: 18 Imported by: 22

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DiscoverLocation added in v0.3.3 

func DiscoverLocation(ctx context.Context, name string) string

DiscoverLocation discover cred location

func TargetType added in v0.3.1 

func TargetType(target string) (reflect.Type, error)

TargetType returns target type for string

Types

type Aws 

type Aws struct {
	Id       string      `json:",omitempty"`
	PoolId   string      `json:",omitempty"`
	Endpoint string      `json:",omitempty"`
	Region   string      `json:",omitempty"`
	Token    string      `json:",omitempty"`
	Session  *AwsSession `json:",omitempty"`
	SecretKey
}

Aws represents AWS credentials

type AwsSession added in v0.3.2 

type AwsSession struct {
	RoleArn string `json:",omitempty"`
	Name    string `json:",omitempty"`
}

Aws represents AWS credentials

type Azure added in v0.26.0 

type Azure struct {
	Oauth2Config `yaml:",inline"`
	TenantID     string ` yaml:"tenantId"`
}

Azure represents Azure OAuth2 configuration ClientSecret is optional for public clients; when empty, Cipher/Decipher are no-ops.

func (*Azure) Cipher added in v0.26.0 

func (b *Azure) Cipher(ctx context.Context, key *kms.Key) error

Cipher encrypts ClientSecret when present and clears it.

func (*Azure) Decipher added in v0.26.0 

func (b *Azure) Decipher(ctx context.Context, key *kms.Key) error

Decipher decrypts EncryptedClientSecret when present.

type Basic 

type Basic struct {
	Endpoint          string `json:",omitempty"`
	Email             string `json:",omitempty"`
	Username          string `json:",omitempty"`
	Password          string `json:",omitempty"`
	EncryptedPassword string `json:",omitempty"`
}

Basic represents basic credentials

func (*Basic) Cipher 

func (b *Basic) Cipher(ctx context.Context, key *kms.Key) error

Cipher ciphers password to encrypted password, clears password after that

func (*Basic) Decipher 

func (b *Basic) Decipher(ctx context.Context, key *kms.Key) error

Decipher deciphers EncryptedPassword or returns error

type Certificate added in v0.34.0 

type Certificate struct {
	CertificatePath    string `json:",omitempty" yaml:",omitempty"`
	CertificatePEM     []byte `json:",omitempty" yaml:",omitempty"`
	PrivateKeyPath     string `json:",omitempty" yaml:",omitempty"`
	PrivateKeyPEM      []byte `json:",omitempty" yaml:",omitempty"`
	PrivateKeyPassword string `json:",omitempty" yaml:",omitempty"`

	EncryptedPrivateKey         string `json:",omitempty" yaml:",omitempty"`
	EncryptedPrivateKeyPassword string `json:",omitempty" yaml:",omitempty"`
}

Certificate represents an X.509 certificate bundle and its private key. Public certificate material is not encrypted; private key material and its password participate in Scy's kms.Securable lifecycle.

func (*Certificate) Cipher added in v0.34.0 

func (c *Certificate) Cipher(ctx context.Context, key *kms.Key) error

Cipher encrypts inlined private key material and its password.

func (*Certificate) Decipher added in v0.34.0 

func (c *Certificate) Decipher(ctx context.Context, key *kms.Key) error

Decipher restores encrypted private key material and its password.

func (*Certificate) Identity added in v0.34.0 

func (c *Certificate) Identity(ctx context.Context) (*signing.Identity, error)

Identity loads and parses the credential into a certificate-backed signer.

func (*Certificate) Load added in v0.34.0 

func (c *Certificate) Load(ctx context.Context) error

Load downloads certificate or key material configured by path/URL.

type Generic 

type Generic struct {
	SSH
	JwtConfig
	Aws
}

Generic represents generic credentials

func (*Generic) Cipher 

func (g *Generic) Cipher(ctx context.Context, key *kms.Key) error

func (*Generic) Decipher 

func (g *Generic) Decipher(ctx context.Context, key *kms.Key) error

func (*Generic) NewJWTConfig added in v0.8.0 

func (c *Generic) NewJWTConfig(scopes ...string) (*jwt.Config, error)

NewJWTConfig returns new JWT config for supplied scopes

func (*Generic) UnmarshalYAML added in v0.34.0 

func (g *Generic) UnmarshalYAML(value *yaml.Node) error

UnmarshalYAML preserves the flat credential representation used by Scy. yaml.v3 does not automatically flatten multiple anonymous structs, so each credential facet is decoded explicitly from the same mapping node.

type JwtConfig 

type JwtConfig struct {
	ClientEmail             string   `json:"client_email,omitempty"`
	TokenURL                string   `json:"token_url,omitempty"`
	PrivateKey              string   `json:"private_key,omitempty"`
	PrivateKeyID            string   `json:"private_key_id,omitempty"`
	ProjectID               string   `json:"project_id,omitempty"`
	TokenURI                string   `json:"token_uri,omitempty"`
	Type                    string   `json:"type,omitempty"`
	ClientX509CertURL       string   `json:"client_x509_cert_url,omitempty"`
	AuthProviderX509CertURL string   `json:"auth_provider_x509_cert_url,omitempty"`
	Scopes                  []string `json:",omitempty"`
}

JwtConfig represents jws config

type Oauth2Config added in v0.19.0 

type Oauth2Config struct {
	oauth2.Config         `yaml:",inline"`
	EncryptedClientSecret string `json:",omitempty" yaml:"EncryptedSecret"`
}

func (*Oauth2Config) Cipher added in v0.19.0 

func (b *Oauth2Config) Cipher(ctx context.Context, key *kms.Key) error

Cipher ciphers password to encrypted password, clears password after that

func (*Oauth2Config) Decipher added in v0.19.0 

func (b *Oauth2Config) Decipher(ctx context.Context, key *kms.Key) error

Decipher deciphers EncryptedSecret or returns error

type SHA1 

type SHA1 struct {
	Key                   string `json:",omitempty"`
	EncryptedKey          string `json:",omitempty"`
	IntegrityKey          string `json:",omitempty"`
	EncryptedIntegrityKey string `json:",omitempty"`
}

SHA1 represents sha1 key secrets

func (*SHA1) Cipher 

func (b *SHA1) Cipher(ctx context.Context, key *kms.Key) error

Cipher ciphers password to encrypted password, clears password after that

func (*SHA1) Decipher 

func (b *SHA1) Decipher(ctx context.Context, key *kms.Key) error

Decipher deciphers EncryptedSecret or returns error

type SSH 

type SSH struct {
	Basic
	PrivateKeyPath              string `json:",omitempty"`
	PrivateKeyPayload           []byte `json:",omitempty"`
	PrivateKeyPassword          string `json:",omitempty"`
	EncryptedPrivateKey         string `json:",omitempty"`
	EncryptedPrivateKeyPassword string `json:",omitempty"`
}

SSH represents SSH config

func (*SSH) Cipher 

func (b *SSH) Cipher(ctx context.Context, key *kms.Key) error

Cipher ciphers sensitive data or error

func (*SSH) Config added in v0.7.0 

func (s *SSH) Config(ctx context.Context) (*ssh.ClientConfig, error)

func (*SSH) Decipher 

func (b *SSH) Decipher(ctx context.Context, key *kms.Key) error

Decipher deciphers sensitive data or error

func (*SSH) LoadPrivateKey added in v0.7.0 

func (s *SSH) LoadPrivateKey(ctx context.Context) error

type SecretKey added in v0.9.3 

type SecretKey struct {
	Key             string `json:",omitempty" yaml:"Key"`
	Secret          string `json:",omitempty" yaml:"Secret"`
	EncryptedSecret string `json:",omitempty" yaml:"EncryptedSecret"`
}

SecretKey represents a key

func (*SecretKey) Cipher added in v0.9.3 

func (b *SecretKey) Cipher(ctx context.Context, key *kms.Key) error

Cipher ciphers password to encrypted password, clears password after that

func (*SecretKey) Decipher added in v0.9.3 

func (b *SecretKey) Decipher(ctx context.Context, key *kms.Key) error

Decipher deciphers EncryptedSecret or returns error

func (*SecretKey) SetEnv added in v0.9.3 

func (k *SecretKey) SetEnv() error

SetEnv sets env

Source Files

View all Source files

Directories

Path Synopsis
term

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.