Skip to content

Include the character option statuses even when an empty string is inputted to validatePassword #7471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 17, 2023
Merged

Include the character option statuses even when an empty string is inputted to validatePassword #7471

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68e03c3
Include the character option statuses even when an empty string is in…
ch5zzy Jul 17, 2023
efcbc06
Update formatting
ch5zzy Jul 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions packages/auth/src/core/auth/password_policy_impl.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,15 @@ describe('core/auth/password_policy_impl', () => {
allowedNonAlphanumericCharacters: TEST_ALLOWED_NON_ALPHANUMERIC_CHARS,
schemaVersion: TEST_SCHEMA_VERSION
};
const PASSWORD_POLICY_RESPONSE_REQUIRE_NUMERIC: GetPasswordPolicyResponse = {
customStrengthOptions: {
minPasswordLength: TEST_MIN_PASSWORD_LENGTH,
maxPasswordLength: TEST_MAX_PASSWORD_LENGTH,
containsNumericCharacter: TEST_CONTAINS_NUMERIC
},
allowedNonAlphanumericCharacters: TEST_ALLOWED_NON_ALPHANUMERIC_CHARS,
schemaVersion: TEST_SCHEMA_VERSION
};
const PASSWORD_POLICY_REQUIRE_ALL: PasswordPolicy = {
customStrengthOptions: {
minPasswordLength: TEST_MIN_PASSWORD_LENGTH,
Expand All @@ -78,6 +87,7 @@ describe('core/auth/password_policy_impl', () => {
},
allowedNonAlphanumericCharacters: TEST_ALLOWED_NON_ALPHANUMERIC_STRING
};
const TEST_EMPTY_PASSWORD = '';

context('#PasswordPolicyImpl', () => {
it('can construct the password policy from the backend response', () => {
Expand Down Expand Up @@ -126,6 +136,9 @@ describe('core/auth/password_policy_impl', () => {
const PASSWORD_POLICY_IMPL_REQUIRE_LENGTH = new PasswordPolicyImpl(
PASSWORD_POLICY_RESPONSE_REQUIRE_LENGTH
);
const PASSWORD_POLICY_IMPL_REQUIRE_NUMERIC = new PasswordPolicyImpl(
PASSWORD_POLICY_RESPONSE_REQUIRE_NUMERIC
);

it('password that is too short is considered invalid', async () => {
const policy = PASSWORD_POLICY_IMPL_REQUIRE_ALL;
Expand Down Expand Up @@ -294,6 +307,38 @@ describe('core/auth/password_policy_impl', () => {
expect(status.containsNumericCharacter).to.be.undefined;
expect(status.containsNonAlphanumericCharacter).to.be.undefined;
});

it('should include statuses for requirements included in the policy when the password is an empty string', async () => {
let policy = PASSWORD_POLICY_IMPL_REQUIRE_ALL;
let expectedValidationStatus: PasswordValidationStatus = {
isValid: false,
meetsMinPasswordLength: false,
meetsMaxPasswordLength: true,
containsLowercaseLetter: false,
containsUppercaseLetter: false,
containsNumericCharacter: false,
containsNonAlphanumericCharacter: false,
passwordPolicy: policy
};

let status = policy.validatePassword(TEST_EMPTY_PASSWORD);
expect(status).to.eql(expectedValidationStatus);

policy = PASSWORD_POLICY_IMPL_REQUIRE_NUMERIC;
expectedValidationStatus = {
isValid: false,
meetsMinPasswordLength: false,
meetsMaxPasswordLength: true,
containsNumericCharacter: false,
passwordPolicy: policy
};

status = policy.validatePassword(TEST_EMPTY_PASSWORD);
expect(status).to.eql(expectedValidationStatus);
expect(status.containsLowercaseLetter).to.be.undefined;
expect(status.containsUppercaseLetter).to.be.undefined;
expect(status.containsNonAlphanumericCharacter).to.be.undefined;
});
});
});
});
70 changes: 54 additions & 16 deletions packages/auth/src/core/auth/password_policy_impl.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,25 +118,63 @@ export class PasswordPolicyImpl implements PasswordPolicyInternal {
password: string,
status: PasswordValidationStatusInternal
): void {
// Assign statuses for requirements even if the password is an empty string.
this.updatePasswordCharacterOptionsStasuses(
status,
/* containsLowercaseCharacter= */ false,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added parameter name comments to make this more readable as per the TS/JS style guide.

/* containsUppercaseCharacter= */ false,
/* containsNumericCharacter= */ false,
/* containsNonAlphanumericCharacter= */ false
);

let passwordChar;
for (let i = 0; i < password.length; i++) {
passwordChar = password.charAt(i);
if (this.customStrengthOptions.containsLowercaseLetter) {
status.containsLowercaseLetter ||=
passwordChar >= 'a' && passwordChar <= 'z';
}
if (this.customStrengthOptions.containsUppercaseLetter) {
status.containsUppercaseLetter ||=
passwordChar >= 'A' && passwordChar <= 'Z';
}
if (this.customStrengthOptions.containsNumericCharacter) {
status.containsNumericCharacter ||=
passwordChar >= '0' && passwordChar <= '9';
}
if (this.customStrengthOptions.containsNonAlphanumericCharacter) {
status.containsNonAlphanumericCharacter ||=
this.allowedNonAlphanumericCharacters.includes(passwordChar);
}
this.updatePasswordCharacterOptionsStasuses(
status,
/* containsLowercaseCharacter= */ passwordChar >= 'a' &&
passwordChar <= 'z',
/* containsUppercaseCharacter= */ passwordChar >= 'A' &&
passwordChar <= 'Z',
/* containsNumericCharacter= */ passwordChar >= '0' &&
passwordChar <= '9',
/* containsNonAlphanumericCharacter= */ this.allowedNonAlphanumericCharacters.includes(
passwordChar
)
);
}
}

/**
* Updates the running validation status with the statuses for the character options.
* Expected to be called each time a character is processed to update each option status
* based on the current character.
*
* @param status Validation status.
* @param containsLowercaseCharacter Whether the character is a lowercase letter.
* @param containsUppercaseCharacter Whether the character is an uppercase letter.
* @param containsNumericCharacter Whether the character is a numeric character.
* @param containsNonAlphanumericCharacter Whether the character is a non-alphanumeric character.
*/
private updatePasswordCharacterOptionsStasuses(
status: PasswordValidationStatusInternal,
containsLowercaseCharacter: boolean,
containsUppercaseCharacter: boolean,
containsNumericCharacter: boolean,
containsNonAlphanumericCharacter: boolean
): void {
if (this.customStrengthOptions.containsLowercaseLetter) {
status.containsLowercaseLetter ||= containsLowercaseCharacter;
}
if (this.customStrengthOptions.containsUppercaseLetter) {
status.containsUppercaseLetter ||= containsUppercaseCharacter;
}
if (this.customStrengthOptions.containsNumericCharacter) {
status.containsNumericCharacter ||= containsNumericCharacter;
}
if (this.customStrengthOptions.containsNonAlphanumericCharacter) {
status.containsNonAlphanumericCharacter ||=
containsNonAlphanumericCharacter;
}
}
}