Skip to content

server: control honouring internal IDs by old APIs #11976

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

server: control honouring internal IDs by old APIs #11976

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
16 changes: 15 additions & 1 deletion server/src/main/java/com/cloud/api/ApiServer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,6 +348,19 @@ public class ApiServer extends ManagerBase implements HttpRequestHandler, ApiSer
, ConfigKey.Scope.Global, null, null, null, null, null, ConfigKey.Kind.Select,
EnumSet.allOf(ApiSessionKeyCheckOption.class).stream().map(Enum::toString).collect(Collectors.joining(", ")));

public static final ConfigKey<Boolean> ApiDisallowInternalIds = new ConfigKey<>(
ConfigKey.CATEGORY_ADVANCED,
Boolean.class,
"api.disallow.internal.ids",
"false",
"When enabled, APIs will not honour requests containing internal database IDs. "
+ "Only UUIDs will be accepted as entity identifiers. "
+ "By default, internal IDs are still accepted for backward compatibility with pre-3.x APIs.",
true,
ConfigKey.Scope.Global
);


@Override
public boolean configure(final String name, final Map<String, Object> params) throws ConfigurationException {
messageBus.subscribe(AsyncJob.Topics.JOB_EVENT_PUBLISH, MessageDispatcher.getDispatcher(this));
Expand Down Expand Up @@ -1685,7 +1698,8 @@ public ConfigKey<?>[] getConfigKeys() {
useForwardHeader,
listOfForwardHeaders,
ApiSessionKeyCookieSameSiteSetting,
ApiSessionKeyCheckLocations
ApiSessionKeyCheckLocations,
ApiDisallowInternalIds
};
}
}
3 changes: 2 additions & 1 deletion server/src/main/java/com/cloud/api/dispatch/ParamProcessWorker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.LogManager;

import com.cloud.api.ApiServer;
import com.cloud.exception.InvalidParameterValueException;
import com.cloud.user.Account;
import com.cloud.user.AccountManager;
Expand Down Expand Up @@ -510,7 +511,7 @@ private Long translateUuidToInternalId(final String uuid, final Parameter annota
}
Long internalId = null;
// If annotation's empty, the cmd existed before 3.x try conversion to long
final boolean isPre3x = annotation.since().isEmpty();
final boolean isPre3x = annotation.since().isEmpty() && !ApiServer.ApiDisallowInternalIds.value();
// Match against Java's UUID regex to check if input is uuid string
final boolean isUuid = UuidUtils.isUuid(uuid);
// Enforce that it's uuid for newly added apis from version 3.x
Expand Down
Loading