Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lanrat/czds
simple golang API and tools to interact with czds.icann.org
https://github.com/lanrat/czds
czds czds-requests dns icann zone-file zone-files zones
Last synced: about 2 months ago
JSON representation
simple golang API and tools to interact with czds.icann.org
- Host: GitHub
- URL: https://github.com/lanrat/czds
- Owner: lanrat
- License: gpl-3.0
- Created: 2018-07-29T18:55:13.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-07-14T21:24:03.000Z (over 1 year ago)
- Last Synced: 2024-08-02T14:08:31.762Z (5 months ago)
- Topics: czds, czds-requests, dns, icann, zone-file, zone-files, zones
- Language: Go
- Homepage: https://pkg.go.dev/github.com/lanrat/czds
- Size: 3.25 MB
- Stars: 71
- Watchers: 8
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CZDS
[](https://goreportcard.com/report/lanrat/czds)
[](https://pkg.go.dev/github.com/lanrat/czds)
[](https://github.com/lanrat/czds/actions/workflows/codeql-analysis.yml)
[](https://github.com/lanrat/czds/actions/workflows/docker.yml)
A utility and golang library implementing a client to the [CZDS REST API](https://github.com/icann/czds-api-client-java/blob/master/docs/ICANN_CZDS_api.pdf)
using both the documented and undocumented API endpoints
Should allow you to perform almost any action you can in the web interface via [this API](https://pkg.go.dev/github.com/lanrat/czds)
## CZDS-DL
Implements a client for the officially documented [CZDS REST API](https://github.com/icann/czds-api-client-java/blob/master/docs/ICANN_CZDS_api.pdf)
### Download zone files from [czds.icann.org](https://czds.icann.org) in parallel
### Features
* Can be used as a standalone client or as an API for another client
* Automatically refreshes authorization token if expired during download
* Can save downloaded zones as named by `Content-Disposition` or URL name
* Can compare local and remote files size and modification time to skip redownloading unchanged zones
* Can download multiple zones in parallel
* [Docker](#docker) image available
### Usage
```console
Usage of czds-dl:
-exclude string
don't fetch these zones
-force
force redownloading the zone even if it already exists on local disk with same size and modification date
-out string
path to save downloaded zones to (default ".")
-parallel uint
number of zones to download in parallel (default 5)
-passin
password source (default: prompt on tty; other options: cmd:command, env:var, file:path, keychain:name, lpass:name, op:name)
-password string
password to authenticate with
-quiet
suppress progress printing
-redownload
redownload zones that are newer on the remote server than local copy
-retries uint
max retry attempts per zone file download (default 3)
-urlname
use the filename from the url link as the saved filename instead of the file header
-username string
username to authenticate with
-verbose
enable verbose logging
-version
print version and exit
-zone string
comma separated list of zones to download, defaults to all
```
### Example
```shell
$ ./czds-dl -out /zones -username "$USERNAME" -password "$PASSWORD" -verbose
2019/01/12 16:23:51 Authenticating to https://account-api.icann.org/api/authenticate
2019/01/12 16:23:52 'zones' does not exist, creating
2019/01/12 16:23:52 requesting download links
2019/01/12 16:23:54 received 5 zone links
2019/01/12 16:23:54 starting 5 parallel downloads
2019/01/12 16:23:54 downloading 'https://czds-api.icann.org/czds/downloads/example2.zone'
2019/01/12 16:23:54 downloading 'https://czds-api.icann.org/czds/downloads/example4.zone'
2019/01/12 16:23:54 downloading 'https://czds-api.icann.org/czds/downloads/example1.zone'
2019/01/12 16:23:54 downloading 'https://czds-api.icann.org/czds/downloads/example3.zone'
2019/01/12 16:23:54 downloading 'https://czds-api.icann.org/czds/downloads/example5.zone'
```
## CZDS-REQUEST
Submit a new zone request or modify an existing CZDS request. Be sure to view and accept the terms and conditions with the `-terms` flag.
### Usage
```text
Usage of czds-request:
-cancel string
comma separated list of zones to cancel outstanding requests for
-exclude string
comma separated list of zones to exclude from request-all or extend-all
-extend string
comma separated list of zones to request extensions
-extend-all
extend all possible zones
-passin
password source (default: prompt on tty; other options: cmd:command, env:var, file:path, keychain:name, lpass:name, op:name)
-password string
password to authenticate with
-reason string
reason to request zone access
-request string
comma separated list of zones to request
-request-all
request all available zones
-status
print status of zones
-terms
print CZDS Terms & Conditions
-username string
username to authenticate with
-verbose
enable verbose logging
-version
print version and exit
```
### Example
View zones able to be requested, prompting the user
interactively for their password:
```text
./czds-request -username "$USERNAME" -passin "tty" -status | grep -v pending | grep -v approved
Password:
```
Request access to new zones, reading the user's
password from the file `~/.czds.pass`:
```text
./czds-request -username "$USERNAME" -passin "file:~/.czds.pass" -request "red,blue,xyz" -reason "$REASON"
```
Request access to all zones:
```text
./czds-request -username "$USERNAME" -passin "tty" -request-all -reason "$REASON"
Password:
```
## CZDS-STATUS
View information about current zone file requests
### Usage
By default czds-requests prints high-level information about all czds requests, like the [reports page](https://czds.icann.org/zone-requests/all) on czds.
Detailed information about a particular zone can be displayed with the `-zone` or `-id` flag.
```text
-id string
ID of specific zone request to lookup, defaults to printing all
-passin
password source (default: prompt on tty; other options: cmd:command, env:var, file:path, keychain:name, lpass:name, op:name)
-password string
password to authenticate with
-report string
filename to save report CSV to, '-' for stdout
-username string
username to authenticate with
-verbose
enable verbose logging
-version
print version and exit
-zone string
same as -id, but prints the request by zone name
```
### Example
Show all requests:
```text
$ ./czds-status -username "$USERNAME" -password "$PASSWORD"
TLD ID UnicodeTLD Status Created Updated Expires SFTP
xn--mxtq1m e59839f1-d69d-4970-9a15-7b49f3592065 政府 Approved Wed Jan 30 08:00:42 2019 Wed Jan 30 08:53:41 2019 Sat Jan 12 08:53:41 2030 false
aigo c6886423-b67d-43b6-828f-9d5a6cb3e6a3 aigo Pending Wed Jan 30 08:00:41 2019 Wed Jan 30 08:01:38 2019 false
barclaycard fa6d9c14-17ac-4b15-baf6-2d10g8e806fe barclaycard Pending Wed Jan 30 08:00:41 2019 Wed Jan 30 08:01:38 2019 false
fans 977d8589-9cec-41ef-b62e-0d3f0cf863e0 fans Pending Wed Jan 30 08:00:41 2019 Wed Jan 30 08:01:38 2019 false
live 8c95ccae-ae4d-4028-8997-655b132f542d live Approved Wed Jan 30 08:00:41 2019 Wed Jan 30 16:40:15 2019 Sat Jan 12 16:40:13 2030 false
onyourside 259aa66b-ac77-43db-a09a-9d3f57cf0e6b onyourside Pending Wed Jan 30 08:00:41 2019 Wed Jan 30 08:02:16 2019 false
wtc 67f5b31d-19f0-4071-a176-25ff71f509f7 wtc Pending Wed Jan 30 08:00:41 2019 Wed Jan 30 08:02:55 2019 false
xn--d1acj3b 69929632-ed92-437a-b140-fff4b0d771a7 дети Approved Wed Jan 30 08:00:41 2019 Wed Jan 30 10:55:03 2019 Tue Apr 30 10:55:03 2019 false
```
Lookup specific request details:
```console
$ ./czds-status -username "$USERNAME" -password "$PASSWORD" -zone red
ID: a056b38d-0080-4097-95cb-014b35ed4cb7
TLD: red (red)
Status: approved
Created: Wed Jan 30 08:00:41 2019
Updated: Thu Jan 31 20:51:22 2019
Expires: Sun Jan 13 20:51:20 2030
Request IP: 123.456.789.123
FTP IPs: []
Reason: ...
History:
Wed Jan 30 08:00:41 2019 Request submitted
Wed Jan 30 08:02:16 2019 Request status change to Pending
Thu Jan 31 20:51:22 2019 Request status change to Approved
```
## Building
Just run make!
Building from source requires go >= 1.11 for module support
```console
make
```
## [Docker](https://hub.docker.com/r/lanrat/czds/)
```console
docker run --rm -v /path/to/zones/:/zones lanrat/czds czds-dl -out /zones -username "$USERNAME" -password "$PASSWORD"
```