encryption

Documentation

Overview

Package encryption provides abstraction level for various disk encryption methods.

Index

• Constants
• Variables
• type Key
  • func NewKey(slot int, value []byte) *Key
• type Keyslot
• type Keyslots
• type Provider
• type TokenProvider

Constants

const (
	// LUKS2 encryption.
	LUKS2 = "luks2"
	// Unknown unecrypted or unsupported encryption.
	Unknown = "unknown"
)

const AnyKeyslot = -1

AnyKeyslot tells providers to pick any keyslot.

Variables

var (
	// ErrEncryptionKeyRejected triggered when encryption key does not match.
	ErrEncryptionKeyRejected = fmt.Errorf("encryption key rejected")

	// ErrDeviceBusy returned when mapped device is still in use.
	ErrDeviceBusy = fmt.Errorf("mapped device is still in use")

	// ErrTokenNotFound returned when trying to get/delete not existing token.
	ErrTokenNotFound = fmt.Errorf("no token with supplied id exists")

	// ErrDeviceNotReady returned when device is not ready.
	ErrDeviceNotReady = fmt.Errorf("device is not ready")
)

Types

type Key

type Key struct {
	Value []byte
	Slot  int
}

Key represents a single key.

func NewKey

func NewKey(slot int, value []byte) *Key

NewKey create a new key.

type Keyslot

type Keyslot struct {
	Type    string `json:"type"`
	KeySize int64  `json:"key_size"`
}

Keyslot represents a single LUKS2 keyslot.

type Keyslots

type Keyslots struct {
	Keyslots map[string]*Keyslot `json:"keyslots"`
}

Keyslots represents LUKS2 keyslots metadata.

type Provider

type Provider interface {
	TokenProvider
	Encrypt(ctx context.Context, devname string, key *Key) error
	IsOpen(ctx context.Context, devname, mappedName string) (bool, string, error)
	Open(ctx context.Context, devname, mappedName string, key *Key) (string, error)
	Close(ctx context.Context, devname string) error
	AddKey(ctx context.Context, devname string, key, newKey *Key) error
	SetKey(ctx context.Context, devname string, key, newKey *Key) error
	CheckKey(ctx context.Context, devname string, key *Key) (bool, error)
	RemoveKey(ctx context.Context, devname string, slot int, key *Key) error
	ReadKeyslots(deviceName string) (*Keyslots, error)
}

Provider represents encryption utility methods.

type TokenProvider

type TokenProvider interface {
	SetToken(ctx context.Context, devname string, slot int, token token.Token) error
	ReadToken(ctx context.Context, devname string, slot int, token token.Token) error
	RemoveToken(ctx context.Context, devname string, slot int) error
}

TokenProvider represents token management methods.