Skip to content

fix: allow third-party backup provider plugins via configurable allowed list #13332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yigitbasalma wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −4
Open

fix: allow third-party backup provider plugins via configurable allowed list #13332

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions api/src/main/java/org/apache/cloudstack/backup/BackupManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

import java.util.List;
import java.util.Map;
import java.util.Arrays;

import com.cloud.capacity.Capacity;
import com.cloud.exception.ResourceAllocationException;
Expand Down Expand Up @@ -57,9 +58,16 @@ public interface BackupManager extends BackupService, Configurable, PluggableSer
ConfigKey<String> BackupProviderPlugin = new ValidatedConfigKey<>("Advanced", String.class,
"backup.framework.provider.plugin",
"dummy",
"The backup and recovery provider plugin. Valid plugin values: dummy, veeam, networker and nas",
"The backup and recovery provider plugin. Default built-in plugins: dummy, veeam, networker, nas. Additional plugins can be allowed via backup.framework.provider.plugin.allowed setting.",
true, ConfigKey.Scope.Zone, BackupFrameworkEnabled.key(), value -> validateBackupProviderConfig((String)value));

ConfigKey<String> AllowedBackupProviderPlugins = new ConfigKey<>(
"Advanced", String.class,
"backup.framework.provider.plugin.allowed",
"dummy,veeam,networker,nas",
"Comma-separated list of allowed backup provider plugins.",
true, ConfigKey.Scope.Zone);

ConfigKey<Long> BackupSyncPollingInterval = new ConfigKey<>("Advanced", Long.class,
"backup.framework.sync.interval",
"300",
Expand Down Expand Up @@ -254,9 +262,14 @@ static void validateBackupProviderConfig(String value) {
if (value != null && (value.contains(",") || value.trim().contains(" "))) {
throw new IllegalArgumentException("Multiple backup provider plugins are not supported. Please provide a single plugin value.");
}
List<String> validPlugins = List.of("dummy", "veeam", "networker", "nas");
if (value != null && !validPlugins.contains(value)) {
throw new IllegalArgumentException("Invalid backup provider plugin: " + value + ". Valid plugin values are: " + String.join(", ", validPlugins));
String allowed = AllowedBackupProviderPlugins.value();
if (allowed != null && value != null) {
List<String> validPlugins = Arrays.asList(allowed.split(","));
if (!validPlugins.contains(value.trim())) {
throw new IllegalArgumentException("Invalid backup provider plugin: " + value +
". Valid plugin values are: " + allowed +
". You can add more plugins via backup.framework.provider.plugin.allowed setting.");
}
}
}
}