PasswordPolicy#

A configurable password validation policy for enforcing password requirements during registration.

Basic Usage#

const policy = PasswordPolicy(
  minLength: 8,
  requireUppercase: true,
  requireNumber: true,
);

// Validate a password
String? error = policy.validate(password);
if (error != null) {
  print('Invalid: $error');
}

Properties#

Preset Policies#

Weak (Default)#

PasswordPolicy.weak
// Minimum 6 characters, no other requirements

Medium#

PasswordPolicy.medium
// Minimum 8 characters
// One uppercase letter
// One number

Strong#

PasswordPolicy.strong
// Minimum 8 characters
// One uppercase letter
// One lowercase letter
// One number
// One special character

Methods#

validate(String password)#

Returns null if valid, or an error message string if invalid.

final policy = PasswordPolicy.medium;
final error = policy.validate('weak');
// Returns: 'Password must be at least 8 characters long.'

isValid(String password)#

Returns true if the password meets all requirements.

final policy = PasswordPolicy.medium;
bool valid = policy.isValid('StrongPass123');
// Returns: true

description#

Returns a human-readable description of the policy requirements.

final policy = PasswordPolicy.strong;
print(policy.description);
// Output: "At least 8 characters, one uppercase letter, one lowercase letter, one number, one special character"

Custom Policies#

// Very strict policy
const strictPolicy = PasswordPolicy(
  minLength: 12,
  maxLength: 64,
  requireUppercase: true,
  requireLowercase: true,
  requireNumber: true,
  requireSpecialChar: true,
);

// Length-only policy
const lengthPolicy = PasswordPolicy(
  minLength: 10,
);

// Numbers and uppercase only
const simplePolicy = PasswordPolicy(
  minLength: 8,
  requireUppercase: true,
  requireNumber: true,
);

With Signup Card#

ArcaneSignupCard(
  passwordPolicy: PasswordPolicy.strong,
  methods: [AuthMethod.email],
  loginRoute: '/login',
)

The signup card displays the policy description as a hint below the password field.

Error Messages#

The validate method returns specific error messages:

Special Characters#

The following characters count as special characters:

! @ # $ % ^ & * ( ) , . ? " : { } | < >

Related Components#

• ArcaneSignupCard - Registration form
• ArcaneLoginCard - Login form