azure

Documentation

Index

• Variables
• type KeyVault
  • func New(vaultURL, key, keyVersion string) (*KeyVault, error)
  • func (k *KeyVault) Decrypt(ciphertext []byte) ([]byte, error)
  • func (k *KeyVault) Encrypt(plaintext []byte) ([]byte, error)
• type MetadataHeader

Variables

var (

	// ErrVaultURLMissing - this is the custom error, returned when vault url is missing
	ErrVaultURLMissing = errors.New("key vault URL is empty or missing")
	// ErrKeyMissing = this is the custom error, returned when the KeyVault key is missing
	ErrKeyMissing = errors.New("key vault key is empty or missing")
	// ErrKeyVersionMissing = this is the custom error, returned when the KeyVault key version is missing
	ErrKeyVersionMissing = errors.New("key vault key version is empty or missing")
)

Types

type KeyVault

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

KeyVault struct represents Azure Key Vault

func New

func New(vaultURL, key, keyVersion string) (*KeyVault, error)

New creates Azure Key Vault KeyVault

func (*KeyVault) Decrypt

func (k *KeyVault) Decrypt(ciphertext []byte) ([]byte, error)

Decrypt is responsible for decrypting ciphertext by Azure Key Vault encryption key and returning plaintext in bytes. See Crypt.EncryptFile

func (*KeyVault) Encrypt

func (k *KeyVault) Encrypt(plaintext []byte) ([]byte, error)

Encrypt encrypts plaintext using Azure Key Vault and returns ciphertext See Crypt.Encrypt

type MetadataHeader

type MetadataHeader struct {
	Provider                string `json:"provider"`
	CryptVersion            string `json:"crypt"`
	AzureKeyVaultURL        string `json:"kvURL"`
	AzureKeyVaultKeyName    string `json:"kvKey"`
	AzureKeyVaultKeyVersion string `json:"kvKeyVer"`
}

MetadataHeader holds information about KeyVault key used to encrypt