@contrast/common 1.8.0 → 1.9.0

package/src/constants.ts

@@ -94,5 +94,141 @@ export enum InputType {
   UNKNOWN = 'UNKNOWN',
 }
 
+export enum DataflowTag {
+  XML_ENCODED = 'XML_ENCODED',
+  XML_DECODED = 'XML_DECODED',
+  HTML_ENCODED = 'HTML_ENCODED',
+  HTML_DECODED = 'HTML_DECODED',
+  URL_ENCODED = 'URL_ENCODED',
+  URL_DECODED = 'URL_DECODED',
+  CSS_ENCODED = 'CSS_ENCODED',
+  CSS_DECODED = 'CSS_DECODED',
+  BASE64_ENCODED = 'BASE64_ENCODED',
+  BASE64_DECODED = 'BASE64_DECODED',
+  JAVASCRIPT_ENCODED = 'JAVASCRIPT_ENCODED',
+  JAVASCRIPT_DECODED = 'JAVASCRIPT_DECODED',
+  JAVA_ENCODED = 'JAVA_ENCODED',
+  JAVA_DECODED = 'JAVA_DECODED',
+  CSV_ENCODED = 'CSV_ENCODED',
+  CSV_DECODED = 'CSV_DECODED',
+  SQL_ENCODED = 'SQL_ENCODED',
+  SQL_DECODED = 'SQL_DECODED',
+  LDAP_ENCODED = 'LDAP_ENCODED',
+  LDAP_DECODED = 'LDAP_DECODED',
+  XPATH_ENCODED = 'XPATH_ENCODED',
+  XPATH_DECODED = 'XPATH_DECODED',
+  OS_ENCODED = 'OS_ENCODED',
+  OS_DECODED = 'OS_DECODED',
+  VBSCRIPT_ENCODED = 'VBSCRIPT_ENCODED',
+  VBSCRIPT_DECODED = 'VBSCRIPT_DECODED',
+  POTENTIAL_SANITIZED = 'POTENTIAL_SANITIZED',
+  POTENTIAL_VALIDATED = 'POTENTIAL_VALIDATED',
+  NO_CONTROL_CHARS = 'NO_CONTROL_CHARS',
+  CUSTOM = 'CUSTOM_CATCH_ALL',
+  // custom encoded/validated tags, only for data flow rules
+  CUSTOM_ENCODED = 'CUSTOM_ENCODED',
+  CUSTOM_ENCODED_CMD_INJECTION = 'CUSTOM_ENCODED_CMD_INJECTION',
+  CUSTOM_ENCODED_EXPRESSION_LANGUAGE_INJECTION = 'CUSTOM_ENCODED_EXPRESSION_LANGUAGE_INJECTION',
+  CUSTOM_ENCODED_HEADER_INJECTION = 'CUSTOM_ENCODED_HEADER_INJECTION',
+  CUSTOM_ENCODED_HQL_INJECTION = 'CUSTOM_ENCODED_HQL_INJECTION',
+  CUSTOM_ENCODED_LDAP_INJECTION = 'CUSTOM_ENCODED_LDAP_INJECTION',
+  CUSTOM_ENCODED_LOG_INJECTION = 'CUSTOM_ENCODED_LOG_INJECTION',
+  CUSTOM_ENCODED_NOSQL_INJECTIOn = 'CUSTOM_ENCODED_NOSQL_INJECTION',
+  CUSTOM_ENCODED_PATH_TRAVERSAL = 'CUSTOM_ENCODED_PATH_TRAVERSAL',
+  CUSTOM_ENCODED_REDOS = 'CUSTOM_ENCODED_REDOS',
+  CUSTOM_ENCODED_REFLECTED_XSS = 'CUSTOM_ENCODED_REFLECTED_XSS',
+  CUSTOM_ENCODED_REFLECTION_INJECTION = 'CUSTOM_ENCODED_REFLECTION_INJECTION',
+  CUSTOM_ENCODED_SMTP_INJECTION = 'CUSTOM_ENCODED_SMTP_INJECTION',
+  CUSTOM_ENCODED_SQL_INJECTION = 'CUSTOM_ENCODED_SQL_INJECTION',
+  CUSTOM_ENCODED_SSRF = 'CUSTOM_ENCODED_SSRF',
+  CUSTOM_ENCODED_STORED_XSS = 'CUSTOM_ENCODED_STORED_XSS',
+  CUSTOM_ENCODED_TRUST_BOUNDARY_VIOLATION = 'CUSTOM_ENCODED_TRUST_BOUNDARY_VIOLATION',
+  CUSTOM_ENCODED_UNSAFE_CODE_EXECUTION = 'CUSTOM_ENCODED_UNSAFE_CODE_EXECUTION',
+  CUSTOM_ENCODED_UNSAFE_READLINE = 'CUSTOM_ENCODED_UNSAFE_READLINE',
+  CUSTOM_ENCODED_UNSAFE_XML_DECODE = 'CUSTOM_ENCODED_UNSAFE_XML_DECODE',
+  CUSTOM_ENCODED_UNTRUSTED_DESERIALIZATION = 'CUSTOM_ENCODED_UNTRUSTED_DESERIALIZATION',
+  CUSTOM_ENCODED_UNVALIDATED_FORWARD = 'CUSTOM_ENCODED_UNVALIDATED_FORWARD',
+  CUSTOM_ENCODED_UNVALIDATED_REDIRECT = 'CUSTOM_ENCODED_UNVALIDATED_REDIRECT',
+  CUSTOM_ENCODED_XPATH_INJECTION = 'CUSTOM_ENCODED_XPATH_INJECTION',
+  CUSTOM_ENCODED_XXE = 'CUSTOM_ENCODED_XXE',
+  CUSTOM_SECURITY_CONTROL_APPLIED = 'CUSTOM_SECURITY_CONTROL_APPLIED',
+  CUSTOM_VALIDATED = 'CUSTOM_VALIDATED',
+  CUSTOM_VALIDATED_CMD_INJECTION = 'CUSTOM_VALIDATED_CMD_INJECTION',
+  CUSTOM_VALIDATED_EXPRESSION_LANGUAGE_INJECTION = 'CUSTOM_VALIDATED_EXPRESSION_LANGUAGE_INJECTION',
+  CUSTOM_VALIDATED_HEADER_INJECTION = 'CUSTOM_VALIDATED_HEADER_INJECTION',
+  CUSTOM_VALIDATED_HQL_INJECTION = 'CUSTOM_VALIDATED_HQL_INJECTION',
+  CUSTOM_VALIDATED_LDAP_INJECTION = 'CUSTOM_VALIDATED_LDAP_INJECTION',
+  CUSTOM_VALIDATED_LOG_INJECTION = 'CUSTOM_VALIDATED_LOG_INJECTION',
+  CUSTOM_VALIDATED_NOSQL_INJECTION = 'CUSTOM_VALIDATED_NOSQL_INJECTION',
+  CUSTOM_VALIDATED_PATH_TRAVERSAL = 'CUSTOM_VALIDATED_PATH_TRAVERSAL',
+  CUSTOM_VALIDATED_REDOS = 'CUSTOM_VALIDATED_REDOS',
+  CUSTOM_VALIDATED_REFLECTED_XSS = 'CUSTOM_VALIDATED_REFLECTED_XSS',
+  CUSTOM_VALIDATED_REFLECTION_INJECTION = 'CUSTOM_VALIDATED_REFLECTION_INJECTION',
+  CUSTOM_VALIDATED_SMTP_INJECTION = 'CUSTOM_VALIDATED_SMTP_INJECTION',
+  CUSTOM_VALIDATED_SQL_INJECTION = 'CUSTOM_VALIDATED_SQL_INJECTION',
+  CUSTOM_VALIDATED_SSRF = 'CUSTOM_VALIDATED_SSRF',
+  CUSTOM_VALIDATED_STORED_XSS = 'CUSTOM_VALIDATED_STORED_XSS',
+  CUSTOM_VALIDATED_TRUST_BOUNDARY_VIOLATION = 'CUSTOM_VALIDATED_TRUST_BOUNDARY_VIOLATION',
+  CUSTOM_VALIDATED_UNSAFE_CODE_EXECUTION = 'CUSTOM_VALIDATED_UNSAFE_CODE_EXECUTION',
+  CUSTOM_VALIDATED_UNSAFE_READLINE = 'CUSTOM_VALIDATED_UNSAFE_READLINE',
+  CUSTOM_VALIDATED_UNSAFE_XML_DECODE = 'CUSTOM_VALIDATED_UNSAFE_XML_DECODE',
+  CUSTOM_VALIDATED_UNTRUSTED_DESERIALIZATION = 'CUSTOM_VALIDATED_UNTRUSTED_DESERIALIZATION',
+  CUSTOM_VALIDATED_UNVALIDATED_FORWARD = 'CUSTOM_VALIDATED_UNVALIDATED_FORWARD',
+  CUSTOM_VALIDATED_UNVALIDATED_REDIRECT = 'CUSTOM_VALIDATED_UNVALIDATED_REDIRECT',
+  CUSTOM_VALIDATED_XPATH_INJECTION = 'CUSTOM_VALIDATED_XPATH_INJECTION',
+  CUSTOM_VALIDATED_XXE = 'CUSTOM_VALIDATED_XXE',
+  // tracked_string range tags
+  NO_NEWLINES = 'NO_NEWLINES',
+  UNTRUSTED = 'UNTRUSTED',
+  CROSS_SITE = 'CROSS_SITE',
+  LIMITED_CHARS = 'LIMITED_CHARS',
+  ALPHANUM_SPACE_HYPHEN = 'ALPHANUM_SPACE_HYPHEN',
+  STRING_TYPE_CHECKED = 'STRING_TYPE_CHECKED',
+  DATABASE_WRITE = 'DATABASE_WRITE',
+  HEADER = 'HEADER',
+  COOKIE = 'COOKIE',
+  WEAK_URL_ENCODED = 'WEAK_URL_ENCODED',
+}
+
 export const BLOCKING_MODES = ['block', 'block_at_perimeter'];
 
