├── .gitignore ├── .gitreview ├── .stestr.conf ├── .zuul.yaml ├── LICENSE ├── README.md ├── __init__.py ├── copyright ├── interface.yaml ├── provides.py ├── requires.py ├── test-requirements.txt └── tox.ini /.gitignore: -------------------------------------------------------------------------------- 1 | .tox 2 | .testrepository 3 | -------------------------------------------------------------------------------- /.gitreview: -------------------------------------------------------------------------------- 1 | [gerrit] 2 | host=review.opendev.org 3 | port=29418 4 | project=openstack/charm-interface-bind-rndc 5 | -------------------------------------------------------------------------------- /.stestr.conf: -------------------------------------------------------------------------------- 1 | [DEFAULT] 2 | test_path=./unit_tests 3 | top_dir=./ 4 | -------------------------------------------------------------------------------- /.zuul.yaml: -------------------------------------------------------------------------------- 1 | - project: 2 | templates: 3 | - python-charm-interface-jobs 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Overview 2 | 3 | This interface supports integration with BIND using RNDC keys. 4 | 5 | # Usage 6 | 7 | No explicit handler is required to consume this interface in charms 8 | that consume this interface. 9 | 10 | ## metadata 11 | To consume this interface in your charm or layer, add the following to `layer.yaml`: 12 | 13 | ```yaml 14 | includes: ['interface:bind-rndc'] 15 | ``` 16 | 17 | and add a requires interface of type `bind-rndc` to your charm or layers 18 | `metadata.yaml`: 19 | 20 | ```yaml 21 | requires: 22 | dns-backend: 23 | interface: bind-rndc 24 | ``` 25 | 26 | 27 | ## state: {relation\_name}.connected 28 | 29 | This state is set when a relation of type bind-rndc is detected, but 30 | the data may not have yet been presented by the providing charm. 31 | 32 | ## state: {relation\_name}.available 33 | 34 | This state is set when the providing application unit has set all 35 | required data items on the interface. 36 | 37 | The interface provides implicit bindings for: 38 | 39 | - `algorithm` - RNDC algorithm to use. 40 | - `rndckey` - key to use to secure RNDC commands. 41 | - `private_address` - address of providing application unit. 42 | 43 | ## handler 44 | 45 | ```python 46 | @when('dns-backend.available') 47 | def sync_zones(bind_interface): 48 | sync_all_zones(bind_interface.private_address, 49 | bind_interface.algorithm, 50 | bind_interface.rndckey) 51 | ``` 52 | 53 | In this case, `sync_all_zones` is a function provided by the consuming 54 | charm. 55 | 56 | # Bugs 57 | 58 | Please report bugs on [Launchpad](https://bugs.launchpad.net/openstack-charms/+filebug). 59 | 60 | For development questions please refer to the OpenStack [Charm Guide](https://github.com/openstack/charm-guide). 61 | -------------------------------------------------------------------------------- /__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack/charm-interface-bind-rndc/4c69d8ceb1af495156ff5bd9e3111bd8d34a347e/__init__.py -------------------------------------------------------------------------------- /copyright: -------------------------------------------------------------------------------- 1 | Format: http://dep.debian.net/deps/dep5/ 2 | 3 | Files: * 4 | Copyright: Copyright 2016, Canonical Ltd. 5 | License: Apache-2.0 6 | Licensed under the Apache License, Version 2.0 (the "License"); you may 7 | not use this file except in compliance with the License. You may obtain 8 | a copy of the License at 9 | 10 | http://www.apache.org/licenses/LICENSE-2.0 11 | 12 | Unless required by applicable law or agreed to in writing, software 13 | distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 14 | WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 15 | License for the specific language governing permissions and limitations 16 | under the License. 17 | -------------------------------------------------------------------------------- /interface.yaml: -------------------------------------------------------------------------------- 1 | name: bind-rndc 2 | summary: Interface for integrating with BIND using RNDC keys 3 | maintainer: OpenStack Charmers 4 | -------------------------------------------------------------------------------- /provides.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # 3 | # Copyright 2016 Canonical Ltd 4 | # 5 | # Licensed under the Apache License, Version 2.0 (the "License"); 6 | # you may not use this file except in compliance with the License. 7 | # You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | # See the License for the specific language governing permissions and 15 | # limitations under the License. 16 | 17 | from charms.reactive import RelationBase 18 | from charms.reactive import hook 19 | from charms.reactive import scopes 20 | from charms.reactive.bus import get_states 21 | 22 | from charmhelpers.core import hookenv 23 | from charmhelpers.contrib.network import ip as ch_ip 24 | 25 | 26 | class BindRNDCProvides(RelationBase): 27 | scope = scopes.UNIT 28 | 29 | @hook('{provides:bind-rndc}-relation-joined') 30 | def joined(self): 31 | conv = self.conversation() 32 | conv.set_state('{relation_name}.related') 33 | conv.set_remote('private-address', 34 | ch_ip.get_relation_ip(conv.relation_name)) 35 | hookenv.log('States: {}'.format(get_states().keys())) 36 | 37 | @hook('{provides:bind-rndc}-relation-departed') 38 | def departed(self): 39 | conv = self.conversation() 40 | conv.remove_state('{relation_name}.related') 41 | 42 | def send_rndckey_info(self, rndckey, algorithm): 43 | for conv in self.conversations(): 44 | conv.set_remote('rndckey', rndckey) 45 | conv.set_remote('algorithm', algorithm) 46 | 47 | def client_ips(self): 48 | ips = [] 49 | for conv in self.conversations(): 50 | ips.append(conv.get_remote('private-address')) 51 | return ips 52 | 53 | def egress_subnets(self): 54 | cidrs = [] 55 | for conv in self.conversations(): 56 | egress_subnets = conv.get_remote('egress-subnets') 57 | if egress_subnets: 58 | # NOTE: egress-subnets is potentially a comma 59 | # delimited list 60 | cidrs.extend(egress_subnets.split(',')) 61 | return cidrs 62 | -------------------------------------------------------------------------------- /requires.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # 3 | # Copyright 2016 Canonical Ltd 4 | # 5 | # Licensed under the Apache License, Version 2.0 (the "License"); 6 | # you may not use this file except in compliance with the License. 7 | # You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | # See the License for the specific language governing permissions and 15 | # limitations under the License. 16 | 17 | from charms.reactive import RelationBase 18 | from charms.reactive import hook 19 | from charms.reactive import scopes 20 | 21 | from charmhelpers.contrib.network import ip as ch_ip 22 | 23 | 24 | class BindRNDCRequires(RelationBase): 25 | scope = scopes.UNIT 26 | 27 | # These remote data fields will be automatically mapped to accessors 28 | # with a basic documentation string provided. 29 | 30 | @hook('{requires:bind-rndc}-relation-joined') 31 | def joined(self): 32 | conv = self.conversation() 33 | conv.set_state('{relation_name}.connected') 34 | conv.set_remote('private-address', 35 | ch_ip.get_relation_ip(conv.relation_name)) 36 | 37 | @hook('{requires:bind-rndc}-relation-changed') 38 | def changed(self): 39 | conv = self.conversation() 40 | conv.set_state('{relation_name}.connected') 41 | if self.data_complete(): 42 | conv.set_state('{relation_name}.available') 43 | 44 | @hook('{requires:bind-rndc}-relation-{broken,departed}') 45 | def departed_or_broken(self): 46 | conv = self.conversation() 47 | conv.remove_state('{relation_name}.connected') 48 | conv.remove_state('{relation_name}.available') 49 | 50 | def data_complete(self): 51 | """Check if all information for a RNDC connection has been sent 52 | 53 | @returns boolean: True if all required data for connection is present 54 | """ 55 | if self.rndc_info and all(self.rndc_info.values()): 56 | return True 57 | return False 58 | 59 | @property 60 | def rndc_info(self): 61 | """Get RNDC connection information from DNS Slave 62 | 63 | @returns dict: Return dict of RNDC connection information 64 | """ 65 | for conv in self.conversations(): 66 | data = { 67 | 'algorithm': conv.get_remote('algorithm'), 68 | 'secret': conv.get_remote('rndckey'), 69 | } 70 | if all(data.values()): 71 | return data 72 | return {} 73 | 74 | @property 75 | def algorithm(self): 76 | """Get algorith used to gen rndc secret from DNS Slave 77 | 78 | @returns str: Return algorith used to gen rndc secret 79 | """ 80 | return self.rndc_info.get('algorithm') 81 | 82 | @property 83 | def rndckey(self): 84 | """Get rndc secret from DNS Slave 85 | 86 | @returns str: Return rndc secret 87 | """ 88 | return self.rndc_info.get('secret') 89 | 90 | @property 91 | def private_address(self): 92 | """Get private address of unit in current relation context 93 | 94 | @returns str: Return ip address 95 | """ 96 | conv = self.conversation() 97 | return conv.get_remote('private-address') 98 | 99 | def slave_ips(self): 100 | """Address information of DNS slaves 101 | 102 | @return list: List of dicts containing unit name and address 103 | """ 104 | values = [] 105 | for conv in self.conversations(): 106 | values.append({ 107 | # Unit scoped relation so only one unit per conversation. 108 | 'unit': list(conv.units)[0], 109 | 'address': conv.get_remote('private-address')}) 110 | return values 111 | -------------------------------------------------------------------------------- /test-requirements.txt: -------------------------------------------------------------------------------- 1 | flake8>=2.2.4 2 | stestr>=2.2.0 3 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = pep8,py34,py35 3 | skipsdist = True 4 | # NOTE(beisner): Avoid build/test env pollution by not enabling sitepackages. 5 | sitepackages = False 6 | # NOTE(beisner): Avoid false positives by not skipping missing interpreters. 7 | skip_missing_interpreters = False 8 | 9 | [testenv] 10 | setenv = VIRTUAL_ENV={envdir} 11 | PYTHONHASHSEED=0 12 | install_command = 13 | pip install {opts} {packages} 14 | commands = stestr run {posargs} 15 | 16 | [testenv:py34] 17 | basepython = python3.4 18 | deps = -r{toxinidir}/test-requirements.txt 19 | # TODO: Need to write unit tests then remove the following command. 20 | commands = /bin/true 21 | 22 | [testenv:py35] 23 | basepython = python3.5 24 | deps = -r{toxinidir}/test-requirements.txt 25 | # TODO: Need to write unit tests then remove the following command. 26 | commands = /bin/true 27 | 28 | [testenv:py3] 29 | basepython = python3 30 | deps = -r{toxinidir}/test-requirements.txt 31 | # TODO: Need to write unit tests then remove the following command. 32 | commands = /bin/true 33 | 34 | [testenv:pep8] 35 | basepython = python3 36 | deps = -r{toxinidir}/test-requirements.txt 37 | commands = flake8 {posargs} 38 | 39 | [testenv:venv] 40 | basepython = python3 41 | commands = {posargs} 42 | 43 | [flake8] 44 | ignore = E402,E226 45 | --------------------------------------------------------------------------------