package
0.0.0-20231128064227-1e47281359cc
Repository: https://github.com/provideplatform/provide-go.git
Documentation: pkg.go.dev

# Functions

AggregateSignatures aggregates BLS signatures into a single BLS signature.
CreateKey creates a new vault key.
CreateSecret stores a new secret in the vault.
CreateVault on behalf of the given API token.
Decrypt decrypts provided encrypted data with a key from the vault.
DeleteKey deletes a key.
DeleteSecret deletes a secret from the vault.
DeriveKey derives a key.
Encrypt encrypts provided data with a key from the vault and a randomly generated nonce.
EncryptDetached uses the given public key to encrypt arbitrary data.
EncryptWithNonce encrypts provided data with a key from the vault and provided nonce.
FetchKey fetches a key from the given vault.
FetchSecret fetches a secret from the given vault.
GenerateSeal returns a valid unsealing key used to encrypt vault master keys.
InitVaultService convenience method to initialize an `vault.Service` instance.
ListKeys retrieves a paginated list of vault keys.
ListSecrets retrieves a paginated list of secrets in the vault.
ListVaults retrieves a paginated list of vaults scoped to the given API token.
Seal seals the vault to disable decryption of vault, key and secret material.
SignMessage signs a message with the given key.
Unseal unseals the vault to enable decryption of vault, key and secret material.
VerifyAggregateSignatures verifies a bls signature.
VerifyDetachedSignature verifies a signature generated by a key external to vault.
VerifySignature verifies a signature.

# Constants

KeyBits2048 is the bit length for 2048-bit keys.
KeyBits3072 is the bit length for 3072-bit keys.
KeyBits4096 is the bit length for 4096-bit keys.
KeySpecAES256GCM AES-256-GCM key spec.
KeySpecChaCha20 ChaCha20 key spec.
KeySpecECCBabyJubJub babyJubJub key spec.
KeySpecECCBIP39 BIP39 key spec.
KeySpecECCC25519 C25519 key spec.
KeySpecECCEd25519 Ed25519 key spec.
KeySpecECCSecp256k1 secp256k1 key spec.
KeySpecRSA2048 rsa 2048 key spec.
KeySpecRSA3072 rsa 3072 key spec.
KeySpecRSA4096 rsa 4096 key spec.
KeyTypeAsymmetric asymmetric key type.
KeyTypeSymmetric symmetric key type.
KeyUsageEncryptDecrypt encrypt/decrypt usage.
KeyUsageSignVerify sign/verify usage.
MaxHDIteration is the maximum HD account index.
NonceSizeSymmetric chacha20 & aes256 encrypt/decrypt nonce size.

# Structs

BLSAggregateRequestResponse provides the BLS sig information to aggregate n BLS signatures into one BLS signature.
DetachedEncryptDecryptRequestResponse contains the data to be encrypted/decrypted.
EncryptDecryptRequestResponse contains the data (i.e., encrypted or decrypted) and an optional nonce.
Key represents a symmetric or asymmetric signing key.
SealUnsealRequestResponse provides the unseal information.
Secret represents a string, encrypted by the vault master key.
Service for the vault api.
SignRequest contains a message to be signed.
SignResponse contains the signature for the message.
Vault provides secure key management.
VerifyRequest contains the message and signature for verification.
VerifyResponse contains a flag indicating if the signature was verified.