feat(isSIP): check if string is a SIP

README.md

@@ -173,6 +173,7 @@ Validator                               | Description
 **isVAT(str, countryCode)**             | check if the string is a [valid VAT number][VAT Number] if validation is available for the given country code matching [ISO 3166-1 alpha-2][ISO 3166-1 alpha-2]. <br/><br/>`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.<br/><br/>Either `matches('foo', /foo/i)` or `matches('foo', 'foo', 'i')`.
+**isSIP(str)** | check if the string is a [SIP](https://www.ietf.org/rfc/rfc3261.txt).
 
 ## Sanitizers
 

src/index.js

@@ -129,6 +129,8 @@ import isStrongPassword from './lib/isStrongPassword';
 
 import isVAT from './lib/isVAT';
 
+import isSIP from './lib/isSIP';
+
 const version = '13.12.0';
 
 const validator = {
@@ -243,6 +245,7 @@ const validator = {
   isLicensePlate,
   isVAT,
   ibanLocales,
+  isSIP,
 };
 
 export default validator;

src/lib/isSIP.js

@@ -0,0 +1,65 @@
+import assertString from './util/assertString';
+
+/* Regular expression to match the SIP URI structure */
+function isValidSipUri(uri) {
+  const sipUriRegex = /^sips?:([^:@]+(:[^@]*)?@)?((([a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?\.)+[a-zA-Z]{2,}|(\d{1,3}\.){3}\d{1,3}|\[[0-9a-fA-F:]+\])(:\d{1,5})?)(;([a-zA-Z0-9-]+=[^;?]+|lr))*?(\?[^#]*)?$/;
+  return sipUriRegex.test(uri);
+}
+
+function isValidPort(domain) {
+  const portMatch = domain.match(/:(\d+)($|;)/);
+  if (portMatch) {
+    const port = parseInt(portMatch[1], 10);
+    return !isNaN(port) && port > 0 && port <= 65535;
+  }
+  return true;
+}
+
+function isValidParameters(uri) {
+  if (uri.includes(';')) {
+    const params = uri.split(';').slice(1);
+    for (const param of params) {
+      /*
+        - key is a valid parameter
+        - key=value is a valid parameter
+        - key=value1;key=value2;... is a valid parameter
+      */
+      const paramPart = param.split('?')[0];
+      if (!/^[a-zA-Z0-9-]+(=[a-zA-Z0-9_.!~*'();&=+$,%-]*)?$/.test(paramPart)) {
+        return false;
+      }
+    }
+  }
+  return true;
+}
+
+
+/**
+ * Function to validate if a string is a valid SIP URI
+ * @param {String} str - The SIP URI string
+ * @returns {Boolean} - Returns true if valid, otherwise false
+ */
+export default function isSIP(str) {
+  assertString(str);
+
+  // First check the structure using regex
+  if (!isValidSipUri(str)) {
+    return false;
+  }
+
+  // Split the URI into parts (scheme, user, domain)
+  const parts = str.split('@');
+  const domain = parts.pop();
+
+  // Check if there's a port
+  if (!isValidPort(domain)) {
+    return false;
+  }
+
+  // Validate parameters if present
+  if (!isValidParameters(str)) {
+    return false;
+  }
+
+  return true;
+}

test/validators/isSIP.test.js

@@ -0,0 +1,42 @@
+import test from '../testFunctions';
+
+describe('isSIP', () => {
+  it('should validate SIP URIs', () => {
+    test({
+      validator: 'isSIP',
+      valid: [
+        'sip:[email protected]',
+        'sips:[email protected]',
+        'sip:[email protected]:5060',
+        'sip:[email protected];transport=tcp',
+        'sips:[email protected]:5060',
+        'sips:[email protected];transport=tcp',
+        'sip:[email protected]',
+        'sip:[email protected]',
+        'sip:alice:[email protected]',
+        'sip:[email protected]',
+        'sips:[email protected]:5061;transport=tls',
+        'sip:[email protected];user=phone',
+        'sip:[email protected];method=INVITE',
+        'sip:[email protected]?subject=test',
+        'sip:[email protected];tag=1234',
+        'sips:[email protected];secure=true',
+        'sip:[email protected]:5060;lr',
+        'sip:username:[email protected]:5060;transport=udp?header=value',
+      ],
+      invalid: [
+        'https://www.example.com',
+        'sip:user',
+        'sips:@invalid.com',
+        'sip:[email protected]',
+        'sip:[email protected]:abc',
+        'sip:[email protected];user=phone;tag=',
+        'sips:user@domain:[email protected]',
+        'sip:@',
+        'sip:[email protected]',
+        'sip:[email protected]',
+        'sips:[email protected]:port',
+      ],
+    });
+  });
+});