whois-that 0.1.2

A feature full whois client library with support for non-UTF8 responses
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

# whois-that

[![Crates.io](https://img.shields.io/crates/v/whois-that.svg)](https://crates.io/crates/whois-that)
[![Documentation](https://docs.rs/whois-that/badge.svg)](https://docs.rs/whois-that)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/supercoolspy/whois-that/blob/master/LICENSE)

`whois-that` is a fast, asynchronous WHOIS client library for Rust using `tokio`. It provides comprehensive domain information lookups with support for international domains, custom server lists, and various character encodings.

## Features

- **Async by default** - Built on Tokio for non-blocking network operations
- **International Domain Support** - Handles IDNs via IDNA Punycode conversion
- **Multiple Character Encodings** - Support for non-UTF8 responses (Windows-1252)
- **Configurable Server Lists** - Use default or custom WHOIS server configurations
- **Efficient Domain Suffix Lookup** - Fast TLD and domain lookups
- **Minimal Dependencies** - Feature flags let you include only what you need

## Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
whois-that = "0.1"
tokio = { version = "1", features = ["full"] }
```

### Feature Flags

The library uses feature flags to provide flexibility:

| Flag | Description | Default |
|------|-------------|---------|
| `serde` | Enable serde support for loading server lists from files/JSON data | ✓ |
| `idna` | Enable IDNA support for international domain names | ✓ |
| `decode-global` | Enable Windows-1252 character encoding support | ✓ |

To use only specific features:

```toml
[dependencies]
whois-that = { version = "0.1", default-features = false, features = ["serde", "idna"] }
```

## Usage

### Basic Usage

```rust
use whois_that::whois::Whois;
use whois_that::builder::WhoisBuilder;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Create a default whois client with built-in server list
    let whois = WhoisBuilder::default().build()?;
    
    // Look up WHOIS data for a domain
    let whois_data = whois.whois_lookup("google.com").await?;
    
    println!("{}", whois_data);
    
    Ok(())
}
```

### Custom Server List

You can provide your own WHOIS server list as a JSON file:

```rust
use whois_that::whois::Whois;
use whois_that::builder::WhoisBuilder;
use std::path::Path;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Create a whois client with a custom server list
    let whois = WhoisBuilder::default()
        .with_server_path(Path::new("path/to/custom_servers.json"))
        .build()?;
    
    // Look up WHOIS data for a domain
    let whois_data = whois.whois_lookup("example.com").await?;
    
    println!("{}", whois_data);
    
    Ok(())
}
```

### International Domain Names

When the `idna` feature is enabled (on by default), you can lookup international domain names:

```rust
use whois_that::whois::Whois;
use whois_that::builder::WhoisBuilder;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let whois = WhoisBuilder::default().build()?;
    
    // Look up WHOIS data for an IDN domain
    let whois_data = whois.whois_lookup("例子.网址").await?;
    println!("{}", whois_data);
    
    Ok(())
}
```

### Server List Format

Custom server lists should be JSON files in the following formats:

```json5
{
  // Standard format
  "io": "whois.nic.io",
  // Detailed format
  "net": {
    "host": "whois.verisign-grs.com",
    "query": "DOMAIN $addr\r\n",
    "punycode": true
  },
}
```

## Contributing

Contributions are welcome!

## Acknowledgments

- [Tokio](https://tokio.rs/) for the asynchronous runtime
- [DashMap](https://github.com/xacrimon/dashmap) for concurrent maps
- [node-whois](https://github.com/FurqanSoftware/node-whois) for the original server list