Introduce validatePassword for SignIn and SignUp resources#1445

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
panteliselef merged 3 commits into from
Aug 9, 2023
Merged

Introduce validatePassword for SignIn and SignUp resources #1445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8fd9843
feat(clerk-js): Expose password validation from SignIn and SignUp res…
panteliselef Jun 18, 2023
feb492d
chore(clerk-js): Use ZxcvbnResult from `@types`
panteliselef Jun 18, 2023
e4c03a1
chore(repo): Example usage password validation in custom flows
panteliselef Jun 18, 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
7 changes: 7 additions & 0 deletions .changeset/nice-experts-hope.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

Introducing validatePassword for SignIn and SignUp resources
- Validate a password based on the instance's configuration set in Password Policies in Dashboard
10 changes: 10 additions & 0 deletions packages/clerk-js/src/core/resources/SignIn.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ import type {
} from '@clerk/types';

import { generateSignatureWithMetamask, getMetamaskIdentifier, windowNavigate } from '../../utils';
import { createValidatePassword } from '../../utils/passwords/password';
import {
clerkInvalidFAPIResponse,
clerkInvalidStrategy,
Expand DownExpand Up@@ -234,6 +235,15 @@ export class SignIn extends BaseResource implements SignInResource {
});
};

validatePassword: ReturnType<typeof createValidatePassword> = (password, cb) => {
if (SignIn.clerk.__unstable__environment?.userSettings.passwordSettings) {
return createValidatePassword({
...(SignIn.clerk.__unstable__environment?.userSettings.passwordSettings as any),
validatePassword: true,
})(password, cb);
}
};

