keymanagement

package
v0.11.0 Latest Latest
Warning

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

Go to latest
Published: Oct 13, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrProviderAuthenticationFailed = errors.New("failed to authenticate with the keystore provider")
	ErrHYOKKeyNotFound              = errors.New("HYOK provider key not found")
	ErrGenericGetKeyError           = errors.New("failed to get key")
	ErrImportKeyMaterialFailed      = errors.New("invalid or incorrectly wrapped key material")
	ErrImportJobNotReady            = errors.New("import job is not yet ready")
)

Functions

This section is empty.

Types

type CreateKeyRequest

type CreateKeyRequest struct {
	// V1 Fields
	Config       common.KeystoreConfig
	KeyAlgorithm KeyAlgorithm
	ID           *string
	Region       string
	KeyType      KeyType
}

CreateKeyRequest contains parameters for key creation

type CreateKeyResponse

type CreateKeyResponse struct {
	// V1 Fields
	KeyID  string
	Status string
}

type DeleteKeyRequest

type DeleteKeyRequest struct {
	// V1 Fields
	Parameters RequestParameters
	Window     *int32
}

DeleteKeyRequest contains parameters for key deletion

type DeleteKeyResponse

type DeleteKeyResponse struct{}

type DisableKeyRequest

type DisableKeyRequest struct {
	// V1 Fields
	Parameters RequestParameters
}

DisableKeyRequest contains parameters for key disablement

type DisableKeyResponse

type DisableKeyResponse struct{}

type EnableKeyRequest

type EnableKeyRequest struct {
	// V1 Fields
	Parameters RequestParameters
}

EnableKeyRequest contains parameters for key enablement

type EnableKeyResponse

type EnableKeyResponse struct{}

type ExtractKeyRegionRequest

type ExtractKeyRegionRequest struct {
	// V1 Fields
	NativeKeyID          string
	ManagementAccessData map[string]any
}

type ExtractKeyRegionResponse

type ExtractKeyRegionResponse struct {
	// V1 Fields
	Region string
}

type GetImportParametersRequest

type GetImportParametersRequest struct {
	// V1 Fields
	Parameters   RequestParameters
	KeyAlgorithm KeyAlgorithm
}

type GetImportParametersResponse

type GetImportParametersResponse struct {
	// V1 Fields
	KeyID            string
	ImportParameters map[string]any
}

type GetKeyRequest

type GetKeyRequest struct {
	// V1 Fields
	Parameters RequestParameters
}

type GetKeyResponse

type GetKeyResponse struct {
	// V1 Fields
	KeyID              string
	KeyAlgorithm       KeyAlgorithm
	Status             string
	Usage              string
	LatestKeyVersionId string
	RotationTime       *time.Time // Timestamp of last rotation
}

type GetKeyVersionsRequest added in v0.10.0

type GetKeyVersionsRequest struct {
	// V1 Fields
	Parameters RequestParameters
}

type GetKeyVersionsResponse added in v0.10.0

type GetKeyVersionsResponse struct {
	// V1 Fields
	Versions []KeyVersion
}

type ImportKeyMaterialRequest

type ImportKeyMaterialRequest struct {
	// V1 Fields
	Parameters           RequestParameters
	ImportParameters     map[string]any
	EncryptedKeyMaterial string
}

type ImportKeyMaterialResponse

type ImportKeyMaterialResponse struct{}

type KeyAlgorithm

type KeyAlgorithm int32
const (
	UnspecifiedKeyAlgorithm KeyAlgorithm = iota
	AES256
)

type KeyType

type KeyType int32
const (
	UnspecifiedKeyType KeyType = iota
	SystemManaged
	BYOK
	HYOK
)

type KeyVersion added in v0.10.0

type KeyVersion struct {
	// V1 Fields
	ID           string
	CreationTime *time.Time
	Status       string
}

type ProviderAuthError added in v0.10.0

type ProviderAuthError struct {
	Reason string
}

ProviderAuthError wraps ErrProviderAuthenticationFailed and carries the provider-specific reason string (e.g. "DENIED_BY_POLICY") from the gRPC ErrorInfo detail.

func (*ProviderAuthError) Error added in v0.10.0

func (e *ProviderAuthError) Error() string

func (*ProviderAuthError) Is added in v0.10.0

func (e *ProviderAuthError) Is(target error) bool

func (*ProviderAuthError) Unwrap added in v0.10.0

func (e *ProviderAuthError) Unwrap() error

type RequestParameters

type RequestParameters struct {
	// V1 Fields
	Config common.KeystoreConfig
	KeyID  string
}

type TransformCryptoAccessDataRequest

type TransformCryptoAccessDataRequest struct {
	// V1 Fields
	NativeKeyID string
	AccessData  []byte
}

type TransformCryptoAccessDataResponse

type TransformCryptoAccessDataResponse struct {
	// V1 Fields
	TransformedAccessData map[string][]byte
}

type ValidateKeyAccessDataRequest

type ValidateKeyAccessDataRequest struct {
	// V1 Fields
	Management map[string]any
	Crypto     map[string]cmkapi.KeyAccessDetailsRegion
}

type ValidateKeyAccessDataResponse

type ValidateKeyAccessDataResponse struct {
	// V1 Fields
	IsValid bool
	Message string
}

type ValidateKeyRequest

type ValidateKeyRequest struct {
	// V1 Fields
	KeyType      KeyType
	KeyAlgorithm KeyAlgorithm
	Region       string
	NativeKeyID  string
}

type ValidateKeyResponse

type ValidateKeyResponse struct {
	// V1 Fields
	IsValid bool
	Message string
}

Jump to

Keyboard shortcuts

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