fourkitchens / czdap-tools Goto Github PK

Tools for downloading zone data and authentication credentials from ICANN's CZDS application.

License: MIT License

Python 100.00%

czdap-tools's Introduction

CZDAP Tools

Some registries allow users to download zone data directly from CZDAP, and others provide FTP credentials that you can use to login to their servers. These tools allow you to programatically perform these two tasks:

Decrypt FTP credentials downloaded from ICANN's CZDAP application.
Download zone data directly using the CZDAP API.

Installation

This script requires Python 2.x plus the pycrypto and requests extension libraries.

Mac OSX

Tested on Snow Leopard and Mountain Lion

OSX comes with Python preinstalled. To install the required extensions, issue the following commands:

sudo easy_install pip
sudo pip install --upgrade pycrypto requests

Linux

Tested on Ubuntu 13.04 Raring Ringtail

sudo apt-get install python-crypto python-requests

Windows

Tested on Windows 7

Download and configure the Python environment:

Download Python version 2.7.x from the main download page.
Run the installer and follow the installation instructions.

Install pycrypto and requests:

Pycrypto: pre-built binary
Requests: pre-built binary

Decrypting credentials

To confirm that you've installed the dependencies correctly, simply run the test and it should process the example data successfully:

cd credentials-decrypt/test
python test-decrypt.py

You should get the following sample output in basic CSV format:

server,username,password
ftp.download.com,com_ftp_access,specialpassword__22
ftp.download.biz,sally,password12345$
ftp.download.net,net_access,secretpassword456

To decrypt your own FTP credentials:

Visit CZDAP and copy your token. You can find it on your user profile page, under the tab "API".
In the /credentials-decrypt directory, make a copy of the config.sample.json file and name it config.json.
Edit config.json and overwrite the "token" parameter with the your unique token.
Copy your private key into this directory and make sure it's named czdap.private.key.
Run python decrypt.py.

Downloading zone data

Visit CZDAP and copy your token. You can find it on your user profile page.
In the /zonedata-download directory, make a copy of the config.sample.json file and name it config.json.
Edit config.json and overwrite the "token" parameter with the your unique token.
Run python download.py

Contributing

Contributions are welcome.

czdap-tools's People

Contributors

Stargazers

Watchers

czdap-tools's Issues

Does not work on CentOS

I did yum install python-crypto python-requests. Python-crypto installed but python-requests said No Package found.

Then when running pythong test-decrypt.py I get:
Traceback (most recent call last):
File "test-decrypt.py", line 5, in
from Crypto.Cipher import PKCS1_v1_5
ImportError: cannot import name PKCS1_v1_5

Please advise how to run this on CentOS. Thanks.

error running test-decrypt.py

cd credentials-decrypt/test
ubuntu@x:/opt/czdap-tools/credentials-decrypt/test$ python test-decrypt.py
Traceback (most recent call last):
  File "test-decrypt.py", line 5, in <module>
    from Crypto.Cipher import PKCS1_v1_5
ImportError: cannot import name PKCS1_v1_5

download.py not working

ubuntu 12.04 LTS

I install the requirements

sudo apt-get install python-crypto python-requests

then I copy the config and replace xxxx.... with my api key

then

python download.py

Unable to parse JSON returned from CZDAP

Thoughts?
Eddie

Issue with decrypt.py

Test is working fine. Able to download zonefiles but unable to decrypt. I am getting output as below

server,username,password

But no host, user, pass in it. I think credentials.json gets generated through decrypt.py as I dont have in the file.

Please solve this issue & correct me if I am wrong.

CZDS API changing

I got this in an email from ICANN earlier this month.

"If you currently use the CZDS API to programmatically download zone files, please be aware that the API is changing with the introduction of the new CZDS portal. The updated CZDS API specification will be available shortly, and ICANN will provide an opportunity for you to test the new CZDS API implementation by making a test bed available starting 10 December 2018. The test bed will operate until the CZDS update goes live in January 2019."

Anyone have plans to update this set of tools to work with the changed API?

Too much memory used

Hey!
Update the download.py file to use less memory:

r = s.get(config['base_url'] + url, stream = True)

Setting stream = True makes it not allocate that much memory. Since we iterate it on 1024b blocks it's not necessary.

Filenames are numbers rather than date-zonename-zone-data.txt.gz?

The file names seem to be just numbers (eg 123.txt.gz) rather than zone names with dates. Is this just the way they are stored on the server (rather than the YYYYMMDD-zname-zone-data.txt.gz from manual downloads)?

Failed to establish a new connection: [Errno 11002]

I have successfully run "python download.py" and a number of files have been downloaded. But after a while I get the below error:

Error occoured: HTTPSConnectionPool(host='czds.icann.org', port=443): Max retries exceeded with url: /en/download-zone-data/3659?token=XXXXXXXXXXXXXXX (Caused by NewConnectionError('<urllib3.connection.VerifiedHTTPSConnection object at 0x030300F0>: Failed to establish a new connection: [Errno 11002] getaddrinfo failed',))

(I have replaced the actual token in the error message with XXXXXXXX)

When I rerun the script, it seems to run for some time and then again the same error. This is on Windows 10, using Python 2.7

Any ideas?

Missing tld/id in user-credentials.json output

As the first registries released their user credentials in key crypted form, there is something very important missing - the tld where this credentials should be used.

$ ./decrypt.py
server,username,password
******.CN,c*******,***********
******.CN,c*******,***********

Could you please extend the API to return the id or the tld?

credentials-decrypt/test does not exits

Where should this directory exits? I seem not to have such a directory although I have python-crypto python-requests libraries.

Error: Decryption failed, do you have the correct keyfile?

My token and the key file is correct but I could not decrypt my credentials.

The test is ok. I can see the test cred from the test directory.

Is there anything I can check for it?