Giter VIP home page Giter VIP logo

validator.js's Introduction

validator.js

NPM version CI Coverage Downloads Backers on Open Collective Sponsors on Open Collective Gitter Disclose a vulnerability

A library of string validators and sanitizers.

Strings only

This library validates and sanitizes strings only.

If you're not sure if your input is a string, coerce it using input + ''. Passing anything other than a string will result in an error.

Installation and Usage

Server-side usage

Install the library with npm install validator

No ES6

var validator = require('validator');

validator.isEmail('[email protected]'); //=> true

ES6

import validator from 'validator';

Or, import only a subset of the library:

import isEmail from 'validator/lib/isEmail';

Tree-shakeable ES imports

import isEmail from 'validator/es/lib/isEmail';

Client-side usage

The library can be loaded either as a standalone script, or through an AMD-compatible loader

<script type="text/javascript" src="validator.min.js"></script>
<script type="text/javascript">
  validator.isEmail('[email protected]'); //=> true
</script>

The library can also be installed through bower

$ bower install validator-js

CDN

<script src="https://unpkg.com/validator@latest/validator.min.js"></script>

Contributors

Become a backer

Become a sponsor

Thank you to the people who have already contributed:

Validators

Here is a list of the validators currently available.

Validator Description
contains(str, seed [, options]) check if the string contains the seed.

options is an object that defaults to { ignoreCase: false, minOccurrences: 1 }.
Options:
ignoreCase: Ignore case when doing comparison, default false.
minOccurences: Minimum number of occurrences for the seed in the string. Defaults to 1.
equals(str, comparison) check if the string matches the comparison.
isAbaRouting(str) check if the string is an ABA routing number for US bank account / cheque.
isAfter(str [, options]) check if the string is a date that is after the specified date.

options is an object that defaults to { comparisonDate: Date().toString() }.
Options:
comparisonDate: Date to compare to. Defaults to Date().toString() (now).
isAlpha(str [, locale, options]) check if the string contains only letters (a-zA-Z).

