Skip to content

server: add global setting consoleproxy.sslEnabled #8809

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

Merged
yadvr merged 1 commit into from
Jun 21, 2024
Merged

server: add global setting consoleproxy.sslEnabled #8809

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion server/src/main/java/com/cloud/consoleproxy/AgentBasedConsoleProxyManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ public boolean configure(String name, Map<String, Object> params) throws Configu
_consoleProxyPort = NumbersUtil.parseInt(value, ConsoleProxyManager.DEFAULT_PROXY_VNC_PORT);
}

value = configs.get("consoleproxy.sslEnabled");
value = configs.get(ConsoleProxySslEnabled.key());
if (value != null && value.equalsIgnoreCase("true")) {
_sslEnabled = true;
}
Expand Down
2 changes: 1 addition & 1 deletion server/src/main/java/com/cloud/consoleproxy/AgentHookBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ public void startAgentHttpHandlerInVM(StartupProxyCommand startupCmd) {
byte[] ksBits = null;

String consoleProxyUrlDomain = _configDao.getValue(Config.ConsoleProxyUrlDomain.key());
String consoleProxySslEnabled = _configDao.getValue("consoleproxy.sslEnabled");
String consoleProxySslEnabled = _configDao.getValue(ConsoleProxyManager.ConsoleProxySslEnabled.key());

@GutoVeronezi GutoVeronezi Mar 20, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
String consoleProxySslEnabled = _configDao.getValue(ConsoleProxyManager.ConsoleProxySslEnabled.key());
String consoleProxySslEnabled = ConsoleProxyManager.ConsoleProxySslEnabled.value();

@weizhouapache weizhouapache Mar 20, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GutoVeronezi
this may not work as the _configDao is set in the constructor of the class.

    protected AgentHookBase(VMInstanceDao instanceDao, HostDao hostDao, ConfigurationDao cfgDao, KeystoreManager ksMgr,
                         AgentManager agentMgr, KeysManager keysMgr, ConsoleAccessManager consoleAccessMgr) {
        _instanceDao = instanceDao;
        _hostDao = hostDao;
        _agentMgr = agentMgr;
        _configDao = cfgDao;
        _ksMgr = ksMgr;
        _keysMgr = keysMgr;
        consoleAccessManager = consoleAccessMgr;
    }

@GutoVeronezi GutoVeronezi Mar 20, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the class will have access to the DB, it should work, as the value() will query for the value (if the configDepot is configured).

@weizhouapache weizhouapache Mar 21, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did some debugging, it looks the values are the same.

2024-03-21T08:05:48,498 DEBUG [c.c.c.ConsoleProxyManagerImpl] (main:[]) (logid:) configs.get(ConsoleProxySslEnabled.key() = true
2024-03-21T08:05:48,502 DEBUG [c.c.c.ConsoleProxyManagerImpl] (main:[]) (logid:) ConsoleProxySslEnabled.value() = true

2024-03-21T08:06:02,499 DEBUG [c.c.c.C.VmBasedAgentHook] (AgentConnectTaskPool-4:[ctx-f64d74cc]) (logid:29169184) _configDao.getValue(ConsoleProxyManager.ConsoleProxySslEnabled.key()) = true
2024-03-21T08:06:02,499 DEBUG [c.c.c.C.VmBasedAgentHook] (AgentConnectTaskPool-4:[ctx-f64d74cc]) (logid:29169184) ConsoleProxySslEnabled.value() = true

however, I prefer not to change the code as the old/new codes basically get the same value from database.
The old code has been proved to be working. Some other values are fetched in the same way.
@GutoVeronezi

@yadvr yadvr Mar 21, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as line-215

if (!StringUtils.isEmpty(consoleProxyUrlDomain) && !StringUtils.isEmpty(consoleProxySslEnabled)
&& consoleProxySslEnabled.equalsIgnoreCase("true")) {
ksBits = _ksMgr.getKeystoreBits(ConsoleProxyManager.CERTIFICATE_NAME, ConsoleProxyManager.CERTIFICATE_NAME, storePassword);
Expand Down
3 changes: 3 additions & 0 deletions server/src/main/java/com/cloud/consoleproxy/ConsoleProxyManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ public interface ConsoleProxyManager extends Manager, ConsoleProxyService {
String ALERT_SUBJECT = "proxy-alert";
String CERTIFICATE_NAME = "CPVMCertificate";

ConfigKey<Boolean> ConsoleProxySslEnabled = new ConfigKey<>(ConfigKey.CATEGORY_ADVANCED, Boolean.class, "consoleproxy.sslEnabled", "false",
Comment thread
weizhouapache marked this conversation as resolved.
"Enable SSL for console proxy", false);

ConfigKey<Boolean> NoVncConsoleDefault = new ConfigKey<>(ConfigKey.CATEGORY_ADVANCED, Boolean.class, "novnc.console.default", "true",
"If true, noVNC console will be default console for virtual machines", true);

Expand Down
4 changes: 2 additions & 2 deletions server/src/main/java/com/cloud/consoleproxy/ConsoleProxyManagerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1120,7 +1120,7 @@ public boolean configure(String name, Map<String, Object> params) throws Configu

Map<String, String> configs = configurationDao.getConfiguration("management-server", params);

String value = configs.get("consoleproxy.sslEnabled");
String value = configs.get(ConsoleProxySslEnabled.key());
if (value != null && value.equalsIgnoreCase("true")) {
sslEnabled = true;
}
Expand Down Expand Up @@ -1609,7 +1609,7 @@ public String getConfigComponentName() {

@Override
public ConfigKey<?>[] getConfigKeys() {
return new ConfigKey<?>[] { NoVncConsoleDefault, NoVncConsoleSourceIpCheckEnabled };
return new ConfigKey<?>[] { ConsoleProxySslEnabled, NoVncConsoleDefault, NoVncConsoleSourceIpCheckEnabled };
}

protected ConsoleProxyStatus parseJsonToConsoleProxyStatus(String json) throws JsonParseException {
Expand Down
2 changes: 1 addition & 1 deletion server/src/main/java/com/cloud/consoleproxy/StaticConsoleProxyManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ public boolean configure(String name, Map<String, Object> params) throws Configu
_ip = "127.0.0.1";
}

String value = (String)params.get("consoleproxy.sslEnabled");
String value = (String)params.get(ConsoleProxySslEnabled.key());
if (value != null && value.equalsIgnoreCase("true")) {
_sslEnabled = true;
}
Expand Down