mirror of
https://github.com/edgelesssys/constellation.git
synced 2024-10-01 01:36:09 -04:00
bd63aa3c6b
sed -i '1i/*\nCopyright (c) Edgeless Systems GmbH\n\nSPDX-License-Identifier: AGPL-3.0-only\n*/\n' `grep -rL --include='*.go' 'DO NOT EDIT'` gofumpt -w .
45 lines
2.0 KiB
Go
45 lines
2.0 KiB
Go
/*
|
|
Copyright (c) Edgeless Systems GmbH
|
|
|
|
SPDX-License-Identifier: AGPL-3.0-only
|
|
*/
|
|
|
|
package mapper
|
|
|
|
import cryptsetup "github.com/martinjungblut/go-cryptsetup"
|
|
|
|
type cryptDevice interface {
|
|
// ActivateByPassphrase activates a device by using a passphrase from a specific keyslot.
|
|
// Returns nil on success, or an error otherwise.
|
|
// C equivalent: crypt_activate_by_passphrase
|
|
ActivateByPassphrase(deviceName string, keyslot int, passphrase string, flags int) error
|
|
// ActivateByVolumeKey activates a device by using a volume key.
|
|
// Returns nil on success, or an error otherwise.
|
|
ActivateByVolumeKey(deviceName string, volumeKey string, volumeKeySize int, flags int) error
|
|
// Deactivate deactivates a device.
|
|
// Returns nil on success, or an error otherwise.
|
|
// C equivalent: crypt_deactivate
|
|
Deactivate(deviceName string) error
|
|
// Format formats a Device, using a specific device type, and type-independent parameters.
|
|
// Returns nil on success, or an error otherwise.
|
|
// C equivalent: crypt_format
|
|
Format(deviceType cryptsetup.DeviceType, genericParams cryptsetup.GenericParams) error
|
|
// Free releases crypt device context and used memory.
|
|
// C equivalent: crypt_free
|
|
Free() bool
|
|
// GetUUID gets the device's UUID.
|
|
// C equivalent: crypt_get_uuid
|
|
GetUUID() string
|
|
// Load loads crypt device parameters from the on-disk header.
|
|
// Returns nil on success, or an error otherwise.
|
|
// C equivalent: crypt_load
|
|
Load(cryptsetup.DeviceType) error
|
|
// KeyslotAddByVolumeKey adds a key slot using a volume key to perform the required security check.
|
|
// Returns nil on success, or an error otherwise.
|
|
// C equivalent: crypt_keyslot_add_by_volume_key
|
|
KeyslotAddByVolumeKey(keyslot int, volumeKey string, passphrase string) error
|
|
// Wipe removes existing data and clears the device for use with dm-integrity.
|
|
// Returns nil on success, or an error otherwise.
|
|
Wipe(devicePath string, pattern int, offset, length uint64, wipeBlockSize int, flags int, progress func(size, offset uint64) int) error
|
|
}
|