Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/certbot/certbot.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZach Shepherd <zjs@users.noreply.github.com>2017-05-17 21:26:26 +0300
committerBrad Warren <bmw@users.noreply.github.com>2017-05-17 21:26:26 +0300
commit4caff11371fe58a6211488affe29d61da9c80cac (patch)
tree89b61eba21d539648dd856759c73dca50825152e /certbot-dns-google
parente4f65074d1219f49030e3a88cf080cb4daf28ad0 (diff)
Google Cloud DNS Authenticator (#4581)
Implement an Authenticator which can fulfill a dns-01 challenge using the Google Cloud DNS API. Applicable only for domains using Google Cloud DNS for DNS. Testing Done: * `tox -e py27` * `tox -e lint` * Manual testing: * Used `certbot certonly --dns-google -d`, specifying a credentials file as a command line argument. Verified that a certificate was successfully obtained without user interaction. * Used `certbot certonly --dns-google -d`, without specifying a credentials file as a command line argument. Verified that the user was prompted and that a certificate was successfully obtained. * Used `certbot certonly -d`. Verified that the user was prompted for a credentials file after selecting google interactively and that a certificate was successfully obtained. * Used `certbot renew --force-renewal`. Verified that certificates were renewed without user interaction. * Negative testing: * Path to non-existent credentials file. * Credentials file with unsafe permissions (644). * Domain name not registered to Google Cloud Platform account.
Diffstat (limited to 'certbot-dns-google')
-rw-r--r--certbot-dns-google/LICENSE.txt190
-rw-r--r--certbot-dns-google/MANIFEST.in3
-rw-r--r--certbot-dns-google/README.rst1
-rw-r--r--certbot-dns-google/certbot_dns_google/__init__.py1
-rw-r--r--certbot-dns-google/certbot_dns_google/dns_google.py184
-rw-r--r--certbot-dns-google/certbot_dns_google/dns_google_test.py202
-rw-r--r--certbot-dns-google/docs/.gitignore1
-rw-r--r--certbot-dns-google/docs/Makefile20
-rw-r--r--certbot-dns-google/docs/api.rst8
-rw-r--r--certbot-dns-google/docs/api/dns_google.rst5
-rw-r--r--certbot-dns-google/docs/conf.py180
-rw-r--r--certbot-dns-google/docs/index.rst28
-rw-r--r--certbot-dns-google/docs/make.bat36
-rw-r--r--certbot-dns-google/setup.cfg2
-rw-r--r--certbot-dns-google/setup.py70
15 files changed, 931 insertions, 0 deletions
diff --git a/certbot-dns-google/LICENSE.txt b/certbot-dns-google/LICENSE.txt
new file mode 100644
index 000000000..981c46c9f
--- /dev/null
+++ b/certbot-dns-google/LICENSE.txt
@@ -0,0 +1,190 @@
+ Copyright 2015 Electronic Frontier Foundation and others
+
+ 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.
+
+ 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
diff --git a/certbot-dns-google/MANIFEST.in b/certbot-dns-google/MANIFEST.in
new file mode 100644
index 000000000..18f018c08
--- /dev/null
+++ b/certbot-dns-google/MANIFEST.in
@@ -0,0 +1,3 @@
+include LICENSE.txt
+include README.rst
+recursive-include docs *
diff --git a/certbot-dns-google/README.rst b/certbot-dns-google/README.rst
new file mode 100644
index 000000000..37586abbf
--- /dev/null
+++ b/certbot-dns-google/README.rst
@@ -0,0 +1 @@
+Google Cloud DNS Authenticator plugin for Certbot
diff --git a/certbot-dns-google/certbot_dns_google/__init__.py b/certbot-dns-google/certbot_dns_google/__init__.py
new file mode 100644
index 000000000..9e9096d83
--- /dev/null
+++ b/certbot-dns-google/certbot_dns_google/__init__.py
@@ -0,0 +1 @@
+"""Google Cloud DNS Authenticator"""
diff --git a/certbot-dns-google/certbot_dns_google/dns_google.py b/certbot-dns-google/certbot_dns_google/dns_google.py
new file mode 100644
index 000000000..3f7a8d9f2
--- /dev/null
+++ b/certbot-dns-google/certbot_dns_google/dns_google.py
@@ -0,0 +1,184 @@
+"""DNS Authenticator for Google Cloud DNS."""
+import json
+import logging
+
+import zope.interface
+from googleapiclient import discovery
+from googleapiclient import errors as googleapiclient_errors
+from oauth2client.service_account import ServiceAccountCredentials
+
+from certbot import errors
+from certbot import interfaces
+from certbot.plugins import dns_common
+
+logger = logging.getLogger(__name__)
+
+ACCT_URL = 'https://developers.google.com/identity/protocols/OAuth2ServiceAccount#creatinganaccount'
+PERMISSIONS_URL = 'https://cloud.google.com/dns/access-control#permissions_and_roles'
+
+
+@zope.interface.implementer(interfaces.IAuthenticator)
+@zope.interface.provider(interfaces.IPluginFactory)
+class Authenticator(dns_common.DNSAuthenticator):
+ """DNS Authenticator for Google Cloud DNS
+
+ This Authenticator uses the Google Cloud DNS API to fulfill a dns-01 challenge.
+ """
+
+ description = 'Obtain certs using a DNS TXT record (if you are using Google Cloud DNS for DNS).'
+ ttl = 60
+
+ def __init__(self, *args, **kwargs):
+ super(Authenticator, self).__init__(*args, **kwargs)
+ self.credentials = None
+
+ @classmethod
+ def add_parser_arguments(cls, add): # pylint: disable=arguments-differ
+ super(Authenticator, cls).add_parser_arguments(add, default_propagation_seconds=60)
+ add('credentials',
+ help=('Path to Google Cloud DNS service account JSON file. (See {0} for' +
+ 'information about creating a service account and {1} for information about the' +
+ 'required permissions.)').format(ACCT_URL, PERMISSIONS_URL))
+
+ def more_info(self): # pylint: disable=missing-docstring,no-self-use
+ return 'This plugin configures a DNS TXT record to respond to a dns-01 challenge using ' + \
+ 'the Google Cloud DNS API.'
+
+ def _setup_credentials(self):
+ self._configure_file('credentials', 'path to Google Cloud DNS service account JSON file')
+
+ dns_common.validate_file_permissions(self.conf('credentials'))
+
+ def _perform(self, domain, validation_name, validation):
+ self._get_google_client().add_txt_record(domain, validation_name, validation, self.ttl)
+
+ def _cleanup(self, domain, validation_name, validation):
+ self._get_google_client().del_txt_record(domain, validation_name, validation, self.ttl)
+
+ def _get_google_client(self):
+ return _GoogleClient(self.conf('credentials'))
+
+
+class _GoogleClient(object):
+ """
+ Encapsulates all communication with the Google Cloud DNS API.
+ """
+
+ def __init__(self, account_json):
+
+ scopes = ['https://www.googleapis.com/auth/ndev.clouddns.readwrite']
+ credentials = ServiceAccountCredentials.from_json_keyfile_name(account_json, scopes)
+ self.dns = discovery.build('dns', 'v1', credentials=credentials, cache_discovery=False)
+ with open(account_json) as account:
+ self.project_id = json.load(account)['project_id']
+
+ def add_txt_record(self, domain, record_name, record_content, record_ttl):
+ """
+ Add a TXT record using the supplied information.
+
+ :param str domain: The domain to use to look up the managed zone.
+ :param str record_name: The record name (typically beginning with '_acme-challenge.').
+ :param str record_content: The record content (typically the challenge validation).
+ :param int record_ttl: The record TTL (number of seconds that the record may be cached).
+ :raises certbot.errors.PluginError: if an error occurs communicating with the Google API
+ """
+
+ zone_id = self._find_managed_zone_id(domain)
+
+ data = {
+ "kind": "dns#change",
+ "additions": [
+ {
+ "kind": "dns#resourceRecordSet",
+ "type": "TXT",
+ "name": record_name + ".",
+ "rrdatas": [record_content, ],
+ "ttl": record_ttl,
+ },
+ ],
+ }
+
+ changes = self.dns.changes() # changes | pylint: disable=no-member
+
+ try:
+ request = changes.create(project=self.project_id, managedZone=zone_id, body=data)
+ response = request.execute()
+
+ status = response['status']
+ change = response['id']
+ while status == 'pending':
+ request = changes.get(project=self.project_id, managedZone=zone_id, changeId=change)
+ response = request.execute()
+ status = response['status']
+ except googleapiclient_errors.Error as e:
+ logger.error('Encountered error adding TXT record: %s', e)
+ raise errors.PluginError('Error communicating with the Google Cloud DNS API: {0}'
+ .format(e))
+
+ def del_txt_record(self, domain, record_name, record_content, record_ttl):
+ """
+ Delete a TXT record using the supplied information.
+
+ :param str domain: The domain to use to look up the managed zone.
+ :param str record_name: The record name (typically beginning with '_acme-challenge.').
+ :param str record_content: The record content (typically the challenge validation).
+ :param int record_ttl: The record TTL (number of seconds that the record may be cached).
+ :raises certbot.errors.PluginError: if an error occurs communicating with the Google API
+ """
+
+ try:
+ zone_id = self._find_managed_zone_id(domain)
+ except errors.PluginError as e:
+ logger.warn('Error finding zone. Skipping cleanup.')
+ return
+
+ data = {
+ "kind": "dns#change",
+ "deletions": [
+ {
+ "kind": "dns#resourceRecordSet",
+ "type": "TXT",
+ "name": record_name + ".",
+ "rrdatas": [record_content, ],
+ "ttl": record_ttl,
+ },
+ ],
+ }
+
+ changes = self.dns.changes() # changes | pylint: disable=no-member
+
+ try:
+ request = changes.create(project=self.project_id, managedZone=zone_id, body=data)
+ request.execute()
+ except googleapiclient_errors.Error as e:
+ logger.warn('Encountered error deleting TXT record: %s', e)
+
+ def _find_managed_zone_id(self, domain):
+ """
+ Find the managed zone for a given domain.
+
+ :param str domain: The domain for which to find the managed zone.
+ :returns: The ID of the managed zone, if found.
+ :rtype: str
+ :raises certbot.errors.PluginError: if the managed zone cannot be found.
+ """
+
+ zone_dns_name_guesses = dns_common.base_domain_name_guesses(domain)
+
+ mz = self.dns.managedZones() # managedZones | pylint: disable=no-member
+ for zone_name in zone_dns_name_guesses:
+ try:
+ request = mz.list(project=self.project_id, dnsName=zone_name + '.')
+ response = request.execute()
+ zones = response['managedZones']
+ except googleapiclient_errors.Error as e:
+ raise errors.PluginError('Encountered error finding managed zone: {0}'
+ .format(e))
+
+ if len(zones) > 0:
+ zone_id = zones[0]['id']
+ logger.debug('Found id of %s for %s using name %s', zone_id, domain, zone_name)
+ return zone_id
+
+ raise errors.PluginError('Unable to determine managed zone for {0} using zone names: {1}.'
+ .format(domain, zone_dns_name_guesses))
diff --git a/certbot-dns-google/certbot_dns_google/dns_google_test.py b/certbot-dns-google/certbot_dns_google/dns_google_test.py
new file mode 100644
index 000000000..eb41fa4ee
--- /dev/null
+++ b/certbot-dns-google/certbot_dns_google/dns_google_test.py
@@ -0,0 +1,202 @@
+"""Tests for certbot_dns_google.dns_google."""
+
+import os
+import unittest
+
+import mock
+from googleapiclient.errors import Error
+
+from certbot import errors
+from certbot.plugins import dns_test_common
+from certbot.plugins.dns_test_common import DOMAIN
+from certbot.tests import util as test_util
+
+ACCOUNT_JSON_PATH = '/not/a/real/path.json'
+API_ERROR = Error()
+PROJECT_ID = "test-test-1"
+
+
+class AuthenticatorTest(test_util.TempDirTestCase, dns_test_common.BaseAuthenticatorTest):
+
+ def setUp(self):
+ super(AuthenticatorTest, self).setUp()
+
+ from certbot_dns_google.dns_google import Authenticator
+
+ path = os.path.join(self.tempdir, 'file.json')
+ open(path, "wb").close()
+
+ super(AuthenticatorTest, self).setUp()
+ self.config = mock.MagicMock(google_credentials=path,
+ google_propagation_seconds=0) # don't wait during tests
+
+ self.auth = Authenticator(self.config, "google")
+
+ self.mock_client = mock.MagicMock()
+ # _get_google_client | pylint: disable=protected-access
+ self.auth._get_google_client = mock.MagicMock(return_value=self.mock_client)
+
+ def test_perform(self):
+ self.auth.perform([self.achall])
+
+ expected = [mock.call.add_txt_record(DOMAIN, '_acme-challenge.'+DOMAIN, mock.ANY, mock.ANY)]
+ self.assertEqual(expected, self.mock_client.mock_calls)
+
+ def test_cleanup(self):
+ # _attempt_cleanup | pylint: disable=protected-access
+ self.auth._attempt_cleanup = True
+ self.auth.cleanup([self.achall])
+
+ expected = [mock.call.del_txt_record(DOMAIN, '_acme-challenge.'+DOMAIN, mock.ANY, mock.ANY)]
+ self.assertEqual(expected, self.mock_client.mock_calls)
+
+
+class GoogleClientTest(unittest.TestCase):
+ record_name = "foo"
+ record_content = "bar"
+ record_ttl = 42
+ zone = "ZONE_ID"
+ change = "an-id"
+
+ def _setUp_client_with_mock(self, zone_request_side_effect):
+ from certbot_dns_google.dns_google import _GoogleClient
+
+ client = _GoogleClient(ACCOUNT_JSON_PATH)
+
+ # Setup
+ mock_mz = mock.MagicMock()
+ mock_mz.list.return_value.execute.side_effect = zone_request_side_effect
+
+ mock_changes = mock.MagicMock()
+
+ client.dns.managedZones = mock.MagicMock(return_value=mock_mz)
+ client.dns.changes = mock.MagicMock(return_value=mock_changes)
+
+ return client, mock_changes
+
+ @mock.patch('oauth2client.service_account.ServiceAccountCredentials.from_json_keyfile_name')
+ @mock.patch('certbot_dns_google.dns_google.open',
+ mock.mock_open(read_data='{"project_id": "' + PROJECT_ID + '"}'))
+ def test_add_txt_record(self, unused_credential_mock):
+ client, changes = self._setUp_client_with_mock([{'managedZones': [{'id': self.zone}]}])
+
+ client.add_txt_record(DOMAIN, self.record_name, self.record_content, self.record_ttl)
+
+ expected_body = {
+ "kind": "dns#change",
+ "additions": [
+ {
+ "kind": "dns#resourceRecordSet",
+ "type": "TXT",
+ "name": self.record_name + ".",
+ "rrdatas": [self.record_content, ],
+ "ttl": self.record_ttl,
+ },
+ ],
+ }
+
+ changes.create.assert_called_with(body=expected_body,
+ managedZone=self.zone,
+ project=PROJECT_ID)
+
+ @mock.patch('oauth2client.service_account.ServiceAccountCredentials.from_json_keyfile_name')
+ @mock.patch('certbot_dns_google.dns_google.open',
+ mock.mock_open(read_data='{"project_id": "' + PROJECT_ID + '"}'))
+ def test_add_txt_record_and_poll(self, unused_credential_mock):
+ client, changes = self._setUp_client_with_mock([{'managedZones': [{'id': self.zone}]}])
+ changes.create.return_value.execute.return_value = {'status': 'pending', 'id': self.change}
+ changes.get.return_value.execute.return_value = {'status': 'done'}
+
+ client.add_txt_record(DOMAIN, self.record_name, self.record_content, self.record_ttl)
+
+ changes.create.assert_called_with(body=mock.ANY,
+ managedZone=self.zone,
+ project=PROJECT_ID)
+
+ changes.get.assert_called_with(changeId=self.change,
+ managedZone=self.zone,
+ project=PROJECT_ID)
+
+ @mock.patch('oauth2client.service_account.ServiceAccountCredentials.from_json_keyfile_name')
+ @mock.patch('certbot_dns_google.dns_google.open',
+ mock.mock_open(read_data='{"project_id": "' + PROJECT_ID + '"}'))
+ def test_add_txt_record_error_during_zone_lookup(self, unused_credential_mock):
+ client, unused_changes = self._setUp_client_with_mock(API_ERROR)
+
+ self.assertRaises(errors.PluginError, client.add_txt_record,
+ DOMAIN, self.record_name, self.record_content, self.record_ttl)
+
+ @mock.patch('oauth2client.service_account.ServiceAccountCredentials.from_json_keyfile_name')
+ @mock.patch('certbot_dns_google.dns_google.open',
+ mock.mock_open(read_data='{"project_id": "' + PROJECT_ID + '"}'))
+ def test_add_txt_record_zone_not_found(self, unused_credential_mock):
+ client, unused_changes = self._setUp_client_with_mock([{'managedZones': []},
+ {'managedZones': []}])
+
+ self.assertRaises(errors.PluginError, client.add_txt_record,
+ DOMAIN, self.record_name, self.record_content, self.record_ttl)
+
+ @mock.patch('oauth2client.service_account.ServiceAccountCredentials.from_json_keyfile_name')
+ @mock.patch('certbot_dns_google.dns_google.open',
+ mock.mock_open(read_data='{"project_id": "' + PROJECT_ID + '"}'))
+ def test_add_txt_record_error_during_add(self, unused_credential_mock):
+ client, changes = self._setUp_client_with_mock([{'managedZones': [{'id': self.zone}]}])
+ changes.create.side_effect = API_ERROR
+
+ self.assertRaises(errors.PluginError, client.add_txt_record,
+ DOMAIN, self.record_name, self.record_content, self.record_ttl)
+
+ @mock.patch('oauth2client.service_account.ServiceAccountCredentials.from_json_keyfile_name')
+ @mock.patch('certbot_dns_google.dns_google.open',
+ mock.mock_open(read_data='{"project_id": "' + PROJECT_ID + '"}'))
+ def test_del_txt_record(self, unused_credential_mock):
+ client, changes = self._setUp_client_with_mock([{'managedZones': [{'id': self.zone}]}])
+
+ client.del_txt_record(DOMAIN, self.record_name, self.record_content, self.record_ttl)
+
+ expected_body = {
+ "kind": "dns#change",
+ "deletions": [
+ {
+ "kind": "dns#resourceRecordSet",
+ "type": "TXT",
+ "name": self.record_name + ".",
+ "rrdatas": [self.record_content, ],
+ "ttl": self.record_ttl,
+ },
+ ],
+ }
+
+ changes.create.assert_called_with(body=expected_body,
+ managedZone=self.zone,
+ project=PROJECT_ID)
+
+ @mock.patch('oauth2client.service_account.ServiceAccountCredentials.from_json_keyfile_name')
+ @mock.patch('certbot_dns_google.dns_google.open',
+ mock.mock_open(read_data='{"project_id": "' + PROJECT_ID + '"}'))
+ def test_del_txt_record_error_during_zone_lookup(self, unused_credential_mock):
+ client, unused_changes = self._setUp_client_with_mock(API_ERROR)
+
+ client.del_txt_record(DOMAIN, self.record_name, self.record_content, self.record_ttl)
+
+ @mock.patch('oauth2client.service_account.ServiceAccountCredentials.from_json_keyfile_name')
+ @mock.patch('certbot_dns_google.dns_google.open',
+ mock.mock_open(read_data='{"project_id": "' + PROJECT_ID + '"}'))
+ def test_del_txt_record_zone_not_found(self, unused_credential_mock):
+ client, unused_changes = self._setUp_client_with_mock([{'managedZones': []},
+ {'managedZones': []}])
+
+ client.del_txt_record(DOMAIN, self.record_name, self.record_content, self.record_ttl)
+
+ @mock.patch('oauth2client.service_account.ServiceAccountCredentials.from_json_keyfile_name')
+ @mock.patch('certbot_dns_google.dns_google.open',
+ mock.mock_open(read_data='{"project_id": "' + PROJECT_ID + '"}'))
+ def test_del_txt_record_error_during_delete(self, unused_credential_mock):
+ client, changes = self._setUp_client_with_mock([{'managedZones': [{'id': self.zone}]}])
+ changes.create.side_effect = API_ERROR
+
+ client.del_txt_record(DOMAIN, self.record_name, self.record_content, self.record_ttl)
+
+
+if __name__ == "__main__":
+ unittest.main() # pragma: no cover
diff --git a/certbot-dns-google/docs/.gitignore b/certbot-dns-google/docs/.gitignore
new file mode 100644
index 000000000..ba65b13af
--- /dev/null
+++ b/certbot-dns-google/docs/.gitignore
@@ -0,0 +1 @@
+/_build/
diff --git a/certbot-dns-google/docs/Makefile b/certbot-dns-google/docs/Makefile
new file mode 100644
index 000000000..ea465031b
--- /dev/null
+++ b/certbot-dns-google/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+SPHINXPROJ = certbot-dns-google
+SOURCEDIR = .
+BUILDDIR = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file
diff --git a/certbot-dns-google/docs/api.rst b/certbot-dns-google/docs/api.rst
new file mode 100644
index 000000000..8668ec5d8
--- /dev/null
+++ b/certbot-dns-google/docs/api.rst
@@ -0,0 +1,8 @@
+=================
+API Documentation
+=================
+
+.. toctree::
+ :glob:
+
+ api/**
diff --git a/certbot-dns-google/docs/api/dns_google.rst b/certbot-dns-google/docs/api/dns_google.rst
new file mode 100644
index 000000000..6f5459934
--- /dev/null
+++ b/certbot-dns-google/docs/api/dns_google.rst
@@ -0,0 +1,5 @@
+:mod:`certbot_dns_google.dns_google`
+------------------------------------
+
+.. automodule:: certbot_dns_google.dns_google
+ :members:
diff --git a/certbot-dns-google/docs/conf.py b/certbot-dns-google/docs/conf.py
new file mode 100644
index 000000000..4ff1af1d1
--- /dev/null
+++ b/certbot-dns-google/docs/conf.py
@@ -0,0 +1,180 @@
+# -*- coding: utf-8 -*-
+#
+# certbot-dns-google documentation build configuration file, created by
+# sphinx-quickstart on Wed May 10 15:47:49 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc',
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.todo',
+ 'sphinx.ext.coverage',
+ 'sphinx.ext.viewcode']
+
+autodoc_member_order = 'bysource'
+autodoc_default_flags = ['show-inheritance', 'private-members']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'certbot-dns-google'
+copyright = u'2017, Certbot Project'
+author = u'Certbot Project'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u'0'
+# The full version, including alpha/beta/rc tags.
+release = u'0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = 'en'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+default_role = 'py:obj'
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+
+# http://docs.readthedocs.org/en/latest/theme.html#how-do-i-use-this-locally-and-on-read-the-docs
+# on_rtd is whether we are on readthedocs.org
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+if not on_rtd: # only import and set the theme if we're building docs locally
+ import sphinx_rtd_theme
+ html_theme = 'sphinx_rtd_theme'
+ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+# otherwise, readthedocs.org uses their theme by default, so no need to specify it
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'certbot-dns-googledoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+ # The paper size ('letterpaper' or 'a4paper').
+ #
+ # 'papersize': 'letterpaper',
+
+ # The font size ('10pt', '11pt' or '12pt').
+ #
+ # 'pointsize': '10pt',
+
+ # Additional stuff for the LaTeX preamble.
+ #
+ # 'preamble': '',
+
+ # Latex figure (float) alignment
+ #
+ # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ (master_doc, 'certbot-dns-google.tex', u'certbot-dns-google Documentation',
+ u'Certbot Project', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ (master_doc, 'certbot-dns-google', u'certbot-dns-google Documentation',
+ [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ (master_doc, 'certbot-dns-google', u'certbot-dns-google Documentation',
+ author, 'certbot-dns-google', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {
+ 'python': ('https://docs.python.org/', None),
+ 'acme': ('https://acme-python.readthedocs.org/en/latest/', None),
+ 'certbot': ('https://certbot.eff.org/docs/', None),
+}
diff --git a/certbot-dns-google/docs/index.rst b/certbot-dns-google/docs/index.rst
new file mode 100644
index 000000000..a8a322f97
--- /dev/null
+++ b/certbot-dns-google/docs/index.rst
@@ -0,0 +1,28 @@
+.. certbot-dns-google documentation master file, created by
+ sphinx-quickstart on Wed May 10 15:47:49 2017.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to certbot-dns-google's documentation!
+==============================================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+.. toctree::
+ :maxdepth: 1
+
+ api
+
+.. automodule:: certbot_dns_google
+ :members:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/certbot-dns-google/docs/make.bat b/certbot-dns-google/docs/make.bat
new file mode 100644
index 000000000..181c12699
--- /dev/null
+++ b/certbot-dns-google/docs/make.bat
@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=certbot-dns-google
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+ echo.
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+ echo.installed, then set the SPHINXBUILD environment variable to point
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
+ echo.may add the Sphinx directory to PATH.
+ echo.
+ echo.If you don't have Sphinx installed, grab it from
+ echo.http://sphinx-doc.org/
+ exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd
diff --git a/certbot-dns-google/setup.cfg b/certbot-dns-google/setup.cfg
new file mode 100644
index 000000000..2a9acf13d
--- /dev/null
+++ b/certbot-dns-google/setup.cfg
@@ -0,0 +1,2 @@
+[bdist_wheel]
+universal = 1
diff --git a/certbot-dns-google/setup.py b/certbot-dns-google/setup.py
new file mode 100644
index 000000000..043a9ded1
--- /dev/null
+++ b/certbot-dns-google/setup.py
@@ -0,0 +1,70 @@
+import sys
+
+from setuptools import setup
+from setuptools import find_packages
+
+
+version = '0.15.0.dev0'
+
+# Please update tox.ini when modifying dependency version requirements
+install_requires = [
+ 'acme=={0}'.format(version),
+ 'certbot=={0}'.format(version),
+ 'google-api-python-client',
+ 'mock',
+ 'oauth2client',
+ # For pkg_resources. >=1.0 so pip resolves it to a version cryptography
+ # will tolerate; see #2599:
+ 'setuptools>=1.0',
+ 'zope.interface',
+]
+
+docs_extras = [
+ 'Sphinx>=1.0', # autodoc_member_order = 'bysource', autodoc_default_flags
+ 'sphinx_rtd_theme',
+]
+
+setup(
+ name='certbot-dns-google',
+ version=version,
+ description="Google Cloud DNS Authenticator plugin for Certbot",
+ url='https://github.com/certbot/certbot',
+ author="Certbot Project",
+ author_email='client-dev@letsencrypt.org',
+ license='Apache License 2.0',
+ classifiers=[
+ 'Development Status :: 3 - Alpha',
+ 'Environment :: Plugins',
+ 'Intended Audience :: System Administrators',
+ 'License :: OSI Approved :: Apache Software License',
+ 'Operating System :: POSIX :: Linux',
+ 'Programming Language :: Python',
+ 'Programming Language :: Python :: 2',
+ 'Programming Language :: Python :: 2.6',
+ 'Programming Language :: Python :: 2.7',
+ 'Programming Language :: Python :: 3',
+ 'Programming Language :: Python :: 3.3',
+ 'Programming Language :: Python :: 3.4',
+ 'Programming Language :: Python :: 3.5',
+ 'Programming Language :: Python :: 3.6',
+ 'Topic :: Internet :: WWW/HTTP',
+ 'Topic :: Security',
+ 'Topic :: System :: Installation/Setup',
+ 'Topic :: System :: Networking',
+ 'Topic :: System :: Systems Administration',
+ 'Topic :: Utilities',
+ ],
+
+ packages=find_packages(),
+ include_package_data=True,
+ install_requires=install_requires,
+ extras_require={
+ 'docs': docs_extras,
+ },
+ entry_points={
+ 'certbot.plugins': [
+ 'dns-google = certbot_dns_google.dns_google:Authenticator',
+ ],
+ },
+ test_suite='certbot_dns_google',
+)