dbeaver/dbeaver#12430 Refactor tunnels secrets save/load

plugins/org.jkiss.dbeaver.model/src/org/jkiss/dbeaver/model/net/DBWHandlerConfiguration.java

@@ -38,6 +38,9 @@
 
  public static final String PROP_HOST = "host";
  public static final String PROP_PORT = "port";
+ public static final String PROP_USER = "user";
+ public static final String PROP_PASSWORD = "password";
+ public static final String PROP_PROPERTIES = "properties";
 
  @NotNull
  private String id;
@@ -225,44 +228,32 @@
  this.secureProperties.putAll(secureProperties);
  }
 
- public Map<String, Object> saveToMap() {
- return saveToMap(false);
- }
-
- public Map<String, Object> saveToSecret() {
- return saveToMap(true);
- }
-
- private Map<String, Object> saveToMap(boolean ignoreSecureProperties) {
+ public Map<String, Object> saveSecretsToMap() {
  Map<String, Object> handlerProps = new LinkedHashMap<>();
- if (!isSavePassword() && ignoreSecureProperties) {
- return handlerProps;
- }
  if (!CommonUtils.isEmpty(userName)) {
- handlerProps.put("user", userName);
+ handlerProps.put(PROP_USER, userName);
  }
  if (!CommonUtils.isEmpty(password)) {
- handlerProps.put("password", password);
+ handlerProps.put(PROP_PASSWORD, password);
  }
  if (!CommonUtils.isEmpty(secureProperties)) {
- handlerProps.put("properties", secureProperties);
+ handlerProps.put(PROP_PROPERTIES, secureProperties);
  }
  return handlerProps;
  }
 
- void loadFromMap(Map<String, Object> handlerMap) {
- userName = JSONUtils.getString(handlerMap, "user");
- password = JSONUtils.getString(handlerMap, "password");
+ void loadSecretsFromMap(Map<String, Object> handlerMap) {
+ userName = JSONUtils.getString(handlerMap, PROP_USER);
+ password = JSONUtils.getString(handlerMap, PROP_PASSWORD);
  secureProperties.clear();
- secureProperties.putAll(JSONUtils.deserializeStringMap(handlerMap, "properties"));
+ secureProperties.putAll(JSONUtils.deserializeStringMap(handlerMap, PROP_PROPERTIES));
  }
 
  @Override
  public boolean equals(Object obj) {
- if (!(obj instanceof DBWHandlerConfiguration)) {
+ if (!(obj instanceof DBWHandlerConfiguration source)) {
  return false;
  }
- DBWHandlerConfiguration source = (DBWHandlerConfiguration) obj;
  return
  CommonUtils.equalObjects(this.id, source.id) &&
  CommonUtils.equalObjects(this.dataSource, source.dataSource) &&

plugins/org.jkiss.dbeaver.model/src/org/jkiss/dbeaver/model/net/DBWNetworkProfile.java

@@ -121,7 +121,7 @@ public void persistSecrets(DBSSecretController secretController) throws DBExcept
 
  List<Map<String, Object>> handlersConfigs = new ArrayList<>();
  for (DBWHandlerConfiguration cfg : configurations) {
- Map<String, Object> hcProps = cfg.saveToMap();
+ Map<String, Object> hcProps = cfg.saveSecretsToMap();
  if (!hcProps.isEmpty()) {
  hcProps.put("id", cfg.getId());
  handlersConfigs.add(hcProps);
@@ -156,16 +156,15 @@ public void resolveSecrets(DBSSecretController secretController) throws DBExcept
  String configId = JSONUtils.getString(hc, "id");
  DBWHandlerConfiguration configuration = getConfiguration(configId);
  if (configuration != null) {
- configuration.loadFromMap(hc);
+ configuration.loadSecretsFromMap(hc);
  }
  }
  }
 
  private void loadFromLegacySecret(DBSSecretController secretController) throws DBException {
- if (!(secretController instanceof DBSSecretBrowser) || getProject() == null) {
+ if (!(secretController instanceof DBSSecretBrowser secretBrowser) || getProject() == null) {
  return;
  }
- DBSSecretBrowser secretBrowser = (DBSSecretBrowser) secretController;
  for (DBWHandlerConfiguration cfg : configurations) {
  String prefix = "projects/" + getProject().getId() + "/network/" + cfg.getId() + "/profile/" + getProfileId();
  Map<String, String> secureProps = new LinkedHashMap<>();

plugins/org.jkiss.dbeaver.model/src/org/jkiss/dbeaver/model/net/DBWTunnelController.java

@@ -0,0 +1,28 @@
+/*
+ * DBeaver - Universal Database Manager
+ * Copyright (C) 2010-2024 DBeaver Corp and others
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.jkiss.dbeaver.model.net;
+
+/**
+ * Network tunnel controller
+ */
+public interface DBWTunnelController {
+
+ Object acquireTunnelSession(String remoteHost);
+
+ void releaseTunnelSession(Object session);
+
+}

plugins/org.jkiss.dbeaver.net.ssh/src/org/jkiss/dbeaver/model/net/ssh/SSHTunnelHost.java

@@ -0,0 +1,46 @@
+/*
+ * DBeaver - Universal Database Manager
+ * Copyright (C) 2010-2024 DBeaver Corp and others
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.jkiss.dbeaver.model.net.ssh;
+
+import org.jkiss.code.NotNull;
+import org.jkiss.code.Nullable;
+import org.jkiss.dbeaver.model.exec.DBCException;
+import org.jkiss.dbeaver.model.net.ssh.config.SSHHostConfiguration;
+import org.jkiss.dbeaver.model.net.ssh.config.SSHPortForwardConfiguration;
+
+import java.util.List;
+
+/**
+ * SSH tunnel implementation
+ */
+public interface SSHTunnelHost {
+
+ @NotNull
+ SSHHostConfiguration getRemoteHost();
+
+ @NotNull
+ List<SSHTunnelPortForward> getPortForwards();
+
+ @NotNull
+ SSHTunnelPortForward acquirePortForward(SSHPortForwardConfiguration config) throws DBCException;
+
+ void releasePortForward(@NotNull SSHTunnelPortForward portForward);
+
+ @Nullable
+ SSHTunnelHost getNextJump();
+
+}

plugins/org.jkiss.dbeaver.net.ssh/src/org/jkiss/dbeaver/model/net/ssh/SSHTunnelPortForward.java

@@ -0,0 +1,30 @@
+/*
+ * DBeaver - Universal Database Manager
+ * Copyright (C) 2010-2024 DBeaver Corp and others
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.jkiss.dbeaver.model.net.ssh;
+
+import org.jkiss.dbeaver.model.net.ssh.config.SSHPortForwardConfiguration;
+
+/**
+ * SSH tunnel implementation
+ */
+public interface SSHTunnelPortForward {
+
+ SSHTunnelSession<?> getSession();
+
+ SSHPortForwardConfiguration getConfiguration();
+
+}

plugins/org.jkiss.dbeaver.net.ssh/src/org/jkiss/dbeaver/model/net/ssh/SSHTunnelSession.java

@@ -0,0 +1,28 @@
+/*
+ * DBeaver - Universal Database Manager
+ * Copyright (C) 2010-2024 DBeaver Corp and others
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.jkiss.dbeaver.model.net.ssh;
+
+/**
+ * SSH tunnel session
+ */
+public interface SSHTunnelSession<IMPL extends SSHImplementation> {
+
+ IMPL getImplementation();
+
+ SSHTunnelHost getFirstHost();
+
+}

plugins/org.jkiss.dbeaver.net.ssh/src/org/jkiss/dbeaver/model/net/ssh/registry/SSHSessionController.java

@@ -0,0 +1,50 @@
+/*
+ * DBeaver - Universal Database Manager
+ * Copyright (C) 2010-2024 DBeaver Corp and others
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.jkiss.dbeaver.model.net.ssh.registry;
+
+import org.jkiss.dbeaver.model.net.ssh.SSHTunnelSession;
+import org.jkiss.dbeaver.model.net.ssh.config.SSHHostConfiguration;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+public class SSHSessionController {
+ private static final SSHSessionController instance = new SSHSessionController();
+
+ public synchronized static SSHSessionController getInstance() {
+ return instance;
+ }
+
+ private final Map<String, List<SSHTunnelSession<?>>> hostTunnels = new HashMap<>();
+
+ private SSHSessionController() {
+ }
+
+ public SSHTunnelSession<?> acquireSession(List<SSHHostConfiguration> hosts) {
+ return null;
+ }
+
+ public void releaseSession(SSHTunnelSession<?> session) {
+
+ }
+
+ public void shutdown() {
+
+ }
+
+}

plugins/org.jkiss.dbeaver.registry/src/org/jkiss/dbeaver/registry/DataSourceDescriptor.java

@@ -2059,10 +2059,12 @@ private String saveToSecret() {
  // Handlers. If config profile is set then props are saved there
  List<Map<String, Object>> handlersConfigs = new ArrayList<>();
  for (DBWHandlerConfiguration hc : connectionInfo.getHandlers()) {
- Map<String, Object> handlerProps = hc.saveToSecret();
- if (!handlerProps.isEmpty()) {
- handlerProps.put(RegistryConstants.ATTR_ID, hc.getId());
- handlersConfigs.add(handlerProps);
+ if (hc.isSavePassword()) {
+ Map<String, Object> handlerProps = hc.saveSecretsToMap();
+ if (!handlerProps.isEmpty()) {
+ handlerProps.put(RegistryConstants.ATTR_ID, hc.getId());
+ handlersConfigs.add(handlerProps);
+ }
  }
  }
  if (!handlersConfigs.isEmpty()) {