5c2382d296
* fix: allow wildcard prefix in normalizeDomain function The normalizeDomain function now accepts domains with *. prefix (e.g., *.cal.com) for wildcard domain matching in the watchlist. The domain part after *. is validated using the existing regex. Co-Authored-By: alex@cal.com <me@alexvanandel.com> * fix: allow wildcard domains in validation checks Update WatchlistOperationsService and CreateBlocklistEntryModal to accept wildcard domain prefixes (*.) in domain validation. This ensures wildcard domains like *.cal.com can be added through both the API and UI. Co-Authored-By: alex@cal.com <me@alexvanandel.com> --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
165 lines
5.1 KiB
TypeScript
165 lines
5.1 KiB
TypeScript
import { emailRegex } from "@calcom/lib/emailSchema";
|
|
|
|
/**
|
|
* Centralized normalization utilities for emails and domains
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* Normalizes an email address for consistent comparison
|
|
*
|
|
* Rules applied:
|
|
* 1. Convert to lowercase
|
|
* 2. Trim whitespace
|
|
* 3. Validate basic email format
|
|
*
|
|
* @param email - Raw email address
|
|
* @returns Normalized email address
|
|
* @throws Error if email format is invalid
|
|
*/
|
|
export function normalizeEmail(email: string): string {
|
|
const normalized = email.trim().toLowerCase();
|
|
|
|
if (!emailRegex.test(normalized)) {
|
|
throw new Error(`Invalid email format: ${email}`);
|
|
}
|
|
return normalized;
|
|
}
|
|
|
|
/**
|
|
* Normalizes a domain for consistent comparison
|
|
*
|
|
* Rules applied:
|
|
* 1. Convert to lowercase
|
|
* 2. Trim whitespace
|
|
* 3. Remove @ prefix if present
|
|
* 4. Preserve *. prefix for wildcard domains
|
|
*
|
|
* Note: Domains are stored without @ prefix (e.g., mail.google.com, example.co.uk)
|
|
* Wildcard matching is configurable:
|
|
* - `*.cal.com` blocks all subdomains (app.cal.com, sub.app.cal.com, etc.)
|
|
* - `cal.com` only blocks exact matches
|
|
*
|
|
* @param domain - Raw domain (with or without @ prefix, with or without *. prefix)
|
|
* @returns Normalized domain without @ prefix
|
|
*/
|
|
export function normalizeDomain(domain: string): string {
|
|
let normalized = domain.trim().toLowerCase();
|
|
|
|
if (normalized.startsWith("@")) {
|
|
normalized = normalized.slice(1);
|
|
}
|
|
|
|
// Check for wildcard prefix and validate the domain part separately
|
|
let isWildcard = false;
|
|
let domainToValidate = normalized;
|
|
|
|
if (normalized.startsWith("*.")) {
|
|
isWildcard = true;
|
|
domainToValidate = normalized.slice(2); // Remove "*." for validation
|
|
}
|
|
|
|
const domainRegex =
|
|
/^[a-zA-Z0-9\u00a1-\uffff]([a-zA-Z0-9\u00a1-\uffff-]*[a-zA-Z0-9\u00a1-\uffff])?(\.[a-zA-Z0-9\u00a1-\uffff]([a-zA-Z0-9\u00a1-\uffff-]*[a-zA-Z0-9\u00a1-\uffff])?)*$/;
|
|
if (!domainRegex.test(domainToValidate)) {
|
|
throw new Error(`Invalid domain format: ${domain}`);
|
|
}
|
|
|
|
return isWildcard ? `*.${domainToValidate}` : domainToValidate;
|
|
}
|
|
|
|
/**
|
|
* Extracts and normalizes domain from an email address
|
|
*
|
|
* @param email - Email address
|
|
* @returns Normalized domain without @ prefix
|
|
*/
|
|
export function extractDomainFromEmail(email: string): string {
|
|
const normalizedEmail = normalizeEmail(email);
|
|
const domain = normalizedEmail.split("@")[1];
|
|
|
|
if (!domain) {
|
|
throw new Error(`Could not extract domain from email: ${email}`);
|
|
}
|
|
|
|
return normalizeDomain(domain);
|
|
}
|
|
|
|
/**
|
|
* Normalizes a username for consistent comparison
|
|
*
|
|
* Rules applied:
|
|
* 1. Convert to lowercase
|
|
* 2. Trim whitespace
|
|
*
|
|
* @param username - Raw username
|
|
* @returns Normalized username
|
|
*/
|
|
export function normalizeUsername(username: string): string {
|
|
if (!username || typeof username !== "string") {
|
|
throw new Error("Invalid username: must be a non-empty string");
|
|
}
|
|
|
|
return username.trim().toLowerCase();
|
|
}
|
|
|
|
/**
|
|
* Gets the wildcard pattern that could match a given domain.
|
|
* Used to check if a wildcard entry (*.domain.com) would block this domain.
|
|
*
|
|
* Simply strips the first part before the first `.` and adds `*.` prefix.
|
|
* Only returns a pattern if the parent domain has at least 2 parts (to avoid *.com).
|
|
*
|
|
* Example:
|
|
* - Input: "app.cal.com" -> Output: ["*.cal.com"]
|
|
* - Input: "bloody-hell.cal.co.uk" -> Output: ["*.cal.co.uk"]
|
|
* - Input: "cal.com" -> Output: [] (parent would be just "com")
|
|
* - Input: "example.co.uk" -> Output: ["*.co.uk"]
|
|
*
|
|
* @param domain - Normalized domain (without @ prefix)
|
|
* @returns Array with single wildcard pattern, or empty if no valid parent domain
|
|
*/
|
|
export function getWildcardPatternsForDomain(domain: string): string[] {
|
|
const firstDotIndex = domain.indexOf(".");
|
|
|
|
if (firstDotIndex === -1 || firstDotIndex === domain.length - 1) {
|
|
return [];
|
|
}
|
|
|
|
const parentDomain = domain.slice(firstDotIndex + 1);
|
|
|
|
// Only return pattern if parent domain has at least one dot (e.g., "cal.com" not "com")
|
|
if (!parentDomain.includes(".")) {
|
|
return [];
|
|
}
|
|
|
|
return [`*.${parentDomain}`];
|
|
}
|
|
|
|
/**
|
|
* Checks if a domain matches a watchlist entry value.
|
|
* Supports both exact matching and wildcard matching.
|
|
*
|
|
* - Exact match: "cal.com" only matches "cal.com"
|
|
* - Wildcard match: "*.cal.com" matches "app.cal.com", "sub.app.cal.com", etc.
|
|
*
|
|
* @param emailDomain - The domain extracted from an email (e.g., "app.cal.com")
|
|
* @param watchlistValue - The value from the watchlist entry (e.g., "cal.com" or "*.cal.com")
|
|
* @returns true if the domain matches the watchlist entry
|
|
*/
|
|
export function domainMatchesWatchlistEntry(emailDomain: string, watchlistValue: string): boolean {
|
|
const normalizedEmailDomain = emailDomain.toLowerCase();
|
|
const normalizedWatchlistValue = watchlistValue.toLowerCase();
|
|
|
|
// Check for wildcard pattern
|
|
if (normalizedWatchlistValue.startsWith("*.")) {
|
|
const baseDomain = normalizedWatchlistValue.slice(2); // Remove "*." prefix
|
|
// Check if emailDomain is a subdomain of baseDomain
|
|
// e.g., "app.cal.com" ends with ".cal.com" (subdomain of cal.com)
|
|
return normalizedEmailDomain.endsWith(`.${baseDomain}`);
|
|
}
|
|
|
|
// Exact match
|
|
return normalizedEmailDomain === normalizedWatchlistValue;
|
|
}
|