protected fromJSON(data: SignInJSON | null): this {
if (data) {
this.id = data.id;
Expand Down
10 changes: 10 additions & 0 deletions packages/clerk-js/src/core/resources/SignUp.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@ import type {
} from '@clerk/types';

import { generateSignatureWithMetamask, getCaptchaToken, getMetamaskIdentifier, windowNavigate } from '../../utils';
import { createValidatePassword } from '../../utils/passwords/password';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import {
clerkInvalidFAPIResponse,
Expand DownExpand Up@@ -230,6 +231,15 @@ export class SignUp extends BaseResource implements SignUpResource {
});
};

validatePassword: ReturnType<typeof createValidatePassword> = (password, cb) => {
if (SignUp.clerk.__unstable__environment?.userSettings.passwordSettings) {
return createValidatePassword({
...(SignUp.clerk.__unstable__environment?.userSettings.passwordSettings as any),
validatePassword: true,
})(password, cb);
}
};

protected fromJSON(data: SignUpJSON | null): this {
if (data) {
this.id = data.id;
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/hooks/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,6 @@ export * from './useEnabledThirdPartyProviders';
export * from './useLoadingStatus';
export * from './usePassword';
export * from './usePasswordComplexity';
export * from './usePasswordStrength';
export * from './usePopover';
export * from './usePrefersReducedMotion';
export * from './useLocalStorage';
Expand Down
81 changes: 4 additions & 77 deletions packages/clerk-js/src/ui/hooks/usePassword.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,15 @@
import { noop } from '@clerk/shared';
import type { PasswordSettingsData } from '@clerk/types';
import type { PasswordValidation } from '@clerk/types';
import { useCallback, useMemo } from 'react';

import type { UsePasswordCbs, UsePasswordConfig } from '../../utils/passwords/password';
import { createValidatePassword } from '../../utils/passwords/password';
import { localizationKeys, useLocalizations } from '../localization';
import type { FormControlState } from '../utils';
import { loadZxcvbn } from '../utils';
import type { ComplexityErrors } from './usePasswordComplexity';
import { createValidateComplexity, generateErrorTextUtil } from './usePasswordComplexity';
import type { PasswordStrength } from './usePasswordStrength';
import { createValidatePasswordStrength } from './usePasswordStrength';

type UsePasswordConfig = PasswordSettingsData & {
validatePassword: boolean;
};

type PasswordValidation = {
complexity?: ComplexityErrors;
strength?: PasswordStrength;
};

type UsePasswordCbs = {
onValidationFailed?: (errorMessage: string | undefined) => void;
onValidationSuccess?: () => void;
onValidationWarning?: (warningMessage: string) => void;
onValidationComplexity?: (b: boolean) => void;
};

type ValidatePasswordCbs = {
onValidation?: (res: PasswordValidation) => void;
onValidationComplexity?: (b: boolean) => void;
};
import { generateErrorTextUtil } from './usePasswordComplexity';

export const MIN_PASSWORD_LENGTH = 8;

const createValidatePassword = (config: UsePasswordConfig, callbacks?: ValidatePasswordCbs) => {
const { onValidation = noop, onValidationComplexity = noop } = callbacks || {};
const { show_zxcvbn, validatePassword: validatePasswordProp } = config;
const getComplexity = createValidateComplexity(config);
const getScore = createValidatePasswordStrength(config);
let result = {} satisfies PasswordValidation;

return (password: string) => {
if (!validatePasswordProp) {
return;
}

/**
* Validate Complexity
*/
const failedValidationsComplexity = getComplexity(password);
onValidationComplexity(Object.keys(failedValidationsComplexity).length === 0);
result = {
...result,
complexity: failedValidationsComplexity,
};
/**
* Validate score
*/
if (show_zxcvbn) {
/**
* Lazy load zxcvbn without preventing a complexityError to be thrown if it exists
*/
void loadZxcvbn().then(zxcvbn => {
const setPasswordScore = getScore(zxcvbn);
const strength = setPasswordScore(password);

result = {
...result,
strength,
};
onValidation({
...result,
strength,
});
});
}

onValidation({
...result,
complexity: failedValidationsComplexity,
});
};
};

export const usePassword = (config: UsePasswordConfig, callbacks?: UsePasswordCbs) => {
const { t, locale } = useLocalizations();
const {
Expand Down
81 changes: 3 additions & 78 deletions packages/clerk-js/src/ui/hooks/usePasswordComplexity.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,12 @@
import type { PasswordSettingsData } from '@clerk/types';
import { useCallback, useEffect, useMemo, useState } from 'react';

import type { ComplexityErrors, UsePasswordComplexityConfig } from '../../utils/passwords/complexity';
import { validate } from '../../utils/passwords/complexity';
import type { LocalizationKey } from '../localization';
import { localizationKeys, useLocalizations } from '../localization';
import { addFullStop, createListFormat } from '../utils';

export type ComplexityErrors = {
[key in keyof Partial<Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>>]?: boolean;
};

type UsePasswordComplexityConfig = Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>;

const createTestComplexityCases = (config: Pick<UsePasswordComplexityConfig, 'allowed_special_characters'>) => {
let specialCharsRegex: RegExp;
if (config.allowed_special_characters) {
// Avoid a nested group by escaping the `[]` characters
let escaped = config.allowed_special_characters.replace('[', '\\[');
escaped = escaped.replace(']', '\\]');
specialCharsRegex = new RegExp(`[${escaped}]`);
} else {
specialCharsRegex = /[!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]/;
}

return (
password: string,
{
minLength,
maxLength,
}: {
minLength: number;
maxLength: number;
},
) => {
return {
max_length: password.length < maxLength,
min_length: password.length >= minLength,
require_numbers: /\d/.test(password),
require_lowercase: /[a-z]/.test(password),
require_uppercase: /[A-Z]/.test(password),
require_special_char: specialCharsRegex.test(password),
};
};
};

const errorMessages = {
const errorMessages: Record<keyof Omit<ComplexityErrors, 'allowed_special_characters'>, [string, string] | string> = {
max_length: ['unstable__errors.passwordComplexity.maximumLength', 'length'],
min_length: ['unstable__errors.passwordComplexity.minimumLength', 'length'],
require_numbers: 'unstable__errors.passwordComplexity.requireNumbers',
Expand DownExpand Up@@ -89,44 +52,6 @@ export const generateErrorTextUtil = ({
);
};

const validate = (password: string, config: UsePasswordComplexityConfig): ComplexityErrors => {
const { max_length, min_length, require_special_char, require_lowercase, require_numbers, require_uppercase } =
config;
const testComplexityCases = createTestComplexityCases(config);
const testCases = testComplexityCases(password, {
maxLength: config.max_length,
minLength: config.min_length,
});

const keys = {
max_length,
min_length,
require_special_char,
require_numbers,
require_lowercase,
require_uppercase,
};

const _validationsFailedMap = new Map();
for (const k in keys) {
const key = k as keyof typeof keys;

if (!keys[key]) {
continue;
}

if (!testCases[key]) {
_validationsFailedMap.set(key, true);
}
}

return Object.freeze(Object.fromEntries(_validationsFailedMap));
};

export const createValidateComplexity = (config: UsePasswordComplexityConfig) => {
return (password: string) => validate(password, config);
};

export const usePasswordComplexity = (config: UsePasswordComplexityConfig) => {
const [password, _setPassword] = useState('');
const [failedValidations, setFailedValidations] = useState<ComplexityErrors>();
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/utils/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,5 +19,4 @@ export * from './roleLocalizationKey';
export * from './getRelativeToNowDateKey';
export * from './mergeRefs';
export * from './createSlug';
export * from './zxcvbn';
export * from './passwordUtils';
80 changes: 80 additions & 0 deletions packages/clerk-js/src/utils/passwords/complexity.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
import type { PasswordSettingsData } from '@clerk/types';

export type ComplexityErrors = {
[key in keyof Partial<Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>>]?: boolean;
};

export type UsePasswordComplexityConfig = Omit<
PasswordSettingsData,
'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'
>;

const createTestComplexityCases = (config: Pick<UsePasswordComplexityConfig, 'allowed_special_characters'>) => {
let specialCharsRegex: RegExp;
if (config.allowed_special_characters) {
// Avoid a nested group by escaping the `[]` characters
let escaped = config.allowed_special_characters.replace('[', '\\[');
escaped = escaped.replace(']', '\\]');
specialCharsRegex = new RegExp(`[${escaped}]`);
} else {
specialCharsRegex = /[!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]/;
}

return (
password: string,
{
minLength,
maxLength,
}: {
minLength: number;
maxLength: number;
},
) => {
return {
max_length: password.length < maxLength,
min_length: password.length >= minLength,
require_numbers: /\d/.test(password),
require_lowercase: /[a-z]/.test(password),
require_uppercase: /[A-Z]/.test(password),
require_special_char: specialCharsRegex.test(password),
};
};
};

export const validate = (password: string, config: UsePasswordComplexityConfig): ComplexityErrors => {
const { max_length, min_length, require_special_char, require_lowercase, require_numbers, require_uppercase } =
config;
const testComplexityCases = createTestComplexityCases(config);
const testCases = testComplexityCases(password, {
maxLength: config.max_length,
minLength: config.min_length,
});

const keys = {
max_length,
min_length,
require_special_char,
require_lowercase,
require_numbers,
require_uppercase,
};

const _validationsFailedMap = new Map();
for (const k in keys) {
const key = k as keyof typeof keys;

if (!keys[key]) {
continue;
}

if (!testCases[key]) {
_validationsFailedMap.set(key, true);
}
}

return Object.freeze(Object.fromEntries(_validationsFailedMap));
};

export const createValidateComplexity = (config: UsePasswordComplexityConfig) => {
return (password: string) => validate(password, config);
};
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Introduce validatePassword for SignIn and SignUp resources#1445

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

panteliselef
merged 3 commits into

from

Aug 9, 2023
 Merged


Introduce validatePassword for SignIn and SignUp resources
#1445
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8fd9843

feat(clerk-js): Expose password validation from SignIn and SignUp res…


panteliselef Jun 18, 2023
feb492d

chore(clerk-js): Use ZxcvbnResult from `@types`


panteliselef Jun 18, 2023
e4c03a1

chore(repo): Example usage password validation in custom flows


panteliselef Jun 18, 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


7 changes: 7 additions & 0 deletions
.changeset/nice-experts-hope.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

Introducing validatePassword for SignIn and SignUp resources
- Validate a password based on the instance's configuration set in Password Policies in Dashboard 

10 changes: 10 additions & 0 deletions
packages/clerk-js/src/core/resources/SignIn.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ import type {
} from '@clerk/types';

import { generateSignatureWithMetamask, getMetamaskIdentifier, windowNavigate } from '../../utils';
import { createValidatePassword } from '../../utils/passwords/password';
import {
 clerkInvalidFAPIResponse,
 clerkInvalidStrategy,
Expand DownExpand Up@@ -234,6 +235,15 @@ export class SignIn extends BaseResource implements SignInResource {
 });
 };

 validatePassword: ReturnType<typeof createValidatePassword> = (password, cb) => {
 if (SignIn.clerk.__unstable__environment?.userSettings.passwordSettings) {
 return createValidatePassword({
 ...(SignIn.clerk.__unstable__environment?.userSettings.passwordSettings as any),
 validatePassword: true,
 })(password, cb);
 }
 };

 protected fromJSON(data: SignInJSON | null): this {
 if (data) {
 this.id = data.id;
Expand Down

10 changes: 10 additions & 0 deletions
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@ import type {
} from '@clerk/types';

import { generateSignatureWithMetamask, getCaptchaToken, getMetamaskIdentifier, windowNavigate } from '../../utils';
import { createValidatePassword } from '../../utils/passwords/password';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import {
 clerkInvalidFAPIResponse,
Expand DownExpand Up@@ -230,6 +231,15 @@ export class SignUp extends BaseResource implements SignUpResource {
 });
 };

 validatePassword: ReturnType<typeof createValidatePassword> = (password, cb) => {
 if (SignUp.clerk.__unstable__environment?.userSettings.passwordSettings) {
 return createValidatePassword({
 ...(SignUp.clerk.__unstable__environment?.userSettings.passwordSettings as any),
 validatePassword: true,
 })(password, cb);
 }
 };

 protected fromJSON(data: SignUpJSON | null): this {
 if (data) {
 this.id = data.id;
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/hooks/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,6 @@ export * from './useEnabledThirdPartyProviders';
export * from './useLoadingStatus';
export * from './usePassword';
export * from './usePasswordComplexity';
export * from './usePasswordStrength';
export * from './usePopover';
export * from './usePrefersReducedMotion';
export * from './useLocalStorage';
Expand Down

81 changes: 4 additions & 77 deletions
packages/clerk-js/src/ui/hooks/usePassword.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,88 +1,15 @@
import { noop } from '@clerk/shared';
import type { PasswordSettingsData } from '@clerk/types';
import type { PasswordValidation } from '@clerk/types';
import { useCallback, useMemo } from 'react';

import type { UsePasswordCbs, UsePasswordConfig } from '../../utils/passwords/password';
import { createValidatePassword } from '../../utils/passwords/password';
import { localizationKeys, useLocalizations } from '../localization';
import type { FormControlState } from '../utils';
import { loadZxcvbn } from '../utils';
import type { ComplexityErrors } from './usePasswordComplexity';
import { createValidateComplexity, generateErrorTextUtil } from './usePasswordComplexity';
import type { PasswordStrength } from './usePasswordStrength';
import { createValidatePasswordStrength } from './usePasswordStrength';

type UsePasswordConfig = PasswordSettingsData & {
 validatePassword: boolean;
};

type PasswordValidation = {
 complexity?: ComplexityErrors;
 strength?: PasswordStrength;
};

type UsePasswordCbs = {
 onValidationFailed?: (errorMessage: string | undefined) => void;
 onValidationSuccess?: () => void;
 onValidationWarning?: (warningMessage: string) => void;
 onValidationComplexity?: (b: boolean) => void;
};

type ValidatePasswordCbs = {
 onValidation?: (res: PasswordValidation) => void;
 onValidationComplexity?: (b: boolean) => void;
};
import { generateErrorTextUtil } from './usePasswordComplexity';

export const MIN_PASSWORD_LENGTH = 8;

const createValidatePassword = (config: UsePasswordConfig, callbacks?: ValidatePasswordCbs) => {
 const { onValidation = noop, onValidationComplexity = noop } = callbacks || {};
 const { show_zxcvbn, validatePassword: validatePasswordProp } = config;
 const getComplexity = createValidateComplexity(config);
 const getScore = createValidatePasswordStrength(config);
 let result = {} satisfies PasswordValidation;

 return (password: string) => {
 if (!validatePasswordProp) {
 return;
 }

 /**
 * Validate Complexity
 */
 const failedValidationsComplexity = getComplexity(password);
 onValidationComplexity(Object.keys(failedValidationsComplexity).length === 0);
 result = {
 ...result,
 complexity: failedValidationsComplexity,
 };
 /**
 * Validate score
 */
 if (show_zxcvbn) {
 /**
 * Lazy load zxcvbn without preventing a complexityError to be thrown if it exists
 */
 void loadZxcvbn().then(zxcvbn => {
 const setPasswordScore = getScore(zxcvbn);
 const strength = setPasswordScore(password);

 result = {
 ...result,
 strength,
 };
 onValidation({
 ...result,
 strength,
 });
 });
 }

 onValidation({
 ...result,
 complexity: failedValidationsComplexity,
 });
 };
};

export const usePassword = (config: UsePasswordConfig, callbacks?: UsePasswordCbs) => {
 const { t, locale } = useLocalizations();
 const {
Expand Down

81 changes: 3 additions & 78 deletions
packages/clerk-js/src/ui/hooks/usePasswordComplexity.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,49 +1,12 @@
import type { PasswordSettingsData } from '@clerk/types';
import { useCallback, useEffect, useMemo, useState } from 'react';

import type { ComplexityErrors, UsePasswordComplexityConfig } from '../../utils/passwords/complexity';
import { validate } from '../../utils/passwords/complexity';
import type { LocalizationKey } from '../localization';
import { localizationKeys, useLocalizations } from '../localization';
import { addFullStop, createListFormat } from '../utils';

export type ComplexityErrors = {
 [key in keyof Partial<Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>>]?: boolean;
};

type UsePasswordComplexityConfig = Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>;

const createTestComplexityCases = (config: Pick<UsePasswordComplexityConfig, 'allowed_special_characters'>) => {
 let specialCharsRegex: RegExp;
 if (config.allowed_special_characters) {
 // Avoid a nested group by escaping the `[]` characters
 let escaped = config.allowed_special_characters.replace('[', '\\[');
 escaped = escaped.replace(']', '\\]');
 specialCharsRegex = new RegExp(`[${escaped}]`);
 } else {
 specialCharsRegex = /[!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]/;
 }

 return (
 password: string,
 {
 minLength,
 maxLength,
 }: {
 minLength: number;
 maxLength: number;
 },
 ) => {
 return {
 max_length: password.length < maxLength,
 min_length: password.length >= minLength,
 require_numbers: /\d/.test(password),
 require_lowercase: /[a-z]/.test(password),
 require_uppercase: /[A-Z]/.test(password),
 require_special_char: specialCharsRegex.test(password),
 };
 };
};

const errorMessages = {
const errorMessages: Record<keyof Omit<ComplexityErrors, 'allowed_special_characters'>, [string, string] | string> = {
 max_length: ['unstable__errors.passwordComplexity.maximumLength', 'length'],
 min_length: ['unstable__errors.passwordComplexity.minimumLength', 'length'],
 require_numbers: 'unstable__errors.passwordComplexity.requireNumbers',
Expand DownExpand Up@@ -89,44 +52,6 @@ export const generateErrorTextUtil = ({
 );
};

const validate = (password: string, config: UsePasswordComplexityConfig): ComplexityErrors => {
 const { max_length, min_length, require_special_char, require_lowercase, require_numbers, require_uppercase } =
 config;
 const testComplexityCases = createTestComplexityCases(config);
 const testCases = testComplexityCases(password, {
 maxLength: config.max_length,
 minLength: config.min_length,
 });

 const keys = {
 max_length,
 min_length,
 require_special_char,
 require_numbers,
 require_lowercase,
 require_uppercase,
 };

 const _validationsFailedMap = new Map();
 for (const k in keys) {
 const key = k as keyof typeof keys;

 if (!keys[key]) {
 continue;
 }

 if (!testCases[key]) {
 _validationsFailedMap.set(key, true);
 }
 }

 return Object.freeze(Object.fromEntries(_validationsFailedMap));
};

export const createValidateComplexity = (config: UsePasswordComplexityConfig) => {
 return (password: string) => validate(password, config);
};

export const usePasswordComplexity = (config: UsePasswordComplexityConfig) => {
 const [password, _setPassword] = useState('');
 const [failedValidations, setFailedValidations] = useState<ComplexityErrors>();
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/utils/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,5 +19,4 @@ export * from './roleLocalizationKey';
export * from './getRelativeToNowDateKey';
export * from './mergeRefs';
export * from './createSlug';
export * from './zxcvbn';
export * from './passwordUtils';

80 changes: 80 additions & 0 deletions
packages/clerk-js/src/utils/passwords/complexity.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
import type { PasswordSettingsData } from '@clerk/types';

export type ComplexityErrors = {
 [key in keyof Partial<Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>>]?: boolean;
};

export type UsePasswordComplexityConfig = Omit<
 PasswordSettingsData,
 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'
>;

const createTestComplexityCases = (config: Pick<UsePasswordComplexityConfig, 'allowed_special_characters'>) => {
 let specialCharsRegex: RegExp;
 if (config.allowed_special_characters) {
 // Avoid a nested group by escaping the `[]` characters
 let escaped = config.allowed_special_characters.replace('[', '\\[');
 escaped = escaped.replace(']', '\\]');
 specialCharsRegex = new RegExp(`[${escaped}]`);
 } else {
 specialCharsRegex = /[!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]/;
 }

 return (
 password: string,
 {
 minLength,
 maxLength,
 }: {
 minLength: number;
 maxLength: number;
 },
 ) => {
 return {
 max_length: password.length < maxLength,
 min_length: password.length >= minLength,
 require_numbers: /\d/.test(password),
 require_lowercase: /[a-z]/.test(password),
 require_uppercase: /[A-Z]/.test(password),
 require_special_char: specialCharsRegex.test(password),
 };
 };
};

export const validate = (password: string, config: UsePasswordComplexityConfig): ComplexityErrors => {
 const { max_length, min_length, require_special_char, require_lowercase, require_numbers, require_uppercase } =
 config;
 const testComplexityCases = createTestComplexityCases(config);
 const testCases = testComplexityCases(password, {
 maxLength: config.max_length,
 minLength: config.min_length,
 });

 const keys = {
 max_length,
 min_length,
 require_special_char,
 require_lowercase,
 require_numbers,
 require_uppercase,
 };

 const _validationsFailedMap = new Map();
 for (const k in keys) {
 const key = k as keyof typeof keys;

 if (!keys[key]) {
 continue;
 }

 if (!testCases[key]) {
 _validationsFailedMap.set(key, true);
 }
 }

 return Object.freeze(Object.fromEntries(_validationsFailedMap));
};

export const createValidateComplexity = (config: UsePasswordComplexityConfig) => {
 return (password: string) => validate(password, config);
};
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Introduce validatePassword for SignIn and SignUp resources#1445

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

panteliselef
merged 3 commits into

from

Aug 9, 2023
 Merged


Introduce validatePassword for SignIn and SignUp resources
#1445
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8fd9843

feat(clerk-js): Expose password validation from SignIn and SignUp res…


panteliselef Jun 18, 2023
feb492d

chore(clerk-js): Use ZxcvbnResult from `@types`


panteliselef Jun 18, 2023
e4c03a1

chore(repo): Example usage password validation in custom flows


panteliselef Jun 18, 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


7 changes: 7 additions & 0 deletions
.changeset/nice-experts-hope.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

Introducing validatePassword for SignIn and SignUp resources
- Validate a password based on the instance's configuration set in Password Policies in Dashboard 

10 changes: 10 additions & 0 deletions
packages/clerk-js/src/core/resources/SignIn.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ import type {
} from '@clerk/types';

import { generateSignatureWithMetamask, getMetamaskIdentifier, windowNavigate } from '../../utils';
import { createValidatePassword } from '../../utils/passwords/password';
import {
 clerkInvalidFAPIResponse,
 clerkInvalidStrategy,
Expand DownExpand Up@@ -234,6 +235,15 @@ export class SignIn extends BaseResource implements SignInResource {
 });
 };

 validatePassword: ReturnType<typeof createValidatePassword> = (password, cb) => {
 if (SignIn.clerk.__unstable__environment?.userSettings.passwordSettings) {
 return createValidatePassword({
 ...(SignIn.clerk.__unstable__environment?.userSettings.passwordSettings as any),
 validatePassword: true,
 })(password, cb);
 }
 };

 protected fromJSON(data: SignInJSON | null): this {
 if (data) {
 this.id = data.id;
Expand Down

10 changes: 10 additions & 0 deletions
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@ import type {
} from '@clerk/types';

import { generateSignatureWithMetamask, getCaptchaToken, getMetamaskIdentifier, windowNavigate } from '../../utils';
import { createValidatePassword } from '../../utils/passwords/password';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import {
 clerkInvalidFAPIResponse,
Expand DownExpand Up@@ -230,6 +231,15 @@ export class SignUp extends BaseResource implements SignUpResource {
 });
 };

 validatePassword: ReturnType<typeof createValidatePassword> = (password, cb) => {
 if (SignUp.clerk.__unstable__environment?.userSettings.passwordSettings) {
 return createValidatePassword({
 ...(SignUp.clerk.__unstable__environment?.userSettings.passwordSettings as any),
 validatePassword: true,
 })(password, cb);
 }
 };

 protected fromJSON(data: SignUpJSON | null): this {
 if (data) {
 this.id = data.id;
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/hooks/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,6 @@ export * from './useEnabledThirdPartyProviders';
export * from './useLoadingStatus';
export * from './usePassword';
export * from './usePasswordComplexity';
export * from './usePasswordStrength';
export * from './usePopover';
export * from './usePrefersReducedMotion';
export * from './useLocalStorage';
Expand Down

81 changes: 4 additions & 77 deletions
packages/clerk-js/src/ui/hooks/usePassword.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,88 +1,15 @@
import { noop } from '@clerk/shared';
import type { PasswordSettingsData } from '@clerk/types';
import type { PasswordValidation } from '@clerk/types';
import { useCallback, useMemo } from 'react';

import type { UsePasswordCbs, UsePasswordConfig } from '../../utils/passwords/password';
import { createValidatePassword } from '../../utils/passwords/password';
import { localizationKeys, useLocalizations } from '../localization';
import type { FormControlState } from '../utils';
import { loadZxcvbn } from '../utils';
import type { ComplexityErrors } from './usePasswordComplexity';
import { createValidateComplexity, generateErrorTextUtil } from './usePasswordComplexity';
import type { PasswordStrength } from './usePasswordStrength';
import { createValidatePasswordStrength } from './usePasswordStrength';

type UsePasswordConfig = PasswordSettingsData & {
 validatePassword: boolean;
};

type PasswordValidation = {
 complexity?: ComplexityErrors;
 strength?: PasswordStrength;
};

type UsePasswordCbs = {
 onValidationFailed?: (errorMessage: string | undefined) => void;
 onValidationSuccess?: () => void;
 onValidationWarning?: (warningMessage: string) => void;
 onValidationComplexity?: (b: boolean) => void;
};

type ValidatePasswordCbs = {
 onValidation?: (res: PasswordValidation) => void;
 onValidationComplexity?: (b: boolean) => void;
};
import { generateErrorTextUtil } from './usePasswordComplexity';

export const MIN_PASSWORD_LENGTH = 8;

const createValidatePassword = (config: UsePasswordConfig, callbacks?: ValidatePasswordCbs) => {
 const { onValidation = noop, onValidationComplexity = noop } = callbacks || {};
 const { show_zxcvbn, validatePassword: validatePasswordProp } = config;
 const getComplexity = createValidateComplexity(config);
 const getScore = createValidatePasswordStrength(config);
 let result = {} satisfies PasswordValidation;

 return (password: string) => {
 if (!validatePasswordProp) {
 return;
 }

 /**
 * Validate Complexity
 */
 const failedValidationsComplexity = getComplexity(password);
 onValidationComplexity(Object.keys(failedValidationsComplexity).length === 0);
 result = {
 ...result,
 complexity: failedValidationsComplexity,
 };
 /**
 * Validate score
 */
 if (show_zxcvbn) {
 /**
 * Lazy load zxcvbn without preventing a complexityError to be thrown if it exists
 */
 void loadZxcvbn().then(zxcvbn => {
 const setPasswordScore = getScore(zxcvbn);
 const strength = setPasswordScore(password);

 result = {
 ...result,
 strength,
 };
 onValidation({
 ...result,
 strength,
 });
 });
 }

 onValidation({
 ...result,
 complexity: failedValidationsComplexity,
 });
 };
};

export const usePassword = (config: UsePasswordConfig, callbacks?: UsePasswordCbs) => {
 const { t, locale } = useLocalizations();
 const {
Expand Down

81 changes: 3 additions & 78 deletions
packages/clerk-js/src/ui/hooks/usePasswordComplexity.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,49 +1,12 @@
import type { PasswordSettingsData } from '@clerk/types';
import { useCallback, useEffect, useMemo, useState } from 'react';

import type { ComplexityErrors, UsePasswordComplexityConfig } from '../../utils/passwords/complexity';
import { validate } from '../../utils/passwords/complexity';
import type { LocalizationKey } from '../localization';
import { localizationKeys, useLocalizations } from '../localization';
import { addFullStop, createListFormat } from '../utils';

export type ComplexityErrors = {
 [key in keyof Partial<Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>>]?: boolean;
};

type UsePasswordComplexityConfig = Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>;

const createTestComplexityCases = (config: Pick<UsePasswordComplexityConfig, 'allowed_special_characters'>) => {
 let specialCharsRegex: RegExp;
 if (config.allowed_special_characters) {
 // Avoid a nested group by escaping the `[]` characters
 let escaped = config.allowed_special_characters.replace('[', '\\[');
 escaped = escaped.replace(']', '\\]');
 specialCharsRegex = new RegExp(`[${escaped}]`);
 } else {
 specialCharsRegex = /[!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]/;
 }

 return (
 password: string,
 {
 minLength,
 maxLength,
 }: {
 minLength: number;
 maxLength: number;
 },
 ) => {
 return {
 max_length: password.length < maxLength,
 min_length: password.length >= minLength,
 require_numbers: /\d/.test(password),
 require_lowercase: /[a-z]/.test(password),
 require_uppercase: /[A-Z]/.test(password),
 require_special_char: specialCharsRegex.test(password),
 };
 };
};

const errorMessages = {
const errorMessages: Record<keyof Omit<ComplexityErrors, 'allowed_special_characters'>, [string, string] | string> = {
 max_length: ['unstable__errors.passwordComplexity.maximumLength', 'length'],
 min_length: ['unstable__errors.passwordComplexity.minimumLength', 'length'],
 require_numbers: 'unstable__errors.passwordComplexity.requireNumbers',
Expand DownExpand Up@@ -89,44 +52,6 @@ export const generateErrorTextUtil = ({
 );
};

const validate = (password: string, config: UsePasswordComplexityConfig): ComplexityErrors => {
 const { max_length, min_length, require_special_char, require_lowercase, require_numbers, require_uppercase } =
 config;
 const testComplexityCases = createTestComplexityCases(config);
 const testCases = testComplexityCases(password, {
 maxLength: config.max_length,
 minLength: config.min_length,
 });

 const keys = {
 max_length,
 min_length,
 require_special_char,
 require_numbers,
 require_lowercase,
 require_uppercase,
 };

 const _validationsFailedMap = new Map();
 for (const k in keys) {
 const key = k as keyof typeof keys;

 if (!keys[key]) {
 continue;
 }

 if (!testCases[key]) {
 _validationsFailedMap.set(key, true);
 }
 }

 return Object.freeze(Object.fromEntries(_validationsFailedMap));
};

export const createValidateComplexity = (config: UsePasswordComplexityConfig) => {
 return (password: string) => validate(password, config);
};

export const usePasswordComplexity = (config: UsePasswordComplexityConfig) => {
 const [password, _setPassword] = useState('');
 const [failedValidations, setFailedValidations] = useState<ComplexityErrors>();
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/utils/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,5 +19,4 @@ export * from './roleLocalizationKey';
export * from './getRelativeToNowDateKey';
export * from './mergeRefs';
export * from './createSlug';
export * from './zxcvbn';
export * from './passwordUtils';

80 changes: 80 additions & 0 deletions
packages/clerk-js/src/utils/passwords/complexity.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
import type { PasswordSettingsData } from '@clerk/types';

export type ComplexityErrors = {
 [key in keyof Partial<Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>>]?: boolean;
};

export type UsePasswordComplexityConfig = Omit<
 PasswordSettingsData,
 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'
>;

const createTestComplexityCases = (config: Pick<UsePasswordComplexityConfig, 'allowed_special_characters'>) => {
 let specialCharsRegex: RegExp;
 if (config.allowed_special_characters) {
 // Avoid a nested group by escaping the `[]` characters
 let escaped = config.allowed_special_characters.replace('[', '\\[');
 escaped = escaped.replace(']', '\\]');
 specialCharsRegex = new RegExp(`[${escaped}]`);
 } else {
 specialCharsRegex = /[!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]/;
 }

 return (
 password: string,
 {
 minLength,
 maxLength,
 }: {
 minLength: number;
 maxLength: number;
 },
 ) => {
 return {
 max_length: password.length < maxLength,
 min_length: password.length >= minLength,
 require_numbers: /\d/.test(password),
 require_lowercase: /[a-z]/.test(password),
 require_uppercase: /[A-Z]/.test(password),
 require_special_char: specialCharsRegex.test(password),
 };
 };
};

export const validate = (password: string, config: UsePasswordComplexityConfig): ComplexityErrors => {
 const { max_length, min_length, require_special_char, require_lowercase, require_numbers, require_uppercase } =
 config;
 const testComplexityCases = createTestComplexityCases(config);
 const testCases = testComplexityCases(password, {
 maxLength: config.max_length,
 minLength: config.min_length,
 });

 const keys = {
 max_length,
 min_length,
 require_special_char,
 require_lowercase,
 require_numbers,
 require_uppercase,
 };

 const _validationsFailedMap = new Map();
 for (const k in keys) {
 const key = k as keyof typeof keys;

 if (!keys[key]) {
 continue;
 }

 if (!testCases[key]) {
 _validationsFailedMap.set(key, true);
 }
 }

 return Object.freeze(Object.fromEntries(_validationsFailedMap));
};

export const createValidateComplexity = (config: UsePasswordComplexityConfig) => {
 return (password: string) => validate(password, config);
};
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Introduce validatePassword for SignIn and SignUp resources#1445

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

panteliselef
merged 3 commits into

from

Aug 9, 2023
 Merged


Introduce validatePassword for SignIn and SignUp resources
#1445
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8fd9843

feat(clerk-js): Expose password validation from SignIn and SignUp res…


panteliselef Jun 18, 2023
feb492d

chore(clerk-js): Use ZxcvbnResult from `@types`


panteliselef Jun 18, 2023
e4c03a1

chore(repo): Example usage password validation in custom flows


panteliselef Jun 18, 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


7 changes: 7 additions & 0 deletions
.changeset/nice-experts-hope.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

Introducing validatePassword for SignIn and SignUp resources
- Validate a password based on the instance's configuration set in Password Policies in Dashboard 

10 changes: 10 additions & 0 deletions
packages/clerk-js/src/core/resources/SignIn.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ import type {
} from '@clerk/types';

import { generateSignatureWithMetamask, getMetamaskIdentifier, windowNavigate } from '../../utils';
import { createValidatePassword } from '../../utils/passwords/password';
import {
 clerkInvalidFAPIResponse,
 clerkInvalidStrategy,
Expand DownExpand Up@@ -234,6 +235,15 @@ export class SignIn extends BaseResource implements SignInResource {
 });
 };

 validatePassword: ReturnType<typeof createValidatePassword> = (password, cb) => {
 if (SignIn.clerk.__unstable__environment?.userSettings.passwordSettings) {
 return createValidatePassword({
 ...(SignIn.clerk.__unstable__environment?.userSettings.passwordSettings as any),
 validatePassword: true,
 })(password, cb);
 }
 };

 protected fromJSON(data: SignInJSON | null): this {
 if (data) {
 this.id = data.id;
Expand Down

10 changes: 10 additions & 0 deletions
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@ import type {
} from '@clerk/types';

import { generateSignatureWithMetamask, getCaptchaToken, getMetamaskIdentifier, windowNavigate } from '../../utils';
import { createValidatePassword } from '../../utils/passwords/password';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import {
 clerkInvalidFAPIResponse,
Expand DownExpand Up@@ -230,6 +231,15 @@ export class SignUp extends BaseResource implements SignUpResource {
 });
 };

 validatePassword: ReturnType<typeof createValidatePassword> = (password, cb) => {
 if (SignUp.clerk.__unstable__environment?.userSettings.passwordSettings) {
 return createValidatePassword({
 ...(SignUp.clerk.__unstable__environment?.userSettings.passwordSettings as any),
 validatePassword: true,
 })(password, cb);
 }
 };

 protected fromJSON(data: SignUpJSON | null): this {
 if (data) {
 this.id = data.id;
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/hooks/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,6 @@ export * from './useEnabledThirdPartyProviders';
export * from './useLoadingStatus';
export * from './usePassword';
export * from './usePasswordComplexity';
export * from './usePasswordStrength';
export * from './usePopover';
export * from './usePrefersReducedMotion';
export * from './useLocalStorage';
Expand Down

81 changes: 4 additions & 77 deletions
packages/clerk-js/src/ui/hooks/usePassword.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,88 +1,15 @@
import { noop } from '@clerk/shared';
import type { PasswordSettingsData } from '@clerk/types';
import type { PasswordValidation } from '@clerk/types';
import { useCallback, useMemo } from 'react';

import type { UsePasswordCbs, UsePasswordConfig } from '../../utils/passwords/password';
import { createValidatePassword } from '../../utils/passwords/password';
import { localizationKeys, useLocalizations } from '../localization';
import type { FormControlState } from '../utils';
import { loadZxcvbn } from '../utils';
import type { ComplexityErrors } from './usePasswordComplexity';
import { createValidateComplexity, generateErrorTextUtil } from './usePasswordComplexity';
import type { PasswordStrength } from './usePasswordStrength';
import { createValidatePasswordStrength } from './usePasswordStrength';

type UsePasswordConfig = PasswordSettingsData & {
 validatePassword: boolean;
};

type PasswordValidation = {
 complexity?: ComplexityErrors;
 strength?: PasswordStrength;
};

type UsePasswordCbs = {
 onValidationFailed?: (errorMessage: string | undefined) => void;
 onValidationSuccess?: () => void;
 onValidationWarning?: (warningMessage: string) => void;
 onValidationComplexity?: (b: boolean) => void;
};

type ValidatePasswordCbs = {
 onValidation?: (res: PasswordValidation) => void;
 onValidationComplexity?: (b: boolean) => void;
};
import { generateErrorTextUtil } from './usePasswordComplexity';

export const MIN_PASSWORD_LENGTH = 8;

const createValidatePassword = (config: UsePasswordConfig, callbacks?: ValidatePasswordCbs) => {
 const { onValidation = noop, onValidationComplexity = noop } = callbacks || {};
 const { show_zxcvbn, validatePassword: validatePasswordProp } = config;
 const getComplexity = createValidateComplexity(config);
 const getScore = createValidatePasswordStrength(config);
 let result = {} satisfies PasswordValidation;

 return (password: string) => {
 if (!validatePasswordProp) {
 return;
 }

 /**
 * Validate Complexity
 */
 const failedValidationsComplexity = getComplexity(password);
 onValidationComplexity(Object.keys(failedValidationsComplexity).length === 0);
 result = {
 ...result,
 complexity: failedValidationsComplexity,
 };
 /**
 * Validate score
 */
 if (show_zxcvbn) {
 /**
 * Lazy load zxcvbn without preventing a complexityError to be thrown if it exists
 */
 void loadZxcvbn().then(zxcvbn => {
 const setPasswordScore = getScore(zxcvbn);
 const strength = setPasswordScore(password);

 result = {
 ...result,
 strength,
 };
 onValidation({
 ...result,
 strength,
 });
 });
 }

 onValidation({
 ...result,
 complexity: failedValidationsComplexity,
 });
 };
};

export const usePassword = (config: UsePasswordConfig, callbacks?: UsePasswordCbs) => {
 const { t, locale } = useLocalizations();
 const {
Expand Down

81 changes: 3 additions & 78 deletions
packages/clerk-js/src/ui/hooks/usePasswordComplexity.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,49 +1,12 @@
import type { PasswordSettingsData } from '@clerk/types';
import { useCallback, useEffect, useMemo, useState } from 'react';

import type { ComplexityErrors, UsePasswordComplexityConfig } from '../../utils/passwords/complexity';
import { validate } from '../../utils/passwords/complexity';
import type { LocalizationKey } from '../localization';
import { localizationKeys, useLocalizations } from '../localization';
import { addFullStop, createListFormat } from '../utils';

export type ComplexityErrors = {
 [key in keyof Partial<Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>>]?: boolean;
};

type UsePasswordComplexityConfig = Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>;

const createTestComplexityCases = (config: Pick<UsePasswordComplexityConfig, 'allowed_special_characters'>) => {
 let specialCharsRegex: RegExp;
 if (config.allowed_special_characters) {
 // Avoid a nested group by escaping the `[]` characters
 let escaped = config.allowed_special_characters.replace('[', '\\[');
 escaped = escaped.replace(']', '\\]');
 specialCharsRegex = new RegExp(`[${escaped}]`);
 } else {
 specialCharsRegex = /[!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]/;
 }

 return (
 password: string,
 {
 minLength,
 maxLength,
 }: {
 minLength: number;
 maxLength: number;
 },
 ) => {
 return {
 max_length: password.length < maxLength,
 min_length: password.length >= minLength,
 require_numbers: /\d/.test(password),
 require_lowercase: /[a-z]/.test(password),
 require_uppercase: /[A-Z]/.test(password),
 require_special_char: specialCharsRegex.test(password),
 };
 };
};

const errorMessages = {
const errorMessages: Record<keyof Omit<ComplexityErrors, 'allowed_special_characters'>, [string, string] | string> = {
 max_length: ['unstable__errors.passwordComplexity.maximumLength', 'length'],
 min_length: ['unstable__errors.passwordComplexity.minimumLength', 'length'],
 require_numbers: 'unstable__errors.passwordComplexity.requireNumbers',
Expand DownExpand Up@@ -89,44 +52,6 @@ export const generateErrorTextUtil = ({
 );
};

const validate = (password: string, config: UsePasswordComplexityConfig): ComplexityErrors => {
 const { max_length, min_length, require_special_char, require_lowercase, require_numbers, require_uppercase } =
 config;
 const testComplexityCases = createTestComplexityCases(config);
 const testCases = testComplexityCases(password, {
 maxLength: config.max_length,
 minLength: config.min_length,
 });

 const keys = {
 max_length,
 min_length,
 require_special_char,
 require_numbers,
 require_lowercase,
 require_uppercase,
 };

 const _validationsFailedMap = new Map();
 for (const k in keys) {
 const key = k as keyof typeof keys;

 if (!keys[key]) {
 continue;
 }

 if (!testCases[key]) {
 _validationsFailedMap.set(key, true);
 }
 }

 return Object.freeze(Object.fromEntries(_validationsFailedMap));
};

export const createValidateComplexity = (config: UsePasswordComplexityConfig) => {
 return (password: string) => validate(password, config);
};

export const usePasswordComplexity = (config: UsePasswordComplexityConfig) => {
 const [password, _setPassword] = useState('');
 const [failedValidations, setFailedValidations] = useState<ComplexityErrors>();
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/utils/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,5 +19,4 @@ export * from './roleLocalizationKey';
export * from './getRelativeToNowDateKey';
export * from './mergeRefs';
export * from './createSlug';
export * from './zxcvbn';
export * from './passwordUtils';

80 changes: 80 additions & 0 deletions
packages/clerk-js/src/utils/passwords/complexity.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
import type { PasswordSettingsData } from '@clerk/types';

export type ComplexityErrors = {
 [key in keyof Partial<Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>>]?: boolean;
};

export type UsePasswordComplexityConfig = Omit<
 PasswordSettingsData,
 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'
>;

const createTestComplexityCases = (config: Pick<UsePasswordComplexityConfig, 'allowed_special_characters'>) => {
 let specialCharsRegex: RegExp;
 if (config.allowed_special_characters) {
 // Avoid a nested group by escaping the `[]` characters
 let escaped = config.allowed_special_characters.replace('[', '\\[');
 escaped = escaped.replace(']', '\\]');
 specialCharsRegex = new RegExp(`[${escaped}]`);
 } else {
 specialCharsRegex = /[!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]/;
 }

 return (
 password: string,
 {
 minLength,
 maxLength,
 }: {
 minLength: number;
 maxLength: number;
 },
 ) => {
 return {
 max_length: password.length < maxLength,
 min_length: password.length >= minLength,
 require_numbers: /\d/.test(password),
 require_lowercase: /[a-z]/.test(password),
 require_uppercase: /[A-Z]/.test(password),
 require_special_char: specialCharsRegex.test(password),
 };
 };
};

export const validate = (password: string, config: UsePasswordComplexityConfig): ComplexityErrors => {
 const { max_length, min_length, require_special_char, require_lowercase, require_numbers, require_uppercase } =
 config;
 const testComplexityCases = createTestComplexityCases(config);
 const testCases = testComplexityCases(password, {
 maxLength: config.max_length,
 minLength: config.min_length,
 });

 const keys = {
 max_length,
 min_length,
 require_special_char,
 require_lowercase,
 require_numbers,
 require_uppercase,
 };

 const _validationsFailedMap = new Map();
 for (const k in keys) {
 const key = k as keyof typeof keys;

 if (!keys[key]) {
 continue;
 }

 if (!testCases[key]) {
 _validationsFailedMap.set(key, true);
 }
 }

 return Object.freeze(Object.fromEntries(_validationsFailedMap));
};

export const createValidateComplexity = (config: UsePasswordComplexityConfig) => {
 return (password: string) => validate(password, config);
};
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Introduce validatePassword for SignIn and SignUp resources#1445

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

panteliselef
merged 3 commits into

from

Aug 9, 2023
 Merged


Introduce validatePassword for SignIn and SignUp resources
#1445
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8fd9843

feat(clerk-js): Expose password validation from SignIn and SignUp res…


panteliselef Jun 18, 2023
feb492d

chore(clerk-js): Use ZxcvbnResult from `@types`


panteliselef Jun 18, 2023
e4c03a1

chore(repo): Example usage password validation in custom flows


panteliselef Jun 18, 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


7 changes: 7 additions & 0 deletions
.changeset/nice-experts-hope.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

Introducing validatePassword for SignIn and SignUp resources
- Validate a password based on the instance's configuration set in Password Policies in Dashboard 

10 changes: 10 additions & 0 deletions
packages/clerk-js/src/core/resources/SignIn.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ import type {
} from '@clerk/types';

import { generateSignatureWithMetamask, getMetamaskIdentifier, windowNavigate } from '../../utils';
import { createValidatePassword } from '../../utils/passwords/password';
import {
 clerkInvalidFAPIResponse,
 clerkInvalidStrategy,
Expand DownExpand Up@@ -234,6 +235,15 @@ export class SignIn extends BaseResource implements SignInResource {
 });
 };

 validatePassword: ReturnType<typeof createValidatePassword> = (password, cb) => {
 if (SignIn.clerk.__unstable__environment?.userSettings.passwordSettings) {
 return createValidatePassword({
 ...(SignIn.clerk.__unstable__environment?.userSettings.passwordSettings as any),
 validatePassword: true,
 })(password, cb);
 }
 };

 protected fromJSON(data: SignInJSON | null): this {
 if (data) {
 this.id = data.id;
Expand Down

10 changes: 10 additions & 0 deletions
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@ import type {
} from '@clerk/types';

import { generateSignatureWithMetamask, getCaptchaToken, getMetamaskIdentifier, windowNavigate } from '../../utils';
import { createValidatePassword } from '../../utils/passwords/password';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import {
 clerkInvalidFAPIResponse,
Expand DownExpand Up@@ -230,6 +231,15 @@ export class SignUp extends BaseResource implements SignUpResource {
 });
 };

 validatePassword: ReturnType<typeof createValidatePassword> = (password, cb) => {
 if (SignUp.clerk.__unstable__environment?.userSettings.passwordSettings) {
 return createValidatePassword({
 ...(SignUp.clerk.__unstable__environment?.userSettings.passwordSettings as any),
 validatePassword: true,
 })(password, cb);
 }
 };

 protected fromJSON(data: SignUpJSON | null): this {
 if (data) {
 this.id = data.id;
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/hooks/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,6 @@ export * from './useEnabledThirdPartyProviders';
export * from './useLoadingStatus';
export * from './usePassword';
export * from './usePasswordComplexity';
export * from './usePasswordStrength';
export * from './usePopover';
export * from './usePrefersReducedMotion';
export * from './useLocalStorage';
Expand Down

81 changes: 4 additions & 77 deletions
packages/clerk-js/src/ui/hooks/usePassword.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,88 +1,15 @@
import { noop } from '@clerk/shared';
import type { PasswordSettingsData } from '@clerk/types';
import type { PasswordValidation } from '@clerk/types';
import { useCallback, useMemo } from 'react';

import type { UsePasswordCbs, UsePasswordConfig } from '../../utils/passwords/password';
import { createValidatePassword } from '../../utils/passwords/password';
import { localizationKeys, useLocalizations } from '../localization';
import type { FormControlState } from '../utils';
import { loadZxcvbn } from '../utils';
import type { ComplexityErrors } from './usePasswordComplexity';
import { createValidateComplexity, generateErrorTextUtil } from './usePasswordComplexity';
import type { PasswordStrength } from './usePasswordStrength';
import { createValidatePasswordStrength } from './usePasswordStrength';

type UsePasswordConfig = PasswordSettingsData & {
 validatePassword: boolean;
};

type PasswordValidation = {
 complexity?: ComplexityErrors;
 strength?: PasswordStrength;
};

type UsePasswordCbs = {
 onValidationFailed?: (errorMessage: string | undefined) => void;
 onValidationSuccess?: () => void;
 onValidationWarning?: (warningMessage: string) => void;
 onValidationComplexity?: (b: boolean) => void;
};

type ValidatePasswordCbs = {
 onValidation?: (res: PasswordValidation) => void;
 onValidationComplexity?: (b: boolean) => void;
};
import { generateErrorTextUtil } from './usePasswordComplexity';

export const MIN_PASSWORD_LENGTH = 8;

const createValidatePassword = (config: UsePasswordConfig, callbacks?: ValidatePasswordCbs) => {
 const { onValidation = noop, onValidationComplexity = noop } = callbacks || {};
 const { show_zxcvbn, validatePassword: validatePasswordProp } = config;
 const getComplexity = createValidateComplexity(config);
 const getScore = createValidatePasswordStrength(config);
 let result = {} satisfies PasswordValidation;

 return (password: string) => {
 if (!validatePasswordProp) {
 return;
 }

 /**
 * Validate Complexity
 */
 const failedValidationsComplexity = getComplexity(password);
 onValidationComplexity(Object.keys(failedValidationsComplexity).length === 0);
 result = {
 ...result,
 complexity: failedValidationsComplexity,
 };
 /**
 * Validate score
 */
 if (show_zxcvbn) {
 /**
 * Lazy load zxcvbn without preventing a complexityError to be thrown if it exists
 */
 void loadZxcvbn().then(zxcvbn => {
 const setPasswordScore = getScore(zxcvbn);
 const strength = setPasswordScore(password);

 result = {
 ...result,
 strength,
 };
 onValidation({
 ...result,
 strength,
 });
 });
 }

 onValidation({
 ...result,
 complexity: failedValidationsComplexity,
 });
 };
};

export const usePassword = (config: UsePasswordConfig, callbacks?: UsePasswordCbs) => {
 const { t, locale } = useLocalizations();
 const {
Expand Down

81 changes: 3 additions & 78 deletions
packages/clerk-js/src/ui/hooks/usePasswordComplexity.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,49 +1,12 @@
import type { PasswordSettingsData } from '@clerk/types';
import { useCallback, useEffect, useMemo, useState } from 'react';

import type { ComplexityErrors, UsePasswordComplexityConfig } from '../../utils/passwords/complexity';
import { validate } from '../../utils/passwords/complexity';
import type { LocalizationKey } from '../localization';
import { localizationKeys, useLocalizations } from '../localization';
import { addFullStop, createListFormat } from '../utils';

export type ComplexityErrors = {
 [key in keyof Partial<Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>>]?: boolean;
};

type UsePasswordComplexityConfig = Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>;

const createTestComplexityCases = (config: Pick<UsePasswordComplexityConfig, 'allowed_special_characters'>) => {
 let specialCharsRegex: RegExp;
 if (config.allowed_special_characters) {
 // Avoid a nested group by escaping the `[]` characters
 let escaped = config.allowed_special_characters.replace('[', '\\[');
 escaped = escaped.replace(']', '\\]');
 specialCharsRegex = new RegExp(`[${escaped}]`);
 } else {
 specialCharsRegex = /[!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]/;
 }

 return (
 password: string,
 {
 minLength,
 maxLength,
 }: {
 minLength: number;
 maxLength: number;
 },
 ) => {
 return {
 max_length: password.length < maxLength,
 min_length: password.length >= minLength,
 require_numbers: /\d/.test(password),
 require_lowercase: /[a-z]/.test(password),
 require_uppercase: /[A-Z]/.test(password),
 require_special_char: specialCharsRegex.test(password),
 };
 };
};

const errorMessages = {
const errorMessages: Record<keyof Omit<ComplexityErrors, 'allowed_special_characters'>, [string, string] | string> = {
 max_length: ['unstable__errors.passwordComplexity.maximumLength', 'length'],
 min_length: ['unstable__errors.passwordComplexity.minimumLength', 'length'],
 require_numbers: 'unstable__errors.passwordComplexity.requireNumbers',
Expand DownExpand Up@@ -89,44 +52,6 @@ export const generateErrorTextUtil = ({
 );
};

const validate = (password: string, config: UsePasswordComplexityConfig): ComplexityErrors => {
 const { max_length, min_length, require_special_char, require_lowercase, require_numbers, require_uppercase } =
 config;
 const testComplexityCases = createTestComplexityCases(config);
 const testCases = testComplexityCases(password, {
 maxLength: config.max_length,
 minLength: config.min_length,
 });

 const keys = {
 max_length,
 min_length,
 require_special_char,
 require_numbers,
 require_lowercase,
 require_uppercase,
 };

 const _validationsFailedMap = new Map();
 for (const k in keys) {
 const key = k as keyof typeof keys;

 if (!keys[key]) {
 continue;
 }

 if (!testCases[key]) {
 _validationsFailedMap.set(key, true);
 }
 }

 return Object.freeze(Object.fromEntries(_validationsFailedMap));
};

export const createValidateComplexity = (config: UsePasswordComplexityConfig) => {
 return (password: string) => validate(password, config);
};

export const usePasswordComplexity = (config: UsePasswordComplexityConfig) => {
 const [password, _setPassword] = useState('');
 const [failedValidations, setFailedValidations] = useState<ComplexityErrors>();
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/utils/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,5 +19,4 @@ export * from './roleLocalizationKey';
export * from './getRelativeToNowDateKey';
export * from './mergeRefs';
export * from './createSlug';
export * from './zxcvbn';
export * from './passwordUtils';

80 changes: 80 additions & 0 deletions
packages/clerk-js/src/utils/passwords/complexity.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
import type { PasswordSettingsData } from '@clerk/types';

export type ComplexityErrors = {
 [key in keyof Partial<Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>>]?: boolean;
};

export type UsePasswordComplexityConfig = Omit<
 PasswordSettingsData,
 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'
>;

const createTestComplexityCases = (config: Pick<UsePasswordComplexityConfig, 'allowed_special_characters'>) => {
 let specialCharsRegex: RegExp;
 if (config.allowed_special_characters) {
 // Avoid a nested group by escaping the `[]` characters
 let escaped = config.allowed_special_characters.replace('[', '\\[');
 escaped = escaped.replace(']', '\\]');
 specialCharsRegex = new RegExp(`[${escaped}]`);
 } else {
 specialCharsRegex = /[!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]/;
 }

 return (
 password: string,
 {
 minLength,
 maxLength,
 }: {
 minLength: number;
 maxLength: number;
 },
 ) => {
 return {
 max_length: password.length < maxLength,
 min_length: password.length >= minLength,
 require_numbers: /\d/.test(password),
 require_lowercase: /[a-z]/.test(password),
 require_uppercase: /[A-Z]/.test(password),
 require_special_char: specialCharsRegex.test(password),
 };
 };
};

export const validate = (password: string, config: UsePasswordComplexityConfig): ComplexityErrors => {
 const { max_length, min_length, require_special_char, require_lowercase, require_numbers, require_uppercase } =
 config;
 const testComplexityCases = createTestComplexityCases(config);
 const testCases = testComplexityCases(password, {
 maxLength: config.max_length,
 minLength: config.min_length,
 });

 const keys = {
 max_length,
 min_length,
 require_special_char,
 require_lowercase,
 require_numbers,
 require_uppercase,
 };

 const _validationsFailedMap = new Map();
 for (const k in keys) {
 const key = k as keyof typeof keys;

 if (!keys[key]) {
 continue;
 }

 if (!testCases[key]) {
 _validationsFailedMap.set(key, true);
 }
 }

 return Object.freeze(Object.fromEntries(_validationsFailedMap));
};

export const createValidateComplexity = (config: UsePasswordComplexityConfig) => {
 return (password: string) => validate(password, config);
};
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Introduce validatePassword for SignIn and SignUp resources#1445

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

panteliselef
merged 3 commits into

from

Aug 9, 2023
 Merged


Introduce validatePassword for SignIn and SignUp resources
#1445
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8fd9843

feat(clerk-js): Expose password validation from SignIn and SignUp res…


panteliselef Jun 18, 2023
feb492d

chore(clerk-js): Use ZxcvbnResult from `@types`


panteliselef Jun 18, 2023
e4c03a1

chore(repo): Example usage password validation in custom flows


panteliselef Jun 18, 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


7 changes: 7 additions & 0 deletions
.changeset/nice-experts-hope.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

Introducing validatePassword for SignIn and SignUp resources
- Validate a password based on the instance's configuration set in Password Policies in Dashboard 

10 changes: 10 additions & 0 deletions
packages/clerk-js/src/core/resources/SignIn.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ import type {
} from '@clerk/types';

import { generateSignatureWithMetamask, getMetamaskIdentifier, windowNavigate } from '../../utils';
import { createValidatePassword } from '../../utils/passwords/password';
import {
 clerkInvalidFAPIResponse,
 clerkInvalidStrategy,
Expand DownExpand Up@@ -234,6 +235,15 @@ export class SignIn extends BaseResource implements SignInResource {
 });
 };

 validatePassword: ReturnType<typeof createValidatePassword> = (password, cb) => {
 if (SignIn.clerk.__unstable__environment?.userSettings.passwordSettings) {
 return createValidatePassword({
 ...(SignIn.clerk.__unstable__environment?.userSettings.passwordSettings as any),
 validatePassword: true,
 })(password, cb);
 }
 };

 protected fromJSON(data: SignInJSON | null): this {
 if (data) {
 this.id = data.id;
Expand Down

10 changes: 10 additions & 0 deletions
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@ import type {
} from '@clerk/types';

import { generateSignatureWithMetamask, getCaptchaToken, getMetamaskIdentifier, windowNavigate } from '../../utils';
import { createValidatePassword } from '../../utils/passwords/password';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import {
 clerkInvalidFAPIResponse,
Expand DownExpand Up@@ -230,6 +231,15 @@ export class SignUp extends BaseResource implements SignUpResource {
 });
 };

 validatePassword: ReturnType<typeof createValidatePassword> = (password, cb) => {
 if (SignUp.clerk.__unstable__environment?.userSettings.passwordSettings) {
 return createValidatePassword({
 ...(SignUp.clerk.__unstable__environment?.userSettings.passwordSettings as any),
 validatePassword: true,
 })(password, cb);
 }
 };

 protected fromJSON(data: SignUpJSON | null): this {
 if (data) {
 this.id = data.id;
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/hooks/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,6 @@ export * from './useEnabledThirdPartyProviders';
export * from './useLoadingStatus';
export * from './usePassword';
export * from './usePasswordComplexity';
export * from './usePasswordStrength';
export * from './usePopover';
export * from './usePrefersReducedMotion';
export * from './useLocalStorage';
Expand Down

81 changes: 4 additions & 77 deletions
packages/clerk-js/src/ui/hooks/usePassword.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,88 +1,15 @@
import { noop } from '@clerk/shared';
import type { PasswordSettingsData } from '@clerk/types';
import type { PasswordValidation } from '@clerk/types';
import { useCallback, useMemo } from 'react';

import type { UsePasswordCbs, UsePasswordConfig } from '../../utils/passwords/password';
import { createValidatePassword } from '../../utils/passwords/password';
import { localizationKeys, useLocalizations } from '../localization';
import type { FormControlState } from '../utils';
import { loadZxcvbn } from '../utils';
import type { ComplexityErrors } from './usePasswordComplexity';
import { createValidateComplexity, generateErrorTextUtil } from './usePasswordComplexity';
import type { PasswordStrength } from './usePasswordStrength';
import { createValidatePasswordStrength } from './usePasswordStrength';

type UsePasswordConfig = PasswordSettingsData & {
 validatePassword: boolean;
};

type PasswordValidation = {
 complexity?: ComplexityErrors;
 strength?: PasswordStrength;
};

type UsePasswordCbs = {
 onValidationFailed?: (errorMessage: string | undefined) => void;
 onValidationSuccess?: () => void;
 onValidationWarning?: (warningMessage: string) => void;
 onValidationComplexity?: (b: boolean) => void;
};

type ValidatePasswordCbs = {
 onValidation?: (res: PasswordValidation) => void;
 onValidationComplexity?: (b: boolean) => void;
};
import { generateErrorTextUtil } from './usePasswordComplexity';

export const MIN_PASSWORD_LENGTH = 8;

const createValidatePassword = (config: UsePasswordConfig, callbacks?: ValidatePasswordCbs) => {
 const { onValidation = noop, onValidationComplexity = noop } = callbacks || {};
 const { show_zxcvbn, validatePassword: validatePasswordProp } = config;
 const getComplexity = createValidateComplexity(config);
 const getScore = createValidatePasswordStrength(config);
 let result = {} satisfies PasswordValidation;

 return (password: string) => {
 if (!validatePasswordProp) {
 return;
 }

 /**
 * Validate Complexity
 */
 const failedValidationsComplexity = getComplexity(password);
 onValidationComplexity(Object.keys(failedValidationsComplexity).length === 0);
 result = {
 ...result,
 complexity: failedValidationsComplexity,
 };
 /**
 * Validate score
 */
 if (show_zxcvbn) {
 /**
 * Lazy load zxcvbn without preventing a complexityError to be thrown if it exists
 */
 void loadZxcvbn().then(zxcvbn => {
 const setPasswordScore = getScore(zxcvbn);
 const strength = setPasswordScore(password);

 result = {
 ...result,
 strength,
 };
 onValidation({
 ...result,
 strength,
 });
 });
 }

 onValidation({
 ...result,
 complexity: failedValidationsComplexity,
 });
 };
};

export const usePassword = (config: UsePasswordConfig, callbacks?: UsePasswordCbs) => {
 const { t, locale } = useLocalizations();
 const {
Expand Down

81 changes: 3 additions & 78 deletions
packages/clerk-js/src/ui/hooks/usePasswordComplexity.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,49 +1,12 @@
import type { PasswordSettingsData } from '@clerk/types';
import { useCallback, useEffect, useMemo, useState } from 'react';

import type { ComplexityErrors, UsePasswordComplexityConfig } from '../../utils/passwords/complexity';
import { validate } from '../../utils/passwords/complexity';
import type { LocalizationKey } from '../localization';
import { localizationKeys, useLocalizations } from '../localization';
import { addFullStop, createListFormat } from '../utils';

export type ComplexityErrors = {
 [key in keyof Partial<Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>>]?: boolean;
};

type UsePasswordComplexityConfig = Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>;

const createTestComplexityCases = (config: Pick<UsePasswordComplexityConfig, 'allowed_special_characters'>) => {
 let specialCharsRegex: RegExp;
 if (config.allowed_special_characters) {
 // Avoid a nested group by escaping the `[]` characters
 let escaped = config.allowed_special_characters.replace('[', '\\[');
 escaped = escaped.replace(']', '\\]');
 specialCharsRegex = new RegExp(`[${escaped}]`);
 } else {
 specialCharsRegex = /[!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]/;
 }

 return (
 password: string,
 {
 minLength,
 maxLength,
 }: {
 minLength: number;
 maxLength: number;
 },
 ) => {
 return {
 max_length: password.length < maxLength,
 min_length: password.length >= minLength,
 require_numbers: /\d/.test(password),
 require_lowercase: /[a-z]/.test(password),
 require_uppercase: /[A-Z]/.test(password),
 require_special_char: specialCharsRegex.test(password),
 };
 };
};

const errorMessages = {
const errorMessages: Record<keyof Omit<ComplexityErrors, 'allowed_special_characters'>, [string, string] | string> = {
 max_length: ['unstable__errors.passwordComplexity.maximumLength', 'length'],
 min_length: ['unstable__errors.passwordComplexity.minimumLength', 'length'],
 require_numbers: 'unstable__errors.passwordComplexity.requireNumbers',
Expand DownExpand Up@@ -89,44 +52,6 @@ export const generateErrorTextUtil = ({
 );
};

const validate = (password: string, config: UsePasswordComplexityConfig): ComplexityErrors => {
 const { max_length, min_length, require_special_char, require_lowercase, require_numbers, require_uppercase } =
 config;
 const testComplexityCases = createTestComplexityCases(config);
 const testCases = testComplexityCases(password, {
 maxLength: config.max_length,
 minLength: config.min_length,
 });

 const keys = {
 max_length,
 min_length,
 require_special_char,
 require_numbers,
 require_lowercase,
 require_uppercase,
 };

 const _validationsFailedMap = new Map();
 for (const k in keys) {
 const key = k as keyof typeof keys;

 if (!keys[key]) {
 continue;
 }

 if (!testCases[key]) {
 _validationsFailedMap.set(key, true);
 }
 }

 return Object.freeze(Object.fromEntries(_validationsFailedMap));
};

export const createValidateComplexity = (config: UsePasswordComplexityConfig) => {
 return (password: string) => validate(password, config);
};

export const usePasswordComplexity = (config: UsePasswordComplexityConfig) => {
 const [password, _setPassword] = useState('');
 const [failedValidations, setFailedValidations] = useState<ComplexityErrors>();
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/utils/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,5 +19,4 @@ export * from './roleLocalizationKey';
export * from './getRelativeToNowDateKey';
export * from './mergeRefs';
export * from './createSlug';
export * from './zxcvbn';
export * from './passwordUtils';

80 changes: 80 additions & 0 deletions
packages/clerk-js/src/utils/passwords/complexity.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
import type { PasswordSettingsData } from '@clerk/types';

export type ComplexityErrors = {
 [key in keyof Partial<Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>>]?: boolean;
};

export type UsePasswordComplexityConfig = Omit<
 PasswordSettingsData,
 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'
>;

const createTestComplexityCases = (config: Pick<UsePasswordComplexityConfig, 'allowed_special_characters'>) => {
 let specialCharsRegex: RegExp;
 if (config.allowed_special_characters) {
 // Avoid a nested group by escaping the `[]` characters
 let escaped = config.allowed_special_characters.replace('[', '\\[');
 escaped = escaped.replace(']', '\\]');
 specialCharsRegex = new RegExp(`[${escaped}]`);
 } else {
 specialCharsRegex = /[!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]/;
 }

 return (
 password: string,
 {
 minLength,
 maxLength,
 }: {
 minLength: number;
 maxLength: number;
 },
 ) => {
 return {
 max_length: password.length < maxLength,
 min_length: password.length >= minLength,
 require_numbers: /\d/.test(password),
 require_lowercase: /[a-z]/.test(password),
 require_uppercase: /[A-Z]/.test(password),
 require_special_char: specialCharsRegex.test(password),
 };
 };
};

export const validate = (password: string, config: UsePasswordComplexityConfig): ComplexityErrors => {
 const { max_length, min_length, require_special_char, require_lowercase, require_numbers, require_uppercase } =
 config;
 const testComplexityCases = createTestComplexityCases(config);
 const testCases = testComplexityCases(password, {
 maxLength: config.max_length,
 minLength: config.min_length,
 });

 const keys = {
 max_length,
 min_length,
 require_special_char,
 require_lowercase,
 require_numbers,
 require_uppercase,
 };

 const _validationsFailedMap = new Map();
 for (const k in keys) {
 const key = k as keyof typeof keys;

 if (!keys[key]) {
 continue;
 }

 if (!testCases[key]) {
 _validationsFailedMap.set(key, true);
 }
 }

 return Object.freeze(Object.fromEntries(_validationsFailedMap));
};

export const createValidateComplexity = (config: UsePasswordComplexityConfig) => {
 return (password: string) => validate(password, config);
};
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Introduce validatePassword for SignIn and SignUp resources#1445

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

panteliselef
merged 3 commits into

from

Aug 9, 2023
 Merged


Introduce validatePassword for SignIn and SignUp resources
#1445
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8fd9843

feat(clerk-js): Expose password validation from SignIn and SignUp res…


panteliselef Jun 18, 2023
feb492d

chore(clerk-js): Use ZxcvbnResult from `@types`


panteliselef Jun 18, 2023
e4c03a1

chore(repo): Example usage password validation in custom flows


panteliselef Jun 18, 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


7 changes: 7 additions & 0 deletions
.changeset/nice-experts-hope.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

Introducing validatePassword for SignIn and SignUp resources
- Validate a password based on the instance's configuration set in Password Policies in Dashboard 

10 changes: 10 additions & 0 deletions
packages/clerk-js/src/core/resources/SignIn.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ import type {
} from '@clerk/types';

import { generateSignatureWithMetamask, getMetamaskIdentifier, windowNavigate } from '../../utils';
import { createValidatePassword } from '../../utils/passwords/password';
import {
 clerkInvalidFAPIResponse,
 clerkInvalidStrategy,
Expand DownExpand Up@@ -234,6 +235,15 @@ export class SignIn extends BaseResource implements SignInResource {
 });
 };

 validatePassword: ReturnType<typeof createValidatePassword> = (password, cb) => {
 if (SignIn.clerk.__unstable__environment?.userSettings.passwordSettings) {
 return createValidatePassword({
 ...(SignIn.clerk.__unstable__environment?.userSettings.passwordSettings as any),
 validatePassword: true,
 })(password, cb);
 }
 };

 protected fromJSON(data: SignInJSON | null): this {
 if (data) {
 this.id = data.id;
Expand Down

10 changes: 10 additions & 0 deletions
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@ import type {
} from '@clerk/types';

import { generateSignatureWithMetamask, getCaptchaToken, getMetamaskIdentifier, windowNavigate } from '../../utils';
import { createValidatePassword } from '../../utils/passwords/password';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import {
 clerkInvalidFAPIResponse,
Expand DownExpand Up@@ -230,6 +231,15 @@ export class SignUp extends BaseResource implements SignUpResource {
 });
 };

 validatePassword: ReturnType<typeof createValidatePassword> = (password, cb) => {
 if (SignUp.clerk.__unstable__environment?.userSettings.passwordSettings) {
 return createValidatePassword({
 ...(SignUp.clerk.__unstable__environment?.userSettings.passwordSettings as any),
 validatePassword: true,
 })(password, cb);
 }
 };

 protected fromJSON(data: SignUpJSON | null): this {
 if (data) {
 this.id = data.id;
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/hooks/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,6 @@ export * from './useEnabledThirdPartyProviders';
export * from './useLoadingStatus';
export * from './usePassword';
export * from './usePasswordComplexity';
export * from './usePasswordStrength';
export * from './usePopover';
export * from './usePrefersReducedMotion';
export * from './useLocalStorage';
Expand Down

81 changes: 4 additions & 77 deletions
packages/clerk-js/src/ui/hooks/usePassword.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,88 +1,15 @@
import { noop } from '@clerk/shared';
import type { PasswordSettingsData } from '@clerk/types';
import type { PasswordValidation } from '@clerk/types';
import { useCallback, useMemo } from 'react';

import type { UsePasswordCbs, UsePasswordConfig } from '../../utils/passwords/password';
import { createValidatePassword } from '../../utils/passwords/password';
import { localizationKeys, useLocalizations } from '../localization';
import type { FormControlState } from '../utils';
import { loadZxcvbn } from '../utils';
import type { ComplexityErrors } from './usePasswordComplexity';
import { createValidateComplexity, generateErrorTextUtil } from './usePasswordComplexity';
import type { PasswordStrength } from './usePasswordStrength';
import { createValidatePasswordStrength } from './usePasswordStrength';

type UsePasswordConfig = PasswordSettingsData & {
 validatePassword: boolean;
};

type PasswordValidation = {
 complexity?: ComplexityErrors;
 strength?: PasswordStrength;
};

type UsePasswordCbs = {
 onValidationFailed?: (errorMessage: string | undefined) => void;
 onValidationSuccess?: () => void;
 onValidationWarning?: (warningMessage: string) => void;
 onValidationComplexity?: (b: boolean) => void;
};

type ValidatePasswordCbs = {
 onValidation?: (res: PasswordValidation) => void;
 onValidationComplexity?: (b: boolean) => void;
};
import { generateErrorTextUtil } from './usePasswordComplexity';

export const MIN_PASSWORD_LENGTH = 8;

const createValidatePassword = (config: UsePasswordConfig, callbacks?: ValidatePasswordCbs) => {
 const { onValidation = noop, onValidationComplexity = noop } = callbacks || {};
 const { show_zxcvbn, validatePassword: validatePasswordProp } = config;
 const getComplexity = createValidateComplexity(config);
 const getScore = createValidatePasswordStrength(config);
 let result = {} satisfies PasswordValidation;

 return (password: string) => {
 if (!validatePasswordProp) {
 return;
 }

 /**
 * Validate Complexity
 */
 const failedValidationsComplexity = getComplexity(password);
 onValidationComplexity(Object.keys(failedValidationsComplexity).length === 0);
 result = {
 ...result,
 complexity: failedValidationsComplexity,
 };
 /**
 * Validate score
 */
 if (show_zxcvbn) {
 /**
 * Lazy load zxcvbn without preventing a complexityError to be thrown if it exists
 */
 void loadZxcvbn().then(zxcvbn => {
 const setPasswordScore = getScore(zxcvbn);
 const strength = setPasswordScore(password);

 result = {
 ...result,
 strength,
 };
 onValidation({
 ...result,
 strength,
 });
 });
 }

 onValidation({
 ...result,
 complexity: failedValidationsComplexity,
 });
 };
};

export const usePassword = (config: UsePasswordConfig, callbacks?: UsePasswordCbs) => {
 const { t, locale } = useLocalizations();
 const {
Expand Down

81 changes: 3 additions & 78 deletions
packages/clerk-js/src/ui/hooks/usePasswordComplexity.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,49 +1,12 @@
import type { PasswordSettingsData } from '@clerk/types';
import { useCallback, useEffect, useMemo, useState } from 'react';

import type { ComplexityErrors, UsePasswordComplexityConfig } from '../../utils/passwords/complexity';
import { validate } from '../../utils/passwords/complexity';
import type { LocalizationKey } from '../localization';
import { localizationKeys, useLocalizations } from '../localization';
import { addFullStop, createListFormat } from '../utils';

export type ComplexityErrors = {
 [key in keyof Partial<Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>>]?: boolean;
};

type UsePasswordComplexityConfig = Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>;

const createTestComplexityCases = (config: Pick<UsePasswordComplexityConfig, 'allowed_special_characters'>) => {
 let specialCharsRegex: RegExp;
 if (config.allowed_special_characters) {
 // Avoid a nested group by escaping the `[]` characters
 let escaped = config.allowed_special_characters.replace('[', '\\[');
 escaped = escaped.replace(']', '\\]');
 specialCharsRegex = new RegExp(`[${escaped}]`);
 } else {
 specialCharsRegex = /[!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]/;
 }

 return (
 password: string,
 {
 minLength,
 maxLength,
 }: {
 minLength: number;
 maxLength: number;
 },
 ) => {
 return {
 max_length: password.length < maxLength,
 min_length: password.length >= minLength,
 require_numbers: /\d/.test(password),
 require_lowercase: /[a-z]/.test(password),
 require_uppercase: /[A-Z]/.test(password),
 require_special_char: specialCharsRegex.test(password),
 };
 };
};

const errorMessages = {
const errorMessages: Record<keyof Omit<ComplexityErrors, 'allowed_special_characters'>, [string, string] | string> = {
 max_length: ['unstable__errors.passwordComplexity.maximumLength', 'length'],
 min_length: ['unstable__errors.passwordComplexity.minimumLength', 'length'],
 require_numbers: 'unstable__errors.passwordComplexity.requireNumbers',
Expand DownExpand Up@@ -89,44 +52,6 @@ export const generateErrorTextUtil = ({
 );
};

const validate = (password: string, config: UsePasswordComplexityConfig): ComplexityErrors => {
 const { max_length, min_length, require_special_char, require_lowercase, require_numbers, require_uppercase } =
 config;
 const testComplexityCases = createTestComplexityCases(config);
 const testCases = testComplexityCases(password, {
 maxLength: config.max_length,
 minLength: config.min_length,
 });

 const keys = {
 max_length,
 min_length,
 require_special_char,
 require_numbers,
 require_lowercase,
 require_uppercase,
 };

 const _validationsFailedMap = new Map();
 for (const k in keys) {
 const key = k as keyof typeof keys;

 if (!keys[key]) {
 continue;
 }

 if (!testCases[key]) {
 _validationsFailedMap.set(key, true);
 }
 }

 return Object.freeze(Object.fromEntries(_validationsFailedMap));
};

export const createValidateComplexity = (config: UsePasswordComplexityConfig) => {
 return (password: string) => validate(password, config);
};

export const usePasswordComplexity = (config: UsePasswordComplexityConfig) => {
 const [password, _setPassword] = useState('');
 const [failedValidations, setFailedValidations] = useState<ComplexityErrors>();
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/utils/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,5 +19,4 @@ export * from './roleLocalizationKey';
export * from './getRelativeToNowDateKey';
export * from './mergeRefs';
export * from './createSlug';
export * from './zxcvbn';
export * from './passwordUtils';

80 changes: 80 additions & 0 deletions
packages/clerk-js/src/utils/passwords/complexity.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
import type { PasswordSettingsData } from '@clerk/types';

export type ComplexityErrors = {
 [key in keyof Partial<Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>>]?: boolean;
};

export type UsePasswordComplexityConfig = Omit<
 PasswordSettingsData,
 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'
>;

const createTestComplexityCases = (config: Pick<UsePasswordComplexityConfig, 'allowed_special_characters'>) => {
 let specialCharsRegex: RegExp;
 if (config.allowed_special_characters) {
 // Avoid a nested group by escaping the `[]` characters
 let escaped = config.allowed_special_characters.replace('[', '\\[');
 escaped = escaped.replace(']', '\\]');
 specialCharsRegex = new RegExp(`[${escaped}]`);
 } else {
 specialCharsRegex = /[!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]/;
 }

 return (
 password: string,
 {
 minLength,
 maxLength,
 }: {
 minLength: number;
 maxLength: number;
 },
 ) => {
 return {
 max_length: password.length < maxLength,
 min_length: password.length >= minLength,
 require_numbers: /\d/.test(password),
 require_lowercase: /[a-z]/.test(password),
 require_uppercase: /[A-Z]/.test(password),
 require_special_char: specialCharsRegex.test(password),
 };
 };
};

export const validate = (password: string, config: UsePasswordComplexityConfig): ComplexityErrors => {
 const { max_length, min_length, require_special_char, require_lowercase, require_numbers, require_uppercase } =
 config;
 const testComplexityCases = createTestComplexityCases(config);
 const testCases = testComplexityCases(password, {
 maxLength: config.max_length,
 minLength: config.min_length,
 });

 const keys = {
 max_length,
 min_length,
 require_special_char,
 require_lowercase,
 require_numbers,
 require_uppercase,
 };

 const _validationsFailedMap = new Map();
 for (const k in keys) {
 const key = k as keyof typeof keys;

 if (!keys[key]) {
 continue;
 }

 if (!testCases[key]) {
 _validationsFailedMap.set(key, true);
 }
 }

 return Object.freeze(Object.fromEntries(_validationsFailedMap));
};

export const createValidateComplexity = (config: UsePasswordComplexityConfig) => {
 return (password: string) => validate(password, config);
};
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Introduce validatePassword for SignIn and SignUp resources#1445

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

panteliselef
merged 3 commits into

from

Aug 9, 2023
 Merged


Introduce validatePassword for SignIn and SignUp resources
#1445
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
8fd9843

feat(clerk-js): Expose password validation from SignIn and SignUp res…


panteliselef Jun 18, 2023
feb492d

chore(clerk-js): Use ZxcvbnResult from `@types`


panteliselef Jun 18, 2023
e4c03a1

chore(repo): Example usage password validation in custom flows


panteliselef Jun 18, 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


7 changes: 7 additions & 0 deletions
.changeset/nice-experts-hope.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

Introducing validatePassword for SignIn and SignUp resources
- Validate a password based on the instance's configuration set in Password Policies in Dashboard 

10 changes: 10 additions & 0 deletions
packages/clerk-js/src/core/resources/SignIn.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,7 @@ import type {
} from '@clerk/types';

import { generateSignatureWithMetamask, getMetamaskIdentifier, windowNavigate } from '../../utils';
import { createValidatePassword } from '../../utils/passwords/password';
import {
 clerkInvalidFAPIResponse,
 clerkInvalidStrategy,
Expand DownExpand Up@@ -234,6 +235,15 @@ export class SignIn extends BaseResource implements SignInResource {
 });
 };

 validatePassword: ReturnType<typeof createValidatePassword> = (password, cb) => {
 if (SignIn.clerk.__unstable__environment?.userSettings.passwordSettings) {
 return createValidatePassword({
 ...(SignIn.clerk.__unstable__environment?.userSettings.passwordSettings as any),
 validatePassword: true,
 })(password, cb);
 }
 };

 protected fromJSON(data: SignInJSON | null): this {
 if (data) {
 this.id = data.id;
Expand Down

10 changes: 10 additions & 0 deletions
packages/clerk-js/src/core/resources/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,7 @@ import type {
} from '@clerk/types';

import { generateSignatureWithMetamask, getCaptchaToken, getMetamaskIdentifier, windowNavigate } from '../../utils';
import { createValidatePassword } from '../../utils/passwords/password';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import {
 clerkInvalidFAPIResponse,
Expand DownExpand Up@@ -230,6 +231,15 @@ export class SignUp extends BaseResource implements SignUpResource {
 });
 };

 validatePassword: ReturnType<typeof createValidatePassword> = (password, cb) => {
 if (SignUp.clerk.__unstable__environment?.userSettings.passwordSettings) {
 return createValidatePassword({
 ...(SignUp.clerk.__unstable__environment?.userSettings.passwordSettings as any),
 validatePassword: true,
 })(password, cb);
 }
 };

 protected fromJSON(data: SignUpJSON | null): this {
 if (data) {
 this.id = data.id;
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/hooks/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,6 @@ export * from './useEnabledThirdPartyProviders';
export * from './useLoadingStatus';
export * from './usePassword';
export * from './usePasswordComplexity';
export * from './usePasswordStrength';
export * from './usePopover';
export * from './usePrefersReducedMotion';
export * from './useLocalStorage';
Expand Down

81 changes: 4 additions & 77 deletions
packages/clerk-js/src/ui/hooks/usePassword.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,88 +1,15 @@
import { noop } from '@clerk/shared';
import type { PasswordSettingsData } from '@clerk/types';
import type { PasswordValidation } from '@clerk/types';
import { useCallback, useMemo } from 'react';

import type { UsePasswordCbs, UsePasswordConfig } from '../../utils/passwords/password';
import { createValidatePassword } from '../../utils/passwords/password';
import { localizationKeys, useLocalizations } from '../localization';
import type { FormControlState } from '../utils';
import { loadZxcvbn } from '../utils';
import type { ComplexityErrors } from './usePasswordComplexity';
import { createValidateComplexity, generateErrorTextUtil } from './usePasswordComplexity';
import type { PasswordStrength } from './usePasswordStrength';
import { createValidatePasswordStrength } from './usePasswordStrength';

type UsePasswordConfig = PasswordSettingsData & {
 validatePassword: boolean;
};

type PasswordValidation = {
 complexity?: ComplexityErrors;
 strength?: PasswordStrength;
};

type UsePasswordCbs = {
 onValidationFailed?: (errorMessage: string | undefined) => void;
 onValidationSuccess?: () => void;
 onValidationWarning?: (warningMessage: string) => void;
 onValidationComplexity?: (b: boolean) => void;
};

type ValidatePasswordCbs = {
 onValidation?: (res: PasswordValidation) => void;
 onValidationComplexity?: (b: boolean) => void;
};
import { generateErrorTextUtil } from './usePasswordComplexity';

export const MIN_PASSWORD_LENGTH = 8;

const createValidatePassword = (config: UsePasswordConfig, callbacks?: ValidatePasswordCbs) => {
 const { onValidation = noop, onValidationComplexity = noop } = callbacks || {};
 const { show_zxcvbn, validatePassword: validatePasswordProp } = config;
 const getComplexity = createValidateComplexity(config);
 const getScore = createValidatePasswordStrength(config);
 let result = {} satisfies PasswordValidation;

 return (password: string) => {
 if (!validatePasswordProp) {
 return;
 }

 /**
 * Validate Complexity
 */
 const failedValidationsComplexity = getComplexity(password);
 onValidationComplexity(Object.keys(failedValidationsComplexity).length === 0);
 result = {
 ...result,
 complexity: failedValidationsComplexity,
 };
 /**
 * Validate score
 */
 if (show_zxcvbn) {
 /**
 * Lazy load zxcvbn without preventing a complexityError to be thrown if it exists
 */
 void loadZxcvbn().then(zxcvbn => {
 const setPasswordScore = getScore(zxcvbn);
 const strength = setPasswordScore(password);

 result = {
 ...result,
 strength,
 };
 onValidation({
 ...result,
 strength,
 });
 });
 }

 onValidation({
 ...result,
 complexity: failedValidationsComplexity,
 });
 };
};

export const usePassword = (config: UsePasswordConfig, callbacks?: UsePasswordCbs) => {
 const { t, locale } = useLocalizations();
 const {
Expand Down

81 changes: 3 additions & 78 deletions
packages/clerk-js/src/ui/hooks/usePasswordComplexity.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,49 +1,12 @@
import type { PasswordSettingsData } from '@clerk/types';
import { useCallback, useEffect, useMemo, useState } from 'react';

import type { ComplexityErrors, UsePasswordComplexityConfig } from '../../utils/passwords/complexity';
import { validate } from '../../utils/passwords/complexity';
import type { LocalizationKey } from '../localization';
import { localizationKeys, useLocalizations } from '../localization';
import { addFullStop, createListFormat } from '../utils';

export type ComplexityErrors = {
 [key in keyof Partial<Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>>]?: boolean;
};

type UsePasswordComplexityConfig = Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>;

const createTestComplexityCases = (config: Pick<UsePasswordComplexityConfig, 'allowed_special_characters'>) => {
 let specialCharsRegex: RegExp;
 if (config.allowed_special_characters) {
 // Avoid a nested group by escaping the `[]` characters
 let escaped = config.allowed_special_characters.replace('[', '\\[');
 escaped = escaped.replace(']', '\\]');
 specialCharsRegex = new RegExp(`[${escaped}]`);
 } else {
 specialCharsRegex = /[!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]/;
 }

 return (
 password: string,
 {
 minLength,
 maxLength,
 }: {
 minLength: number;
 maxLength: number;
 },
 ) => {
 return {
 max_length: password.length < maxLength,
 min_length: password.length >= minLength,
 require_numbers: /\d/.test(password),
 require_lowercase: /[a-z]/.test(password),
 require_uppercase: /[A-Z]/.test(password),
 require_special_char: specialCharsRegex.test(password),
 };
 };
};

const errorMessages = {
const errorMessages: Record<keyof Omit<ComplexityErrors, 'allowed_special_characters'>, [string, string] | string> = {
 max_length: ['unstable__errors.passwordComplexity.maximumLength', 'length'],
 min_length: ['unstable__errors.passwordComplexity.minimumLength', 'length'],
 require_numbers: 'unstable__errors.passwordComplexity.requireNumbers',
Expand DownExpand Up@@ -89,44 +52,6 @@ export const generateErrorTextUtil = ({
 );
};

const validate = (password: string, config: UsePasswordComplexityConfig): ComplexityErrors => {
 const { max_length, min_length, require_special_char, require_lowercase, require_numbers, require_uppercase } =
 config;
 const testComplexityCases = createTestComplexityCases(config);
 const testCases = testComplexityCases(password, {
 maxLength: config.max_length,
 minLength: config.min_length,
 });

 const keys = {
 max_length,
 min_length,
 require_special_char,
 require_numbers,
 require_lowercase,
 require_uppercase,
 };

 const _validationsFailedMap = new Map();
 for (const k in keys) {
 const key = k as keyof typeof keys;

 if (!keys[key]) {
 continue;
 }

 if (!testCases[key]) {
 _validationsFailedMap.set(key, true);
 }
 }

 return Object.freeze(Object.fromEntries(_validationsFailedMap));
};

export const createValidateComplexity = (config: UsePasswordComplexityConfig) => {
 return (password: string) => validate(password, config);
};

export const usePasswordComplexity = (config: UsePasswordComplexityConfig) => {
 const [password, _setPassword] = useState('');
 const [failedValidations, setFailedValidations] = useState<ComplexityErrors>();
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/utils/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,5 +19,4 @@ export * from './roleLocalizationKey';
export * from './getRelativeToNowDateKey';
export * from './mergeRefs';
export * from './createSlug';
export * from './zxcvbn';
export * from './passwordUtils';

80 changes: 80 additions & 0 deletions
packages/clerk-js/src/utils/passwords/complexity.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
import type { PasswordSettingsData } from '@clerk/types';

export type ComplexityErrors = {
 [key in keyof Partial<Omit<PasswordSettingsData, 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'>>]?: boolean;
};

export type UsePasswordComplexityConfig = Omit<
 PasswordSettingsData,
 'disable_hibp' | 'min_zxcvbn_strength' | 'show_zxcvbn'
>;

const createTestComplexityCases = (config: Pick<UsePasswordComplexityConfig, 'allowed_special_characters'>) => {
 let specialCharsRegex: RegExp;
 if (config.allowed_special_characters) {
 // Avoid a nested group by escaping the `[]` characters
 let escaped = config.allowed_special_characters.replace('[', '\\[');
 escaped = escaped.replace(']', '\\]');
 specialCharsRegex = new RegExp(`[${escaped}]`);
 } else {
 specialCharsRegex = /[!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]/;
 }

 return (
 password: string,
 {
 minLength,
 maxLength,
 }: {
 minLength: number;
 maxLength: number;
 },
 ) => {
 return {
 max_length: password.length < maxLength,
 min_length: password.length >= minLength,
 require_numbers: /\d/.test(password),
 require_lowercase: /[a-z]/.test(password),
 require_uppercase: /[A-Z]/.test(password),
 require_special_char: specialCharsRegex.test(password),
 };
 };
};

export const validate = (password: string, config: UsePasswordComplexityConfig): ComplexityErrors => {
 const { max_length, min_length, require_special_char, require_lowercase, require_numbers, require_uppercase } =
 config;
 const testComplexityCases = createTestComplexityCases(config);
 const testCases = testComplexityCases(password, {
 maxLength: config.max_length,
 minLength: config.min_length,
 });

 const keys = {
 max_length,
 min_length,
 require_special_char,
 require_lowercase,
 require_numbers,
 require_uppercase,
 };

 const _validationsFailedMap = new Map();
 for (const k in keys) {
 const key = k as keyof typeof keys;

 if (!keys[key]) {
 continue;
 }

 if (!testCases[key]) {
 _validationsFailedMap.set(key, true);
 }
 }

 return Object.freeze(Object.fromEntries(_validationsFailedMap));
};

export const createValidateComplexity = (config: UsePasswordComplexityConfig) => {
 return (password: string) => validate(password, config);
};
Loading