+export const FS_METHODS = [
+  { name: 'access', promises: true, sync: true, indices: [0] },
+  { name: 'appendFile', promises: true, sync: true, indices: [0] },
+  { name: 'chmod', promises: true, sync: true, indices: [0] },
+  { name: 'chown', promises: true, sync: true, indices: [0] },
+  { name: 'copyFile', promises: true, sync: true, indices: [0, 1] },
+  { name: 'cp', promises: true, sync: true, indices: [0, 1] },
+  { name: 'createReadStream', promises: false, sync: false, indices: [0] },
+  { name: 'createWriteStream', promises: false, sync: false, indices: [0] },
+  { name: 'exists', promises: false, sync: true, indices: [0] },
+  { name: 'lchmod', promises: true, sync: true, indices: [0] },
+  { name: 'lchown', promises: true, sync: true, indices: [0] },
+  { name: 'link', promises: true, sync: true, indices: [0] },
+  { name: 'lstat', promises: true, sync: true, indices: [0] },
+  { name: 'lutimes', promises: true, sync: true, indices: [0] },
+  { name: 'mkdir', promises: true, sync: true, indices: [0] },
+  { name: 'mkdtemp', promises: true, sync: true, indices: [0] },
+  { name: 'open', promises: true, sync: true, indices: [0] },
+  { name: 'openAsBlob', promises: false, sync: false, indices: [0] },
+  { name: 'opendir', promises: true, sync: true, indices: [0] },
+  { name: 'readdir', promises: true, sync: true, indices: [0] },
+  { name: 'readFile', promises: true, sync: true, indices: [0] },
+  { name: 'readlink', promises: true, sync: true, indices: [0] },
+  { name: 'realpath', promises: true, sync: true, indices: [0] },
+  { name: 'rename', promises: true, sync: true, indices: [0, 1] },
+  { name: 'rmdir', promises: true, sync: true, indices: [0] },
+  { name: 'rm', promises: true, sync: true, indices: [0] },
+  { name: 'stat', promises: true, sync: true, indices: [0] },
+  { name: 'statfs', promises: true, sync: true, indices: [0] },
+  { name: 'symlink', promises: true, sync: true, indices: [0, 1] },
+  { name: 'truncate', promises: true, sync: true, indices: [0] },
+  { name: 'unlink', promises: true, sync: true, indices: [0] },
+  { name: 'unwatchFile', promises: false, sync: false, indices: [0] },
+  { name: 'utimes', promises: true, sync: true, indices: [0] },
+  { name: 'watch', promises: true, sync: false, indices: [0] },
+  { name: 'watchFile', promises: false, sync: false, indices: [0] },
+  { name: 'writeFile', promises: true, sync: true, indices: [0] },
+] as const;
+
+

