Skip to content

Root CA: support multiple management network CIDRs with comma separated #13206

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

Draft
weizhouapache wants to merge 2 commits into
base: 4.22
Choose a base branch
from
+88 −3
Draft

Root CA: support multiple management network CIDRs with comma separated #13206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b53714
Root CA: support multiple management network CIDRs with comma separated
weizhouapache May 21, 2026
f52077e
Apply suggestion from @weizhouapache
weizhouapache May 21, 2026
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
12 changes: 9 additions & 3 deletions plugins/ca/root-ca/src/main/java/org/apache/cloudstack/ca/provider/RootCAProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,15 +401,21 @@ private boolean loadManagementKeyStore() {

protected void addConfiguredManagementIp(List<String> ipList) {
String msNetworkCidr = configDao.getValue(Config.ManagementNetwork.key());
if (StringUtils.isEmpty(msNetworkCidr)) {
return;
}
try {
logger.debug(String.format("Trying to find management IP in CIDR range [%s].", msNetworkCidr));
Enumeration<NetworkInterface> networkInterfaces = NetworkInterface.getNetworkInterfaces();

networkInterfaces.asIterator().forEachRemaining(networkInterface -> {
networkInterface.getInetAddresses().asIterator().forEachRemaining(inetAddress -> {
if (NetUtils.isIpWithInCidrRange(inetAddress.getHostAddress(), msNetworkCidr)) {
ipList.add(inetAddress.getHostAddress());
logger.debug(String.format("Added IP [%s] to the list of IPs in the management server's certificate.", inetAddress.getHostAddress()));
String[] msNetworkCidrs = msNetworkCidr.split(",");
for (String cidr : msNetworkCidrs) {
if (NetUtils.isIpWithInCidrRange(inetAddress.getHostAddress(), cidr.trim())) {
ipList.add(inetAddress.getHostAddress());
logger.debug(String.format("Added IP [%s] to the list of IPs in the management server's certificate.", inetAddress.getHostAddress()));
}
}
});
});
Expand Down
79 changes: 79 additions & 0 deletions plugins/ca/root-ca/src/test/java/org/apache/cloudstack/ca/provider/RootCAProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
package org.apache.cloudstack.ca.provider;

import java.lang.reflect.Field;
import java.net.NetworkInterface;
import java.net.SocketException;
import java.security.InvalidKeyException;
import java.security.KeyPair;
import java.security.NoSuchAlgorithmException;
Expand All @@ -38,6 +40,7 @@

import org.apache.cloudstack.framework.ca.Certificate;
import org.apache.cloudstack.framework.config.ConfigKey;
import org.apache.cloudstack.framework.config.dao.ConfigurationDao;
import org.apache.cloudstack.utils.security.CertUtils;
import org.apache.cloudstack.utils.security.SSLUtils;
import org.bouncycastle.asn1.x509.GeneralName;
Expand All @@ -47,10 +50,14 @@
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.MockedStatic;
import org.mockito.Mockito;
import org.mockito.junit.MockitoJUnitRunner;
import org.springframework.test.util.ReflectionTestUtils;

import com.cloud.configuration.Config;
import com.cloud.utils.exception.CloudRuntimeException;


@RunWith(MockitoJUnitRunner.class)
public class RootCAProviderTest {
Expand Down Expand Up @@ -208,4 +215,76 @@ public void testIsManagementCertificateMatch() {
Assert.fail(String.format("Exception occurred: %s", e.getMessage()));
}
}

// ---------------------------------------------------------------
// Tests for addConfiguredManagementIp
// ---------------------------------------------------------------

private ConfigurationDao mockConfigDao(String cidr) throws Exception {
ConfigurationDao mockDao = Mockito.mock(ConfigurationDao.class);
Mockito.when(mockDao.getValue(Config.ManagementNetwork.key())).thenReturn(cidr);
addField(provider, "configDao", mockDao);
return mockDao;
}

@Test
public void testAddConfiguredManagementIpWithMatchingCidr() throws Exception {
// 127.0.0.0/8 covers the loopback address (127.0.0.1) that is always
// present on a Linux host, so the method must add it to the list.
mockConfigDao("127.0.0.0/8");

List<String> ipList = new ArrayList<>();
provider.addConfiguredManagementIp(ipList);

Assert.assertTrue("127.0.0.1 should be included for CIDR 127.0.0.0/8",
ipList.contains("127.0.0.1"));
}

@Test
public void testAddConfiguredManagementIpWithNonMatchingCidr() throws Exception {
// 192.0.2.0/24 is TEST-NET-1 (RFC 5737) and is never assigned to a real
// interface, so nothing should be added to the list.
mockConfigDao("192.0.2.0/24");

List<String> ipList = new ArrayList<>();
provider.addConfiguredManagementIp(ipList);

Assert.assertTrue("No IP should be added when no interface matches the CIDR",
ipList.isEmpty());
}

@Test
public void testAddConfiguredManagementIpWithMultipleCidrs() throws Exception {
// First CIDR is a non-matching TEST-NET; second covers loopback.
// The method splits on "," and checks each CIDR individually, so
// 127.0.0.1 must still be found via the second CIDR.
mockConfigDao("192.0.2.0/24,127.0.0.0/8");

List<String> ipList = new ArrayList<>();
provider.addConfiguredManagementIp(ipList);

Assert.assertTrue("127.0.0.1 should be included when the second comma-separated CIDR matches",
ipList.contains("127.0.0.1"));
}

@Test
public void testAddConfiguredManagementIpSocketException() throws Exception {
mockConfigDao("127.0.0.0/8");

try (MockedStatic<NetworkInterface> networkInterfaceMock =
Mockito.mockStatic(NetworkInterface.class)) {
networkInterfaceMock.when(NetworkInterface::getNetworkInterfaces)
.thenThrow(new SocketException("simulated network error"));

try {
provider.addConfiguredManagementIp(new ArrayList<>());
Assert.fail("Expected CloudRuntimeException to be thrown on SocketException");
} catch (CloudRuntimeException e) {
Assert.assertTrue("Exception message should describe the failure",
e.getMessage().contains("Exception while trying to gather the management server's network interfaces."));
Assert.assertTrue("Cause should be the original SocketException",
e.getCause() instanceof SocketException);
}
}
}
}
Loading