Added support for threats (PX9) & residential proxies (PX10)

Author: ip2location-com

ChangeLog.md

@@ -1,5 +1,9 @@
 # Revision history for ip2proxy
 
+## 3.0.0  -- 2020-08-11
+
+* Added support for PX9 to PX10 packages.
+
 ## 2.2.1  -- 2020-04-22
 
 * Modified version requirement for base module.

IP2Proxy.hs

@@ -10,7 +10,7 @@ This Haskell package allows users to query an IP address to determine if it was
 
 IP2Proxy LITE BIN databases are available for free at http://lite.ip2location.com/
 -}
-module IP2Proxy (Meta, IP2ProxyRecord(..), getModuleVersion, getPackageVersion, getDatabaseVersion, open, getAll, getCountryShort, getCountryLong, getRegion, getCity, getISP, getProxyType, getDomain, getUsageType, getASN, getAS, getLastSeen, isProxy) where
+module IP2Proxy (Meta, IP2ProxyRecord(..), getModuleVersion, getPackageVersion, getDatabaseVersion, open, getAll, getCountryShort, getCountryLong, getRegion, getCity, getISP, getProxyType, getDomain, getUsageType, getASN, getAS, getLastSeen, getThreat, isProxy) where
 
 import qualified Data.ByteString.Lazy as BS
 import qualified Data.ByteString.Lazy.Char8 as BS8
@@ -44,6 +44,8 @@ data IP2ProxyRecord = IP2ProxyRecord {
     as :: String,
     -- | Last seen
     last_seen :: String,
+    -- | Threat
+    threat :: String,
     -- | Is proxy
     is_proxy :: Int
 } deriving (Show)
@@ -99,7 +101,7 @@ getMeta = do
     The 'getModuleVersion' function returns a string containing the module version.
 -}
 getModuleVersion :: String
-getModuleVersion = "2.2.1"
+getModuleVersion = "3.0.0"
 
 {-|
     The 'getPackageVersion' function returns a string containing the package version.
@@ -215,16 +217,17 @@ countif f = length . filter f
 
 readrecord :: BS.ByteString -> Int -> Int -> Int -> IP2ProxyRecord
 readrecord contents dbtype rowoffset mode = do
-    let country_position = [0, 2, 3, 3, 3, 3, 3, 3, 3]
-    let region_position = [0, 0, 0, 4, 4, 4, 4, 4, 4]
-    let city_position = [0, 0, 0, 5, 5, 5, 5, 5, 5]
-    let isp_position = [0, 0, 0, 0, 6, 6, 6, 6, 6]
-    let proxytype_position = [0, 0, 2, 2, 2, 2, 2, 2, 2]
-    let domain_position = [0, 0, 0, 0, 0, 7, 7, 7, 7]
-    let usagetype_position = [0, 0, 0, 0, 0, 0, 8, 8, 8]
-    let asn_position = [0, 0, 0, 0, 0, 0, 0, 9, 9]
-    let as_position = [0, 0, 0, 0, 0, 0, 0, 10, 10]
-    let lastseen_position = [0, 0, 0, 0, 0, 0, 0, 0, 11]
+    let country_position = [0, 2, 3, 3, 3, 3, 3, 3, 3, 3, 3]
+    let region_position = [0, 0, 0, 4, 4, 4, 4, 4, 4, 4, 4]
+    let city_position = [0, 0, 0, 5, 5, 5, 5, 5, 5, 5, 5]
+    let isp_position = [0, 0, 0, 0, 6, 6, 6, 6, 6, 6, 6]
+    let proxytype_position = [0, 0, 2, 2, 2, 2, 2, 2, 2, 2, 2]
+    let domain_position = [0, 0, 0, 0, 0, 7, 7, 7, 7, 7, 7]
+    let usagetype_position = [0, 0, 0, 0, 0, 0, 8, 8, 8, 8, 8]
+    let asn_position = [0, 0, 0, 0, 0, 0, 0, 9, 9, 9, 9]
+    let as_position = [0, 0, 0, 0, 0, 0, 0, 10, 10, 10, 10]
+    let lastseen_position = [0, 0, 0, 0, 0, 0, 0, 0, 11, 11, 11]
+    let threat_position = [0, 0, 0, 0, 0, 0, 0, 0, 0, 12, 12]
 
     let countryshort_field = 1
     let countrylong_field = 2
@@ -238,8 +241,9 @@ readrecord contents dbtype rowoffset mode = do
     let asn_field = 512
     let as_field = 1024
     let lastseen_field = 2048
+    let threat_field = 4096
 
-    let allcols = (take 1 (drop dbtype country_position)) ++ (take 1 (drop dbtype region_position)) ++ (take 1 (drop dbtype city_position)) ++ (take 1 (drop dbtype isp_position)) ++ (take 1 (drop dbtype proxytype_position)) ++ (take 1 (drop dbtype domain_position)) ++ (take 1 (drop dbtype usagetype_position)) ++ (take 1 (drop dbtype asn_position)) ++ (take 1 (drop dbtype as_position)) ++ (take 1 (drop dbtype lastseen_position))
+    let allcols = (take 1 (drop dbtype country_position)) ++ (take 1 (drop dbtype region_position)) ++ (take 1 (drop dbtype city_position)) ++ (take 1 (drop dbtype isp_position)) ++ (take 1 (drop dbtype proxytype_position)) ++ (take 1 (drop dbtype domain_position)) ++ (take 1 (drop dbtype usagetype_position)) ++ (take 1 (drop dbtype asn_position)) ++ (take 1 (drop dbtype as_position)) ++ (take 1 (drop dbtype lastseen_position)) ++ (take 1 (drop dbtype threat_position))
     let cols = (countif (>0) allcols) `shiftL` 2
     let row = BS.take (fromIntegral cols) (BS.drop (fromIntegral rowoffset - 1) contents)
 
@@ -293,13 +297,18 @@ readrecord contents dbtype rowoffset mode = do
         then readcolstringrow contents row dbtype lastseen_position
         else ""
 
+    let threat = if ((.&.) mode threat_field) /= 0
+        -- then readcolstring contents dbtype rowoffset threat_position
+        then readcolstringrow contents row dbtype threat_position
+        else ""
+    
     let is_proxy = if (country_short == "-") || (proxy_type == "-")
         then 0
         else if (proxy_type == "DCH") || (proxy_type == "SES")
             then 2
             else 1
 
-    IP2ProxyRecord country_short country_long region city isp proxy_type domain usage_type asn as last_seen is_proxy
+    IP2ProxyRecord country_short country_long region city isp proxy_type domain usage_type asn as last_seen threat is_proxy
 
 searchtree :: BS.ByteString -> Integer -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> IP2ProxyRecord
 searchtree contents ipnum dbtype low high baseaddr colsize iptype mode = do
@@ -333,7 +342,7 @@ searchtree contents ipnum dbtype low high baseaddr colsize iptype mode = do
                         searchtree contents ipnum dbtype (mid + 1) high baseaddr colsize iptype mode
         else do
             let x = "INVALID IP ADDRESS"
-            IP2ProxyRecord x x x x x x x x x x x (-1)
+            IP2ProxyRecord x x x x x x x x x x x x (-1)
 
 search4 :: BS.ByteString -> Integer -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> IP2ProxyRecord
 search4 contents ipnum dbtype low high baseaddr indexbaseaddr colsize mode = do
@@ -369,7 +378,7 @@ tryfirst myIP = do
 -}
 getAll :: String -> Meta -> String -> IO IP2ProxyRecord
 getAll myfile meta myip = do
