This is an automated email from the ASF dual-hosted git repository.
RosiKyu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/cloudstack.git
The following commit(s) were added to refs/heads/main by this push:
new 2a179466a4f make password an optional parameter/field in createAccount
(#13955)
2a179466a4f is described below
commit 2a179466a4f6b5eb9186f1b37cd9e6af230281e3
Author: dahn <[email protected]>
AuthorDate: Wed Nov 18 10:44:05 2026 +0100
make password an optional parameter/field in createAccount (#13955)
* make password an optional parameter/field in createAccount
* Update
api/src/main/java/org/apache/cloudstack/api/command/admin/account/CreateAccountCmd.java
Co-authored-by: GaOrtiga <[email protected]>
* Apply suggestion from @vishesh92
* disallow empty passwords
* make null-password test not depend on the internal-error path
* Remove extra space
Co-authored-by: Copilot Autofix powered by AI
<[email protected]>
* space after punctuation
Co-authored-by: Copilot Autofix powered by AI
<[email protected]>
* Apply suggestion from @DaanHoogland
---------
Co-authored-by: GaOrtiga <[email protected]>
Co-authored-by: Copilot Autofix powered by AI
<[email protected]>
---
.../command/admin/account/CreateAccountCmd.java | 16 ++++++--
.../admin/account/CreateAccountCmdTest.java | 43 ++++++++++++++--------
ui/public/locales/en.json | 1 +
ui/src/views/iam/AddAccount.vue | 20 +++++++++-
4 files changed, 58 insertions(+), 22 deletions(-)
diff --git
a/api/src/main/java/org/apache/cloudstack/api/command/admin/account/CreateAccountCmd.java
b/api/src/main/java/org/apache/cloudstack/api/command/admin/account/CreateAccountCmd.java
index cc154ed964b..a4879da2a4d 100644
---
a/api/src/main/java/org/apache/cloudstack/api/command/admin/account/CreateAccountCmd.java
+++
b/api/src/main/java/org/apache/cloudstack/api/command/admin/account/CreateAccountCmd.java
@@ -37,12 +37,14 @@ import org.apache.cloudstack.context.CallContext;
import com.cloud.user.Account;
import com.cloud.user.UserAccount;
+import com.cloud.utils.PasswordGenerator;
@APICommand(name = "createAccount", description = "Creates an account",
responseObject = AccountResponse.class, entityType = {Account.class},
requestHasSensitiveInfo = true, responseHasSensitiveInfo = true)
public class CreateAccountCmd extends BaseCmd {
+ private static final int GENERATED_PASSWORD_LENGTH = 12;
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
@@ -75,8 +77,8 @@ public class CreateAccountCmd extends BaseCmd {
@Parameter(name = ApiConstants.PASSWORD,
type = CommandType.STRING,
- required = true,
- description = "Clear text password (Default hashed to
SHA256SALT). If you wish to use any other hashing algorithm, you would need to
write a custom authentication adapter See Docs section.")
+ description = "Clear text password (Default hashed to
SHA256SALT). If you wish to use any other hashing algorithm, you will need to
write a custom authentication adapter. See Docs section."
+ + " If omitted, a random password is generated, e.g.
for an account that will only ever authenticate externally via SAML/LDAP.")
private String password;
@Parameter(name = ApiConstants.TIMEZONE,
@@ -191,10 +193,16 @@ public class CreateAccountCmd extends BaseCmd {
/**
* TODO: this should be done through a validator. for now replicating the
validation logic in create account and user
+ *
+ * <p>An omitted password generates a random one instead of failing, since
an account that will
+ * only ever authenticate externally (SAML/LDAP) has no need for the admin
to set one. A password
+ * that is passed but blank is still rejected, as that is more likely a
client error.
*/
private void validateParams() {
- if(StringUtils.isEmpty(getPassword())) {
- throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Empty
passwords are not allowed");
+ if (getPassword() == null) {
+ password =
PasswordGenerator.generateRandomPassword(GENERATED_PASSWORD_LENGTH);
+ } else if (StringUtils.isBlank(getPassword())) {
+ throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Blank
passwords are not allowed");
}
if (getAccountType() == null && (getRoleId() == null || getRoleId() <
1L)) {
throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Neither
account type and role ID are not provided");
diff --git
a/api/src/test/java/org/apache/cloudstack/api/command/admin/account/CreateAccountCmdTest.java
b/api/src/test/java/org/apache/cloudstack/api/command/admin/account/CreateAccountCmdTest.java
index 365646de7a3..b72062b5d59 100644
---
a/api/src/test/java/org/apache/cloudstack/api/command/admin/account/CreateAccountCmdTest.java
+++
b/api/src/test/java/org/apache/cloudstack/api/command/admin/account/CreateAccountCmdTest.java
@@ -20,7 +20,10 @@ package org.apache.cloudstack.api.command.admin.account;
import org.apache.cloudstack.acl.RoleService;
import org.apache.cloudstack.api.ApiErrorCode;
+import org.apache.cloudstack.api.ResponseGenerator;
+import org.apache.cloudstack.api.ResponseObject.ResponseView;
import org.apache.cloudstack.api.ServerApiException;
+import org.apache.cloudstack.api.response.AccountResponse;
import org.apache.cloudstack.context.CallContext;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.LogManager;
@@ -37,6 +40,7 @@ import org.springframework.test.util.ReflectionTestUtils;
import com.cloud.user.Account;
import com.cloud.user.AccountService;
import com.cloud.user.User;
+import com.cloud.user.UserAccount;
public class CreateAccountCmdTest {
protected Logger logger = LogManager.getLogger(getClass());
@@ -45,6 +49,8 @@ public class CreateAccountCmdTest {
private AccountService accountService;
@Mock
private RoleService roleService;
+ @Mock
+ private ResponseGenerator responseGenerator;
@InjectMocks
private CreateAccountCmd createAccountCmd = new CreateAccountCmd();
@@ -81,28 +87,33 @@ public class CreateAccountCmdTest {
}
@Test
- public void testExecuteWithNullPassword() {
+ public void testExecuteWithNullPasswordGeneratesOne() {
ReflectionTestUtils.setField(createAccountCmd, "password", null);
- try {
- createAccountCmd.execute();
- Assert.fail("should throw exception for a null password");
- } catch (ServerApiException e) {
- Assert.assertEquals(ApiErrorCode.PARAM_ERROR, e.getErrorCode());
- Assert.assertEquals("Empty passwords are not allowed",
e.getMessage());
- }
- Mockito.verify(accountService,
Mockito.never()).createUserAccount(createAccountCmd);
+ UserAccount userAccount = Mockito.mock(UserAccount.class);
+
Mockito.when(accountService.createUserAccount(createAccountCmd)).thenReturn(userAccount);
+
Mockito.when(responseGenerator.createUserAccountResponse(ResponseView.Full,
userAccount)).thenReturn(Mockito.mock(AccountResponse.class));
+
+ createAccountCmd.execute();
+
+ Assert.assertEquals("a password should be generated for accounts that
authenticate externally",
+ 12, createAccountCmd.getPassword().length());
+ Mockito.verify(accountService,
Mockito.times(1)).createUserAccount(createAccountCmd);
}
@Test
public void testExecuteWithEmptyPassword() {
ReflectionTestUtils.setField(createAccountCmd, "password", "");
- try {
- createAccountCmd.execute();
- Assert.fail("should throw exception for a empty password");
- } catch (ServerApiException e) {
- Assert.assertEquals(ApiErrorCode.PARAM_ERROR, e.getErrorCode());
- Assert.assertEquals("Empty passwords are not allowed",
e.getMessage());
- }
+ ServerApiException e = Assert.assertThrows(ServerApiException.class,
() -> createAccountCmd.execute());
+ Assert.assertEquals(ApiErrorCode.PARAM_ERROR, e.getErrorCode());
+ Assert.assertEquals("Blank passwords are not allowed", e.getMessage());
+ Mockito.verify(accountService,
Mockito.never()).createUserAccount(createAccountCmd);
+ }
+
+ @Test
+ public void testExecuteWithWhitespacePassword() {
+ ReflectionTestUtils.setField(createAccountCmd, "password", " ");
+ ServerApiException e = Assert.assertThrows(ServerApiException.class,
() -> createAccountCmd.execute());
+ Assert.assertEquals(ApiErrorCode.PARAM_ERROR, e.getErrorCode());
Mockito.verify(accountService,
Mockito.never()).createUserAccount(createAccountCmd);
}
}
diff --git a/ui/public/locales/en.json b/ui/public/locales/en.json
index 1c193e96d49..2dc2873a21f 100644
--- a/ui/public/locales/en.json
+++ b/ui/public/locales/en.json
@@ -4112,6 +4112,7 @@
"message.restart.vpc": "Please confirm that you want to restart the VPC.",
"message.restart.vpc.remark": "Please confirm that you want to restart the VPC
<p><i>Remark: making a non-redundant VPC redundant will force a clean up. The
Networks will not be available for a couple of minutes</i>.</p>",
"message.running.custom.action": "Running action",
+"message.saml.account.no.password": "This account will authenticate via SAML
SSO, so no password is needed — one will be generated automatically.",
"message.scale.processing": "Scale in progress",
"message.scaledown.policies": "Please add at least a ScaleDown policy. The
AutoScale Group will be scaled down when all conditions in a ScaleDown policy
are matched. ScaleDown policies will be checked after ScaleUp policies.",
"message.scaledown.policy.continue": "Please add at least condition to
ScaleDown policy to continue",
diff --git a/ui/src/views/iam/AddAccount.vue b/ui/src/views/iam/AddAccount.vue
index 5c0b7e14110..7071786e3e1 100644
--- a/ui/src/views/iam/AddAccount.vue
+++ b/ui/src/views/iam/AddAccount.vue
@@ -60,7 +60,7 @@
v-model:value="form.username"
:placeholder="apiParams.username.description" />
</a-form-item>
- <a-row :gutter="12">
+ <a-row :gutter="12" v-if="!form.samlenable">
<a-col :md="24" :lg="12">
<a-form-item ref="password" name="password">
<template #label>
@@ -82,6 +82,12 @@
</a-form-item>
</a-col>
</a-row>
+ <a-alert
+ v-else
+ type="info"
+ show-icon
+ :message="$t('message.saml.account.no.password')"
+ style="margin-bottom: 12px;" />
<a-form-item ref="email" name="email">
<template #label>
<tooltip-label :title="$t('label.email')"
:tooltip="apiParams.email.description"/>
@@ -257,6 +263,14 @@ export default {
}
},
immediate: false
+ },
+ 'form.samlenable' (samlEnabled) {
+ // a SAML-authenticated account never logs in with a native password
+ this.rules.password = samlEnabled ? [] : [{ required: true, message:
this.$t('message.error.required.input') }]
+ this.rules.confirmpassword = samlEnabled ? [] : [
+ { required: true, message: this.$t('message.error.required.input') },
+ { validator: this.validateConfirmPassword }
+ ]
}
},
methods: {
@@ -415,12 +429,14 @@ export default {
const params = {
roleid: values.roleid,
username: values.username,
- password: values.password,
email: values.email,
firstname: values.firstname,
lastname: values.lastname,
domainid: values.domainid
}
+ if (!values.samlenable) {
+ params.password = values.password
+ }
if (this.isValidValueForKey(values, 'account') &&
values.account.length > 0) {
params.account = values.account
}