README.md

CZDS-Client

A modern tool and Java library for downloading zone files from ICANN's CZDS API.

CZDS-Client is in NO WAY associated with ICANN. It is a project built and maintained by Sidpatchy.

CLI

CZDS-Client includes a basic CLI. Usage details can be viewed below.

Usage

usage: ZoneFile-Tools
 -a,--all              Download all zones
 -d,--debug            Enable debug mode
 -f,--path <arg>       Specify which directory zone files should be downloaded to -- defaults to './Downloads/'
 -h,--help             Show help
 -p,--password <arg>   ICANN CZDS Password
 -s,--show-approved    Lists all TLDs you are approved to access
 -u,--username <arg>   ICANN CZDS Username
 -v,--version          Show version
 -z,--zone <arg>       Specify a zone file to download.

Examples

# Download the .com zone file:
java -jar CZDS-Client-1.0.jar --username 'email@example.com' --password 'password123' --zone 'com'

# Download all zone files you're authorized to download:
java -jar CZDS-Client-1.0.jar --username 'email@example.com' --password 'password123' --all

# List which zone files you are authorized to download:
java -jar CZDS-Client-1.0.jar --username 'email@example.com' --password 'password123' --show-approved

Library

CZDS-Client is built using CompletableFutures for non-blocking API calls, enabling efficient handling of concurrent operations. Further, it is built using standard Java classes to minimize the learning curve.

Usage

Download the '.com' zone file:

String username = "email@example.com";
String password = "password123";

CZDSClient client = new CZDSClient(username, password);
client.getDownloader().downloadZoneFile("com").join();

Download all authorized zone files:

String username = "email@example.com";
String password = "password123";

CZDSClient client = new CZDSClient(username, password);
client.getDownloader().downloadAllApprovedZoneFiles().join();