secretlock

Documentation

Overview

Package secretlock provides the API for secret lock services, used to secure keys used by Aries KMS implementations.

Index

• type DecryptRequest
• type DecryptResponse
• type EncryptRequest
• type EncryptResponse
• type Service

Types

type DecryptRequest

type DecryptRequest struct {
	Ciphertext                  string
	AdditionalAuthenticatedData string
}

DecryptRequest for decrypting remote kms requests.

type DecryptResponse

type DecryptResponse struct {
	Plaintext string
}

DecryptResponse for receiving decryption response from remote kms requests.

type EncryptRequest

type EncryptRequest struct {
	Plaintext                   string
	AdditionalAuthenticatedData string
}

EncryptRequest for encrypting remote kms requests.

type EncryptResponse

type EncryptResponse struct {
	Ciphertext string
}

EncryptResponse for receiving encryption response from remote kms requests.

type Service

type Service interface {
	// Encrypt req for master key in keyURI
	Encrypt(keyURI string, req *EncryptRequest) (*EncryptResponse, error)
	// Decrypt req for master key in keyURI
	Decrypt(keyURI string, req *DecryptRequest) (*DecryptResponse, error)
}

Service provides crypto service used internally by the KMS it is responsible for wrapping/unwrapping keys stored by the KMS using a master key.