Skip to content

CLAUDE.md

Latest commit

 

History

History
104 lines (78 loc) · 4.19 KB

CLAUDE.md

File metadata and controls

104 lines (78 loc) · 4.19 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Build Commands

# Build the project
cargo build

# Build release version (optimized, stripped binary)
cargo build --release

# Run tests
cargo test

# Run only library tests
cargo test --lib

# Run a specific test
cargo test test_detect_type

# Run the CLI directly
cargo run -- example.com

# Check without building
cargo check

# Run an example
cargo run --example basic_query

Architecture

This is an RDAP (Registration Data Access Protocol) client written in Rust, implementing RFCs 7480-7484. It provides both a CLI tool and a library.

Core Components

  • src/main.rs - CLI entry point using clap for argument parsing, includes rdap update subcommand
  • src/lib.rs - Library entry point, re-exports public API
  • src/client.rs - RdapClient - main client that orchestrates queries, handles HTTP requests, parses responses, and follows registrar referrals for multi-layer RDAP queries
  • src/request.rs - RdapRequest and QueryType - request building and query type detection
  • src/bootstrap.rs - BootstrapClient - IANA bootstrap service discovery to find authoritative RDAP servers, with TLD override support
  • src/config.rs - Configuration management with priority loading (local > user > system > builtin)
  • src/display.rs - RdapDisplay and RdapDisplayWithQuery traits - colored terminal output formatting, abuse contact display
  • src/cache.rs - Bootstrap file caching in ~/.cache/rdap/
  • src/ip.rs - IP address utilities: normalization (shorthand → standard), CIDR detection/parsing
  • src/models/ - RDAP data models (Domain, Entity, Autnum, IpNetwork, Nameserver, etc.)

Configuration System

Priority (highest to lowest):
1. ~/.config/rdap/*.local.json  - User local overrides (never updated)
2. ~/.config/rdap/*.json        - Downloaded configs
3. /etc/rdap/*.json             - System configs
4. Built-in defaults            - Embedded in binary via include_str!

Files:
- config.json      - Bootstrap URLs for IANA RDAP
- tlds.json        - TLD overrides for ccTLDs not in IANA bootstrap
- *.local.json     - User overrides (merged, not replaced)

Config files in config/ directory are embedded into the binary at compile time.

Query Flow

  1. User provides query string (domain, TLD, IP, CIDR, AS number)
  2. RdapRequest::detect_type_with_tld_check() auto-detects query type:
    • Pure numbers → QueryType::Autnum (AS number)
    • Checks if single word matches IANA TLD list (from tlds.txt) → QueryType::Tld
    • IP-like patterns → QueryType::Ip
    • Otherwise → QueryType::Domain
  3. For IP queries: ip::normalize_ip() normalizes shorthand IPs (1.1 → 1.0.0.1)
  4. For domains: Check TLD overrides from tlds.json first, then IANA bootstrap
  5. BootstrapClient fetches IANA bootstrap registry to find authoritative RDAP server
  6. RdapClient sends HTTP request with Accept: application/rdap+json
  7. Response is parsed into appropriate RdapObject variant based on objectClassName
  8. For domain queries: Follow registrar referral link for multi-layer RDAP data
  9. Result is displayed via RdapDisplay trait (with abuse contact for IP/ASN) or serialized to JSON

Key Types

  • RdapObject - enum of all possible RDAP response types (Domain, Entity, IpNetwork, Autnum, etc.)
  • QueryType - enum for query types (Domain, Tld, Ip, Autnum, Entity, Nameserver, searches)
  • RdapQueryResult - Result with registry and optional registrar data, plus server URLs
  • VCard - jCard/vCard parsing for contact information in entities
  • Config - Configuration with bootstrap URLs and cache settings
  • TldOverrides - HashMap of TLD -> RDAP server URL
  • TldList - IANA TLD list for detecting TLD queries (e.g., rdap google → query .google TLD)

CLI Options

  • rdap <query> - Main query command
  • rdap --update / rdap -u - Update config files from GitHub

Dependencies

  • tokio + reqwest - async HTTP client
  • serde + serde_json - JSON serialization
  • clap - CLI parsing with subcommands
  • colored + comfy-table - terminal output formatting
  • ipnet - IP network/CIDR parsing and matching