Added support for PX9 to PX10 packages

Author: ip2location

README.md

@@ -1,6 +1,6 @@
 # IP2Proxy Node.js Module
 
-This module allows user to query an IP address if it was being used as VPN anonymizer, open proxies, web proxies, Tor exits, data center, web hosting (DCH) range and search engine robots (SES). It lookup the proxy IP address from **IP2Proxy BIN Data** file. This data file can be downloaded at
+This module allows user to query an IP address if it was being used as VPN anonymizer, open proxies, web proxies, Tor exits, data center, web hosting (DCH) range, search engine robots (SES) and residential (RES). It lookup the proxy IP address from **IP2Proxy BIN Data** file. This data file can be downloaded at
 
 * Free IP2Proxy BIN Data: https://lite.ip2location.com
 * Commercial IP2Proxy BIN Data: https://www.ip2location.com/database/ip2proxy
@@ -23,30 +23,31 @@ Below are the methods supported in this class.
 |---|---|
 |Open|Open the IP2Proxy BIN data for lookup.|
 |Close|Close and clean up the file pointer.|
-|getPackageVersion|Get the package version (1 to 8 for PX1 to PX8 respectively).|
+|getPackageVersion|Get the package version (1 to 10 for PX1 to PX10 respectively).|
 |getModuleVersion|Get the module version.|
 |getDatabaseVersion|Get the database version.|
 |isProxy|Check whether if an IP address was a proxy. Returned value:<ul><li>-1 : errors</li><li>0 : not a proxy</li><li>1 : a proxy</li><li>2 : a data center IP address or search engine robot</li></ul>|
 |getAll|Return the proxy information in an object.|
-|getProxyType|Return the proxy type. Please visit <a href="https://www.ip2location.com/database/px8-ip-proxytype-country-region-city-isp-domain-usagetype-asn-lastseen" target="_blank">IP2Location</a> for the list of proxy types supported|
+|getProxyType|Return the proxy type. Please visit <a href="https://www.ip2location.com/database/px10-ip-proxytype-country-region-city-isp-domain-usagetype-asn-lastseen-threat-residential" target="_blank">IP2Location</a> for the list of proxy types supported|
 |getCountryShort|Return the ISO3166-1 country code (2-digits) of the proxy.|
 |getCountryLong|Return the ISO3166-1 country name of the proxy.|
 |getRegion|Return the ISO3166-2 region name of the proxy. Please visit <a href="https://www.ip2location.com/free/iso3166-2" target="_blank">ISO3166-2 Subdivision Code</a> for the information of ISO3166-2 supported|
 |getCity|Return the city name of the proxy.|
 |getISP|Return the ISP name of the proxy.|
 |getDomain|Return the domain name of the proxy.|
-|getUsageType|Return the usage type classification of the proxy. Please visit <a href="https://www.ip2location.com/database/px8-ip-proxytype-country-region-city-isp-domain-usagetype-asn-lastseen" target="_blank">IP2Location</a> for the list of usage types supported.|
+|getUsageType|Return the usage type classification of the proxy. Please visit <a href="https://www.ip2location.com/database/px10-ip-proxytype-country-region-city-isp-domain-usagetype-asn-lastseen-threat-residential" target="_blank">IP2Location</a> for the list of usage types supported.|
 |getASN|Return the autonomous system number of the proxy.|
 |getAS|Return the autonomous system name of the proxy.|
 |getLastSeen|Return the number of days that the proxy was last seen.|