-    result <- doQuery myfile meta myip 4095
+    result <- doQuery myfile meta myip 8191
     return result
 
 {-|
@@ -471,6 +480,15 @@ getLastSeen myfile meta myip = do
     result <- doQuery myfile meta myip 2048
     return (show (last_seen result))
 
+{-|
+    The 'getThreat' function returns the threat type of the proxy.
+    It takes 3 arguments; the BIN database file path (String), the metadata from 'open' function (Meta record) & either IPv4 or IPv6 address (String).
+-}
+getThreat :: String -> Meta -> String -> IO String
+getThreat myfile meta myip = do
+    result <- doQuery myfile meta myip 4096
+    return (show (threat result))
+
 {-|
     The 'isProxy' function returns 0 if IP is not a proxy, 1 if is a proxy and not data center IP, 2 if is a proxy and is a data center IP, -1 if error.
     It takes 3 arguments; the BIN database file path (String), the metadata from 'open' function (Meta record) & either IPv4 or IPv6 address (String).
@@ -497,7 +515,7 @@ doQuery myfile meta myip mode = do
     if ipnum == -1
         then do
             let x = "INVALID IP ADDRESS"
-            return $ IP2ProxyRecord x x x x x x x x x x x (-1)
+            return $ IP2ProxyRecord x x x x x x x x x x x x (-1)
         else if ipnum >= fromV4Mapped && ipnum <= toV4Mapped
             then do
                 return $ search4 contents (ipnum - (toInteger fromV4Mapped)) (databasetype meta) 0 (ipv4databasecount meta) (ipv4databaseaddr meta) (ipv4indexbaseaddr meta) (ipv4columnsize meta) mode

README.md

@@ -1,6 +1,6 @@
 # IP2Proxy Haskell Module
 
-This Haskell package 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 Haskell package 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
@@ -18,22 +18,23 @@ Below are the methods supported in this package.
 |Method Name|Description|
 |---|---|
 |open|Open the IP2Proxy BIN data for lookup.|
-|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 a record.|
-|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.|
 
 ## Example
 
@@ -42,7 +43,7 @@ import IP2Proxy
 
 main :: IO ()
 main = do
-    let myfile = "./IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN.BIN"
+    let myfile = "./IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN-THREAT-RESIDENTIAL.BIN"
     let ip = "199.83.103.79"
     meta <- open myfile
 
@@ -62,6 +63,7 @@ main = do
     putStrLn $ "asn: " ++ (show (asn result))
     putStrLn $ "as: " ++ (show (as result))
     putStrLn $ "last_seen: " ++ (show (last_seen result))
+    putStrLn $ "threat: " ++ (show (threat result))
     putStrLn $ "is_proxy: " ++ (show (is_proxy result))
 
     result <- getCountryShort myfile meta ip
@@ -86,6 +88,8 @@ main = do
     putStrLn $ "as: " ++ result
     result <- getLastSeen myfile meta ip
     putStrLn $ "last_seen: " ++ result
+    result <- getThreat myfile meta ip
+    putStrLn $ "threat: " ++ result
     result <- isProxy myfile meta ip
     putStrLn $ "is_proxy: " ++ result
 ```

ip2proxy.cabal

@@ -10,13 +10,13 @@ name:                ip2proxy
 -- PVP summary:      +-+------- breaking API changes
 --                   | | +----- non-breaking API additions
 --                   | | | +--- code changes with no API change
-version:             2.2.1
+version:             3.0.0
 
 -- A short (one-line) description of the package.
 synopsis:            IP2Proxy Haskell package for proxy detection.
 
 -- A longer description of the package.
-description:      This Haskell package allows users to query an IP address to determine 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).
+description:      This Haskell package allows users to query an IP address to determine 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).
 
 -- URL for the project homepage or repository.
 homepage:            https://www.ip2location.com
@@ -60,7 +60,7 @@ library
   -- other-extensions:    
 
   -- Other library packages from which modules are imported.
-  build-depends:       base >=4.11 && <=4.14, bytestring >=0.10 && <0.11, binary >=0.8.4 && <0.9, iproute >=1.7 && <1.8
+  build-depends:       base >=4.7 && <=4.14, bytestring >=0.10 && <0.11, binary >=0.8.8 && <0.9, iproute >=1.7 && <1.8
 
   -- Directories containing source files.
   -- hs-source-dirs:      

test.hs

@@ -0,0 +1,53 @@
+import IP2Proxy
+
+main :: IO ()
+main = do
+    let myfile = "./IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN-THREAT-RESIDENTIAL.BIN"
+    let ip = "123.25.30.87"
+    meta <- open myfile
+    
+    putStrLn $ "module_version: " ++ getModuleVersion
+    putStrLn $ "package_version: " ++ (getPackageVersion meta)
+    putStrLn $ "database_version: " ++ (getDatabaseVersion meta)
+    
+    result <- getAll myfile meta ip
+    putStrLn $ "country_short: " ++ (show (country_short result))
+    putStrLn $ "country_long: " ++ (show (country_long result))
+    putStrLn $ "region: " ++ (show (region result))
+    putStrLn $ "city: " ++ (show (city result))
+    putStrLn $ "isp: " ++ (show (isp result))
+    putStrLn $ "proxy_type: " ++ (show (proxy_type result))
+    putStrLn $ "domain: " ++ (show (domain result))
+    putStrLn $ "usage_type: " ++ (show (usage_type result))
+    putStrLn $ "asn: " ++ (show (asn result))
+    putStrLn $ "as: " ++ (show (as result))
+    putStrLn $ "last_seen: " ++ (show (last_seen result))
+    putStrLn $ "threat: " ++ (show (threat result))
+    putStrLn $ "is_proxy: " ++ (show (is_proxy result))
+
+    result <- getCountryShort myfile meta ip
+    putStrLn $ "country_short: " ++ result
+    result <- getCountryLong myfile meta ip
+    putStrLn $ "country_long: " ++ result
+    result <- getRegion myfile meta ip
+    putStrLn $ "region: " ++ result
+    result <- getCity myfile meta ip
+    putStrLn $ "city: " ++ result
+    result <- getISP myfile meta ip
+    putStrLn $ "isp: " ++ result
+    result <- getProxyType myfile meta ip
+    putStrLn $ "proxy_type: " ++ result
+    result <- getDomain myfile meta ip
+    putStrLn $ "domain: " ++ result
+    result <- getUsageType myfile meta ip
+    putStrLn $ "usage_type: " ++ result
+    result <- getASN myfile meta ip
+    putStrLn $ "asn: " ++ result
+    result <- getAS myfile meta ip
+    putStrLn $ "as: " ++ result
+    result <- getLastSeen myfile meta ip
+    putStrLn $ "last_seen: " ++ result
+    result <- getThreat myfile meta ip
+    putStrLn $ "threat: " ++ result
+    result <- isProxy myfile meta ip
+    putStrLn $ "is_proxy: " ++ result