IBANValidator.java
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.validator.routines;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import org.apache.commons.validator.routines.checkdigit.IBANCheckDigit;
/**
* IBAN Validator.
* <p>
* The validator includes a default set of formats derived from the IBAN registry at
* https://www.swift.com/standards/data-standards/iban.
* </p>
* <p>
* This can get out of date, but the set can be adjusted by creating a validator and using the
* {@link #setValidator(String, int, String)} or
* {@link #setValidator(Validator)}
* method to add (or remove) an entry.
* </p>
* <p>
* For example:
* </p>
* <pre>
* IBANValidator ibv = new IBANValidator();
* ibv.setValidator("XX", 12, "XX\\d{10}")
* </pre>
* <p>
* The singleton default instance cannot be modified in this way.
* </p>
* @since 1.5.0
*/
public class IBANValidator {
/**
* The validation class
*/
public static class Validator {
/*
* The minimum length does not appear to be defined by the standard.
* Norway is currently the shortest at 15.
*
* There is no standard for BBANs; they vary between countries.
* But a BBAN must consist of a branch id and account number.
* Each of these must be at least 2 chars (generally more) so an absolute minimum is
* 4 characters for the BBAN and 8 for the IBAN.
*/
private static final int MIN_LEN = 8;
private static final int MAX_LEN = 34; // defined by [3]
final String countryCode;
final String[] otherCountryCodes;
final RegexValidator regexValidator;
final int ibanLength; // used to avoid unnecessary regex matching
/**
* Creates the validator.
* @param countryCode the country code
* @param ibanLength the length of the IBAN
* @param regexWithCC the regex to use to check the format, the regex MUST start with the country code.
*/
public Validator(final String countryCode, final int ibanLength, final String regexWithCC) {
this(countryCode, ibanLength, regexWithCC.substring(countryCode.length()), new String[] {});
}
/**
* Creates the validator.
* @param countryCode the country code
* @param ibanLength the length of the IBAN
* @param regexWithoutCC the regex to use to check the format, the regex MUST NOT start with the country code.
*/
Validator(final String countryCode, final int ibanLength, final String regexWithoutCC, final String... otherCountryCodes) {
if (!(countryCode.length() == 2 && Character.isUpperCase(countryCode.charAt(0)) && Character.isUpperCase(countryCode.charAt(1)))) {
throw new IllegalArgumentException("Invalid country Code; must be exactly 2 upper-case characters");
}
if (ibanLength > MAX_LEN || ibanLength < MIN_LEN) {
throw new IllegalArgumentException("Invalid length parameter, must be in range " + MIN_LEN + " to " + MAX_LEN + " inclusive: " + ibanLength);
}
final String regex = countryCode + regexWithoutCC;
if (!regex.startsWith(countryCode)) {
throw new IllegalArgumentException("countryCode '" + countryCode + "' does not agree with format: " + regex);
}
this.countryCode = countryCode;
this.otherCountryCodes = otherCountryCodes.clone();
final List<String> regexList = new ArrayList<>(this.otherCountryCodes.length + 1);
regexList.add(countryCode + regexWithoutCC);
for (final String otherCc : otherCountryCodes) {
regexList.add(otherCc + regexWithoutCC);
}
this.ibanLength = ibanLength;
this.regexValidator = new RegexValidator(regexList);
}
/**
* Gets the RegexValidator.
*
* @return the RegexValidator.
* @since 1.8
*/
public RegexValidator getRegexValidator() {
return regexValidator;
}
}
private static final int SHORT_CODE_LEN = 2;
private static final Validator[] DEFAULT_VALIDATORS = { //
new Validator("AD", 24, "AD\\d{10}[A-Z0-9]{12}"), // Andorra
new Validator("AE", 23, "AE\\d{21}"), // United Arab Emirates (The)
new Validator("AL", 28, "AL\\d{10}[A-Z0-9]{16}"), // Albania
new Validator("AT", 20, "AT\\d{18}"), // Austria
new Validator("AZ", 28, "AZ\\d{2}[A-Z]{4}[A-Z0-9]{20}"), // Azerbaijan
new Validator("BA", 20, "BA\\d{18}"), // Bosnia and Herzegovina
new Validator("BE", 16, "BE\\d{14}"), // Belgium
new Validator("BG", 22, "BG\\d{2}[A-Z]{4}\\d{6}[A-Z0-9]{8}"), // Bulgaria
new Validator("BH", 22, "BH\\d{2}[A-Z]{4}[A-Z0-9]{14}"), // Bahrain
new Validator("BI", 27, "BI\\d{25}"), // Burundi
new Validator("BR", 29, "BR\\d{25}[A-Z]{1}[A-Z0-9]{1}"), // Brazil
new Validator("BY", 28, "BY\\d{2}[A-Z0-9]{4}\\d{4}[A-Z0-9]{16}"), // Republic of Belarus
new Validator("CH", 21, "CH\\d{7}[A-Z0-9]{12}"), // Switzerland
new Validator("CR", 22, "CR\\d{20}"), // Costa Rica
new Validator("CY", 28, "CY\\d{10}[A-Z0-9]{16}"), // Cyprus
new Validator("CZ", 24, "CZ\\d{22}"), // Czechia
new Validator("DE", 22, "DE\\d{20}"), // Germany
new Validator("DJ", 27, "DJ\\d{25}"), // Djibouti
new Validator("DK", 18, "DK\\d{16}"), // Denmark
new Validator("DO", 28, "DO\\d{2}[A-Z0-9]{4}\\d{20}"), // Dominican Republic
new Validator("EE", 20, "EE\\d{18}"), // Estonia
new Validator("EG", 29, "EG\\d{27}"), // Egypt
new Validator("ES", 24, "ES\\d{22}"), // Spain
new Validator("FI", 18, "\\d{16}", "AX"), // Finland
new Validator("FK", 18, "FK\\d{2}[A-Z]{2}\\d{12}"), // Falkland Islands, since Jul-23
new Validator("FO", 18, "FO\\d{16}"), // Faroe Islands
new Validator("FR", 27, "\\d{12}[A-Z0-9]{11}\\d{2}", "GF", "GP", "MQ", "RE", "PF", "TF", "YT", "NC", "BL", "MF", "PM", "WF"), // France
new Validator("GB", 22, "\\d{2}[A-Z]{4}\\d{14}", "IM", "JE", "GG"), // United Kingdom
new Validator("GE", 22, "GE\\d{2}[A-Z]{2}\\d{16}"), // Georgia
new Validator("GI", 23, "GI\\d{2}[A-Z]{4}[A-Z0-9]{15}"), // Gibraltar
new Validator("GL", 18, "GL\\d{16}"), // Greenland
new Validator("GR", 27, "GR\\d{9}[A-Z0-9]{16}"), // Greece
new Validator("GT", 28, "GT\\d{2}[A-Z0-9]{24}"), // Guatemala
new Validator("HR", 21, "HR\\d{19}"), // Croatia
new Validator("HU", 28, "HU\\d{26}"), // Hungary
new Validator("IE", 22, "IE\\d{2}[A-Z]{4}\\d{14}"), // Ireland
new Validator("IL", 23, "IL\\d{21}"), // Israel
new Validator("IQ", 23, "IQ\\d{2}[A-Z]{4}\\d{15}"), // Iraq
new Validator("IS", 26, "IS\\d{24}"), // Iceland
new Validator("IT", 27, "IT\\d{2}[A-Z]{1}\\d{10}[A-Z0-9]{12}"), // Italy
new Validator("JO", 30, "JO\\d{2}[A-Z]{4}\\d{4}[A-Z0-9]{18}"), // Jordan
new Validator("KW", 30, "KW\\d{2}[A-Z]{4}[A-Z0-9]{22}"), // Kuwait
new Validator("KZ", 20, "KZ\\d{5}[A-Z0-9]{13}"), // Kazakhstan
new Validator("LB", 28, "LB\\d{6}[A-Z0-9]{20}"), // Lebanon
new Validator("LC", 32, "LC\\d{2}[A-Z]{4}[A-Z0-9]{24}"), // Saint Lucia
new Validator("LI", 21, "LI\\d{7}[A-Z0-9]{12}"), // Liechtenstein
new Validator("LT", 20, "LT\\d{18}"), // Lithuania
new Validator("LU", 20, "LU\\d{5}[A-Z0-9]{13}"), // Luxembourg
new Validator("LV", 21, "LV\\d{2}[A-Z]{4}[A-Z0-9]{13}"), // Latvia
new Validator("LY", 25, "LY\\d{23}"), // Libya
new Validator("MC", 27, "MC\\d{12}[A-Z0-9]{11}\\d{2}"), // Monaco
new Validator("MD", 24, "MD\\d{2}[A-Z0-9]{20}"), // Moldova
new Validator("ME", 22, "ME\\d{20}"), // Montenegro
new Validator("MK", 19, "MK\\d{5}[A-Z0-9]{10}\\d{2}"), // Macedonia
new Validator("MN", 20, "MN\\d{18}"), // Mongolia, since Apr-23
new Validator("MR", 27, "MR\\d{25}"), // Mauritania
new Validator("MT", 31, "MT\\d{2}[A-Z]{4}\\d{5}[A-Z0-9]{18}"), // Malta
new Validator("MU", 30, "MU\\d{2}[A-Z]{4}\\d{19}[A-Z]{3}"), // Mauritius
new Validator("NI", 28, "NI\\d{2}[A-Z]{4}\\d{20}"), // Nicaragua, since Apr-23
new Validator("NL", 18, "NL\\d{2}[A-Z]{4}\\d{10}"), // Netherlands (The)
new Validator("NO", 15, "NO\\d{13}"), // Norway
new Validator("OM", 23, "OM\\d{5}[A-Z0-9]{16}"), // Oman, since Mar-24
new Validator("PK", 24, "PK\\d{2}[A-Z]{4}[A-Z0-9]{16}"), // Pakistan
new Validator("PL", 28, "PL\\d{26}"), // Poland
new Validator("PS", 29, "PS\\d{2}[A-Z]{4}[A-Z0-9]{21}"), // Palestine, State of
new Validator("PT", 25, "PT\\d{23}"), // Portugal
new Validator("QA", 29, "QA\\d{2}[A-Z]{4}[A-Z0-9]{21}"), // Qatar
new Validator("RO", 24, "RO\\d{2}[A-Z]{4}[A-Z0-9]{16}"), // Romania
new Validator("RS", 22, "RS\\d{20}"), // Serbia
new Validator("RU", 33, "RU\\d{16}[A-Z0-9]{15}"), // Russia
new Validator("SA", 24, "SA\\d{4}[A-Z0-9]{18}"), // Saudi Arabia
new Validator("SC", 31, "SC\\d{2}[A-Z]{4}\\d{20}[A-Z]{3}"), // Seychelles
new Validator("SD", 18, "SD\\d{16}"), // Sudan
new Validator("SE", 24, "SE\\d{22}"), // Sweden
new Validator("SI", 19, "SI\\d{17}"), // Slovenia
new Validator("SK", 24, "SK\\d{22}"), // Slovakia
new Validator("SM", 27, "SM\\d{2}[A-Z]{1}\\d{10}[A-Z0-9]{12}"), // San Marino
new Validator("SO", 23, "SO\\d{21}"), // Somalia, since Feb-23
new Validator("ST", 25, "ST\\d{23}"), // Sao Tome and Principe
new Validator("SV", 28, "SV\\d{2}[A-Z]{4}\\d{20}"), // El Salvador
new Validator("TL", 23, "TL\\d{21}"), // Timor-Leste
new Validator("TN", 24, "TN\\d{22}"), // Tunisia
new Validator("TR", 26, "TR\\d{8}[A-Z0-9]{16}"), // Turkey
new Validator("UA", 29, "UA\\d{8}[A-Z0-9]{19}"), // Ukraine
new Validator("VA", 22, "VA\\d{20}"), // Vatican City State
new Validator("VG", 24, "VG\\d{2}[A-Z]{4}\\d{16}"), // Virgin Islands
new Validator("XK", 20, "XK\\d{18}"), // Kosovo
};
/*
* Wikipedia [1] says that only uppercase is allowed.
* The SWIFT PDF file [2] implies that lower case is allowed.
* However there are no examples using lower-case.
* Unfortunately the relevant ISO documents (ISO 13616-1) are not available for free.
* The IBANCheckDigit code treats upper and lower case the same,
* so any case validation has to be done in this class.
*
* Note: the European Payments council has a document [3] which includes a description
* of the IBAN. Section 5 clearly states that only upper case is allowed.
* Also the maximum length is 34 characters (including the country code),
* and the length is fixed for each country.
*
* It looks like lower-case is permitted in BBANs, but they must be converted to
* upper case for IBANs.
*
* [1] https://en.wikipedia.org/wiki/International_Bank_Account_Number
* [2] http://www.swift.com/dsp/resources/documents/IBAN_Registry.pdf (404)
* => https://www.swift.com/sites/default/files/resources/iban_registry.pdf
* The above is an old version (62, Jan 2016)
* As of May 2020, the current IBAN standards are located at:
* https://www.swift.com/standards/data-standards/iban
* The above page contains links for the PDF and TXT (CSV) versions of the registry
* Warning: these may not agree -- in the past there have been discrepancies.
* The TXT file can be used to determine changes which can be cross-checked in the PDF file.
* [3] http://www.europeanpaymentscouncil.eu/documents/ECBS%20IBAN%20standard%20EBS204_V3.2.pdf
*/
/** The singleton instance which uses the default formats */
public static final IBANValidator DEFAULT_IBAN_VALIDATOR = new IBANValidator();
/**
* Gets the singleton instance of the IBAN validator using the default formats
*
* @return A singleton instance of the IBAN validator
*/
public static IBANValidator getInstance() {
return DEFAULT_IBAN_VALIDATOR;
}
private final ConcurrentMap<String, Validator> validatorMap;
/**
* Create a default IBAN validator.
*/
public IBANValidator() {
this(DEFAULT_VALIDATORS);
}
/**
* Create an IBAN validator from the specified map of IBAN formats.
*
* @param validators map of IBAN formats
*/
public IBANValidator(final Validator[] validators) {
this.validatorMap = createValidators(validators);
}
private ConcurrentMap<String, Validator> createValidators(final Validator[] validators) {
final ConcurrentMap<String, Validator> map = new ConcurrentHashMap<>();
for (final Validator validator : validators) {
map.put(validator.countryCode, validator);
for (final String otherCC : validator.otherCountryCodes) {
map.put(otherCC, validator);
}
}
return map;
}
/**
* Gets a copy of the default Validators.
*
* @return a copy of the default Validator array
*/
public Validator[] getDefaultValidators() {
return Arrays.copyOf(DEFAULT_VALIDATORS, DEFAULT_VALIDATORS.length);
}
/**
* Gets the Validator for a given IBAN
*
* @param code a string starting with the ISO country code (e.g. an IBAN)
*
* @return the validator or {@code null} if there is not one registered.
*/
public Validator getValidator(final String code) {
if (code == null || code.length() < SHORT_CODE_LEN) { // ensure we can extract the code
return null;
}
final String key = code.substring(0, SHORT_CODE_LEN);
return validatorMap.get(key);
}
/**
* Does the class have the required validator?
*
* @param code the code to check
* @return true if there is a validator
*/
public boolean hasValidator(final String code) {
return getValidator(code) != null;
}
/**
* Validate an IBAN Code
*
* @param code The value validation is being performed on
* @return {@code true} if the value is valid
*/
public boolean isValid(final String code) {
final Validator formatValidator = getValidator(code);
if (formatValidator == null || code.length() != formatValidator.ibanLength || !formatValidator.regexValidator.isValid(code)) {
return false;
}
return IBANCheckDigit.IBAN_CHECK_DIGIT.isValid(code);
}
/**
* Installs a validator.
* Will replace any existing entry which has the same countryCode.
*
* @param countryCode the country code
* @param length the length of the IBAN. Must be ≥ 8 and ≤ 32.
* If the length is < 0, the validator is removed, and the format is not used.
* @param format the format of the IBAN (as a regular expression)
* @return the previous Validator, or {@code null} if there was none
* @throws IllegalArgumentException if there is a problem
* @throws IllegalStateException if an attempt is made to modify the singleton validator
*/
public Validator setValidator(final String countryCode, final int length, final String format) {
if (this == DEFAULT_IBAN_VALIDATOR) {
throw new IllegalStateException("The singleton validator cannot be modified");
}
if (length < 0) {
return validatorMap.remove(countryCode);
}
return setValidator(new Validator(countryCode, length, format));
}
/**
* Installs a validator.
* Will replace any existing entry which has the same countryCode
*
* @param validator the instance to install.
* @return the previous Validator, or {@code null} if there was none
* @throws IllegalStateException if an attempt is made to modify the singleton validator
*/
public Validator setValidator(final Validator validator) {
if (this == DEFAULT_IBAN_VALIDATOR) {
throw new IllegalStateException("The singleton validator cannot be modified");
}
return validatorMap.put(validator.countryCode, validator);
}
}