package/src/index.ts

@@ -282,3 +282,10 @@ const { trim: origTrim } = String.prototype;
 export function trim(str: string, ...args: []) {
   return origTrim.call(str, ...args);
 }
+
+import { inspect as originalInspect } from 'util';
+export function inspect(...args: any) {
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  return originalInspect.call(null, ...args);
+}

package/src/signatures/fs.ts

@@ -0,0 +1,65 @@
+/*
+ * Copyright: 2022 Contrast Security, Inc
+ * Contact: support@contrastsecurity.com
+ * License: Commercial
+
+ * NOTICE: This Software and the patented inventions embodied within may only be
+ * used as part of Contrast Security’s commercial offerings. Even though it is
+ * made available through public repositories, use of this Software is subject to
+ * the applicable End User Licensing Agreement found at
+ * https://www.contrastsecurity.com/enduser-terms-0317a or as otherwise agreed
+ * between Contrast Security and the End User. The Software may not be reverse
+ * engineered, modified, repackaged, sold, redistributed or otherwise used in a
+ * way not consistent with the End User License Agreement.
+ */
+
+import { FS_METHODS } from '../constants';
+import { Signature } from '../types';
+
+const fs = new Map<string, Signature>(
+  FS_METHODS.reduce((sigs, method) => {
+    sigs.push([
+      `fs.${method.name}`,
+      {
+        moduleName: 'fs',
+        methodName: method.name,
+        isModule: true,
+      }
+    ]);
+
+    if (method.sync) {
+      sigs.push([
+        `fs.${method.name}Sync`,
+        {
+          moduleName: 'fs',
+          methodName: `${method.name}Sync`,
+          isModule: true,
+        }
+      ]);
+    }
+
+    if (method.promises) {
+      sigs.push([
+        `fs.promises.${method.name}`,
+        {
+          moduleName: 'fs.promises',
+          methodName: method.name,
+          isModule: true,
+        }
+      ]);
+
+      sigs.push([
+        `fsPromises.${method.name}`,
+        {
+          moduleName: 'fsPromises',
+          methodName: method.name,
+          isModule: true,
+        }
+      ]);
+    }
+
+    return sigs;
+  }, [] as [string, Signature][])
+);
+
+export default fs;