locale is one of ['ar', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-IQ', 'ar-JO', 'ar-KW', 'ar-LB', 'ar-LY', 'ar-MA', 'ar-QA', 'ar-QM', 'ar-SA', 'ar-SD', 'ar-SY', 'ar-TN', 'ar-YE', 'bg-BG', 'bn', 'cs-CZ', 'da-DK', 'de-DE', 'el-GR', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'eo', 'es-ES', 'fa-IR', 'fi-FI', 'fr-CA', 'fr-FR', 'he', 'hi-IN', 'hu-HU', 'it-IT', 'kk-KZ', 'ko-KR', 'ja-JP', 'ku-IQ', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'si-LK', 'sl-SI', 'sk-SK', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'th-TH', 'tr-TR', 'uk-UA'] and defaults to en-US. Locale list is validator.isAlphaLocales. options is an optional object that can be supplied with the following key(s): ignore which can either be a String or RegExp of characters to be ignored e.g. " -" will ignore spaces and -'s.
isAlphanumeric(str [, locale, options]) check if the string contains only letters and numbers (a-zA-Z0-9).

locale is one of ['ar', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-IQ', 'ar-JO', 'ar-KW', 'ar-LB', 'ar-LY', 'ar-MA', 'ar-QA', 'ar-QM', 'ar-SA', 'ar-SD', 'ar-SY', 'ar-TN', 'ar-YE', 'bn', 'bg-BG', 'cs-CZ', 'da-DK', 'de-DE', 'el-GR', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'eo', 'es-ES', 'fa-IR', 'fi-FI', 'fr-CA', 'fr-FR', 'he', 'hi-IN', 'hu-HU', 'it-IT', 'kk-KZ', 'ko-KR', 'ja-JP','ku-IQ', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'si-LK', 'sl-SI', 'sk-SK', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'th-TH', 'tr-TR', 'uk-UA']) and defaults to en-US. Locale list is validator.isAlphanumericLocales. options is an optional object that can be supplied with the following key(s): ignore which can either be a String or RegExp of characters to be ignored e.g. " -" will ignore spaces and -'s.
isAscii(str) check if the string contains ASCII chars only.
isBase32(str [, options]) check if the string is base32 encoded. options is optional and defaults to { crockford: false }.
When crockford is true it tests the given base32 encoded string using Crockford's base32 alternative.
isBase58(str) check if the string is base58 encoded.
isBase64(str [, options]) check if the string is base64 encoded. options is optional and defaults to { urlSafe: false }
when urlSafe is true it tests the given base64 encoded string is url safe.
isBefore(str [, date]) check if the string is a date that is before the specified date.
isBIC(str) check if the string is a BIC (Bank Identification Code) or SWIFT code.
isBoolean(str [, options]) check if the string is a boolean.
options is an object which defaults to { loose: false }. If loose is set to false, the validator will strictly match ['true', 'false', '0', '1']. If loose is set to true, the validator will also match 'yes', 'no', and will match a valid boolean string of any case. (e.g.: ['true', 'True', 'TRUE']).
isBtcAddress(str) check if the string is a valid BTC address.
isByteLength(str [, options]) check if the string's length (in UTF-8 bytes) falls in a range.

options is an object which defaults to { min: 0, max: undefined }.
isCreditCard(str [, options]) check if the string is a credit card number.

options is an optional object that can be supplied with the following key(s): provider is an optional key whose value should be a string, and defines the company issuing the credit card. Valid values include ['amex', 'dinersclub', 'discover', 'jcb', 'mastercard', 'unionpay', 'visa'] or blank will check for any provider.
isCurrency(str [, options]) check if the string is a valid currency amount.

options is an object which defaults to { symbol: '$', require_symbol: false, allow_space_after_symbol: false, symbol_after_digits: false, allow_negatives: true, parens_for_negatives: false, negative_sign_before_digits: false, negative_sign_after_digits: false, allow_negative_sign_placeholder: false, thousands_separator: ',', decimal_separator: '.', allow_decimal: true, require_decimal: false, digits_after_decimal: [2], allow_space_after_digits: false }.
Note: The array digits_after_decimal is filled with the exact number of digits allowed not a range, for example a range 1 to 3 will be given as [1, 2, 3].
isDataURI(str) check if the string is a data uri format.
isDate(str [, options]) check if the string is a valid date. e.g. [2002-07-15, new Date()].

options is an object which can contain the keys format, strictMode and/or delimiters.

format is a string and defaults to YYYY/MM/DD.

strictMode is a boolean and defaults to false. If strictMode is set to true, the validator will reject strings different from format.

delimiters is an array of allowed date delimiters and defaults to ['/', '-'].
isDecimal(str [, options]) check if the string represents a decimal number, such as 0.1, .3, 1.1, 1.00003, 4.0, etc.

options is an object which defaults to {force_decimal: false, decimal_digits: '1,', locale: 'en-US'}.

locale determines the decimal separator and is one of ['ar', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-IQ', 'ar-JO', 'ar-KW', 'ar-LB', 'ar-LY', 'ar-MA', 'ar-QA', 'ar-QM', 'ar-SA', 'ar-SD', 'ar-SY', 'ar-TN', 'ar-YE', 'bg-BG', 'cs-CZ', 'da-DK', 'de-DE', 'el-GR', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'es-ES', 'fa', 'fa-AF', 'fa-IR', 'fr-FR', 'fr-CA', 'hu-HU', 'id-ID', 'it-IT', 'ku-IQ', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pl-Pl', 'pt-BR', 'pt-PT', 'ru-RU', 'sl-SI', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA', 'vi-VN'].
Note: decimal_digits is given as a range like '1,3', a specific value like '3' or min like '1,'.
isDivisibleBy(str, number) check if the string is a number that is divisible by another.
isEAN(str) check if the string is an EAN (European Article Number).
isEmail(str [, options]) check if the string is an email.

options is an object which defaults to { allow_display_name: false, require_display_name: false, allow_utf8_local_part: true, require_tld: true, allow_ip_domain: false, allow_underscores: false, domain_specific_validation: false, blacklisted_chars: '', host_blacklist: [] }. If allow_display_name is set to true, the validator will also match Display Name <email-address>. If require_display_name is set to true, the validator will reject strings without the format Display Name <email-address>. If allow_utf8_local_part is set to false, the validator will not allow any non-English UTF8 character in email address' local part. If require_tld is set to false, email addresses without a TLD in their domain will also be matched. If ignore_max_length is set to true, the validator will not check for the standard max length of an email. If allow_ip_domain is set to true, the validator will allow IP addresses in the host part. If domain_specific_validation is true, some additional validation will be enabled, e.g. disallowing certain syntactically valid email addresses that are rejected by Gmail. If blacklisted_chars receives a string, then the validator will reject emails that include any of the characters in the string, in the name part. If host_blacklist is set to an array of strings and the part of the email after the @ symbol matches one of the strings defined in it, the validation fails. If host_whitelist is set to an array of strings and the part of the email after the @ symbol matches none of the strings defined in it, the validation fails.
isEmpty(str [, options]) check if the string has a length of zero.

options is an object which defaults to { ignore_whitespace: false }.
isEthereumAddress(str) check if the string is an Ethereum address. Does not validate address checksums.
isFloat(str [, options]) check if the string is a float.

options is an object which can contain the keys min, max, gt, and/or lt to validate the float is within boundaries (e.g. { min: 7.22, max: 9.55 }) it also has locale as an option.

min and max are equivalent to 'greater or equal' and 'less or equal', respectively while gt and lt are their strict counterparts.

locale determines the decimal separator and is one of ['ar', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-IQ', 'ar-JO', 'ar-KW', 'ar-LB', 'ar-LY', 'ar-MA', 'ar-QA', 'ar-QM', 'ar-SA', 'ar-SD', 'ar-SY', 'ar-TN', 'ar-YE', 'bg-BG', 'cs-CZ', 'da-DK', 'de-DE', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'es-ES', 'fr-CA', 'fr-FR', 'hu-HU', 'it-IT', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'sl-SI', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA']. Locale list is validator.isFloatLocales.
isFQDN(str [, options]) check if the string is a fully qualified domain name (e.g. domain.com).

options is an object which defaults to { require_tld: true, allow_underscores: false, allow_trailing_dot: false, allow_numeric_tld: false, allow_wildcard: false, ignore_max_length: false }. If allow_wildcard is set to true, the validator will allow domain starting with *. (e.g. *.example.com or *.shop.example.com).
isFreightContainerID(str) alias for isISO6346, check if the string is a valid ISO 6346 shipping container identification.
isFullWidth(str) check if the string contains any full-width chars.
isHalfWidth(str) check if the string contains any half-width chars.
isHash(str, algorithm) check if the string is a hash of type algorithm.

Algorithm is one of ['crc32', 'crc32b', 'md4', 'md5', 'ripemd128', 'ripemd160', 'sha1', 'sha256', 'sha384', 'sha512', 'tiger128', 'tiger160', 'tiger192'].
isHexadecimal(str) check if the string is a hexadecimal number.
isHexColor(str) check if the string is a hexadecimal color.
isHSL(str) check if the string is an HSL (hue, saturation, lightness, optional alpha) color based on CSS Colors Level 4 specification.

Comma-separated format supported. Space-separated format supported with the exception of a few edge cases (ex: hsl(200grad+.1%62%/1)).
isIBAN(str, [, options]) check if the string is an IBAN (International Bank Account Number).

options is an object which accepts two attributes: whitelist: where you can restrict IBAN codes you want to receive data from and blacklist: where you can remove some of the countries from the current list. For both you can use an array with the following values ['AD','AE','AL','AT','AZ','BA','BE','BG','BH','BR','BY','CH','CR','CY','CZ','DE','DK','DO','EE','EG','ES','FI','FO','FR','GB','GE','GI','GL','GR','GT','HR','HU','IE','IL','IQ','IR','IS','IT','JO','KW','KZ','LB','LC','LI','LT','LU','LV','MC','MD','ME','MK','MR','MT','MU','MZ','NL','NO','PK','PL','PS','PT','QA','RO','RS','SA','SC','SE','SI','SK','SM','SV','TL','TN','TR','UA','VA','VG','XK'].
isIdentityCard(str [, locale]) check if the string is a valid identity card code.

locale is one of ['LK', 'PL', 'ES', 'FI', 'IN', 'IT', 'IR', 'MZ', 'NO', 'TH', 'zh-TW', 'he-IL', 'ar-LY', 'ar-TN', 'zh-CN', 'zh-HK'] OR 'any'. If 'any' is used, function will check if any of the locales match.

Defaults to 'any'.
isIMEI(str [, options])) check if the string is a valid IMEI number. IMEI should be of format ############### or ##-######-######-#.

options is an object which can contain the keys allow_hyphens. Defaults to first format. If allow_hyphens is set to true, the validator will validate the second format.
isIn(str, values) check if the string is in an array of allowed values.
isInt(str [, options]) check if the string is an integer.

options is an object which can contain the keys min and/or max to check the integer is within boundaries (e.g. { min: 10, max: 99 }). options can also contain the key allow_leading_zeroes, which when set to false will disallow integer values with leading zeroes (e.g. { allow_leading_zeroes: false }). Finally, options can contain the keys gt and/or lt which will enforce integers being greater than or less than, respectively, the value provided (e.g. {gt: 1, lt: 4} for a number between 1 and 4).
isIP(str [, version]) check if the string is an IP (version 4 or 6).
isIPRange(str [, version]) check if the string is an IP Range (version 4 or 6).
isISBN(str [, options]) check if the string is an ISBN.

options is an object that has no default.
Options:
version: ISBN version to compare to. Accepted values are '10' and '13'. If none provided, both will be tested.
isISIN(str) check if the string is an ISIN (stock/security identifier).
isISO6346(str) check if the string is a valid ISO 6346 shipping container identification.
isISO6391(str) check if the string is a valid ISO 639-1 language code.
isISO8601(str [, options]) check if the string is a valid ISO 8601 date.
options is an object which defaults to { strict: false, strictSeparator: false }. If strict is true, date strings with invalid dates like 2009-02-29 will be invalid. If strictSeparator is true, date strings with date and time separated by anything other than a T will be invalid.
isISO31661Alpha2(str) check if the string is a valid ISO 3166-1 alpha-2 officially assigned country code.
isISO31661Alpha3(str) check if the string is a valid ISO 3166-1 alpha-3 officially assigned country code.
isISO4217(str) check if the string is a valid ISO 4217 officially assigned currency code.
isISRC(str) check if the string is an ISRC.
isISSN(str [, options]) check if the string is an ISSN.

options is an object which defaults to { case_sensitive: false, require_hyphen: false }. If case_sensitive is true, ISSNs with a lowercase 'x' as the check digit are rejected.
isJSON(str [, options]) check if the string is valid JSON (note: uses JSON.parse).

options is an object which defaults to { allow_primitives: false }. If allow_primitives is true, the primitives 'true', 'false' and 'null' are accepted as valid JSON values.
isJWT(str) check if the string is valid JWT token.
isLatLong(str [, options]) check if the string is a valid latitude-longitude coordinate in the format lat,long or lat, long.

options is an object that defaults to { checkDMS: false }. Pass checkDMS as true to validate DMS(degrees, minutes, and seconds) latitude-longitude format.
isLength(str [, options]) check if the string's length falls in a range.

options is an object which defaults to { min: 0, max: undefined }. Note: this function takes into account surrogate pairs.
isLicensePlate(str, locale) check if the string matches the format of a country's license plate.

locale is one of ['cs-CZ', 'de-DE', 'de-LI', 'en-IN', 'en-PK', 'es-AR', 'hu-HU', 'pt-BR', 'pt-PT', 'sq-AL', 'sv-SE'] or 'any'.
isLocale(str) check if the string is a locale.
isLowercase(str) check if the string is lowercase.
isLuhnNumber(str) check if the string passes the Luhn algorithm check.
isMACAddress(str [, options]) check if the string is a MAC address.

options is an object which defaults to { no_separators: false }. If no_separators is true, the validator will allow MAC addresses without separators. Also, it allows the use of hyphens, spaces or dots e.g. '01 02 03 04 05 ab', '01-02-03-04-05-ab' or '0102.0304.05ab'. The options also allow a eui property to specify if it needs to be validated against EUI-48 or EUI-64. The accepted values of eui are: 48, 64.
isMagnetURI(str) check if the string is a Magnet URI format.
isMailtoURI(str, [, options]) check if the string is a Mailto URI format.

options is an object of validating emails inside the URI (check isEmails options for details).
isMD5(str) check if the string is a MD5 hash.

Please note that you can also use the isHash(str, 'md5') function. Keep in mind that MD5 has some collision weaknesses compared to other algorithms (e.g., SHA).
isMimeType(str) check if the string matches to a valid MIME type format.
isMobilePhone(str [, locale [, options]]) check if the string is a mobile phone number,

locale is either an array of locales (e.g. ['sk-SK', 'sr-RS']) OR one of ['am-Am', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-EH', 'ar-IQ', 'ar-JO', 'ar-KW', 'ar-PS', 'ar-SA', 'ar-SD', 'ar-SY', 'ar-TN', 'ar-YE', 'az-AZ', 'az-LB', 'az-LY', 'be-BY', 'bg-BG', 'bn-BD', 'bs-BA', 'ca-AD', 'cs-CZ', 'da-DK', 'de-AT', 'de-CH', 'de-DE', 'de-LU', 'dv-MV', 'dz-BT', 'el-CY', 'el-GR', 'en-AG', 'en-AI', 'en-AU', 'en-BM', 'en-BS', 'en-BW', 'en-CA', 'en-GB', 'en-GG', 'en-GH', 'en-GY', 'en-HK', 'en-IE', 'en-IN', 'en-JM', 'en-KE', 'en-KI', 'en-KN', 'en-LS', 'en-MO', 'en-MT', 'en-MU', 'en-MW', 'en-NG', 'en-NZ', 'en-PG', 'en-PH', 'en-PK', 'en-RW', 'en-SG', 'en-SL', 'en-SS', 'en-TZ', 'en-UG', 'en-US', 'en-ZA', 'en-ZM', 'en-ZW', 'es-AR', 'es-BO', 'es-CL', 'es-CO', 'es-CR', 'es-CU', 'es-DO', 'es-EC', 'es-ES', 'es-HN', 'es-MX', 'es-NI', 'es-PA', 'es-PE', 'es-PY', 'es-SV', 'es-UY', 'es-VE', 'et-EE', 'fa-AF', 'fa-IR', 'fi-FI', 'fj-FJ', 'fo-FO', 'fr-BE', 'fr-BF', 'fr-BJ', 'fr-CD', 'fr-CF', 'fr-FR', 'fr-GF', 'fr-GP', 'fr-MQ', 'fr-PF', 'fr-RE', 'fr-WF', 'ga-IE', 'he-IL', 'hu-HU', 'id-ID', 'ir-IR', 'it-IT', 'it-SM', 'ja-JP', 'ka-GE', 'kk-KZ', 'kl-GL', 'ko-KR', 'ky-KG', 'lt-LT', 'mg-MG', 'mn-MN', 'ms-MY', 'my-MM', 'mz-MZ', 'nb-NO', 'ne-NP', 'nl-AW', 'nl-BE', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-AO', 'pt-BR', 'pt-PT', 'ro-Md', 'ro-RO', 'ru-RU', 'si-LK', 'sk-SK', 'sl-SI', 'so-SO', 'sq-AL', 'sr-RS', 'sv-SE', 'tg-TJ', 'th-TH', 'tk-TM', 'tr-TR', 'uk-UA', 'uz-UZ', 'vi-VN', 'zh-CN', 'zh-HK', 'zh-MO', 'zh-TW'] OR defaults to 'any'. If 'any' or a falsey value is used, function will check if any of the locales match).

options is an optional object that can be supplied with the following keys: strictMode, if this is set to true, the mobile phone number must be supplied with the country code and therefore must start with +. Locale list is validator.isMobilePhoneLocales.
isMongoId(str) check if the string is a valid hex-encoded representation of a MongoDB ObjectId.
isMultibyte(str) check if the string contains one or more multibyte chars.
isNumeric(str [, options]) check if the string contains only numbers.

options is an object which defaults to { no_symbols: false } it also has locale as an option. If no_symbols is true, the validator will reject numeric strings that feature a symbol (e.g. +, -, or .).

locale determines the decimal separator and is one of ['ar', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-IQ', 'ar-JO', 'ar-KW', 'ar-LB', 'ar-LY', 'ar-MA', 'ar-QA', 'ar-QM', 'ar-SA', 'ar-SD', 'ar-SY', 'ar-TN', 'ar-YE', 'bg-BG', 'cs-CZ', 'da-DK', 'de-DE', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'es-ES', 'fr-FR', 'fr-CA', 'hu-HU', 'it-IT', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'sl-SI', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA'].
isOctal(str) check if the string is a valid octal number.
isPassportNumber(str, countryCode) check if the string is a valid passport number.

countryCode is one of ['AM', 'AR', 'AT', 'AU', 'AZ', 'BE', 'BG', 'BY', 'BR', 'CA', 'CH', 'CN', 'CY', 'CZ', 'DE', 'DK', 'DZ', 'EE', 'ES', 'FI', 'FR', 'GB', 'GR', 'HR', 'HU', 'IE', 'IN', 'IR', 'ID', 'IS', 'IT', 'JM', 'JP', 'KR', 'KZ', 'LI', 'LT', 'LU', 'LV', 'LY', 'MT', 'MX', 'MY', 'MZ', 'NL', 'NZ', 'PH', 'PK', 'PL', 'PT', 'RO', 'RU', 'SE', 'SL', 'SK', 'TH', 'TR', 'UA', 'US', 'ZA'].
isPort(str) check if the string is a valid port number.
isPostalCode(str, locale) check if the string is a postal code.

locale is one of ['AD', 'AT', 'AU', 'AZ', 'BA', 'BE', 'BG', 'BR', 'BY', 'CA', 'CH', 'CN', 'CZ', 'DE', 'DK', 'DO', 'DZ', 'EE', 'ES', 'FI', 'FR', 'GB', 'GR', 'HR', 'HT', 'HU', 'ID', 'IE', 'IL', 'IN', 'IR', 'IS', 'IT', 'JP', 'KE', 'KR', 'LI', 'LK', 'LT', 'LU', 'LV', 'MG', 'MT', 'MX', 'MY', 'NL', 'NO', 'NP', 'NZ', 'PL', 'PR', 'PT', 'RO', 'RU', 'SA', 'SE', 'SG', 'SI', 'SK', 'TH', 'TN', 'TW', 'UA', 'US', 'ZA', 'ZM'] OR 'any'. If 'any' is used, function will check if any of the locales match. Locale list is validator.isPostalCodeLocales.
isRFC3339(str) check if the string is a valid RFC 3339 date.
isRgbColor(str [, includePercentValues]) check if the string is a rgb or rgba color.

includePercentValues defaults to true. If you don't want to allow to set rgb or rgba values with percents, like rgb(5%,5%,5%), or rgba(90%,90%,90%,.3), then set it to false.
isSemVer(str) check if the string is a Semantic Versioning Specification (SemVer).
isSurrogatePair(str) check if the string contains any surrogate pairs chars.
isUppercase(str) check if the string is uppercase.
isSlug(str) check if the string is of type slug.
isStrongPassword(str [, options]) check if the string can be considered a strong password or not. Allows for custom requirements or scoring rules. If returnScore is true, then the function returns an integer score for the password rather than a boolean.
Default options:
{ minLength: 8, minLowercase: 1, minUppercase: 1, minNumbers: 1, minSymbols: 1, returnScore: false, pointsPerUnique: 1, pointsPerRepeat: 0.5, pointsForContainingLower: 10, pointsForContainingUpper: 10, pointsForContainingNumber: 10, pointsForContainingSymbol: 10 }
isTime(str [, options]) check if the string is a valid time e.g. [23:01:59, new Date().toLocaleTimeString()].

options is an object which can contain the keys hourFormat or mode.

hourFormat is a key and defaults to 'hour24'.

mode is a key and defaults to 'default'.

hourFomat can contain the values 'hour12' or 'hour24', 'hour24' will validate hours in 24 format and 'hour12' will validate hours in 12 format.

mode can contain the values 'default' or 'withSeconds', 'default' will validate HH:MM format, 'withSeconds' will validate the HH:MM:SS format.
isTaxID(str, locale) check if the string is a valid Tax Identification Number. Default locale is en-US.

More info about exact TIN support can be found in src/lib/isTaxID.js.

Supported locales: [ 'bg-BG', 'cs-CZ', 'de-AT', 'de-DE', 'dk-DK', 'el-CY', 'el-GR', 'en-CA', 'en-GB', 'en-IE', 'en-US', 'es-AR', 'es-ES', 'et-EE', 'fi-FI', 'fr-BE', 'fr-CA', 'fr-FR', 'fr-LU', 'hr-HR', 'hu-HU', 'it-IT', 'lb-LU', 'lt-LT', 'lv-LV', 'mt-MT', 'nl-BE', 'nl-NL', 'pl-PL', 'pt-BR', 'pt-PT', 'ro-RO', 'sk-SK', 'sl-SI', 'sv-SE' ].
isURL(str [, options]) check if the string is a URL.

options is an object which defaults to { protocols: ['http','https','ftp'], require_tld: true, require_protocol: false, require_host: true, require_port: false, require_valid_protocol: true, allow_underscores: false, host_whitelist: false, host_blacklist: false, allow_trailing_dot: false, allow_protocol_relative_urls: false, allow_fragments: true, allow_query_components: true, disallow_auth: false, validate_length: true }.

require_protocol - if set to true isURL will return false if protocol is not present in the URL.
require_valid_protocol - isURL will check if the URL's protocol is present in the protocols option.
protocols - valid protocols can be modified with this option.
require_host - if set to false isURL will not check if host is present in the URL.
require_port - if set to true isURL will check if port is present in the URL.
allow_protocol_relative_urls - if set to true protocol relative URLs will be allowed.
allow_fragments - if set to false isURL will return false if fragments are present.
allow_query_components - if set to false isURL will return false if query components are present.
validate_length - if set to false isURL will skip string length validation (2083 characters is IE max URL length).
isUUID(str [, version]) check if the string is a UUID (version 1, 2, 3, 4 or 5).
isVariableWidth(str) check if the string contains a mixture of full and half-width chars.
isVAT(str, countryCode) check if the string is a valid VAT number if validation is available for the given country code matching ISO 3166-1 alpha-2.

countryCode is one of ['AL', 'AR', 'AT', 'AU', 'BE', 'BG', 'BO', 'BR', 'BY', 'CA', 'CH', 'CL', 'CO', 'CR', 'CY', 'CZ', 'DE', 'DK', 'DO', 'EC', 'EE', 'EL', 'ES', 'FI', 'FR', 'GB', 'GT', 'HN', 'HR', 'HU', 'ID', 'IE', 'IL', 'IN', 'IS', 'IT', 'KZ', 'LT', 'LU', 'LV', 'MK', 'MT', 'MX', 'NG', 'NI', 'NL', 'NO', 'NZ', 'PA', 'PE', 'PH', 'PL', 'PT', 'PY', 'RO', 'RS', 'RU', 'SA', 'SE', 'SI', 'SK', 'SM', 'SV', 'TR', 'UA', 'UY', 'UZ', 'VE'].
isWhitelisted(str, chars) check if the string consists only of characters that appear in the whitelist chars.
matches(str, pattern [, modifiers]) check if the string matches the pattern.

Either matches('foo', /foo/i) or matches('foo', 'foo', 'i').

Sanitizers

Here is a list of the sanitizers currently available.

Sanitizer Description
blacklist(input, chars) remove characters that appear in the blacklist. The characters are used in a RegExp and so you will need to escape some chars, e.g. blacklist(input, '\\[\\]').
escape(input) replace <, >, &, ', " and / with HTML entities.
ltrim(input [, chars]) trim characters from the left-side of the input.
normalizeEmail(email [, options]) canonicalize an email address. (This doesn't validate that the input is an email, if you want to validate the email use isEmail beforehand).

options is an object with the following keys and default values:
  • all_lowercase: true - Transforms the local part (before the @ symbol) of all email addresses to lowercase. Please note that this may violate RFC 5321, which gives providers the possibility to treat the local part of email addresses in a case sensitive way (although in practice most - yet not all - providers don't). The domain part of the email address is always lowercased, as it is case insensitive per RFC 1035.
  • gmail_lowercase: true - Gmail addresses are known to be case-insensitive, so this switch allows lowercasing them even when all_lowercase is set to false. Please note that when all_lowercase is true, Gmail addresses are lowercased regardless of the value of this setting.
  • gmail_remove_dots: true: Removes dots from the local part of the email address, as Gmail ignores them (e.g. "john.doe" and "johndoe" are considered equal).
  • gmail_remove_subaddress: true: Normalizes addresses by removing "sub-addresses", which is the part following a "+" sign (e.g. "[email protected]" becomes "[email protected]").
  • gmail_convert_googlemaildotcom: true: Converts addresses with domain @googlemail.com to @gmail.com, as they're equivalent.
  • outlookdotcom_lowercase: true - Outlook.com addresses (including Windows Live and Hotmail) are known to be case-insensitive, so this switch allows lowercasing them even when all_lowercase is set to false. Please note that when all_lowercase is true, Outlook.com addresses are lowercased regardless of the value of this setting.
  • outlookdotcom_remove_subaddress: true: Normalizes addresses by removing "sub-addresses", which is the part following a "+" sign (e.g. "[email protected]" becomes "[email protected]").
  • yahoo_lowercase: true - Yahoo Mail addresses are known to be case-insensitive, so this switch allows lowercasing them even when all_lowercase is set to false. Please note that when all_lowercase is true, Yahoo Mail addresses are lowercased regardless of the value of this setting.
  • yahoo_remove_subaddress: true: Normalizes addresses by removing "sub-addresses", which is the part following a "-" sign (e.g. "[email protected]" becomes "[email protected]").
  • icloud_lowercase: true - iCloud addresses (including MobileMe) are known to be case-insensitive, so this switch allows lowercasing them even when all_lowercase is set to false. Please note that when all_lowercase is true, iCloud addresses are lowercased regardless of the value of this setting.
  • icloud_remove_subaddress: true: Normalizes addresses by removing "sub-addresses", which is the part following a "+" sign (e.g. "[email protected]" becomes "[email protected]").
rtrim(input [, chars]) trim characters from the right-side of the input.
stripLow(input [, keep_new_lines]) remove characters with a numerical value < 32 and 127, mostly control characters. If keep_new_lines is true, newline characters are preserved (\n and \r, hex 0xA and 0xD). Unicode-safe in JavaScript.
toBoolean(input [, strict]) convert the input string to a boolean. Everything except for '0', 'false' and '' returns true. In strict mode only '1' and 'true' return true.
toDate(input) convert the input string to a date, or null if the input is not a date.
toFloat(input) convert the input string to a float, or NaN if the input is not a float.
toInt(input [, radix]) convert the input string to an integer, or NaN if the input is not an integer.
trim(input [, chars]) trim characters (whitespace by default) from both sides of the input.
unescape(input) replace HTML encoded entities with <, >, &, ', " and /.
whitelist(input, chars) remove characters that do not appear in the whitelist. The characters are used in a RegExp and so you will need to escape some chars, e.g. whitelist(input, '\\[\\]').

XSS Sanitization

XSS sanitization was removed from the library in 2d5d6999.

For an alternative, have a look at Yahoo's xss-filters library or at DOMPurify.

Contributing

In general, we follow the "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Work on your fork
    1. Make your changes and additions
      • Most of your changes should be focused on src/ and test/ folders and/or README.md.
      • Files such as validator.js, validator.min.js and files in lib/ folder are autogenerated when running tests (npm test) and need not to be changed manually.
    2. Change or add tests if needed
    3. Run tests and make sure they pass
    4. Add changes to README.md if needed
  4. Commit changes to your own branch
  5. Make sure you merge the latest from "upstream" and resolve conflicts if there is any
  6. Repeat step 3(3) above
  7. Push your work back up to your fork
  8. Submit a Pull request so that we can review your changes

Tests

Tests are using mocha, to run the tests use:

$ npm test

Maintainers

Reading

Remember, validating can be troublesome sometimes. See A list of articles about programming assumptions commonly made that aren't true.

License (MIT)

Copyright (c) 2018 Chris O'Hara <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

validator.js's People

Contributors

addaleax avatar ademyan05 avatar calidion avatar chriso avatar ctavan avatar dcthetall avatar ezkemboi avatar fedeci avatar forabi avatar ftrevo avatar gdraganic avatar hkwu avatar idrisakmal avatar italypaleale avatar ivikulin avatar linkinmedo avatar maxattax97 avatar michaltk avatar mika-s avatar neilime avatar pano9000 avatar parasg1999 avatar profnandaa avatar ravestack avatar rubiin avatar tarpsvo avatar tbasse avatar tux-tn avatar vipul-21 avatar wikirik avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

validator.js's Issues

_errors

I've created a custom error function to allow the all validations to run as a chain and collect the errors into an array (currently they short circuit on the first error).

Along the way I noticed that there's already an _errors array defined on the validator, but I don't see where it's used. Was the initial idea to collect all errors on the chain into the _errors array? Maybe I missed something.

Why throw an error after every check?

I noticed that you have this._errors = []; in check(), but it appears to be unused unless you override the Validator.prototype.error() handler to push to that array after an error.

Frankly, what's the point of throwing an error after every single check? In most cases you would want to run a batch of individual check()s and then do something with the errors.

Consider this:

var v = new Validator();

v.check(data.a, 'error message').notNull().len(6);
v.check(data.b, 'error message').notNull().is(/^[a-z]+$/);
v.check(data.c, 'error message').notNull().isEmail();
v.check(data.d, 'error message').notNull().isInt();

if(v.errors)
{
  // handle accumulated errors
}

I think this format would allow Validator to be far more flexible.

If you don't want to change the API that much, maybe something like this?

var v = require('validator');
var check = v.check;


v.captureErrors();   // Errors will start accumulating to that error array. If this isn't called, each individual check() throws an error like normal

check(data.a, 'error message').notNull().len(6);
check(data.b, 'error message').notNull().is(/^[a-z]+$/);
check(data.c, 'error message').notNull().isEmail();
check(data.d, 'error message').notNull().isInt();

if(v.errors)
{
  // handle accumulated errors
}

v.flushErrors();   // Helper method for clearing out the array error.

Let me know what you think of this. I can form a pull request with these changes if you'd like.

isCreditCard can't replace space

if credit card number have space, isCreditCard can't replace it....
i check the code ( validator.js line 299 ), there is line like this...

this.str.replace(/[^0-9]+/g, ''); //remove all dashes, spaces, etc.

but this line doesn't work...

Custom Error Messages

It's be good if either the error messages were defined as variables on the Validator object or if perhaps they were able to be customised somehow.

Use case:

Trying to write tests that my models validate correctly, I need to validate against arbitrary strings that just happen to be spat out by the program, and will break if you ever update those error messages. I don't actually care about the content of the message, just that the right message has been thrown, but currently I'm forced to test against the content of the message.

Perhaps the last param of each check call could be a 'custom message' param.

Additionally, it'd make i18n easier.

Objects don't passed in validator

This condition in Validator.prototype.check don't converts objects without length fild into empty strings:
this.str = (str == null || (isNaN(str) && str.length == undefined)) ? '' : str;
Is it really necessarry?

Support for asynchronous validation

I know this is a big chunk of functionality and would probably change the plumbing a lot, but it would be nice to see async validation in node-validator. What I mean is something like this:

// Validator that checks database records async
Validator.addAsync('userExists', function (value, message, callback) {
    User.findOne({username: value, function(err, user) {
        if (err || !user) {
            callback(message, false); // invalid
        } else {
            callback(message, true); 
        }
    });
}

// We use it like so:
Validator.check('[email protected]').userExists(); // And it should behave the same way as the other validators

Do you think something like this might be possible? It would enable me to get rid of so many nested callbacks... :)

Funky behavior from Entities variable.

I had some funky issues with moving the code in the entities variable, such as &shy (the soft hyphen) disappearing (JSLint says this is an unsafe character and I can see why now), as well as a weird session with closure compiler converting the html escaped symbols and literal characters to \ufffd in one pass (possibly more &shy behavior), so I thought it was best all around to just use a native escape.

Also, I fixed nbsp with the proper escape code which was originally was using a space, not sure if that was intentional or not.
Here's a fixed up entities.
var entities = {
' ': '\u00a0',
'¡': '\u00a1',
'¢': '\u00a2',
'£': '\u00a3',
'¤': '\u20ac',
'¥': '\u00a5',
'¦': '\u0160',
'§': '\u00a7',
'¨': '\u0161',
'©': '\u00a9',
'ª': '\u00aa',
'«': '\u00ab',
'¬': '\u00ac',
'­': '\u00ad',
'®': '\u00ae',
'¯': '\u00af',
'°': '\u00b0',
'±': '\u00b1',
'²': '\u00b2',
'³': '\u00b3',
'´': '\u017d',
'µ': '\u00b5',
'¶': '\u00b6',
'·': '\u00b7',
'¸': '\u017e',
'¹': '\u00b9',
'º': '\u00ba',
'»': '\u00bb',
'¼': '\u0152',
'½': '\u0153',
'¾': '\u0178',
'¿': '\u00bf',
'À': '\u00c0',
'Á': '\u00c1',
'Â': '\u00c2',
'Ã': '\u00c3',
'Ä': '\u00c4',
'Å': '\u00c5',
'Æ': '\u00c6',
'Ç': '\u00c7',
'È': '\u00c8',
'É': '\u00c9',
'Ê': '\u00ca',
'Ë': '\u00cb',
'Ì': '\u00cc',
'Í': '\u00cd',
'Î': '\u00ce',
'Ï': '\u00cf',
'Ð': '\u00d0',
'Ñ': '\u00d1',
'Ò': '\u00d2',
'Ó': '\u00d3',
'Ô': '\u00d4',
'Õ': '\u00d5',
'Ö': '\u00d6',
'×': '\u00d7',
'Ø': '\u00d8',
'Ù': '\u00d9',
'Ú': '\u00da',
'Û': '\u00db',
'Ü': '\u00dc',
'Ý': '\u00dd',
'Þ': '\u00de',
'ß': '\u00df',
'à': '\u00e0',
'á': '\u00e1',
'â': '\u00e2',
'ã': '\u00e3',
'ä': '\u00e4',
'å': '\u00e5',
'æ': '\u00e6',
'ç': '\u00e7',
'è': '\u00e8',
'é': '\u00e9',
'ê': '\u00ea',
'ë': '\u00eb',
'ì': '\u00ec',
'í': '\u00ed',
'î': '\u00ee',
'ï': '\u00ef',
'ð': '\u00f0',
'ñ': '\u00f1',
'ò': '\u00f2',
'ó': '\u00f3',
'ô': '\u00f4',
'õ': '\u00f5',
'ö': '\u00f6',
'÷': '\u00f7',
'ø': '\u00f8',
'ù': '\u00f9',
'ú': '\u00fa',
'û': '\u00fb',
'ü': '\u00fc',
'ý': '\u00fd',
'þ': '\u00fe',
'ÿ': '\u00ff',
'"': '\u0022',
'<': '\u003c',
'>': '\u003e',
''': '\u0027',
'−': '\u2212',
'ˆ': '\u02c6',
'˜': '\u02dc',
'Š': '\u0160',
'‹': '\u2039',
'Œ': '\u0152',
'‘': '\u2018',
'’': '\u2019',
'“': '\u201c',
'”': '\u201d',
'•': '\u2022',
'–': '\u2013',
'—': '\u2014',
'™': '\u2122',
'š': '\u0161',
'›': '\u203a',
'œ': '\u0153',
'Ÿ': '\u0178',
'ƒ': '\u0192',
'Α': '\u0391',
'Β': '\u0392',
'Γ': '\u0393',
'Δ': '\u0394',
'Ε': '\u0395',
'Ζ': '\u0396',
'Η': '\u0397',
'Θ': '\u0398',
'Ι': '\u0399',
'Κ': '\u039a',
'Λ': '\u039b',
'Μ': '\u039c',
'Ν': '\u039d',
'Ξ': '\u039e',
'Ο': '\u039f',
'Π': '\u03a0',
'Ρ': '\u03a1',
'Σ': '\u03a3',
'Τ': '\u03a4',
'Υ': '\u03a5',
'Φ': '\u03a6',
'Χ': '\u03a7',
'Ψ': '\u03a8',
'Ω': '\u03a9',
'α': '\u03b1',
'β': '\u03b2',
'γ': '\u03b3',
'δ': '\u03b4',
'ε': '\u03b5',
'ζ': '\u03b6',
'η': '\u03b7',
'θ': '\u03b8',
'ι': '\u03b9',
'κ': '\u03ba',
'λ': '\u03bb',
'μ': '\u03bc',
'ν': '\u03bd',
'ξ': '\u03be',
'ο': '\u03bf',
'π': '\u03c0',
'ρ': '\u03c1',
'ς': '\u03c2',
'σ': '\u03c3',
'τ': '\u03c4',
'υ': '\u03c5',
'φ': '\u03c6',
'χ': '\u03c7',
'ψ': '\u03c8',
'ω': '\u03c9',
'ϑ': '\u03d1',
'ϒ': '\u03d2',
'ϖ': '\u03d6',
' ': '\u2002',
' ': '\u2003',
' ': '\u2009',
'‌': '\u200c',
'‍': '\u200d',
'‎': '\u200e',
'‏': '\u200f',
'‚': '\u201a',
'„': '\u201e',
'†': '\u2020',
'‡': '\u2021',
'…': '\u2026',
'‰': '\u2030',
'′': '\u2032',
'″': '\u2033',
'‾': '\u203e',
'⁄': '\u2044',
'€': '\u20ac',
'ℑ': '\u2111',
'℘': '\u2118',
'ℜ': '\u211c',
'ℵ': '\u2135',
'←': '\u2190',
'↑': '\u2191',
'→': '\u2192',
'↓': '\u2193',
'↔': '\u2194',
'↵': '\u21b5',
'⇐': '\u21d0',
'⇑': '\u21d1',
'⇒': '\u21d2',
'⇓': '\u21d3',
'⇔': '\u21d4',
'∀': '\u2200',
'∂': '\u2202',
'∃': '\u2203',
'∅': '\u2205',
'∇': '\u2207',
'∈': '\u2208',
'∉': '\u2209',
'∋': '\u220b',
'∏': '\u220f',
'∑': '\u2211',
'∗': '\u2217',
'√': '\u221a',
'∝': '\u221d',
'∞': '\u221e',
'∠': '\u2220',
'∧': '\u2227',
'∨': '\u2228',
'∩': '\u2229',
'∪': '\u222a',
'∫': '\u222b',
'∴': '\u2234',
'∼': '\u223c',
'≅': '\u2245',
'≈': '\u2248',
'≠': '\u2260',
'≡': '\u2261',
'≤': '\u2264',
'≥': '\u2265',
'⊂': '\u2282',
'⊃': '\u2283',
'⊄': '\u2284',
'⊆': '\u2286',
'⊇': '\u2287',
'⊕': '\u2295',
'⊗': '\u2297',
'⊥': '\u22a5',
'⋅': '\u22c5',
'⌈': '\u2308',
'⌉': '\u2309',
'⌊': '\u230a',
'⌋': '\u230b',
'⟨': '\u2329',
'⟩': '\u232a',
'◊': '\u25ca',
'♠': '\u2660',
'♣': '\u2663',
'♥': '\u2665',
'♦': '\u2666'
};

in is a reserved word.

"in" is a reserved word in javascript. Wouldn't it be cleaner to rename the in()-method into something like inList() ?

Browser Usage - Is this a tested scenario?

The readme mentions in a browser to use validator-min.js. Just so we're clear this is exactly the same as validator.js just minified for convenience?

Are there any other dependencies for client-side usage?

I seem to get:
ReferenceError: str is not defined
http://localhost:6002/static/js/validator-min.js?q=1305296710
Line 23

I include that on a page, and in console test check('abc').isInt() etc..

I tried to look in test folder to see if any examples of client side usage but nothing

XSS and numeric code character entities

I'm applying xss sanitization to user input and I'm having problems with numeric entities:

> sanitize("Don&quot;t").xss();
'Don&quot;t'
> sanitize("Don&#39;t").xss();
'Don&#;39t'

Notice the second example producing an incorrect entity.

validator-min.js has a broken xssClean script (or is it just outdated?)

This segment in validator-min.js breaks the sanitizing of "aaa<a>bbb</a>", producing "aaaundefined>bbb</a>" as a result.

(around line 23, column 6460):

b=b.replace(/<\w+.*?(?=>|<|$)/gi,function(a,b){}),

This code is not found on validator.js.

To test:

in a project including validator run:

var x=require('./node_modules/validator/validator-min.js')
x.sanitize('aaa<a>bbb</a>').xss()

Expected output:
'aaa<a>bbb</a>'

Actual output:
'aaaundefined>bbb</a>'

Renaming function names for consistency

It would be consistent if the following methods were renamed to:

not() -> isNot()
notNull() -> isNotNull()
notEmpty() -> isNotEmpty()
notContains() -> doesNotContain()
reqex() -> isRegExp() // Follow Javascript convention
notRegex() -> isNotRegExp()
len() -> hasLength()
notIn() -> isNotIn()
max() -> isMax()
min() -> isMin()
len() -> hasLength() or hasLengthOf()

In this way it reads like english just like all the other methods.

I was going to implement this myself and make a pull request but I didn't know how to run the tests. How are they run and what testing library is it? (Mocha is a good one, simple to write, read and run. Good for collaboration)

unexpected behavior isNull and notNull

isNull and notNull are implemented in this way

notNull: function(str) {
    return str !== '';
},
isNull: function(str) {
    return str === '';
},

which checks if the string is empty and not if the object is null.
Wouldn't be

isNull: function(str) {
    return str === null;
},
notNull: function(str) {
    return !validators.isNull(str);
}

be more consistent with the validation name?

XSS check is too aggressive?

I've been checking out your xss code and wonder if it is not too aggressive.

As far as I know, the only thing you need to do is:

  1. escape quotes (or html encode these?)
  2. decode strange strings like <a href=java&#1&#2&#3&#4&#5&#6&#7&#8&#11&#12script:alert(1)>XXX</a> to normal html
  3. html encode string to html entities

Eg <script> will become &lt;script&gt;

Thus, you do not have to remove<script> or check for other html elements.. you simply html encode these.

You seem to be doing a lot more unneeded procedures. Am I wrong here in that there are more steps involved then the two listed above?

Thanks a lot for your hard work.

Suggested change in API/behavior

I'd like to suggest a more callback oriented API, without constant reconstruction of a validator object whenever validation has to occur. Especially if you get a lot of requests, you do not want to create a new validator object each time:

   var v = require('validator');
   v.check('str', function() {
          //str is not an integer
   }).isInt();

This makes sure that no new validator object has to be instantiated on each request (if one needs specific error behavior for each request) and that no try catch logic is needed.

xss.js

Would you consider rewriting the 'for(var i in compact_words)' (line97) to a normal for loop (perhaps all array iterators)?
Or add an ".hasOwnProperty" check?

The current code crashes under Node.js in combination with several other modules that extend the Array object since your iterator will try to do a ".split" on the extended properties which happen to be functions.

Semi-colon insertion

A string like:

sanitize("Bob&&Alice" ).xss();

gets a semicolon inserted and turns into "Bob&&Alice;".

It's just a string and not javascript. How do I prevent this? Thanks.

User-friendly error messages

I'll admit that I'm being rather picky here, but many computer users don't know what "strings" are. I'd really love to present the user with the node-validator default error message, but "String is too short" is not quite what I'd like to present to the user. "Value is too short" is a bit better.

All this computer jargon about strings and threads... people will think we are sewing, not programming.

I'd fork and submit a pull request, but it's such a small change. Thoughts?

Validating empty strings

I think it might be better for an empty string to pass tests such as "isAlpha", "isLowercase" etc, as you can add always add "notEmpty".

Validation zero by isInt()

I got the message "Invalid number" when I run this line.

require('validator').check(0).isInt()

Zero isn't int? Or I must input just string value?
It's ok when this line.

require('validator').check(100).isInt()

isuuid should be isUUID

According to the document, isUUID is correct.

validators.js: 104

    -- isuuid: function(str, version)
    ++ isUUID: function(str, version)

Regards.

prototypes

Hello,

I define some prototypes in a file (array and string), and when this file is required, I have the next error while I do "sanitize(a).xss();" :

has no method 'split'
at Object.clean (/home/mod/modygo/node_modules/validator/lib/xss.js:102:42)
at [object Object].xss (/home/mod/modygo/node_modules/validator/lib/filter.js:32:21)
at Object. (/home/mod/modygo/temp.js:21:21)
at Module._compile (module.js:411:26)
at Object..js (module.js:417:10)
at Module.load (module.js:343:31)
at Function._load (module.js:302:12)
at Array. (module.js:430:10)
at EventEmitter._tickCallback (node.js:126:26)

Can you please help me?

Thanks,
Philippe

.xss() crashes on "%"

The .xss() method crashes with

URIError: URI malformed
at decodeURIComponent (native)
at Object.clean (.../node_modules/validator/lib/xss.js:67:11)
at [object Object].xss .../node_modules/validator/lib/filter.js:19:21)

when called on any string that contains '%'.

Purpose and impact of xss() is unclear

The current documentation doesn't really address when xss() is appropriate. Having looked at the source code, it appears to be appropriate only when you intend to display the user's input to others without entity escaping. That makes sense if you're allowing users to edit things with a rich text editor, or encouraging the use of HTML tags, but it doesn't make sense if you're going to entity escape at output time.

For instance it would never make sense to use the xss() filter on a blog post title - those should just be entity escaped; if a user types a < or > there it is presumably meant to appear as such.

"Remove common XSS attack vectors from user-supplied HTML" would be a better description. It's worth mentioning that entity escaping is a better solution when it is not your goal to allow any HTML in the first place.

Thanks for an excellent validation library!

decouple rules

hello chriso,

i like your library and have used it in some node projects. kudos to you
i am interested in using the rules of the validator directly without method chaining.

your current code attaches all functions directly to the prototype.
i would like it if the validation functions would be decoupled from the actual validator class.

this would make it possible to reuse them more easily.

if you are interested, i will fork and come back to you with a pull request

xss filter_attributes doesn't work as intended

Looks like there's three problems:

  1. Global leak with out, should be var out = '';

  2. Regexp replace uses $out instead of out.

  3. Regexp is not valid, back references can't be used in character classes.

    Perhaps it's intended to be /\s*[a-z\-]+\s*=\s*(\042|\047)(?:(?!\1).*?)\1/gi.
    However, that results in the following behavior:

 > var s = require('./lib');
 > s.sanitize("<a href=\"javascript:alert('xss')\">some text</a>").xss();
 '<a \'xss\')">some text</a>'

isUrl() validator rejects localhost URLs

The isUrl() validator rejects URLs with hostnames that don't contain dots, like localhost, for example:

http://localhost:8000/en-US/badges/badge/test-day-hero/awards/9.json

Here's a quick runthrough:

% git clone git://github.com/chriso/node-validator.git
Cloning into node-validator...
remote: Counting objects: 848, done.
remote: Compressing objects: 100% (311/311), done.
remote: Total 848 (delta 570), reused 805 (delta 534)
Receiving objects: 100% (848/848), 135.66 KiB, done.
Resolving deltas: 100% (570/570), done.
% cd node-validator 
% node
> validator = require('validator')
{ entities: { encode: [Function], decode: [Function] },
  xssClean: [Function],
  Validator: [Function],
  Filter: [Function],
  convert: [Function],
  sanitize: [Function],
  assert: [Function],
  validate: [Function],
  check: [Function] }
> my_url = 'http://localhost:8000/en-US/badges/badge/test-day-hero/awards/9.json'
'http://localhost:8000/en-US/badges/badge/test-day-hero/awards/9.json'
> validator.check(my_url).isUrl()
Error: Invalid URL
    at [object Object].error (/Users/lorchard/devel/mozilla/badger2/tmp/node-validator/validator.js:538:15)
    at [object Object].isUrl (/Users/lorchard/devel/mozilla/badger2/tmp/node-validator/validator.js:559:25)
    at repl:1:26
    at REPLServer.eval (repl.js:80:21)
    at Interface.<anonymous> (repl.js:182:12)
    at Interface.emit (events.js:67:17)
    at Interface._onLine (readline.js:162:10)
    at Interface._line (readline.js:426:8)
    at Interface._ttyWrite (readline.js:603:14)
    at ReadStream.<anonymous> (readline.js:82:12)
> 

sanitize().toInt() and check().notEmpty()

Hi, I`m doing something like this:

try {
    var foo = sanitize('foo 55 bar').toInt();
    console.log('After sanitize', foo); // NaN
    check(foo).notEmpty(); // Not throwing an error
} catch(e) {
    console.log(e);
}

check(foo).notEmpty() not throwing an error if foo = NaN. As "NaN" is mathematical error, i think check(foo).notEmpty() should throw an error.

I think it can be fixed like that:

Validator.prototype.notEmpty = function() {
    if (!this.str) {
        this.error(this.msg || 'String is empty');
    }
    if (this.str.match(/^[\s\t\r\n]*$/)) {
        this.error(this.msg || 'String is whitespace');
    }
    return this;
}

Thanks.

Global Leak : pattern

Hi, I found a missing var in validators.js while I was writing test with mocha.

There is no pattern variable in arguments, so must be declared in the function.

at line 104

    isuuid: function(str, version) {
++      var pattern = ''
        if (version == 3 || version == 'v3') {

Regards.

xss() does not remove inline event handlers

eg,

try me

the event handler does not get stripped out by xss()

although I could use entityEncode() as a workaround to prevent all HTML..

not sure if this is a bug or a documentation thing, I just assumed it should work.

Validator regex bug for isUrl

Chriso, I found a bug in the isUrl validator, where it thinks that the following string is a valid URL:

"1." or "123." or "asd."

The bug is an (i think) extraneous question mark after the TLD group, unless this is intentional.

  • J

.xss() error

Great work on this library, it's pretty sweet.

One thing I noticed though is that the text: I <3 this

Becomes: I undefined

When passed through .xss()

I tried looking, but couldn't find what was breaking it. If I find it, I'll submit a patch.

isDate() validation

Hi Chris,
had some trouble with the isDate() check. I had a look at the regex and it themes like it would expect something like MM/DD/YYYY but when the regex part is successful the next part fails .
Could you have a look at it and maybe include it in your test file.

Cheers,
Nico

Feature Request: Validation of UUIDs

I would love to see some UUID validation like...

/^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$/

.. or something ;-)

isBoolean?

Would isBoolean() be a good validator?

Some fields only accepts true or false (checkboxes).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.