crypto

package

v0.9.3 Latest Latest Go to latest Published: Apr 22, 2024 License: MIT Imports: 29 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/pluralsh/plural-cli

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func BackupKey(client api.Client) error
func CreateKeyFingerprintFile() error
func Decrypt(prov Provider, text []byte) ([]byte, error)
func DownloadBackup(client api.Client, name string) error
func Encrypt(prov Provider, text []byte) ([]byte, error)
func Flush(prov Provider) error
func GetKeyID() (string, error)
func Hmac(data string, secret string) string
func Identity() (*age.X25519Identity, error)
func RandStr(length int) (string, error)
func RandString(length int) string
func RandStringWithCharset(length int, charset string) string
func Setup(key string) error
func SetupAge(client api.Client, emails []string) error
func SetupIdentity(client api.Client, name string) error
type AESKey
- func DeserializeKey(contents []byte) (k *AESKey, err error)
- func Import(buf []byte) (*AESKey, error)
- func Materialize() (*AESKey, error)
- func Read(path string) (*AESKey, error)
- func (k *AESKey) Flush() error
- func (k *AESKey) ID() string
- func (k *AESKey) Marshal() ([]byte, error)
type Age
- func (age *Age) Flush() error
- func (a *Age) Recipients() []age.Recipient
- func (age *Age) WriteKeyFile(path string, keydata []byte) error
type AgeIdentity
type AgeProvider
- func BuildAgeProvider() (prov *AgeProvider, err error)
- func (prov *AgeProvider) ID() string
- func (prov *AgeProvider) Marshall() ([]byte, error)
- func (prov *AgeProvider) SymmetricKey() ([]byte, error)
type Config
- func ReadConfig() (conf *Config, err error)
type Context
type IdentityType
type KeyConfig
type KeyProvider
- func (prov *KeyProvider) ID() string
- func (prov *KeyProvider) Marshall() ([]byte, error)
- func (prov *KeyProvider) SymmetricKey() ([]byte, error)
type KeyValidator
- func (k *KeyValidator) Flush() error
- func (k *KeyValidator) Marshal() ([]byte, error)
type Provider
- func Build() (prov Provider, err error)

Constants ¶

This section is empty.

Variables ¶

View Source

var EncryptionKeyFile string

Functions ¶

func BackupKey ¶

func BackupKey(client api.Client) error

func CreateKeyFingerprintFile ¶

func CreateKeyFingerprintFile() error

func Decrypt ¶

func Decrypt(prov Provider, text []byte) ([]byte, error)

func DownloadBackup ¶

func DownloadBackup(client api.Client, name string) error

func Encrypt ¶

func Encrypt(prov Provider, text []byte) ([]byte, error)

func Flush ¶

func Flush(prov Provider) error

func GetKeyID ¶

func GetKeyID() (string, error)

func Hmac ¶

func Hmac(data string, secret string) string

func Identity ¶

func Identity() (*age.X25519Identity, error)

func RandStr ¶

func RandStr(length int) (string, error)

func RandString ¶

func RandString(length int) string

func RandStringWithCharset ¶

func RandStringWithCharset(length int, charset string) string

func Setup ¶

func Setup(key string) error

func SetupAge ¶

func SetupAge(client api.Client, emails []string) error

func SetupIdentity ¶

func SetupIdentity(client api.Client, name string) error

Types ¶

type AESKey ¶

type AESKey struct {
	Key string
}

func DeserializeKey ¶

func DeserializeKey(contents []byte) (k *AESKey, err error)

func Import ¶

func Import(buf []byte) (*AESKey, error)

func Materialize ¶

func Materialize() (*AESKey, error)

func Read ¶

func Read(path string) (*AESKey, error)

func (*AESKey) Flush ¶

func (k *AESKey) Flush() error

func (*AESKey) ID ¶

func (k *AESKey) ID() string

func (*AESKey) Marshal ¶

func (k *AESKey) Marshal() ([]byte, error)

type Age ¶

type Age struct {
	RepoKey    string
	Identities []*AgeIdentity
}

func (*Age) Flush ¶

func (age *Age) Flush() error

func (*Age) Recipients ¶

func (a *Age) Recipients() []age.Recipient

func (*Age) WriteKeyFile ¶

func (age *Age) WriteKeyFile(path string, keydata []byte) error

type AgeIdentity ¶

type AgeIdentity struct {
	Key   string
	Email string
}

type AgeProvider ¶

type AgeProvider struct {
	Identity *age.X25519Identity
	Key      *AESKey
}

func BuildAgeProvider ¶

func BuildAgeProvider() (prov *AgeProvider, err error)

func (*AgeProvider) ID ¶

func (prov *AgeProvider) ID() string

func (*AgeProvider) Marshall ¶

func (prov *AgeProvider) Marshall() ([]byte, error)

func (*AgeProvider) SymmetricKey ¶

func (prov *AgeProvider) SymmetricKey() ([]byte, error)

type Config ¶

type Config struct {
	Version string
	Type    IdentityType
	Id      string
	Context *Context
}

func ReadConfig ¶

func ReadConfig() (conf *Config, err error)

type Context ¶

type Context struct {
	Key *KeyConfig `yaml:"key" json:"key"`
}

type IdentityType ¶

type IdentityType string

const (
	KEY IdentityType = "key"
	AGE IdentityType = "age"
)

type KeyConfig ¶

type KeyConfig struct {
	File string
}

type KeyProvider ¶

type KeyProvider struct {
	// contains filtered or unexported fields
}

func (*KeyProvider) ID ¶

func (prov *KeyProvider) ID() string

func (*KeyProvider) Marshall ¶

func (prov *KeyProvider) Marshall() ([]byte, error)

func (*KeyProvider) SymmetricKey ¶

func (prov *KeyProvider) SymmetricKey() ([]byte, error)

type KeyValidator ¶

type KeyValidator struct {
	KeyID string
}

func (*KeyValidator) Flush ¶

func (k *KeyValidator) Flush() error

func (*KeyValidator) Marshal ¶

func (k *KeyValidator) Marshal() ([]byte, error)

type Provider ¶

type Provider interface {
	ID() string
	SymmetricKey() ([]byte, error)
	Marshall() ([]byte, error)
}

func Build ¶

func Build() (prov Provider, err error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL