Skip to content

The Unified and Autonomous Development Platform

feat: Add strong complexity validation when setting a password (OD-2486)

Robin Shen4894da068d8a
diff --git a/server-core/src/main/java/io/onedev/server/annotation/Password.java b/server-core/src/main/java/io/onedev/server/annotation/Password.java
index 280d0b9991..4715eecf1c 100644
--- a/server-core/src/main/java/io/onedev/server/annotation/Password.java
+++ b/server-core/src/main/java/io/onedev/server/annotation/Password.java
@@ -5,11 +5,23 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-@Target({ElementType.METHOD})
+import javax.validation.Constraint;
+import javax.validation.Payload;
+
+import io.onedev.server.validation.validator.PasswordValidator;
+
+@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
+@Constraint(validatedBy=PasswordValidator.class)
public @interface Password {
- boolean needConfirm() default false;
+ String message() default "";
+
+ Class<?>[] groups() default {};
+
+ Class<? extends Payload>[] payload() default {};
+
+ boolean checkPolicy() default false;
String autoComplete() default "";
diff --git a/server-core/src/main/java/io/onedev/server/model/User.java b/server-core/src/main/java/io/onedev/server/model/User.java
index c063aecf06..6d997a7108 100644
--- a/server-core/src/main/java/io/onedev/server/model/User.java
+++ b/server-core/src/main/java/io/onedev/server/model/User.java
@@ -566,7 +566,7 @@ public class User extends AbstractEntity implements AuthenticationInfo {
*/
@Editable(order=150)
@ShowCondition("isServiceAccountDisabled")
- @Password(needConfirm=true, autoComplete="new-password")
+ @Password(checkPolicy=true, autoComplete="new-password")
@NotEmpty
@Nullable
public String getPassword() {
diff --git a/server-core/src/main/java/io/onedev/server/model/support/administration/PasswordPolicy.java b/server-core/src/main/java/io/onedev/server/model/support/administration/PasswordPolicy.java
new file mode 100644
index 0000000000..503782eb37
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/model/support/administration/PasswordPolicy.java
@@ -0,0 +1,107 @@
+package io.onedev.server.model.support.administration;
+
+import java.io.Serializable;
+
+import javax.annotation.Nullable;
+
+import io.onedev.server.annotation.Editable;
+
+@Editable
+public class PasswordPolicy implements Serializable {
+
+ private static final long serialVersionUID = 1L;
+
+ private int minLength = 8;
+
+ private boolean mustContainUppercase = true;
+
+ private boolean mustContainLowercase = true;
+
+ private boolean mustContainNumber = true;
+
+ private boolean mustContainSpecial = true;
+
+ @Editable(order=100, name="PasswordMinimum Length", description="Minimum length of the password")
+ public int getMinLength() {
+ return minLength;
+ }
+
+ public void setMinLength(int minLength) {
+ this.minLength = minLength;
+ }
+
+ @Editable(order=200, name="Password Must Contain Uppercase", description="Whether the password must contain at least one uppercase letter")
+ public boolean isMustContainUppercase() {
+ return mustContainUppercase;
+ }
+
+ public void setMustContainUppercase(boolean mustContainUppercase) {
+ this.mustContainUppercase = mustContainUppercase;
+ }
+
+ @Editable(order=300, name="Password Must Contain Lowercase", description="Whether the password must contain at least one lowercase letter")
+ public boolean isMustContainLowercase() {
+ return mustContainLowercase;
+ }
+
+ public void setMustContainLowercase(boolean mustContainLowercase) {
+ this.mustContainLowercase = mustContainLowercase;
+ }
+
+ @Editable(order=400, name="Password Must Contain Digit", description="Whether the password must contain at least one number")
+ public boolean isMustContainNumber() {
+ return mustContainNumber;
+ }
+
+ public void setMustContainNumber(boolean mustContainNumber) {
+ this.mustContainNumber = mustContainNumber;
+ }
+
+ @Editable(order=500, name="Password Must Contain Special Character", description="Whether the password must contain at least one special character")
+ public boolean isMustContainSpecial() {
+ return mustContainSpecial;
+ }
+
+ public void setMustContainSpecial(boolean mustContainSpecial) {
+ this.mustContainSpecial = mustContainSpecial;
+ }
+
+ @Nullable
+ public String checkPassword(String password) {
+ boolean hasErrors = false;
+ if (password.length() < minLength)
+ hasErrors = true;
+
+ if (mustContainUppercase && !password.matches(".*[A-Z].*"))
+ hasErrors = true;
+
+ if (mustContainLowercase && !password.matches(".*[a-z].*"))
+ hasErrors = true;
+
+ if (mustContainNumber && !password.matches(".*\\d.*"))
+ hasErrors = true;
+
+ if (mustContainSpecial && !password.matches(".*[!@#$%^&*()_+\\-=\\[\\]{};':\"\\\\|,.<>\\/?].*"))
+ hasErrors = true;
+
+ if (hasErrors) {
+ StringBuilder requirements = new StringBuilder("Password requirements:\n");
+ requirements.append("- Minimum length: ").append(minLength).append(" characters\n");
+ if (mustContainUppercase)
+ requirements.append("- Must contain at least one uppercase letter\n");
+
+ if (mustContainLowercase)
+ requirements.append("- Must contain at least one lowercase letter\n");
+
+ if (mustContainNumber)
+ requirements.append("- Must contain at least one number\n");
+
+ if (mustContainSpecial)
+ requirements.append("- Must contain at least one special character\n");
+
+ return requirements.toString();
+ } else {
+ return null;
+ }
+ }
+}
diff --git a/server-core/src/main/java/io/onedev/server/model/support/administration/SecuritySetting.java b/server-core/src/main/java/io/onedev/server/model/support/administration/SecuritySetting.java
index 49f35ac5a2..82a7c10bad 100644
--- a/server-core/src/main/java/io/onedev/server/model/support/administration/SecuritySetting.java
+++ b/server-core/src/main/java/io/onedev/server/model/support/administration/SecuritySetting.java
@@ -32,6 +32,8 @@ public class SecuritySetting implements Serializable {
private boolean enableSelfDeregister;
+ private PasswordPolicy passwordPolicy;
+
private String defaultGroupName;
private boolean enforce2FA;
@@ -72,6 +74,15 @@ public class SecuritySetting implements Serializable {
return (boolean) EditContext.get().getInputValue("enableSelfRegister");
}
+ @Editable(order=250, name="Enforce Password Policy", description="Enforce password policy for new users")
+ public PasswordPolicy getPasswordPolicy() {
+ return passwordPolicy;
+ }
+
+ public void setPasswordPolicy(PasswordPolicy passwordPolicy) {
+ this.passwordPolicy = passwordPolicy;
+ }
+
@Editable(order=300, name="Default Group", description="Optionally add new users to specified default group")
@GroupChoice
public String getDefaultGroupName() {
diff --git a/server-core/src/main/java/io/onedev/server/rest/resource/UserResource.java b/server-core/src/main/java/io/onedev/server/rest/resource/UserResource.java
index ce95c6443b..a1f58afeca 100644
--- a/server-core/src/main/java/io/onedev/server/rest/resource/UserResource.java
+++ b/server-core/src/main/java/io/onedev/server/rest/resource/UserResource.java
@@ -36,6 +36,7 @@ import org.apache.shiro.authz.UnauthorizedException;
import io.onedev.commons.utils.ExplicitException;
import io.onedev.server.SubscriptionManager;
+import io.onedev.server.annotation.Password;
import io.onedev.server.annotation.UserName;
import io.onedev.server.data.migration.VersionedXmlDoc;
import io.onedev.server.entitymanager.AuditManager;
@@ -448,7 +449,7 @@ public class UserResource {
@Api(order=2000)
@Path("/{userId}/password")
@POST
- public Response setPassword(@PathParam("userId") Long userId, @NotEmpty String password) {
+ public Response setPassword(@PathParam("userId") Long userId, @Password(checkPolicy=true) @NotEmpty String password) {
User user = userManager.load(userId);
if (SecurityUtils.isAdministrator()) {
user.setPassword(passwordService.encryptPassword(password));
@@ -680,7 +681,8 @@ public class UserResource {
this.name = name;
}
- @NotEmpty
+ @Password(checkPolicy=true)
+ @NotEmpty
public String getPassword() {
return password;
}
diff --git a/server-core/src/main/java/io/onedev/server/validation/validator/PasswordValidator.java b/server-core/src/main/java/io/onedev/server/validation/validator/PasswordValidator.java
new file mode 100644
index 0000000000..01f95eca7e
--- /dev/null
+++ b/server-core/src/main/java/io/onedev/server/validation/validator/PasswordValidator.java
@@ -0,0 +1,42 @@
+package io.onedev.server.validation.validator;
+
+import javax.validation.ConstraintValidator;
+import javax.validation.ConstraintValidatorContext;
+
+import io.onedev.server.OneDev;
+import io.onedev.server.annotation.Password;
+import io.onedev.server.entitymanager.SettingManager;
+
+public class PasswordValidator implements ConstraintValidator<Password, String> {
+
+ private String message;
+
+ private boolean checkPolicy;
+
+ @Override
+ public void initialize(Password constaintAnnotation) {
+ message = constaintAnnotation.message();
+ checkPolicy = constaintAnnotation.checkPolicy();
+ }
+
+ @Override
+ public boolean isValid(String value, ConstraintValidatorContext constraintContext) {
+ if (value == null || !checkPolicy)
+ return true;
+
+ var passwordPolicy = OneDev.getInstance(SettingManager.class).getSecuritySetting().getPasswordPolicy();
+ if (passwordPolicy != null) {
+ var error = passwordPolicy.checkPassword(value);
+ if (error != null) {
+ String message = this.message;
+ if (message.length() == 0) {
+ message = error;
+ }
+ constraintContext.buildConstraintViolationWithTemplate(message).addConstraintViolation();
+ return false;
+ }
+ }
+ return true;
+ }
+
+}
diff --git a/server-core/src/main/java/io/onedev/server/web/component/user/passwordedit/PasswordEditBean.java b/server-core/src/main/java/io/onedev/server/web/component/user/passwordedit/PasswordEditBean.java
index da1b1d6f41..a1fa3225f0 100644
--- a/server-core/src/main/java/io/onedev/server/web/component/user/passwordedit/PasswordEditBean.java
+++ b/server-core/src/main/java/io/onedev/server/web/component/user/passwordedit/PasswordEditBean.java
@@ -30,7 +30,7 @@ public class PasswordEditBean implements Serializable {
}
@Editable(order=200)
- @Password(needConfirm=true)
+ @Password(checkPolicy=true)
@NotEmpty
public String getNewPassword() {
return newPassword;
diff --git a/server-core/src/main/java/io/onedev/server/web/editable/BeanEditor.java b/server-core/src/main/java/io/onedev/server/web/editable/BeanEditor.java
index 12863c6d0d..f5027897c1 100644
--- a/server-core/src/main/java/io/onedev/server/web/editable/BeanEditor.java
+++ b/server-core/src/main/java/io/onedev/server/web/editable/BeanEditor.java
@@ -18,6 +18,7 @@ import org.apache.wicket.Component;
import org.apache.wicket.behavior.AttributeAppender;
import org.apache.wicket.event.Broadcast;
import org.apache.wicket.event.IEvent;
+import org.apache.wicket.feedback.FeedbackMessage;
import org.apache.wicket.feedback.FencedFeedbackPanel;
import org.apache.wicket.markup.head.IHeaderResponse;
import org.apache.wicket.markup.head.OnDomReadyHeaderItem;
@@ -29,6 +30,7 @@ import org.apache.wicket.model.Model;
import org.apache.wicket.util.convert.ConversionException;
import org.apache.wicket.util.visit.IVisit;
import org.apache.wicket.util.visit.IVisitor;
+import org.unbescape.html.HtmlEscape;
import io.onedev.commons.loader.AppLoader;
import io.onedev.server.annotation.OmitName;
@@ -181,7 +183,22 @@ public class BeanEditor extends ValueEditor<Serializable> {
descriptionLabel.setOutputMarkupPlaceholderTag(true);
add(descriptionLabel);
- add(new FencedFeedbackPanel("feedback", propertyEditor));
+ add(new FencedFeedbackPanel("feedback", propertyEditor) {
+
+ @Override
+ protected Component newMessageDisplayComponent(String id, FeedbackMessage message) {
+ Component component = super.newMessageDisplayComponent(id, message);
+ if (component instanceof Label) {
+ Label label = (Label) component;
+ String messageText = HtmlEscape.escapeHtml5(message.getMessage().toString());
+ messageText = messageText.replace("\n", "<br>");
+ label.setDefaultModelObject(messageText);
+ label.setEscapeModelStrings(false);
+ }
+ return component;
+ }
+
+ });
}
@Override
diff --git a/server-core/src/main/java/io/onedev/server/web/editable/password/PasswordEditSupport.java b/server-core/src/main/java/io/onedev/server/web/editable/password/PasswordEditSupport.java
index 8b43f1a508..266f353386 100644
--- a/server-core/src/main/java/io/onedev/server/web/editable/password/PasswordEditSupport.java
+++ b/server-core/src/main/java/io/onedev/server/web/editable/password/PasswordEditSupport.java
@@ -15,7 +15,7 @@ public class PasswordEditSupport implements EditSupport {
if (descriptor.getPropertyClass() == String.class) {
Password password = descriptor.getPropertyGetter().getAnnotation(Password.class);
if (password != null) {
- if (password.needConfirm()) {
+ if (password.checkPolicy()) {
return new PropertyContext<String>(descriptor) {
@Override
diff --git a/server-core/src/main/java/io/onedev/server/web/page/simple/security/PasswordResetBean.java b/server-core/src/main/java/io/onedev/server/web/page/simple/security/PasswordResetBean.java
index 5fe292afc2..7b46b4f1a8 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/simple/security/PasswordResetBean.java
+++ b/server-core/src/main/java/io/onedev/server/web/page/simple/security/PasswordResetBean.java
@@ -16,7 +16,7 @@ public class PasswordResetBean implements Serializable {
@Editable(order=200)
@OmitName
- @Password(needConfirm=true)
+ @Password(checkPolicy=true)
@NotEmpty
public String getNewPassword() {
return newPassword;