package/src/signatures/index.ts

@@ -13,10 +13,15 @@
  * way not consistent with the End User License Agreement.
  */
 
+import mongodb from './mongodb';
 import mssql from './mssql';
+import fs from './fs';
+import { Signature } from '../types';
 
-export const signatures: Map<string, any> = new Map(
+export const signatures = new Map<string, Signature>(
   [
+    ...fs,
+    ...mongodb,
     ...mssql,
     [
       'Url.prototype.parse',
@@ -414,15 +419,6 @@ export const signatures: Map<string, any> = new Map(
         isModule: true,
       }
     ],
-    [
-      'mongodb.Collection.prototype.rename',
-      {
-        moduleName: 'mongodb',
-        version: '>=3.3.0',
-        methodName: 'Collection.prototype.rename',
-        isModule: true,
-      }
-    ],
     [
       'marsdb.Collection.prototype.find',
       {
@@ -601,6 +597,22 @@ export const signatures: Map<string, any> = new Map(
         isModule: true,
       }
     ],
+    [
+      'child_process.execFile',
+      {
+        moduleName: 'child_process',
+        methodName: 'execFile',
+        isModule: true,
+      }
+    ],
+    [
+      'child_process.execFileSync',
+      {
+        moduleName: 'child_process',
+        methodName: 'execFileSync',
+        isModule: true,
+      }
+    ],
     [
       'Math.random',
       {
@@ -1292,310 +1304,6 @@ export const signatures: Map<string, any> = new Map(
         target: 'R',
       }
     ],
-    [
-      'fs.access',
-      {
-        moduleName: 'fs',
-        methodName: 'access',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.accessSync',
-      {
-        moduleName: 'fs',
-        methodName: 'accessSync',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.copyFile',
-      {
-        moduleName: 'fs',
-        methodName: 'copyFile',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.copyFileSync',
-      {
-        moduleName: 'fs',
-        methodName: 'copyFileSync',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.appendFile',
-      {
-        moduleName: 'fs',
-        methodName: 'appendFile',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.appendFileSync',
-      {
-        moduleName: 'fs',
-        methodName: 'appendFileSync',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.writeFile',
-      {
-        moduleName: 'fs',
-        methodName: 'writeFile',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.writeFileSync',
-      {
-        moduleName: 'fs',
-        methodName: 'writeFileSync',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.createWriteStream',
-      {
-        moduleName: 'fs',
-        methodName: 'createWriteStream',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.createReadStream',
-      {
-        moduleName: 'fs',
-        methodName: 'createReadStream',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.unlink',
-      {
-        moduleName: 'fs',
-        methodName: 'unlink',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.unlinkSync',
-      {
-        moduleName: 'fs',
-        methodName: 'unlinkSync',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.truncate',
-      {
-        moduleName: 'fs',
-        methodName: 'truncate',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.truncateSync',
-      {
-        moduleName: 'fs',
-        methodName: 'truncateSync',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.rmdir',
-      {
-        moduleName: 'fs',
-        methodName: 'rmdir',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.rmdirSync',
-      {
-        moduleName: 'fs',
-        methodName: 'rmdirSync',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.rename',
-      {
-        moduleName: 'fs',
-        methodName: 'rename',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.renameSync',
-      {
-        moduleName: 'fs',
-        methodName: 'renameSync',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.readFile',
-      {
-        moduleName: 'fs',
-        methodName: 'readFile',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.readFileSync',
-      {
-        moduleName: 'fs',
-        methodName: 'readFileSync',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.readdir',
-      {
-        moduleName: 'fs',
-        methodName: 'readdir',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.readdirSync',
-      {
-        moduleName: 'fs',
-        methodName: 'readdirSync',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.open',
-      {
-        moduleName: 'fs',
-        methodName: 'open',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.openSync',
-      {
-        moduleName: 'fs',
-        methodName: 'openSync',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.mkdir',
-      {
-        moduleName: 'fs',
-        methodName: 'mkdir',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.mkdirSync',
-      {
-        moduleName: 'fs',
-        methodName: 'mkdirSync',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.readlink',
-      {
-        moduleName: 'fs',
-        methodName: 'readlink',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.readlinkSync',
-      {
-        moduleName: 'fs',
-        methodName: 'readlinkSync',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.symlink',
-      {
-        moduleName: 'fs',
-        methodName: 'symlink',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.symlinkSync',
-      {
-        moduleName: 'fs',
-        methodName: 'symlinkSync',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.chmod',
-      {
-        moduleName: 'fs',
-        methodName: 'chmod',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.chmodSync',
-      {
-        moduleName: 'fs',
-        methodName: 'chmodSync',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.lchmod',
-      {
-        moduleName: 'fs',
-        methodName: 'lchmod',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.lchmodSync',
-      {
-        moduleName: 'fs',
-        methodName: 'lchmodSync',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.chown',
-      {
-        moduleName: 'fs',
-        methodName: 'chown',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.chownSync',
-      {
-        moduleName: 'fs',
-        methodName: 'chownSync',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.lchown',
-      {
-        moduleName: 'fs',
-        methodName: 'lchown',
-        isModule: true,
-      }
-    ],
-    [
-      'fs.lchownSync',
-      {
-        moduleName: 'fs',
-        methodName: 'lchownSync',
-        isModule: true,
-      }
-    ],
     [
       'querystring.escape',
       {
@@ -2412,5 +2120,5 @@ export const signatures: Map<string, any> = new Map(
         isModule: true,
       }
     ]
-  ]
+  ] as [string, Signature][]
 );

package/src/signatures/mongodb.ts

@@ -0,0 +1,46 @@
+/*
+ * Copyright: 2022 Contrast Security, Inc
+ * Contact: support@contrastsecurity.com
+ * License: Commercial
+
+ * NOTICE: This Software and the patented inventions embodied within may only be
+ * used as part of Contrast Security’s commercial offerings. Even though it is
+ * made available through public repositories, use of this Software is subject to
+ * the applicable End User Licensing Agreement found at
+ * https://www.contrastsecurity.com/enduser-terms-0317a or as otherwise agreed
+ * between Contrast Security and the End User. The Software may not be reverse
+ * engineered, modified, repackaged, sold, redistributed or otherwise used in a
+ * way not consistent with the End User License Agreement.
+ */
+
+const collectionSignatures: [string, any][] = [
+  'find',
+  'findOne',
+  'findAndModify',
+  'findOneAndDelete',
+  'findOneAndReplace',
+  'findOneAndUpdate',
+  'remove',
+  'removeOne',
+  'replaceOne',
+  'removeMany',
+  'save',
+  'update',
+  'updateOne',
+  'updateMany',
+  'deleteOne',
+  'deleteMany',
+].map((method) => [
+  `mongodb.Collection.prototype.${method}`,
+  {
+    moduleName: 'mongodb',
+    methodName: `Collection.prototype.${method}`,
+    isModule: true,
+  }
+]);
+
+const mongodb: Map<string, any> = new Map([
+  ...collectionSignatures,
+]);
+
+export default mongodb;

package/src/signatures/mssql.ts

@@ -13,14 +13,16 @@
  * way not consistent with the End User License Agreement.
  */
 
+import { Signature } from '../types';
 
-const mssql: Map<string, any> = new Map([
+
+const mssql = new Map<string, Signature>([
   [
     'mssql/lib/base/prepared-statement.prototype.prepare',
     {
       moduleName: 'mssql',
       version: '>=6.4.0',
-      filename: 'lib/base/prepared-statement.js',
+      fileName: 'lib/base/prepared-statement.js',
       methodName: 'PreparedStatement.prototype.prepare',
       isModule: true,
     },
@@ -30,7 +32,7 @@ const mssql: Map<string, any> = new Map([
     {
       moduleName: 'mssql',
       version: '>=6.4.0',
-      filename: 'lib/base/request.js',
+      fileName: 'lib/base/request.js',
       methodName: 'Request.prototype.batch',
       isModule: true,
     },
@@ -40,11 +42,11 @@ const mssql: Map<string, any> = new Map([
     {
       moduleName: 'mssql',
       version: '>=6.4.0',
-      filename: 'lib/base/request.js',
+      fileName: 'lib/base/request.js',
       methodName: 'Request.prototype.query',
       isModule: true,
     },
   ],
-]);
+] as [string, Signature][]);
 
 export default mssql;

package/src/types.ts

@@ -21,6 +21,17 @@ export interface Installable {
   uninstall?(): void | Promise<void>;
 }
 
+export interface Signature {
+  moduleName: string;
+  methodName: string;
+  fileName?: string;
+  version?: string;
+  isModule: boolean;
+  isConstructor?: boolean;
+  source?: 'O' | 'P' | 'R';
+  target?: 'O' | 'P' | 'R';
+}
+
 export interface AppInfo {
   os: {
     type: string;