-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: support v2 backing image cloning and encryption
ref: longhorn/longhorn 9996 Signed-off-by: Jack Lin <[email protected]>
- Loading branch information
Showing
9 changed files
with
921 additions
and
562 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,183 @@ | ||
| package backingimagecrypto | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "path" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/pkg/errors" | ||
| "github.com/sirupsen/logrus" | ||
|
|
||
| lhns "github.com/longhorn/go-common-libs/ns" | ||
| lhtypes "github.com/longhorn/go-common-libs/types" | ||
| ) | ||
|
|
||
| const ( | ||
| MapperFilePathPrefix = "/dev/mapper" | ||
|
|
||
| CryptoKeyDefaultCipher = "aes-xts-plain64" | ||
| CryptoKeyDefaultHash = "sha256" | ||
| CryptoKeyDefaultSize = "256" | ||
| CryptoDefaultPBKDF = "argon2i" | ||
|
|
||
| CommandExecutionTimeout = 10 * time.Second | ||
|
|
||
| EncryptionMetaSize = 16 * 1024 * 1024 // 16MB | ||
| ) | ||
|
|
||
| // EncryptParams keeps the customized cipher options from the secret CR | ||
| type EncryptParams struct { | ||
| KeyProvider string | ||
| KeyCipher string | ||
| KeyHash string | ||
| KeySize string | ||
| PBKDF string | ||
| } | ||
|
|
||
| func NewEncryptParams(keyProvider, keyCipher, keyHash, keySize, pbkdf string) *EncryptParams { | ||
| return &EncryptParams{KeyProvider: keyProvider, KeyCipher: keyCipher, KeyHash: keyHash, KeySize: keySize, PBKDF: pbkdf} | ||
| } | ||
|
|
||
| func (cp *EncryptParams) GetKeyCipher() string { | ||
| if cp.KeyCipher == "" { | ||
| return CryptoKeyDefaultCipher | ||
| } | ||
| return cp.KeyCipher | ||
| } | ||
|
|
||
| func (cp *EncryptParams) GetKeyHash() string { | ||
| if cp.KeyHash == "" { | ||
| return CryptoKeyDefaultHash | ||
| } | ||
| return cp.KeyHash | ||
| } | ||
|
|
||
| func (cp *EncryptParams) GetKeySize() string { | ||
| if cp.KeySize == "" { | ||
| return CryptoKeyDefaultSize | ||
| } | ||
| return cp.KeySize | ||
| } | ||
|
|
||
| func (cp *EncryptParams) GetPBKDF() string { | ||
| if cp.PBKDF == "" { | ||
| return CryptoDefaultPBKDF | ||
| } | ||
| return cp.PBKDF | ||
| } | ||
|
|
||
| // EncryptBackingImage encrypts provided device with LUKS. | ||
| func EncryptBackingImage(devicePath, passphrase string, cryptoParams *EncryptParams) error { | ||
| namespaces := []lhtypes.Namespace{lhtypes.NamespaceMnt, lhtypes.NamespaceIpc} | ||
| nsexec, err := lhns.NewNamespaceExecutor(lhtypes.ProcessNone, lhtypes.HostProcDirectory, namespaces) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| logrus.Infof("Encrypting device %s with LUKS", devicePath) | ||
| if _, err := nsexec.LuksFormat( | ||
| devicePath, passphrase, | ||
| cryptoParams.GetKeyCipher(), | ||
| cryptoParams.GetKeyHash(), | ||
| cryptoParams.GetKeySize(), | ||
| cryptoParams.GetPBKDF(), | ||
| lhtypes.LuksTimeout); err != nil { | ||
| return errors.Wrapf(err, "failed to encrypt device %s with LUKS", devicePath) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // OpenBackingImage opens backing image so that it can be used by the client. | ||
| func OpenBackingImage(devicePath, passphrase, name string) error { | ||
| if isOpen, _ := IsEncryptedDeviceOpened(BackingImageMapper(name)); isOpen { | ||
| logrus.Infof("Device %s is already opened at %s", devicePath, BackingImageMapper(name)) | ||
| return nil | ||
| } | ||
|
|
||
| namespaces := []lhtypes.Namespace{lhtypes.NamespaceMnt, lhtypes.NamespaceIpc} | ||
| nsexec, err := lhns.NewNamespaceExecutor(lhtypes.ProcessNone, lhtypes.HostProcDirectory, namespaces) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| logrus.Infof("Opening device %s with LUKS", devicePath) | ||
| _, err = nsexec.LuksOpen(GetLuksBackingImageName(name), devicePath, passphrase, lhtypes.LuksTimeout) | ||
| if err != nil { | ||
| logrus.WithError(err).Warnf("Failed to open LUKS device %s", devicePath) | ||
| } | ||
| return err | ||
| } | ||
|
|
||
| // CloseBackingImage closes encrypted backing image so it can be detached. | ||
| func CloseBackingImage(name string) error { | ||
| namespaces := []lhtypes.Namespace{lhtypes.NamespaceMnt, lhtypes.NamespaceIpc} | ||
| nsexec, err := lhns.NewNamespaceExecutor(lhtypes.ProcessNone, lhtypes.HostProcDirectory, namespaces) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| logrus.Infof("Closing LUKS device %s", GetLuksBackingImageName(name)) | ||
| _, err = nsexec.LuksClose(GetLuksBackingImageName(name), lhtypes.LuksTimeout) | ||
| return err | ||
| } | ||
|
|
||
| // IsEncryptedDeviceOpened determines if encrypted device is already open. | ||
| func IsEncryptedDeviceOpened(device string) (bool, error) { | ||
| _, mappedFile, err := DeviceEncryptionStatus(device) | ||
| return mappedFile != "", err | ||
| } | ||
|
|
||
| // DeviceEncryptionStatus looks to identify if the passed device is a LUKS mapping | ||
| // and if so what the device is and the mapper name as used by LUKS. | ||
| // If not, just returns the original device and an empty string. | ||
| func DeviceEncryptionStatus(devicePath string) (mappedDevice, mapper string, err error) { | ||
| if !strings.HasPrefix(devicePath, MapperFilePathPrefix) { | ||
| return devicePath, "", nil | ||
| } | ||
|
|
||
| namespaces := []lhtypes.Namespace{lhtypes.NamespaceMnt, lhtypes.NamespaceIpc} | ||
| nsexec, err := lhns.NewNamespaceExecutor(lhtypes.ProcessNone, lhtypes.HostProcDirectory, namespaces) | ||
| if err != nil { | ||
| return devicePath, "", err | ||
| } | ||
|
|
||
| backingImage := strings.TrimPrefix(devicePath, MapperFilePathPrefix+"/") | ||
| stdout, err := nsexec.LuksStatus(backingImage, lhtypes.LuksTimeout) | ||
| if err != nil { | ||
| logrus.WithError(err).Warnf("Device %s is not an active LUKS device", devicePath) | ||
| return devicePath, "", nil | ||
| } | ||
|
|
||
| lines := strings.Split(string(stdout), "\n") | ||
| if len(lines) < 1 { | ||
| return "", "", fmt.Errorf("device encryption status returned no stdout for %s", devicePath) | ||
| } | ||
|
|
||
| if !strings.Contains(lines[0], " is active") { | ||
| // Implies this is not a LUKS device | ||
| return devicePath, "", nil | ||
| } | ||
|
|
||
| for i := 1; i < len(lines); i++ { | ||
| kv := strings.SplitN(strings.TrimSpace(lines[i]), ":", 2) | ||
| if len(kv) < 1 { | ||
| return "", "", fmt.Errorf("device encryption status output for %s is badly formatted: %s", | ||
| devicePath, lines[i]) | ||
| } | ||
| if strings.Compare(kv[0], "device") == 0 { | ||
| return strings.TrimSpace(kv[1]), backingImage, nil | ||
| } | ||
| } | ||
| // Identified as LUKS, but failed to identify a mapped device | ||
| return "", "", fmt.Errorf("mapped device not found in path %s", devicePath) | ||
| } | ||
|
|
||
| func BackingImageMapper(uuid string) string { | ||
| return path.Join(MapperFilePathPrefix, GetLuksBackingImageName(uuid)) | ||
| } | ||
|
|
||
| // TODO: Fix hard coded | ||
| func GetLuksBackingImageName(name string) string { | ||
| return fmt.Sprintf("%v-%v", "v2backing", name) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.