Skip to content

armgit / core

Public Imported from GitHub
0

100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps

Updated username pattern based on Keycloak validation (#1550)

Martin Peeters112cf7f004c5
diff --git a/model/src/main/java/org/openremote/model/security/User.java b/model/src/main/java/org/openremote/model/security/User.java
index cf253af92..8afeb63c6 100644
--- a/model/src/main/java/org/openremote/model/security/User.java
+++ b/model/src/main/java/org/openremote/model/security/User.java
@@ -50,6 +50,7 @@ public class User {
public static final String EMAIL_NOTIFICATIONS_DISABLED_ATTRIBUTE = "emailNotificationsDisabled";
public static final String PUSH_NOTIFICATIONS_DISABLED_ATTRIBUTE = "pushNotificationsDisabled";
public static final String LOCALE_ATTRIBUTE = "locale";
+ public static final String USERNAME_PATTERN = "^(?=[\\p{IsLatin}|\\p{IsCommon}]+$)(?=[^<>&\"'\\s\\v\\h$%!#?§,;:*~/\\\\|^=\\[\\]{}()`\\p{Cntrl}]+$).*$"; // Based on Keycloak username validation
protected static Field[] propertyFields;
@Formula("(select r.NAME from PUBLIC.REALM r where r.ID = REALM_ID)")
@@ -120,7 +121,7 @@ public class User {
}
@Size(min = 3, max = 255, message = "{User.username.Size}")
- @Pattern(regexp = "[A-Za-z0-9\\-_@.]+", message = "{User.username.Pattern}")
+ @Pattern(regexp = USERNAME_PATTERN, message = "{User.username.Pattern}")
@JsonProperty
public String getUsername() {
return username == null ? null : username.replace(SERVICE_ACCOUNT_PREFIX, "");
diff --git a/test/src/test/groovy/org/openremote/test/users/UserResourceTest.groovy b/test/src/test/groovy/org/openremote/test/users/UserResourceTest.groovy
index 9f7883d8d..62108685a 100644
--- a/test/src/test/groovy/org/openremote/test/users/UserResourceTest.groovy
+++ b/test/src/test/groovy/org/openremote/test/users/UserResourceTest.groovy
@@ -19,7 +19,7 @@
*/
package org.openremote.test.users
-
+import jakarta.ws.rs.BadRequestException
import org.openremote.manager.setup.SetupService
import org.openremote.model.Constants
import org.openremote.model.query.UserQuery
@@ -299,4 +299,69 @@ class UserResourceTest extends Specification implements ManagerContainerTrait {
user.attributes.any {it.name == EMAIL_NOTIFICATIONS_DISABLED_ATTRIBUTE && it.value == "true"}
user.attributes.any {it.name == "test" && it.value == "testvalue"}
}
+
+ def "Create invalid users"() {
+
+ when: "a regular user is created"
+ String username1 = "openremoteuser"
+ User user1 = new User().setUsername(username1)
+ adminUserResource.create(null, keycloakTestSetup.realmMaster.name, user1)
+
+ then: "user1 is fetched correctly"
+ User[] users = adminUserResource.query(null, new UserQuery().realm(new RealmPredicate(keycloakTestSetup.realmMaster.name)))
+ assert users.size() == (3 + 1)
+ assert users.any { it.username == username1 }
+
+ /* ---------- */
+
+ when: "the same user is created again"
+ adminUserResource.create(null, keycloakTestSetup.realmMaster.name, user1)
+
+ then: "an exception is thrown, because it already exists"
+ thrown(ForbiddenException)
+
+ /* ---------- */
+
+ when: "a user with only special characters is created"
+ String username2 = '#$%^&*()' // only includes illegal characters
+ User user2 = new User().setUsername(username2)
+ adminUserResource.create(null, keycloakTestSetup.realmMaster.name, user2)
+
+ then: "the invalid character-only username causes an exception to be thrown"
+ thrown(BadRequestException)
+
+ /* ---------- */
+
+ when: "a user with a few special characters is created"
+ String username3 = "openremoteuser!"
+ User user3 = new User().setUsername(username3)
+ adminUserResource.create(null, keycloakTestSetup.realmMaster.name, user3)
+
+ then: "the single exclamation mark should cause an exception to be thrown"
+ thrown(BadRequestException)
+
+ /* ---------- */
+
+ when: "a user is created with their email address as username"
+ String username4 = "[email protected]"
+ User user4 = new User().setUsername(username4)
+ adminUserResource.create(null, keycloakTestSetup.realmMaster.name, user4)
+
+ then: "user4 is created correctly"
+ User[] users4 = adminUserResource.query(null, new UserQuery().realm(new RealmPredicate(keycloakTestSetup.realmMaster.name)))
+ assert users4.size() == (3 + 2)
+ assert users4.any { it.username == username4 }
+
+ /* ---------- */
+
+ when: "a user is created with a special email address as their username"
+ String username5 = "dev_dev-dev.dev+dev++dev__ßçʊ@openremote.io" // all special characters should be valid
+ User user5 = new User().setUsername(username5)
+ adminUserResource.create(null, keycloakTestSetup.realmMaster.name, user5)
+
+ then: "user5 is created correctly"
+ User[] users5 = adminUserResource.query(null, new UserQuery().realm(new RealmPredicate(keycloakTestSetup.realmMaster.name)))
+ assert users5.size() == (3 + 3)
+ assert users5.any { it.username == username5 }
+ }
}
diff --git a/ui/app/manager/src/pages/page-account.ts b/ui/app/manager/src/pages/page-account.ts
index 4ae49ca99..424edc8c4 100644
--- a/ui/app/manager/src/pages/page-account.ts
+++ b/ui/app/manager/src/pages/page-account.ts
@@ -241,7 +241,7 @@ export class PageAccount extends Page<AppStateKeyed> {
.type="${InputType.TEXT}"
?required="${!registrationEmailAsUsername}"
.disabled="${true}"
- minLength="3" maxLength="255" pattern="[A-Za-z0-9\\-_]+"
+ minLength="3" maxLength="255" pattern="[A-Za-z0-9\-_+@.ßçʊ]+"
.validationMessage="${i18next.t("invalidUsername")}"
.value="${user?.username}" autocomplete="false"
@or-mwc-input-changed="${(e: OrInputChangedEvent) => {
diff --git a/ui/app/manager/src/pages/page-users.ts b/ui/app/manager/src/pages/page-users.ts
index 297d0e955..bf28f1131 100644
--- a/ui/app/manager/src/pages/page-users.ts
+++ b/ui/app/manager/src/pages/page-users.ts
@@ -375,8 +375,10 @@ export class PageUsers extends Page<AppStateKeyed> {
// This is handled asynchronously, so it will not 'wait' before the request has succeeded.
if (user.password) {
const credentials = {value: user.password} as Credential;
- manager.rest.api.UserResource.resetPassword(manager.displayRealm, user.id, credentials).catch(() => {
- showSnackbar(undefined, "savePasswordFailed");
+ manager.rest.api.UserResource.resetPassword(manager.displayRealm, user.id, credentials).catch(e => {
+ if(isAxiosError(e) && e.response.status !== 404) {
+ showSnackbar(undefined, "savePasswordFailed");
+ }
});
}
@@ -855,7 +857,7 @@ export class PageUsers extends Page<AppStateKeyed> {
.label="${i18next.t("username")}"
.type="${InputType.TEXT}" minLength="3" maxLength="255"
?required="${isServiceUser || !this._registrationEmailAsUsername}"
- pattern="[A-Za-z0-9\\-_]+"
+ pattern="[A-Za-z0-9\-_+@.ßçʊ]+"
.value="${user.username}" autocomplete="false"
.validationMessage="${i18next.t("invalidUsername")}"
@or-mwc-input-changed="${(e: OrInputChangedEvent) => {