aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Security/Events/ValidatePasswordPolicyEvent.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Security/Events/ValidatePasswordPolicyEvent.php')
-rw-r--r--lib/public/Security/Events/ValidatePasswordPolicyEvent.php23
1 files changed, 19 insertions, 4 deletions
diff --git a/lib/public/Security/Events/ValidatePasswordPolicyEvent.php b/lib/public/Security/Events/ValidatePasswordPolicyEvent.php
index 0aa8b516f70..d7ac9442392 100644
--- a/lib/public/Security/Events/ValidatePasswordPolicyEvent.php
+++ b/lib/public/Security/Events/ValidatePasswordPolicyEvent.php
@@ -9,26 +9,41 @@ declare(strict_types=1);
namespace OCP\Security\Events;
use OCP\EventDispatcher\Event;
+use OCP\Security\PasswordContext;
/**
+ * This event can be emitted to request a validation of a password.
+ *
+ * If a password policy app is installed and the password
+ * is invalid, an `\OCP\HintException` will be thrown.
* @since 18.0.0
*/
class ValidatePasswordPolicyEvent extends Event {
- /** @var string */
- private $password;
/**
* @since 18.0.0
+ * @since 31.0.0 - $context parameter added
*/
- public function __construct(string $password) {
+ public function __construct(
+ private string $password,
+ private PasswordContext $context = PasswordContext::ACCOUNT,
+ ) {
parent::__construct();
- $this->password = $password;
}
/**
+ * Get the password that should be validated.
* @since 18.0.0
*/
public function getPassword(): string {
return $this->password;
}
+
+ /**
+ * Get the context this password should validated for.
+ * @since 31.0.0
+ */
+ public function getContext(): PasswordContext {
+ return $this->context;
+ }
}