cyberchef/src/js/operations/Extract.js
2016-11-29 18:36:36 +00:00

300 lines
7.4 KiB
JavaScript
Executable File

/**
* Identifier extraction operations.
*
* @author n1474335 [n1474335@gmail.com]
* @copyright Crown Copyright 2016
* @license Apache-2.0
*
* @namespace
*/
const Extract = {
/**
* Runs search operations across the input data using refular expressions.
*
* @private
* @param {string} input
* @param {RegExp} search_regex
* @param {RegExp} remove_regex - A regular expression defining results to remove from the
* final list
* @param {boolean} include_total - Whether or not to include the total number of results
* @returns {string}
*/
_search(input, search_regex, remove_regex, include_total) {
let output = '',
total = 0,
match;
while (match = search_regex.exec(input)) {
if (remove_regex && remove_regex.test(match[0])) {
continue;
}
total++;
output += `${match[0]}\n`;
}
if (include_total) {
output = `Total found: ${total}\n\n${output}`;
}
return output;
},
/**
* @constant
* @default
*/
MIN_STRING_LEN: 3,
/**
* @constant
* @default
*/
DISPLAY_TOTAL: false,
/**
* Strings operation.
*
* @param {string} input
* @param {Object[]} args
* @returns {string}
*/
run_strings(input, args) {
let min_len = args[0] || Extract.MIN_STRING_LEN,
display_total = args[1],
strings = "[A-Z\\d/\\-:.,_$%'\"()<>= !\\[\\]{}@]",
regex = new RegExp(`${strings}{${min_len},}`, 'ig');
return Extract._search(input, regex, null, display_total);
},
/**
* @constant
* @default
*/
INCLUDE_IPV4: true,
/**
* @constant
* @default
*/
INCLUDE_IPV6: false,
/**
* @constant
* @default
*/
REMOVE_LOCAL: false,
/**
* Extract IP addresses operation.
*
* @param {string} input
* @param {Object[]} args
* @returns {string}
*/
run_ip(input, args) {
let include_ipv4 = args[0],
include_ipv6 = args[1],
remove_local = args[2],
display_total = args[3],
ipv4 = '(?:(?:\\d|[01]?\\d\\d|2[0-4]\\d|25[0-5])\\.){3}(?:25[0-5]|2[0-4]\\d|[01]?\\d\\d|\\d)(?:\\/\\d{1,2})?',
ipv6 = '((?=.*::)(?!.*::.+::)(::)?([\\dA-F]{1,4}:(:|\\b)|){5}|([\\dA-F]{1,4}:){6})((([\\dA-F]{1,4}((?!\\3)::|:\\b|(?![\\dA-F])))|(?!\\2\\3)){2}|(((2[0-4]|1\\d|[1-9])?\\d|25[0-5])\\.?\\b){4})',
ips = '';
if (include_ipv4 && include_ipv6) {
ips = `${ipv4}|${ipv6}`;
} else if (include_ipv4) {
ips = ipv4;
} else if (include_ipv6) {
ips = ipv6;
}
if (ips) {
const regex = new RegExp(ips, 'ig');
if (remove_local) {
let ten = '10\\..+',
oneninetwo = '192\\.168\\..+',
oneseventwo = '172\\.(?:1[6-9]|2\\d|3[01])\\..+',
onetwoseven = '127\\..+',
remove_regex = new RegExp(`^(?:${ten}|${oneninetwo
}|${oneseventwo}|${onetwoseven})`);
return Extract._search(input, regex, remove_regex, display_total);
} else {
return Extract._search(input, regex, null, display_total);
}
} else {
return '';
}
},
/**
* Extract email addresses operation.
*
* @param {string} input
* @param {Object[]} args
* @returns {string}
*/
run_email(input, args) {
let display_total = args[0],
regex = /\w[-.\w]*@[-\w]+(?:\.[-\w]+)*\.[A-Z]{2,4}/ig;
return Extract._search(input, regex, null, display_total);
},
/**
* Extract MAC addresses operation.
*
* @param {string} input
* @param {Object[]} args
* @returns {string}
*/
run_mac(input, args) {
let display_total = args[0],
regex = /[A-F\d]{2}(?:[:-][A-F\d]{2}){5}/ig;
return Extract._search(input, regex, null, display_total);
},
/**
* Extract URLs operation.
*
* @param {string} input
* @param {Object[]} args
* @returns {string}
*/
run_urls(input, args) {
let display_total = args[0],
protocol = '[A-Z]+://',
hostname = '[-\\w]+(?:\\.\\w[-\\w]*)+',
port = ':\\d+',
path = "/[^.!,?;\"'<>()\\[\\]{}\\s\\x7F-\\xFF]*";
path += "(?:[.!,?]+[^.!,?;\"'<>()\\[\\]{}\\s\\x7F-\\xFF]+)*";
const regex = new RegExp(`${protocol + hostname}(?:${port
})?(?:${path})?`, 'ig');
return Extract._search(input, regex, null, display_total);
},
/**
* Extract domains operation.
*
* @param {string} input
* @param {Object[]} args
* @returns {string}
*/
run_domains(input, args) {
let display_total = args[0],
protocol = 'https?://',
hostname = '[-\\w\\.]+',
tld = '\\.(?:com|net|org|biz|info|co|uk|onion|int|mobi|name|edu|gov|mil|eu|ac|ae|af|de|ca|ch|cn|cy|es|gb|hk|il|in|io|tv|me|nl|no|nz|ro|ru|tr|us|az|ir|kz|uz|pk)+',
regex = new RegExp(`(?:${protocol})?${hostname}${tld}`, 'ig');
return Extract._search(input, regex, null, display_total);
},
/**
* @constant
* @default
*/
INCLUDE_WIN_PATH: true,
/**
* @constant
* @default
*/
INCLUDE_UNIX_PATH: true,
/**
* Extract file paths operation.
*
* @param {string} input
* @param {Object[]} args
* @returns {string}
*/
run_file_paths(input, args) {
let include_win_path = args[0],
include_unix_path = args[1],
display_total = args[2],
win_drive = '[A-Z]:\\\\',
win_name = "[A-Z\\d][A-Z\\d\\- '_\\(\\)]{0,61}",
win_ext = '[A-Z\\d]{1,6}',
win_path = `${win_drive}(?:${win_name}\\\\?)*${win_name
}(?:\\.${win_ext})?`,
unix_path = '(?:/[A-Z\\d.][A-Z\\d\\-.]{0,61})+',
file_paths = '';
if (include_win_path && include_unix_path) {
file_paths = `${win_path}|${unix_path}`;
} else if (include_win_path) {
file_paths = win_path;
} else if (include_unix_path) {
file_paths = unix_path;
}
if (file_paths) {
const regex = new RegExp(file_paths, 'ig');
return Extract._search(input, regex, null, display_total);
} else {
return '';
}
},
/**
* Extract dates operation.
*
* @param {string} input
* @param {Object[]} args
* @returns {string}
*/
run_dates(input, args) {
let display_total = args[0],
date1 = '(?:19|20)\\d\\d[- /.](?:0[1-9]|1[012])[- /.](?:0[1-9]|[12][0-9]|3[01])', // yyyy-mm-dd
date2 = '(?:0[1-9]|[12][0-9]|3[01])[- /.](?:0[1-9]|1[012])[- /.](?:19|20)\\d\\d', // dd/mm/yyyy
date3 = '(?:0[1-9]|1[012])[- /.](?:0[1-9]|[12][0-9]|3[01])[- /.](?:19|20)\\d\\d', // mm/dd/yyyy
regex = new RegExp(`${date1}|${date2}|${date3}`, 'ig');
return Extract._search(input, regex, null, display_total);
},
/**
* Extract all identifiers operation.
*
* @param {string} input
* @param {Object[]} args
* @returns {string}
*/
run_all_idents(input, args) {
let output = '';
output += 'IP addresses\n';
output += Extract.run_ip(input, [true, true, false]);
output += '\nEmail addresses\n';
output += Extract.run_email(input, []);
output += '\nMAC addresses\n';
output += Extract.run_mac(input, []);
output += '\nURLs\n';
output += Extract.run_urls(input, []);
output += '\nDomain names\n';
output += Extract.run_domains(input, []);
output += '\nFile paths\n';
output += Extract.run_file_paths(input, [true, true]);
output += '\nDates\n';
output += Extract.run_dates(input, []);
return output;
},
};