├── LICENSE ├── README.md └── dnsimple /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # dnsimple_cli 2 | 3 | A cli for the DNSimple v2 API. This is not a complete API implementation. It should be great to use as a simple dynamic dns client. 4 | 5 | ## Install 6 | 7 | There is no install, it's just `bash`! Well, that's not true. 8 | 9 | ### Dependencies 10 | 11 | 1. [curl](https://curl.haxx.se/) 12 | 2. [jq](https://stedolan.github.io/jq/) 13 | 3. dig 14 | * Part of macOS 15 | * On Linux it's usually the `dnsutils` package 16 | 4. bash version >= 4 17 | * If you're really stuck with bash v3.something, let me know and I'll take all the love and joy out of the script for you. ;) 18 | 19 | ## Setup 20 | 21 | 1. Login to [DNSimple](https://dnsimple.com) 22 | 2. Go to your *Account* page (_not_ your Settings) 23 | 3. Go to *Access Tokens* 24 | 4. Create an account access token. 25 | 5. Add that to your `.bashrc`, `.zshenv`, etc... 26 | * `export DNSIMPLE_ACCOUNT_TOKEN="The token from DNSimple"` 27 | 6. Reload your shell: `exec bash`, `exec zsh`, etc... 28 | 29 | ## Usage 30 | 31 | ### Help 32 | 33 | ``` 34 | $ ./dnsimple -h 35 | Usage: dnsimple [options] [command specific options] 36 | OPTIONS: 37 | -h, --help This. 38 | 39 | --dat, Specify a \$DNSIMPLE_ACCOUNT_TOKEN, in lieu of or to 40 | --account-token override the setting from your environment. 41 | You can create 'User access token' on your dnsimple.com 42 | User Settings page. 43 | 44 | --api Override the default v2 API URL. The default is: 45 | $_api 46 | 47 | --compact Don't show the full json output. 48 | 49 | COMMANDS: 50 | whoami Prints info for your \$DNSIMPLE_ACCOUNT_TOKEN. 51 | 52 | zones Prints available zones. 53 | 54 | zone_info Prints info for a specific zone. 55 | -z, --zone 56 | 57 | zone_records Prints records for a specific zone. 58 | -z, --zone 59 | 60 | zone_record Prints info for a specific zone record. 61 | -z, --zone 62 | -r, --record 63 | 64 | zone_record_id Prints the id for a specific zone record. 65 | -z, --zone 66 | -r, --record 67 | 68 | update_a_record Creates/Updates the zone record with an IP address. 69 | Specifying an IP address of "auto" will detect and use 70 | the current public internet IP. 71 | -z, --zone 72 | -r, --record 73 | -i, --ip 74 | ``` 75 | 76 | 77 | ### `whoami` 78 | 79 | ``` 80 | $ ./dnsimple whoami 81 | { 82 | "data": { 83 | "user": null, 84 | "account": { 85 | "id": ***Your Account ID***, 86 | "email": "***Your Email Address***", 87 | "created_at": "2010-11-16T14:19:28.219Z", 88 | "updated_at": "2016-02-22T11:04:09.404Z" 89 | } 90 | } 91 | } 92 | ``` 93 | 94 | ### `zones` 95 | 96 | ``` 97 | $ ./dnsimple zones --account-id auto 98 | 99 | # Pretty JSON of your available zones. 100 | ``` 101 | 102 | ### `update_a_record` 103 | 104 | Read that as "update an A record" which is really my goal use case, as a dynamic DNS update client. 105 | 106 | ``` 107 | $ ./dnsimple update_a_record --zone chorn.net --record derp3 --ip auto 108 | { 109 | "data": { 110 | "id": 5544144, 111 | "zone_id": "chorn.net", 112 | "parent_id": null, 113 | "name": "derp3", 114 | "content": "173.84.105.46", 115 | "ttl": 3600, 116 | "priority": null, 117 | "type": "A", 118 | "system_record": false, 119 | "created_at": "2016-04-05T11:43:39.691Z", 120 | "updated_at": "2016-04-12T10:50:59.576Z" 121 | } 122 | } 123 | ``` 124 | 125 | 126 | ## Todo 127 | 128 | 1. Update other record types. 129 | 130 | -------------------------------------------------------------------------------- /dnsimple: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # License: See LICENSE 4 | 5 | set -e 6 | 7 | declare _api="https://api.dnsimple.com/v2" 8 | declare _config=$(mktemp -t dnsimple) 9 | declare _json_data=$(mktemp -t dnsimple_json) 10 | declare _debug=$(mktemp -t dnsimple_debug) 11 | declare _api_out=$(mktemp -t dnsimple_curl) 12 | declare _jq_single='.' 13 | declare _jq_list='.' 14 | declare -a _output 15 | 16 | #----------------------------------------------------------------------------- 17 | cleanup() { 18 | local _exit_code="$1" 19 | [[ -n "$_exit_code" ]] || _exit_code=0 20 | 21 | for f in "$_config" "$_json_data" "$_api_out" "$_debug" ; do 22 | if [[ -f "$f" ]] ; then 23 | [[ "$_exit_code" -gt 0 ]] && cat "$f" 24 | rm "$f" 25 | fi 26 | done 27 | 28 | exit "$_exit_code" 29 | } 30 | #----------------------------------------------------------------------------- 31 | usage() { 32 | cat < [options] [command specific options] 34 | OPTIONS: 35 | -h, --help This. 36 | 37 | --dat, Specify a \$DNSIMPLE_ACCOUNT_TOKEN, in lieu of or to 38 | --account-token override the setting from your environment. 39 | You can create 'User access token' on your dnsimple.com 40 | User Settings page. 41 | 42 | --api Override the default v2 API URL. The default is: 43 | $_api 44 | 45 | --compact Don't show the full json output. 46 | 47 | COMMANDS: 48 | whoami Prints info for your \$DNSIMPLE_ACCOUNT_TOKEN. 49 | 50 | zones Prints available zones. 51 | 52 | zone_info Prints info for a specific zone. 53 | -z, --zone 54 | 55 | zone_records Prints records for a specific zone. 56 | -z, --zone 57 | 58 | zone_record Prints info for a specific zone record. 59 | -z, --zone 60 | -r, --record 61 | 62 | zone_record_id Prints the id for a specific zone record. 63 | -z, --zone 64 | -r, --record 65 | 66 | update_a_record Creates/Updates the zone record with an IP address. 67 | Specifying an IP address of "auto" will detect and use 68 | the current public internet IP. 69 | -z, --zone 70 | -r, --record 71 | -i, --ip 72 | 73 | You need to have 'dig', 'curl', and 'jq' installed and in your \$PATH. 74 | https://curl.haxx.se/ 75 | https://stedolan.github.io/jq/ 76 | 77 | USAGE 78 | cleanup -1 79 | } 80 | #----------------------------------------------------------------------------- 81 | # API 82 | typeset -t dnsimple_api 83 | dnsimple_api() { 84 | local _resource="$1" 85 | local _method="$2" 86 | local -i _per_page=100 87 | local _url="${_api}/${_resource}?per_page=${_per_page}" 88 | 89 | local -a _args=( 90 | [1]="silent" 91 | [2]="header = \"Authorization: Bearer ${DNSIMPLE_ACCOUNT_TOKEN}\"" 92 | [3]="header = \"Accept: application/json\"" 93 | ) 94 | 95 | [[ -n "$_method" ]] && _args+=([10]="header = \"Content-Type: application/json\"" [11]="request = \"${_method}\"") 96 | [[ -s "$_json_data" ]] && _args+=([20]="data = \"@${_json_data}\"") 97 | 98 | _args+=([30]="url = \"${_url}\"") 99 | 100 | local -i _total_pages=1 101 | for (( _current_page = 1 ; _current_page <= _total_pages ; _current_page++ )) ; do 102 | _args[30]="url = \"${_url}&page=${_current_page}\"" 103 | 104 | $(IFS=$'\n' ; echo "${_args[*]}" > "$_config") 105 | 106 | curl --config "$_config" --output "$_api_out" >& "$_debug" 107 | _output+=$(cat "$_api_out") 108 | _total_pages=$(jq -cMj ".pagination.total_pages" < "$_api_out") 109 | done 110 | } 111 | #----------------------------------------------------------------------------- 112 | jq_single() { 113 | for _out in "${_output[@]}" ; do 114 | echo "$_out" | jq "$_jq_single" 115 | done 116 | } 117 | #----------------------------------------------------------------------------- 118 | jq_list() { 119 | for _out in "${_output[@]}" ; do 120 | echo "$_out" | jq "$_jq_list" 121 | done 122 | } 123 | #----------------------------------------------------------------------------- 124 | _whoami() { 125 | dnsimple_api "whoami" && jq_single 126 | } 127 | #----------------------------------------------------------------------------- 128 | _zones() { 129 | dnsimple_api "${DAI}/domains" && jq_list 130 | } 131 | #----------------------------------------------------------------------------- 132 | _zone_info() { 133 | [[ -n "$_zone" ]] || usage 134 | 135 | dnsimple_api "${DAI}/zones/${_zone}" && jq_single 136 | } 137 | #----------------------------------------------------------------------------- 138 | _zone_records() { 139 | [[ -n "$_zone" ]] || usage 140 | 141 | dnsimple_api "${DAI}/zones/${_zone}/records" && jq_list 142 | } 143 | #----------------------------------------------------------------------------- 144 | _zone_record() { 145 | [[ -n "$_zone" && -n "$_record" ]] || usage 146 | 147 | dnsimple_api "${DAI}/zones/${_zone}/records" && jq ".data[] | select(.name == \"${_record}\")" < "$_api_out" 148 | } 149 | #----------------------------------------------------------------------------- 150 | _zone_record_id() { 151 | [[ -n "$_zone" && -n "$_record" ]] || usage 152 | 153 | _zone_record "$DAI" "$_zone" "$_record" | jq -cMj ".id" ; echo 154 | } 155 | #----------------------------------------------------------------------------- 156 | _update_a_record() { 157 | [[ -n "$_zone" && -n "$_record" && -n "$_ip" ]] || usage 158 | 159 | local _id=$(_zone_record_id "$DAI" "$_zone" "$_record") 160 | local _method="POST" 161 | 162 | [[ -n "$_id" ]] && _method="PATCH" 163 | 164 | echo "{\"name\":\"${_record}\",\"type\":\"A\",\"content\":\"${_ip}\"}" > "$_json_data" 165 | 166 | dnsimple_api "${DAI}/zones/${_zone}/records/${_id}" "${_method}" && jq_single 167 | } 168 | #----------------------------------------------------------------------------- 169 | # Main program 170 | 171 | [[ $# -eq 0 ]] && usage 172 | 173 | for _cli in curl jq dig ; do 174 | command -v "$_cli" >/dev/null 2>/dev/null || usage 175 | done 176 | 177 | declare _command 178 | _command="$1" ; shift 179 | declare _zone 180 | declare _record 181 | declare _ip 182 | 183 | while [[ $# -gt 0 ]] ; do 184 | declare _arg="$1" && shift 185 | 186 | case "$_arg" in 187 | -c|--compact) 188 | _jq_single='.data' 189 | _jq_list='.data[]' 190 | ;; 191 | *) 192 | declare _next="$1" && shift 193 | case "$_arg" in 194 | --dat|--account-token) DNSIMPLE_ACCOUNT_TOKEN="$_next" ;; 195 | --api) _api="$_next" ;; 196 | -z|--zone) _zone="$_next" ;; 197 | -r|--record) _record="$_next" ;; 198 | -i|--ip) _ip="$_next" ;; 199 | *) usage ;; 200 | esac 201 | ;; 202 | esac 203 | done 204 | 205 | [[ -n "$DNSIMPLE_ACCOUNT_TOKEN" ]] || usage 206 | 207 | if [[ -n "$_ip" && "$_ip" == "auto" ]] ; then 208 | _ip=$(dig +short myip.opendns.com @resolver1.opendns.com || curl -f4L http://ifconfig.me/ || curl -f4L http://icanhazip.com/) 209 | fi 210 | 211 | for _signal in 0 1 ; do 212 | trap "cleanup $_signal" $_signal 213 | done 214 | 215 | declare DAI=$(dnsimple_api "whoami" && jq '.data.account.id' < "$_api_out") 216 | 217 | case "$_command" in 218 | whoami) _whoami ;; 219 | zones) _zones ;; 220 | zone_info) _zone_info ;; 221 | zone_records) _zone_records ;; 222 | zone_record) _zone_record ;; 223 | zone_record_id) _zone_record_id ;; 224 | update_a_record) _update_a_record ;; 225 | *) usage ;; 226 | esac 227 | 228 | --------------------------------------------------------------------------------