+|getThreat|Return the threat type of the proxy.|
 
 ## Usage
 
 ```javascript
 
 var ip2proxy = require("ip2proxy-nodejs");
 
-if (ip2proxy.Open("./IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN.BIN") == 0) {
+if (ip2proxy.Open("./IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN-THREAT-RESIDENTIAL.BIN") == 0) {
 	ip = '199.83.103.79';
 
 	console.log("GetModuleVersion: " + ip2proxy.getModuleVersion());
@@ -66,6 +67,7 @@ if (ip2proxy.Open("./IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGET
 	console.log("ASN: " + ip2proxy.getASN(ip));
 	console.log("AS: " + ip2proxy.getAS(ip));
 	console.log("LastSeen: " + ip2proxy.getLastSeen(ip));
+	console.log("Threat: " + ip2proxy.getThreat(ip));
 
 	// function for all fields
 	var all = ip2proxy.getAll(ip);
@@ -81,6 +83,7 @@ if (ip2proxy.Open("./IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGET
 	console.log("ASN: " + all.ASN);
 	console.log("AS: " + all.AS);
 	console.log("LastSeen: " + all.Last_Seen);
+	console.log("Threat: " + all.Threat);
 }
 else {
 	console.log("Error reading BIN file.");

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ip2proxy-nodejs",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "IP2Proxy proxy detection component",
   "keywords": [
     "vpn-detection",

src/ip2proxy.js

@@ -4,7 +4,7 @@ var bigInt = require("big-integer");
 
 var fd;
 
-var version = "2.2.0";
+var version = "2.3.0";
 var binfile = "";
 var IPv4ColumnSize = 0;
 var IPv6ColumnSize = 0;
@@ -16,17 +16,17 @@ var maxindex = 65536;
 var IndexArrayIPv4 = Array(maxindex);
 var IndexArrayIPv6 = Array(maxindex);
 
-var country_pos = [0, 2, 3, 3, 3, 3, 3, 3, 3];
-var region_pos = [0, 0, 0, 4, 4, 4, 4, 4, 4];
-var city_pos = [0, 0, 0, 5, 5, 5, 5, 5, 5];
-var isp_pos = [0, 0, 0, 0, 6, 6, 6, 6, 6];
-var proxytype_pos = [0, 0, 2, 2, 2, 2, 2, 2, 2];
-var domain_pos = [0, 0, 0, 0, 0, 7, 7, 7, 7];
-var usagetype_pos = [0, 0, 0, 0, 0, 0, 8, 8, 8];
-var asn_pos = [0, 0, 0, 0, 0, 0, 0, 9, 9];
-var as_pos = [0, 0, 0, 0, 0, 0, 0, 10, 10];
-var lastseen_pos = [0, 0, 0, 0, 0, 0, 0, 0, 11];
-
+var country_pos = [0, 2, 3, 3, 3, 3, 3, 3, 3, 3, 3];
+var region_pos = [0, 0, 0, 4, 4, 4, 4, 4, 4, 4, 4];
+var city_pos = [0, 0, 0, 5, 5, 5, 5, 5, 5, 5, 5];
+var isp_pos = [0, 0, 0, 0, 6, 6, 6, 6, 6, 6, 6];
+var proxytype_pos = [0, 0, 2, 2, 2, 2, 2, 2, 2, 2, 2];
+var domain_pos = [0, 0, 0, 0, 0, 7, 7, 7, 7, 7, 7];
+var usagetype_pos = [0, 0, 0, 0, 0, 0, 8, 8, 8, 8, 8];
+var asn_pos = [0, 0, 0, 0, 0, 0, 0, 9, 9, 9, 9];
+var as_pos = [0, 0, 0, 0, 0, 0, 0, 10, 10, 10, 10];
+var lastseen_pos = [0, 0, 0, 0, 0, 0, 0, 0, 11, 11, 11];
+var threat_pos = [0, 0, 0, 0, 0, 0, 0, 0, 0, 12, 12];
 
 var country_pos_offset = 0;
 var region_pos_offset = 0;
@@ -38,6 +38,7 @@ var usagetype_pos_offset = 0;
 var asn_pos_offset = 0;
 var as_pos_offset = 0;
 var lastseen_pos_offset = 0;
+var threat_pos_offset = 0;
 
 var country_enabled = 0;
 var region_enabled = 0;
@@ -49,6 +50,7 @@ var usagetype_enabled = 0;
 var asn_enabled = 0;
 var as_enabled = 0;
 var lastseen_enabled = 0;
+var threat_enabled = 0;
 
 var MAX_IPV4_RANGE = bigInt(4294967295);
 var MAX_IPV6_RANGE = bigInt("340282366920938463463374607431768211455");
@@ -85,6 +87,7 @@ var modes = {
 	"ASN": 10,
 	"AS": 11,
 	"LAST_SEEN": 12,
+	"THREAT": 13,
 	"ALL": 100
 };
 
@@ -263,6 +266,7 @@ function loadbin() {
 			// asn_pos_offset = (asn_pos[dbt] != 0) ? (asn_pos[dbt] - 1) << 2 : 0;
 			// as_pos_offset = (as_pos[dbt] != 0) ? (as_pos[dbt] - 1) << 2 : 0;
 			// lastseen_pos_offset = (lastseen_pos[dbt] != 0) ? (lastseen_pos[dbt] - 1) << 2 : 0;
+			// threat_pos_offset = (threat_pos[dbt] != 0) ? (threat_pos[dbt] - 1) << 2 : 0;
 
 			// slightly different offset for reading by row
 			country_pos_offset = (country_pos[dbt] != 0) ? (country_pos[dbt] - 2) << 2 : 0;
@@ -275,6 +279,7 @@ function loadbin() {
 			asn_pos_offset = (asn_pos[dbt] != 0) ? (asn_pos[dbt] - 2) << 2 : 0;
 			as_pos_offset = (as_pos[dbt] != 0) ? (as_pos[dbt] - 2) << 2 : 0;
 			lastseen_pos_offset = (lastseen_pos[dbt] != 0) ? (lastseen_pos[dbt] - 2) << 2 : 0;
+			threat_pos_offset = (threat_pos[dbt] != 0) ? (threat_pos[dbt] - 2) << 2 : 0;
 
 			country_enabled = (country_pos[dbt] != 0) ? 1 : 0;
 			region_enabled = (region_pos[dbt] != 0) ? 1 : 0;
@@ -286,6 +291,7 @@ function loadbin() {
 			asn_enabled = (asn_pos[dbt] != 0) ? 1 : 0;
 			as_enabled = (as_pos[dbt] != 0) ? 1 : 0;
 			lastseen_enabled = (lastseen_pos[dbt] != 0) ? 1 : 0;
+			threat_enabled = (threat_pos[dbt] != 0) ? 1 : 0;
 
 			var pointer = mydb._IndexBaseAddr;
 
@@ -510,6 +516,12 @@ function proxyquery_data(myIP, iptype, data, mode) {
 					data.Last_Seen = readstr(read32_row(lastseen_pos_offset, row));
 				}
 			}
+			if (threat_enabled) {
+				if (mode == modes.ALL || mode == modes.THREAT) {
+					// data.Threat = readstr(read32(rowoffset + threat_pos_offset));
+					data.Threat = readstr(read32_row(threat_pos_offset, row));
+				}
+			}
 
 			if (data.Country_Short == "-" || data.Proxy_Type == "-") {
 				data.Is_Proxy = 0;
@@ -551,7 +563,8 @@ function proxyquery(myIP, mode) {
 		"Usage_Type": "?",
 		"ASN": "?",
 		"AS": "?",
-		"Last_Seen": "?"
+		"Last_Seen": "?",
+		"Threat": "?"
 	};
 
 	if (/^[:0]+:F{4}:(\d+\.){3}\d+$/i.test(myIP)) {
@@ -676,6 +689,12 @@ exports.getLastSeen = function getLastSeen(myIP) {
 	return data.Last_Seen;
 }
 
+// Returns a string for the threat
+exports.getThreat = function getThreat(myIP) {
+	data = proxyquery(myIP, modes.THREAT);
+	return data.Threat;
+}
+
 // Returns all results
 exports.getAll = function getAll(myIP) {
 	data = proxyquery(myIP, modes.ALL);

src/test.js

@@ -1,7 +1,7 @@
 // var ip2proxy = require("./ip2proxy.js");
 var ip2proxy = require("ip2proxy-nodejs");
 
-ip2proxy.Open("PX8.BIN");
+ip2proxy.Open("PX10.BIN");
 
 testip = ['8.8.8.8', '199.83.103.79'];