Security Fixes (this session + previous)

SAFETY comments on all 4 unsafe { Mmap::map() } calls documenting the contract
db_year <= 20 time bomb removed in both LocationDB::read_header and ProxyDB::read_header — now checks product_code only, so databases from 2021+ work correctly
Header size validation — DB::from_file rejects files < 32 bytes before parsing
Bounds checking on all Source::read_* methods (done in previous round)
Removed stale commented-out code (//path: db.path, //let index_buffer = ...)
Performance (previous session, verified this session)
from_ne_bytes → from_le_bytes — correct on all platforms
Single-mmap DB::from_file — reads product code from one mmap to pick the right variant

Author: marirs

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ip2location"
-version = "0.6.0"
+version = "0.6.1"
 authors = ["MARIRS <marirs@gmail.com>"]
 description = "Find geo information & proxy information based on the given IP using IP2Location BIN databases"
 keywords = ["ip2location", "geoip", "geolocation", "ip", "proxy"]
@@ -13,13 +13,13 @@ exclude = [
 ]
 repository = "https://github.com/marirs/rust-ip2location"
 homepage = "https://github.com/marirs/rust-ip2location"
-edition = "2021"
+edition = "2024"
 
 [dependencies]
 memmap2 = "0.9"
 serde = { version = "1", features = ["derive"] }
 serde_json = "1"
-serde_with = "3.11"
+serde_with = "3.12"
 
 [profile.dev]
 opt-level = 3

README.md

@@ -11,8 +11,14 @@
 
 This library reads the IP2Location DB format for both IP2Location and IP2Proxy and returns geo information for the given IP.
 
+### Features
+- **Zero-copy** — string fields borrow directly from the memory-mapped file
+- **Memory-mapped I/O** — database is mmap’d at open time, no heap allocation on the lookup path
+- Supports both **IP2Location** (geolocation) and **IP2Proxy** (proxy detection) BIN databases
+- Handles **IPv4**, **IPv6**, **6to4**, **Teredo**, and **IPv4-mapped IPv6** addresses
+
 ### Requirements
-- `Rust 1.60.0` and above (edition 2021)
+- Rust **1.85+** (edition 2024)
 
 ### Building
 - debug
@@ -32,7 +38,7 @@ cargo t -v
 ### Usage
 ```toml
 [dependencies]
-ip2location = "0.6.0"
+ip2location = "0.6"
 ```
 
 ### Example
@@ -43,158 +49,50 @@ const IPV4BIN: &str = "data/IP2LOCATION-LITE-DB1.BIN";
 const IPV6BIN: &str = "data/IP2LOCATION-LITE-DB1.IPV6.BIN";
 const IP2PROXYBIN: &str = "data/IP2PROXY-IP-COUNTRY.BIN";
 
-// Lookup an IP v4 in the IP2Location V6 BIN Database
+// Lookup an IPv4 in the IP2Location IPv6 BIN Database
 fn ip_lookup_in_ipv6bin() -> Result<(), error::Error> {
-    let mut db = DB::from_file(IPV6BIN)?;
+    let db = DB::from_file(IPV6BIN)?;
     let record = db.ip_lookup("43.224.159.155".parse().unwrap())?;
-    let record = if let Record::LocationDb(rec) = record {
-        Some(rec)
-    } else {
-        None
-    };
-    assert!(record.is_some());
-    let record = record.unwrap();
-    assert!(!record.country.is_none());
-    assert_eq!(record.country.clone().unwrap().short_name, "IN");
-    assert_eq!(record.country.unwrap().long_name, "India");
+    if let Record::LocationDb(rec) = record {
+        assert!(rec.country.is_some());
+        assert_eq!(rec.country.as_ref().unwrap().short_name, "IN");
+        assert_eq!(rec.country.as_ref().unwrap().long_name, "India");
+    }
     Ok(())
 }
 
-// Lookup an IP v4 in the IP2Location V4 BIN Database
+// Lookup an IPv4 in the IP2Location IPv4 BIN Database
 fn ip_lookup_in_ipv4bin() -> Result<(), error::Error> {
-    let mut db = DB::from_file(IPV4BIN)?;
+    let db = DB::from_file(IPV4BIN)?;
     let record = db.ip_lookup("43.224.159.155".parse().unwrap())?;
-    let record = if let Record::LocationDb(rec) = record {
-        Some(rec)
-    } else {
-        None
-    };
-    assert!(record.is_some());
-    let record = record.unwrap();
-    assert!(!record.country.is_none());
-    assert_eq!(record.country.clone().unwrap().short_name, "IN");
-    assert_eq!(record.country.unwrap().long_name, "India");
+    if let Record::LocationDb(rec) = record {
+        assert!(rec.country.is_some());
+        assert_eq!(rec.country.as_ref().unwrap().short_name, "IN");
+        assert_eq!(rec.country.as_ref().unwrap().long_name, "India");
+    }
     Ok(())
 }
 
 // Lookup an IP in the Proxy Database
 fn ip_lookup_in_proxy_bin() -> Result<(), error::Error> {
-    let mut db = DB::from_file(IP2PROXYBIN)?;
+    let db = DB::from_file(IP2PROXYBIN)?;
     let record = db.ip_lookup("1.1.1.1".parse().unwrap())?;
-    let record = if let Record::ProxyDb(rec) = record {
-        Some(rec)
-    } else {
-        None
-    };
-    assert!(record.is_some());
-    let record = record.unwrap();
-    assert!(!record.country.is_none());
+    if let Record::ProxyDb(rec) = record {
+        assert!(rec.country.is_some());
+    }
     Ok(())
 }
 ```
 
 ### Executing the Example
 ```bash
-cargo b --example
-
-# IP2Lcoation Example
+cargo build --examples
 
+# IP2Location Example
 ./target/debug/examples/lookup data/IP2LOCATION-LITE-DB1.IPV6.BIN 2a01:cb08:8d14::
-Db Path: data/IP2LOCATION-LITE-DB1.IPV6.BIN
- |- Db Type: 1
- |- Db Column: 2
- |- Db Date (YY/MM/DD): 20/12/28
-
-Ok(
-    Record {
-        ip: "2a01:cb08:8d14::",
-        latitude: None,
-        longitude: None,
-        country: Some(
-            Country {
-                short_name: "FR",
-                long_name: "France",
-            },
-        ),
-        region: None,
-        city: None,
-        isp: None,
-        domain: None,
-        zip_code: None,
-        time_zone: None,
-        net_speed: None,
-        idd_code: None,
-        area_code: None,
-        weather_station_code: None,
-        weather_station_name: None,
-        mcc: None,
-        mnc: None,
-        mobile_brand: None,
-        elevation: None,
-        usage_type: None,
-        address_type: None,
-        category: None,
-        district: None,
-        asn: None,
-        as_name: None,
-    },
-)
-
-# IP2Proxy Example 
- 
-./target/debug/examples/lookup data/sample.bin.px11/IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN-THREAT-RESIDENTIAL-PROVIDER.BIN 194.59.249.19
-Db Path: data/sample.bin.px11/IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN-THREAT-RESIDENTIAL-PROVIDER.BIN
- |- Db Type: 11
- |- Db Column: 13
- |- Db Date (YY/MM/DD): 21/5/28
-
-ProxyDb(
-    ProxyRecord {
-        ip: 1.1.1.1,
-        country: Some(
-            Country {
-                short_name: "US",
-                long_name: "United States of America",
-            },
-        ),
-        region: Some(
-            "California",
-        ),
-        city: Some(
-            "Los Angeles",
-        ),
-        isp: Some(
-            "APNIC and CloudFlare DNS Resolver Project",
-        ),
-        domain: Some(
-            "cloudflare.com",
-        ),
-        is_proxy: Some(
-            IsAProxy,
-        ),
-        proxy_type: Some(
-            "DCH",
-        ),
-        asn: Some(
-            "13335",
-        ),
-        as_: Some(
-            "CloudFlare Inc",
-        ),
-        last_seen: Some(
-            "27",
-        ),
-        threat: Some(
-            "-",
-        ),
-        provider: Some(
-            "-",
-        ),
-        usage_type: Some(
-            "CDN",
-        ),
-    },
-)
+
+# IP2Proxy Example
+./target/debug/examples/lookup data/IP2PROXY-IP-COUNTRY.BIN 1.1.1.1
 ```
 
 ### License

examples/lookup.rs

@@ -1,32 +1,34 @@
+//! CLI example: look up an IP address in an IP2Location or IP2Proxy BIN database.
+//!
+//! Usage:
+//!   cargo run --example lookup -- <path/to/db.bin> <ip_address>
+//!
+//! Example:
+//!   cargo run --example lookup -- data/IP2LOCATION-LITE-DB1.IPV6.BIN 2a01:cb08:8d14::
+
 use std::net::IpAddr;
 
 use ip2location::DB;
 
 fn main() -> Result<(), String> {
     let mut args = std::env::args().skip(1);
-    let db = match DB::from_file(&*args.next().ok_or("First argument is the path to db")?) {
-        Ok(db) => db,
-        Err(e) => {
-            println!("{:?}", e);
-            std::process::exit(1)
-        }
-    };
+
+    let db_path = args.next().ok_or("Usage: lookup <db_path> <ip_address>")?;
+    let db = DB::from_file(&db_path).map_err(|e| format!("Failed to open {db_path}: {e}"))?;
 
     let ip: IpAddr = args
         .next()
-        .ok_or("Second argument must be the IP address, like 128.101.101.101")?
+        .ok_or("Usage: lookup <db_path> <ip_address>")?
         .parse()
-        .unwrap();
+        .map_err(|e| format!("Invalid IP address: {e}"))?;
 
-    // print the db information
     db.print_db_info();
     println!();
 
-    // print the IP information
     match db.ip_lookup(ip) {
         Ok(record) => println!("{:#?}", record),
-        Err(e) => println!("{:?}", e),
-    };
+        Err(e) => eprintln!("Lookup failed: {e}"),
+    }
 
     Ok(())
 }