certbot-pdns/certbot_pdns/pdnsapi.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-

import json

import requests


class PdnsApi:
    api_key = None
    base_url = None
    http_auth = None                                # Standard-value of requests-library will be used
    verify_cert = None                              # Standard-value of requests-library will be used

    def set_api_key(self, api_key):
        self.api_key = api_key

    def set_base_url(self, base_url):
        self.base_url = base_url

    def set_verify_cert(self, verify_cert):
        if verify_cert in ("True", "true"):         # convert from string to real bool
            self.verify_cert = True
        elif verify_cert in ("False", "false"):     # convert from string to real bool
            self.verify_cert = False
        elif isinstance(verify_cert, str):          # alternative: path to local cert is given as string
            self.verify_cert = verify_cert          # see requests-documentation for more info
        
    def set_http_auth(self, http_auth):             # credentials should be given as list containing two string-elements
        if len(http_auth) == 2:                     # first: username, second: password for http-basic auth
            self.http_auth = (str(http_auth[0]), str(http_auth[1]))     # ensure right format of credentials
        
    def _query(self, uri, method, kwargs=None):
        headers = {
            'X-API-Key': self.api_key,
            'Accept': 'application/json',
            'Content-Type': 'application/json'
        }

        data = json.dumps(kwargs)

        if method == "GET":
            request = requests.get(self.base_url + uri, headers=headers,
                                   auth=self.http_auth, verify=self.verify_cert)
        elif method == "POST":
            request = requests.post(self.base_url + uri, headers=headers, data=data,
                                    auth=self.http_auth, verify=self.verify_cert)
        elif method == "PUT":
            request = requests.put(self.base_url + uri, headers=headers, data=data,
                                   auth=self.http_auth, verify=self.verify_cert)
        elif method == "PATCH":
            request = requests.patch(self.base_url + uri, headers=headers, data=data,
                                     auth=self.http_auth, verify=self.verify_cert)
        elif method == "DELETE":
            request = requests.delete(self.base_url + uri, headers=headers,
                                      auth=self.http_auth, verify=self.verify_cert)
        else:
            raise ValueError("Invalid method '%s'" % method)

        return None if request.status_code == 204 else request.json()

    def list_zones(self):
        return self._query("/servers/localhost/zones", "GET")

    def get_zone(self, zone_name):
        return self._query("/servers/localhost/zones/%s" % zone_name, "GET")

    def update_zone(self, zone_name, data):
        return self._query("/servers/localhost/zones/%s" % zone_name, "PUT", data)

    def replace_record(self, zone_name, name, type, ttl, content, disabled, set_ptr):
        return self._query("/servers/localhost/zones/%s" % zone_name, "PATCH", {"rrsets": [
            {
                "name": name,
                "type": type,
                "ttl": ttl,
                "changetype": "REPLACE",
                "records": [
                    {
                        "content": content,
                        "disabled": disabled,
                        "set-prt": set_ptr
                    }
                ]
            }
        ]})

    def delete_record(self, zone_name, name, type, ttl, content, disabled, set_ptr):
        return self._query("/servers/localhost/zones/%s" % zone_name, "PATCH", {"rrsets": [
            {
                "name": name,
                "type": type,
                "ttl": ttl,
                "changetype": "DELETE",
                "records": [
                    {
                        "content": content,
                        "disabled": disabled,
                        "set-prt": set_ptr
                    }
                ]
            }
        ]})

    def notify_zone(self, zone_name):
        return self._query("/servers/localhost/zones/%s/notify" % zone_name, "PUT")

    def flush_zone_cache(self, zone_name):
        return self._query("/servers/localhost/cache/flush?domain=%s" % zone_name, "PUT")