UI: prevent credential exposure in object storage errors

Dogface2k · Dogface2k · commit d4712cd85b25 · 2026-08-02T16:57:05.000+01:00
diff --git a/server/src/main/java/com/cloud/api/ApiServlet.java b/server/src/main/java/com/cloud/api/ApiServlet.java
@@ -88,7 +88,7 @@ public class ApiServlet extends HttpServlet {
     private static final Pattern GET_REQUEST_COMMANDS = Pattern.compile("^(get|list|query|find)(\\w+)+$");
     private static final HashSet<String> GET_REQUEST_COMMANDS_LIST = new HashSet<>(Set.of("isaccountallowedtocreateofferingswithtags",
             "readyforshutdown", "cloudianisenabled", "quotabalance", "quotasummary", "quotatarifflist", "quotaisenabled", "quotastatement", "verifyoauthcodeandgetuser"));
-    private static final HashSet<String> POST_REQUESTS_TO_DISABLE_LOGGING = new HashSet<>(Set.of(
+    private static final HashSet<String> REQUESTS_TO_DISABLE_PARAMETER_LOGGING = new HashSet<>(Set.of(
             "login",
             "oauthlogin",
             "createaccount",
@@ -197,11 +197,11 @@ public void run() {
         });
     }
 
-    private void checkSingleQueryParameterValue(Map<String, String[]> params) {
+    protected void checkSingleQueryParameterValue(Map<String, String[]> params) {
         params.forEach((k, v) -> {
             if (v.length > 1) {
-                String message = String.format("Query parameter '%s' has multiple values %s. Only the last value will be respected." +
-                    "It is advised to pass only a single parameter", k, Arrays.toString(v));
+                String message = String.format("Query parameter '%s' has %d values. Only the last value will be respected. " +
+                    "It is advised to pass only a single parameter", saveLogString(k), v.length);
                 LOGGER.warn(message);
             }
         });
@@ -238,17 +238,15 @@ void processRequestInContext(final HttpServletRequest req, final HttpServletResp
 
         // logging the request start and end in management log for easy debugging
         String reqStr = "";
-        String cleanQueryString = StringUtils.cleanString(req.getQueryString());
+        String cleanQueryString = getCleanQueryString(command, req.getQueryString(), reqParams);
         if (LOGGER.isDebugEnabled()) {
             reqStr = auditTrailSb.toString() + " " + cleanQueryString;
             if (req.getMethod().equalsIgnoreCase("POST") && org.apache.commons.lang3.StringUtils.isNotBlank(command)) {
-                if (shouldLogPostRequestParameters(command, reqParams)) {
+                if (shouldLogRequestParameters(command, reqParams)) {
                     String cleanParamsString = getCleanParamsString(reqParams);
                     if (org.apache.commons.lang3.StringUtils.isNotBlank(cleanParamsString)) {
                         reqStr += "\n" + cleanParamsString;
                     }
-                } else {
-                    reqStr += " " + command;
                 }
             }
             LOGGER.debug("===START=== " + reqStr);
@@ -773,7 +771,16 @@ private String getCleanParamsString(Map<String, String[]> reqParams) {
         return cleanParamsString.toString();
     }
 
-    protected boolean shouldLogPostRequestParameters(String command, Map<String, String[]> reqParams) {
-        return !POST_REQUESTS_TO_DISABLE_LOGGING.contains(command.toLowerCase()) && !reqParams.containsKey(ApiConstants.USER_DATA);
+    protected boolean shouldLogRequestParameters(String command, Map<String, String[]> reqParams) {
+        return (org.apache.commons.lang3.StringUtils.isBlank(command)
+                || !REQUESTS_TO_DISABLE_PARAMETER_LOGGING.contains(command.toLowerCase(java.util.Locale.ROOT)))
+                && !reqParams.containsKey(ApiConstants.USER_DATA);
+    }
+
+    protected String getCleanQueryString(String command, String queryString, Map<String, String[]> reqParams) {
+        if (!shouldLogRequestParameters(command, reqParams)) {
+            return org.apache.commons.lang3.StringUtils.isBlank(command) ? "" : "command=" + saveLogString(command);
+        }
+        return StringUtils.cleanString(queryString);
     }
 }
diff --git a/server/src/test/java/com/cloud/api/ApiServletTest.java b/server/src/test/java/com/cloud/api/ApiServletTest.java
@@ -34,11 +34,13 @@
 import org.apache.cloudstack.api.command.admin.config.ListCfgsByCmd;
 import org.apache.cloudstack.framework.config.ConfigKey;
 import org.apache.cloudstack.framework.config.impl.ConfigDepotImpl;
+import org.apache.logging.log4j.Logger;
 import org.junit.After;
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
+import org.mockito.ArgumentCaptor;
 import org.mockito.Mock;
 import org.mockito.Mockito;
 import org.mockito.junit.MockitoJUnitRunner;
@@ -463,26 +465,81 @@ public void testVerify2FAWhenExpectedCommandIsNotCalled() throws UnknownHostExce
     }
 
     @Test
-    public void shouldNotLogPostRequestParametersForAddObjectStoragePool() {
-        boolean result = servlet.shouldLogPostRequestParameters("addObjectStoragePool", new HashMap<>());
+    public void shouldNotLogRequestParametersForAddObjectStoragePool() {
+        boolean result = servlet.shouldLogRequestParameters("addObjectStoragePool", new HashMap<>());
 
         Assert.assertFalse(result);
     }
 
     @Test
-    public void shouldLogPostRequestParametersForCommandWithoutSensitiveParameters() {
-        boolean result = servlet.shouldLogPostRequestParameters("listZones", new HashMap<>());
+    public void shouldLogRequestParametersForCommandWithoutSensitiveParameters() {
+        boolean result = servlet.shouldLogRequestParameters("listZones", new HashMap<>());
 
         Assert.assertTrue(result);
     }
 
     @Test
-    public void shouldNotLogPostRequestParametersContainingUserData() {
+    public void shouldNotLogRequestParametersContainingUserData() {
         Map<String, String[]> params = new HashMap<>();
         params.put(ApiConstants.USER_DATA, new String[] {"sensitive-user-data"});
 
-        boolean result = servlet.shouldLogPostRequestParameters("deployVirtualMachine", params);
+        boolean result = servlet.shouldLogRequestParameters("deployVirtualMachine", params);
 
         Assert.assertFalse(result);
     }
+
+    @Test
+    public void shouldReplaceQueryStringContainingUserDataWithCommandName() {
+        Map<String, String[]> params = new HashMap<>();
+        params.put(ApiConstants.USER_DATA, new String[] {"SYNTHETIC_USER_DATA"});
+        String queryString = "command=deployVirtualMachine&userdata=SYNTHETIC_USER_DATA";
+
+        String result = servlet.getCleanQueryString("deployVirtualMachine", queryString, params);
+
+        Assert.assertEquals("command=deployVirtualMachine", result);
+        Assert.assertFalse(result.contains("SYNTHETIC_USER_DATA"));
+    }
+
+    @Test
+    public void shouldReplaceSensitiveQueryStringWithCommandName() {
+        Map<String, String[]> params = new HashMap<>();
+        String queryString = "command=addObjectStoragePool&details%5B1%5D.value=SYNTHETIC_SECRET_KEY";
+
+        String result = servlet.getCleanQueryString("addObjectStoragePool", queryString, params);
+
+        Assert.assertEquals("command=addObjectStoragePool", result);
+        Assert.assertFalse(result.contains("SYNTHETIC_SECRET_KEY"));
+    }
+
+    @Test
+    public void shouldKeepOrdinaryQueryString() {
+        Map<String, String[]> params = new HashMap<>();
+        String queryString = "command=listZones&response=json";
+
+        String result = servlet.getCleanQueryString("listZones", queryString, params);
+
+        Assert.assertEquals(queryString, result);
+    }
+
+    @Test
+    public void shouldLogDuplicateParameterNameAndCountWithoutValues() {
+        Logger originalLogger = ApiServlet.LOGGER;
+        Logger logger = Mockito.mock(Logger.class);
+        ApiServlet.LOGGER = logger;
+        Map<String, String[]> params = new HashMap<>();
+        params.put("details[1].value", new String[] {"SYNTHETIC_SECRET_ONE", "SYNTHETIC_SECRET_TWO"});
+
+        try {
+            servlet.checkSingleQueryParameterValue(params);
+
+            ArgumentCaptor<String> message = ArgumentCaptor.forClass(String.class);
+            Mockito.verify(logger).warn(message.capture());
+            Assert.assertTrue(message.getValue().contains("details[1].value"));
+            Assert.assertTrue(message.getValue().contains("2 values"));
+            Assert.assertFalse(message.getValue().contains("SYNTHETIC_SECRET_ONE"));
+            Assert.assertFalse(message.getValue().contains("SYNTHETIC_SECRET_TWO"));
+        } finally {
+            ApiServlet.LOGGER = originalLogger;
+        }
+    }
 }
diff --git a/ui/src/utils/apiError.js b/ui/src/utils/apiError.js
@@ -0,0 +1,56 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you 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.
+
+function cleanLogValue (value) {
+  if (typeof value !== 'string') {
+    return value
+  }
+  return value.replace(/[\n\r\t]/g, '_').slice(0, 256)
+}
+
+function getCommand (config) {
+  if (config?.params?.command) {
+    return config.params.command
+  }
+
+  const data = config?.data
+  if (typeof URLSearchParams !== 'undefined' && data instanceof URLSearchParams) {
+    return data.get('command')
+  }
+  if (typeof data === 'string') {
+    return new URLSearchParams(data).get('command')
+  }
+}
+
+export function getSafeApiErrorDetails (error) {
+  const response = error?.response
+  const config = response?.config || error?.config
+  const method = cleanLogValue(config?.method)
+
+  return {
+    name: cleanLogValue(error?.name),
+    code: cleanLogValue(error?.code),
+    status: response?.status,
+    statusText: cleanLogValue(response?.statusText),
+    method: typeof method === 'string' ? method.toUpperCase() : method,
+    command: cleanLogValue(getCommand(config))
+  }
+}
+
+export function logApiError (error) {
+  console.error('CloudStack API request failed', getSafeApiErrorDetails(error))
+}
diff --git a/ui/src/utils/plugins.js b/ui/src/utils/plugins.js
@@ -23,6 +23,7 @@ import eventBus from '@/config/eventBus'
 import store from '@/store'
 import { sourceToken } from '@/utils/request'
 import { toLocalDate, toLocaleDate } from '@/utils/date'
+import { logApiError } from '@/utils/apiError'
 
 export const pollJobPlugin = {
   install (app) {
@@ -217,7 +218,7 @@ export const pollJobPlugin = {
 export const notifierPlugin = {
   install (app) {
     app.config.globalProperties.$notifyError = function (error) {
-      console.log(error)
+      logApiError(error)
       var msg = i18n.global.t('message.request.failed')
       var desc = ''
       if (error && error.response) {
diff --git a/ui/src/utils/request.js b/ui/src/utils/request.js
@@ -24,6 +24,7 @@ import notification from 'ant-design-vue/es/notification'
 import { CURRENT_PROJECT } from '@/store/mutation-types'
 import { i18n } from '@/locales'
 import store from '@/store'
+import { logApiError } from '@/utils/apiError'
 
 let source
 const service = axios.create({
@@ -33,8 +34,8 @@ const service = axios.create({
 const err = (error) => {
   const response = error.response
   let countNotify = store.getters.countNotify
+  logApiError(error)
   if (response) {
-    console.log(response)
     if (response.status === 403) {
       const data = response.data
       countNotify++
diff --git a/ui/src/views/infra/AddObjectStorage.vue b/ui/src/views/infra/AddObjectStorage.vue
@@ -87,7 +87,7 @@
             <a-input v-model:value="form.accessKey" />
           </a-form-item>
           <a-form-item name="secretKey" ref="secretKey" :label="$t('label.secret.key')">
-            <a-input v-model:value="form.secretKey" />
+            <a-input-password v-model:value="form.secretKey" autocomplete="off" />
           </a-form-item>
           <a-form-item name="size" ref="size">
             <template #label>
diff --git a/ui/tests/unit/utils/apiError.spec.js b/ui/tests/unit/utils/apiError.spec.js
@@ -0,0 +1,112 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you 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.
+
+import { getSafeApiErrorDetails, logApiError } from '@/utils/apiError'
+
+describe('API error logging', () => {
+  const accessKey = 'SYNTHETIC_ACCESS_KEY'
+  const secretKey = 'SYNTHETIC_SECRET_KEY'
+  const sessionKey = 'SYNTHETIC_SESSION_KEY'
+
+  function createAxiosError (data) {
+    return {
+      name: 'Error',
+      code: 'ERR_BAD_RESPONSE',
+      isAxiosError: true,
+      response: {
+        status: 500,
+        statusText: 'Internal Server Error',
+        data: {
+          errorresponse: {
+            errortext: secretKey
+          }
+        },
+        config: {
+          method: 'post',
+          url: '/',
+          data
+        }
+      }
+    }
+  }
+
+  it('keeps useful POST failure metadata without request or response secrets', () => {
+    const data = new URLSearchParams()
+    data.append('command', 'addObjectStoragePool')
+    data.append('details[0].value', accessKey)
+    data.append('details[1].value', secretKey)
+    data.append('sessionkey', sessionKey)
+    const error = createAxiosError(data.toString())
+
+    const details = getSafeApiErrorDetails(error)
+    const serializedDetails = JSON.stringify(details)
+
+    expect(details).toEqual({
+      name: 'Error',
+      code: 'ERR_BAD_RESPONSE',
+      status: 500,
+      statusText: 'Internal Server Error',
+      method: 'POST',
+      command: 'addObjectStoragePool'
+    })
+    expect(serializedDetails).not.toContain(accessKey)
+    expect(serializedDetails).not.toContain(secretKey)
+    expect(serializedDetails).not.toContain(sessionKey)
+  })
+
+  it('logs only the safe failure summary', () => {
+    const data = new URLSearchParams()
+    data.append('command', 'addObjectStoragePool')
+    data.append('details[1].value', secretKey)
+    const error = createAxiosError(data.toString())
+    const consoleError = jest.spyOn(console, 'error').mockImplementation(() => {})
+
+    try {
+      logApiError(error)
+
+      expect(consoleError).toHaveBeenCalledWith('CloudStack API request failed', {
+        name: 'Error',
+        code: 'ERR_BAD_RESPONSE',
+        status: 500,
+        statusText: 'Internal Server Error',
+        method: 'POST',
+        command: 'addObjectStoragePool'
+      })
+      expect(JSON.stringify(consoleError.mock.calls)).not.toContain(secretKey)
+    } finally {
+      consoleError.mockRestore()
+    }
+  })
+
+  it('does not copy GET parameters into the safe failure summary', () => {
+    const error = createAxiosError()
+    error.response.config.method = 'get'
+    error.response.config.params = {
+      command: 'addObjectStoragePool',
+      accesskey: accessKey,
+      secretkey: secretKey,
+      sessionkey: sessionKey
+    }
+
+    const serializedDetails = JSON.stringify(getSafeApiErrorDetails(error))
+
+    expect(serializedDetails).toContain('addObjectStoragePool')
+    expect(serializedDetails).not.toContain(accessKey)
+    expect(serializedDetails).not.toContain(secretKey)
+    expect(serializedDetails).not.toContain(sessionKey)
+  })
+})
diff --git a/ui/tests/unit/views/infra/AddObjectStorage.spec.js b/ui/tests/unit/views/infra/AddObjectStorage.spec.js
