From 075d038226c5717bf17f6838c576cfe66abb0c9a Mon Sep 17 00:00:00 2001 From: Dongmei Cao Date: Thu, 6 Dec 2018 18:07:17 -0800 Subject: [PATCH] Initial version --- .gitignore | 11 ++ LICENSE | 28 ++++++ NOTICE | 235 +++++++++++++++++++++++++++++++++++++++++++ README.md | 36 ++++++- config.sample.json | 7 ++ do_authentication.py | 36 +++++++ do_http_get.py | 11 ++ download.py | 152 ++++++++++++++++++++++++++++ 8 files changed, 514 insertions(+), 2 deletions(-) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 NOTICE create mode 100644 config.sample.json create mode 100644 do_authentication.py create mode 100644 do_http_get.py create mode 100644 download.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9663e58 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +.DS_Store +.idea/** +.idea/ +*.iml + +config.json + +zonefiles/ +zonefiles/** + +__* diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ae168cb --- /dev/null +++ b/LICENSE @@ -0,0 +1,28 @@ +Copyright (c) 2018 Internet Corporation for Assigned Names and +Numbers (ICANN). All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + + * Neither the name of the ICANN nor the names of its contributors + may be used to endorse or promote products derived from this + software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY ICANN AND CONTRIBUTORS ``AS IS'' AND ANY +EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ICANN OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF +THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..446926f --- /dev/null +++ b/NOTICE @@ -0,0 +1,235 @@ +This project uses the following third party software: + +--------------------------------------------------------------- + +Apache HttpComponents Client +Copyright 1999-2018 The Apache Software Foundation + +This product includes software developed at +The Apache Software Foundation (http://www.apache.org/). + +Licensed under the Apache License 2.0. + +--------------------------------------------------------------- + +Jackson JSON processor + +Jackson is a high-performance, Free/Open Source JSON processing library. +It was originally written by Tatu Saloranta (tatu.saloranta@iki.fi), and has +been in development since 2007. +It is currently developed by a community of developers, as well as supported +commercially by FasterXML.com. + +Licensed under the Apache License 2.0. + +--------------------------------------------------------------- + +TestNG + +This project includes software developed by Cedric Beust (http://www.testng.org). + +Licensed under the Apache License 2.0. + +--------------------------------------------------------------- + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 31a1ade..01170ab 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ -# czds-api-client-python -A python reference implementation for czds download zone file api +CZDS API Client in Python +=========== + +This repository provides a Python example of how to download zone files via CZDS (Centralized Zone Data Service) REST API. +A detail API Specs can be found [here.](https://github.com/icann/czds-api-client/tree/master/docs) + +There is also an example provided in Java. It can be found in [this repo.](https://github.com/icann/czds-api-client) + +Installation +------------ + +This script requires Python 3. It has been tested with Python 3.7.1. + +It requires the `requests` extension library. Please checkout here to see how to install it - https://github.com/requests/requests + +Run +--------------------- + +1. Make a copy of the `config.sample.json` file and name it `config.json` +2. Edit `config.json` and fill in your information. +2. Run `python download.py` + +All the zone files will be saved in `working-directory`/zonefiles, `working-directory` is specified in `config.json`, +or default to current directory if not specified in `config.json` + +Documentation +------------- + +* CZDS REST API Specs - https://github.com/icann/czds-api-client/blob/master/docs/ICANN_CZDS_api.pdf + +Contributing +------------ + +Contributions are welcome. diff --git a/config.sample.json b/config.sample.json new file mode 100644 index 0000000..707f6db --- /dev/null +++ b/config.sample.json @@ -0,0 +1,7 @@ +{ + "icann.account.username": "username@example.com", + "icann.account.password": "Abcdef#12345678", + "authentication.base.url": "https://account-api-test.icann.org", + "czds.base.url": "https://czds-api-test.icann.org", + "working.directory": "/where/zonefiles/will/be/saved" +} diff --git a/do_authentication.py b/do_authentication.py new file mode 100644 index 0000000..f3c15b1 --- /dev/null +++ b/do_authentication.py @@ -0,0 +1,36 @@ +import json +import requests +import sys +import datetime + +def authenticate(username, password, authen_base_url): + authen_headers = {'Content-Type': 'application/json', + 'Accept': 'application/json'} + + credential = {'username': username, + 'password': password} + + authen_url = authen_base_url + '/api/authenticate' + + response = requests.post(authen_url, data=json.dumps(credential), headers=authen_headers) + + status_code = response.status_code + + # Return the access_token on status code 200. Otherwise, terminate the program. + if status_code == 200: + access_token = response.json()['accessToken'] + print('{0}: Received access_token:'.format(datetime.datetime.now())) + print(access_token) + return access_token + elif status_code == 404: + sys.stderr.write("Invalid url " + authen_url) + exit(1) + elif status_code == 401: + sys.stderr.write("Invalid username/password. Please reset your password via web") + exit(1) + elif status_code == 500: + sys.stderr.write("Internal server error. Please try again later") + exit(1) + else: + sys.stderr.write("Failed to authenticate user {0} with error code {1}".format(username, status_code)) + exit(1) diff --git a/do_http_get.py b/do_http_get.py new file mode 100644 index 0000000..97613fa --- /dev/null +++ b/do_http_get.py @@ -0,0 +1,11 @@ +import requests + +def do_get(url, access_token): + + bearer_headers = {'Content-Type': 'application/json', + 'Accept': 'application/json', + 'Authorization': 'Bearer {0}'.format(access_token)} + + response = requests.get(url, params=None, headers=bearer_headers) + + return response diff --git a/download.py b/download.py new file mode 100644 index 0000000..d7368af --- /dev/null +++ b/download.py @@ -0,0 +1,152 @@ +import json +import sys +import cgi +import os +import datetime + +from do_authentication import authenticate +from do_http_get import do_get + +############################################################################################################## +# First Step: Get the config data from config.json file +############################################################################################################## + +try: + config_file = open("config.json", "r") + config = json.load(config_file) + config_file.close() +except: + sys.stderr.write("Error loading config.json file.\n") + exit(1) + +# The config.json file must contain the following data: +username = config['icann.account.username'] +password = config['icann.account.password'] +authen_base_url = config['authentication.base.url'] +czds_base_url = config['czds.base.url'] + +# This is optional. Default to current directory +working_directory = config['working.directory'] + +if not username: + sys.stderr.write("'icann.account.username' parameter not found in the config.json file\n") + exit(1) + +if not password: + sys.stderr.write("'icann.account.password' parameter not found in the config.json file\n") + exit(1) + +if not authen_base_url: + sys.stderr.write("'authentication.base.url' parameter not found in the config.json file\n") + exit(1) + +if not czds_base_url: + sys.stderr.write("'czds.base.url' parameter not found in the config.json file\n") + exit(1) + +if not working_directory: + # Default to current directory + working_directory = '.' + + + +############################################################################################################## +# Second Step: authenticate the user to get an access_token. +# Note that the access_token is global for all the REST API calls afterwards +############################################################################################################## + +print("Authenticate user {0}".format(username)) +access_token = authenticate(username, password, authen_base_url) + + + +############################################################################################################## +# Third Step: Get the download zone file links +############################################################################################################## + +# Function definition for listing the zone links +def get_zone_links(czds_base_url): + global access_token + + links_url = czds_base_url + "/czds/downloads/links" + links_response = do_get(links_url, access_token) + + status_code = links_response.status_code + + if status_code == 200: + zone_links = links_response.json() + print("{0}: The number of zone files to be downloaded is {1}".format(datetime.datetime.now(),len(zone_links))) + return zone_links + elif status_code == 401: + print("The access_token has been expired. Re-authenticate user {0}".format(username)) + access_token = authenticate(username, password, authen_base_url) + get_zone_links(czds_base_url) + else: + sys.stderr.write("Failed to get zone links from {0} with error code {1}\n".format(links_url, status_code)) + return None + + +# Get the zone links +zone_links = get_zone_links(czds_base_url) +if not zone_links: + exit(1) + + + +############################################################################################################## +# Fourth Step: download zone files +############################################################################################################## + +# Function definition to download one zone file +def download_one_zone(url, output_directory): + print("{0}: Downloading zone file from {1}".format(str(datetime.datetime.now()), url)) + + global access_token + download_zone_response = do_get(url, access_token) + + status_code = download_zone_response.status_code + + if status_code == 200: + # Try to get the filename from the header + _,option = cgi.parse_header(download_zone_response.headers['content-disposition']) + filename = option['filename'] + + # If could get a filename from the header, then makeup one like [tld].txt.gz + if not filename: + filename = url.rsplit('/', 1)[-1].rsplit('.')[-2] + '.txt.gz' + + # This is where the zone file will be saved + path = '{0}/{1}'.format(output_directory, filename) + + with open(path, 'wb') as f: + for chunk in download_zone_response.iter_content(1024): + f.write(chunk) + + print("{0}: Completed downloading zone to file {1}".format(str(datetime.datetime.now()), path)) + + elif status_code == 401: + print("The access_token has been expired. Re-authenticate user {0}".format(username)) + access_token = authenticate(username, password, authen_base_url) + download_one_zone(url, output_directory) + elif status_code == 404: + print("No zone file found for {0}".format(url)) + else: + sys.stderr.write('Failed to download zone from {0} with code {1}\n'.format(url, status_code)) + +# Function definition for downloading all the zone files +def download_zone_files(urls, working_directory): + + # The zone files will be saved in a sub-directory + output_directory = working_directory + "/zonefiles" + + if not os.path.exists(output_directory): + os.makedirs(output_directory) + + # Download the zone files one by one + for link in urls: + download_one_zone(link, output_directory) + +# Finally, download all zone files +download_zone_files(zone_links, working_directory) + +print("{0}: DONE DONE. Completed downloading all zone files".format(str(datetime.datetime.now())))