-
Notifications
You must be signed in to change notification settings - Fork 1
/
dh-dns.py
402 lines (374 loc) · 17.4 KB
/
dh-dns.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
#!/usr/bin/env python
"""DNS Record Updater for DreamHost https://github.com/toddrob99/dh-dns"""
import logging
from logging import handlers
import os
from uuid import uuid4
from urllib.parse import quote_plus
from datetime import datetime
from time import sleep
from IPy import IP
import pyprowl
import requests
""" CONFIGURE YOUR SETTINGS HERE: """
API_URL = "https://api.dreamhost.com/" # You should not need to change this
API_KEY = (
"YOUR_API_KEY_GOES_HERE" # Generate at https://panel.dreamhost.com/?tree=home.api
)
DOMAINS = ["dyn.example.com", "test.example.com"] # Domains to update, list of strings
COMMENT = "Last updated by dh-dns: {date}" # Comment to add to DNS record, {date} parameter available
UPDATE_INTERVAL = 60 # Minutes
LOG_LEVEL = "INFO" # Options: WARNING, INFO, DEBUG
PROWL_API_KEY = "" # Leave blank ("") to disable,
# or generate an API key at
# https://www.prowlapp.com/api_settings.php
""" DO NOT CHANGE ANYTHING BELOW THIS LINE """
class Domain:
def __init__(self, domain):
self.name = domain
self.lastUpdate = None
logger.info("Domain added: %s", self.name)
class DreamHost:
cmds = {
"list": "dns-list_records",
"remove": "dns-remove_record",
"add": "dns-add_record",
}
def __init__(self, apiUrl, apiKey):
self.url = apiUrl + "?key=" + API_KEY + "&format=json"
self.apiKey = apiKey
self.allDomains = {}
def api_call(self, cmd):
url = self.url + "&unique_id=" + str(uuid4())[:64] + "&cmd=" + cmd
logger.debug("Making DreamHost API call: %s", url)
try:
apiResponse = requests.get(url)
if apiResponse.status_code not in [200, 201]:
raise ValueError(
"Request failed. Status Code: " + str(apiResponse.status_code) + "."
)
else:
logger.debug("API Response: %s", apiResponse.json())
return apiResponse.json()
except Exception as e:
logger.error("Error encountered while making API call: %s", e)
return {"result": "error", "data": str(e)}
class Logger:
cwd = os.path.dirname(os.path.realpath(__file__))
logDir = cwd + "/logs"
if not os.path.exists(logDir):
os.makedirs(logDir)
logPath = logDir + "/dh-dns.log"
logLevel = getattr(logging, LOG_LEVEL.upper(), 30)
logger = logging.getLogger("dh-dns")
logger.setLevel(logLevel)
handler = handlers.TimedRotatingFileHandler(
logPath, when="midnight", interval=7, backupCount=3
)
formatter = logging.Formatter("%(asctime)s :: %(levelname)s :: %(message)s")
handler.setFormatter(formatter)
logger.addHandler(handler)
# aliases to shorten calls (logger.logger.info -> logger.info)
info = logger.info
warn = logger.warn
error = logger.error
debug = logger.debug
def monitor(domains):
""" domains is a list of Domain class objects """
dh = DreamHost(API_URL, API_KEY)
currentIp = ""
global PROWL_API_KEY
if PROWL_API_KEY != "":
logger.info("Setting up Prowl notifications...")
prowl = pyprowl.Prowl(apiKey=PROWL_API_KEY, appName="dh-dhs")
verifyKey = prowl.verify_key()
if verifyKey.get("status") == "success":
logger.info("Prowl API key successfully verified. Notifications enabled!")
else:
PROWL_API_KEY = ""
prowl = None
logger.error(
"Unable to verify Prowl API key. Disabling Prowl notifications. Error code: %s %s, message: %s",
verifyKey.get("status"),
verifyKey.get("message"),
verifyKey.get("errMsg"),
)
else:
prowl = None
while True: # Enter update loop
# Pull current domain info from DH
dhDomainResponse = dh.api_call(
dh.cmds["list"]
) # List all domains from DH account
if dhDomainResponse.get("result") == "success":
for data in [
data for data in dhDomainResponse.get("data") if data.get("type") == "A"
]:
dh.allDomains.update(
{
data.get("record"): {
"value": data.get("value"),
"editable": data.get("editable"),
"comment": data.get("comment"),
}
}
)
logger.debug("All A records from DreamHost: %s", format(dh.allDomains))
else:
logger.error(
"Error reported by DreamHost API: %s.", dhDomainResponse.get("data")
)
newIp = ""
validIp = False
# Get current IP
try:
newIp = requests.get("https://api.ipify.org").text.strip()
ipType = IP(newIp).iptype()
if ipType != "PUBLIC":
logger.warn(
"%s IP address detected: [%s]. PUBLIC IP required, ignoring.",
ipType,
newIp,
)
else:
logger.debug("%s IP address detected: [%s].", ipType, newIp)
validIp = True
except Exception as e:
logger.error("Error encountered while looking up current IP: %s.", e)
if not validIp:
try:
IP(
currentIp
) # Failed to look up current IP, so check if last known IP is valid
except ValueError as e:
logger.error(
"Last known IP is invalid: %s. Skipping domain check and sleeping for %i minutes.",
e,
UPDATE_INTERVAL,
)
else:
newIp = currentIp
validIp = True
logger.info("Checking domains against last known IP: [%s].", newIp)
if validIp:
for domain in domains:
addFlag = False
if dh.allDomains.get(domain.name):
# Monitored domain already exists
if dh.allDomains.get(domain.name).get("editable") == "0":
logger.warn("Domain %s is not editable, skipping.", domain.name)
if prowl: # Send Prowl notification
event = (
"Monitored DNS Record Not Editable: ["
+ domain.name
+ "]"
)
description = (
"Please check your configuration. Domain "
+ domain.name
+ " is monitored but DreamHost says it is not editable."
)
try:
prowlResult = prowl.notify(event, description)
if prowlResult.get("status") == "success":
logger.debug(
"Successfully sent notification to Prowl... Event: %s, Description: %s",
event,
description,
)
else:
logger.error(
"Failed to send notification to Prowl... Event: %s, Description: %s, Status code: %s %s, Error message: %s",
event,
description,
prowlResult.get("status"),
prowlResult.get("message"),
prowlResult.get("errMsg"),
)
except Exception as e:
logger.error(
"Failed to send notification to Prowl... Event: %s, Description: %s, Error message: %s",
event,
description,
e,
)
elif dh.allDomains.get(domain.name).get("value") == newIp:
logger.info("No update needed for %s.", domain.name)
else:
# Update needed - remove record and set flag to add it
logger.info(
"New IP detected for %s: [%s]. Deleting existing record.",
domain.name,
newIp,
)
dhRemoveResponse = dh.api_call(
dh.cmds["remove"]
+ "&type=A&record="
+ domain.name
+ "&value="
+ dh.allDomains.get(domain.name).get("value")
)
if dhRemoveResponse.get("result") == "success":
logger.info("Successfully deleted domain %s.", domain.name)
addFlag = True
else:
logger.error(
"Error deleting domain %s: %s.",
domain.name,
dhRemoveResponse.get("data"),
)
if prowl: # Send Prowl notification
event = (
"Failed to Delete DNS Record: [" + domain.name + "]"
)
description = (
"Domain "
+ domain.name
+ " needs to be updated with new IP ["
+ newIp
+ "], but the deletion failed.\nError message: "
+ dhRemoveResponse.get("data")
)
try:
prowlResult = prowl.notify(event, description)
if prowlResult.get("status") == "success":
logger.debug(
"Successfully sent notification to Prowl... Event: %s, Description: %s",
event,
description,
)
else:
logger.error(
"Failed to send notification to Prowl... Event: %s, Description: %s, Status code: %s %s, Error message: %s",
event,
description,
prowlResult.get("status"),
prowlResult.get("message"),
prowlResult.get("errMsg"),
)
except Exception as e:
logger.error(
"Failed to send notification to Prowl... Event: %s, Description: %s, Error message: %s",
event,
description,
e,
)
else:
# Monitored domain does not exist
logger.info("Domain %s does not exist.", domain.name)
addFlag = True
if addFlag:
if len(COMMENT) > 0:
comment = "&comment=" + quote_plus(
COMMENT.replace(
"{date}",
datetime.utcnow().strftime("%Y-%m-%dT%H:%M:%SZ"),
)
)
else:
comment = ""
dhAddResponse = dh.api_call(
dh.cmds["add"]
+ "&record="
+ domain.name
+ "&type=A&value="
+ newIp
+ comment
)
if dhAddResponse.get("result") == "success":
domain.lastUpdate = datetime.utcnow().strftime(
"%Y-%m-%dT%H:%M:%SZ"
)
logger.info(
"Successfully added domain %s with IP [%s].",
domain.name,
newIp,
)
if prowl: # Send Prowl notification
event = "DNS Record Updated: [" + domain.name + "]"
description = (
"Successfully updated domain "
+ domain.name
+ " with IP ["
+ newIp
+ "]."
)
try:
prowlResult = prowl.notify(event, description)
if prowlResult.get("status") == "success":
logger.debug(
"Successfully sent notification to Prowl... Event: %s, Description: %s",
event,
description,
)
else:
logger.error(
"Failed to send notification to Prowl... Event: %s, Description: %s, Status code: %s %s, Error message: %s",
event,
description,
prowlResult.get("status"),
prowlResult.get("message"),
prowlResult.get("errMsg"),
)
except Exception as e:
logger.error(
"Failed to send notification to Prowl... Event: %s, Description: %s, Error message: %s",
event,
description,
e,
)
else:
logger.error(
"Error adding domain %s: %s.",
domain.name,
dhAddResponse.get("data"),
)
if prowl: # Send Prowl notification
event = "DNS Record Update Failed: [" + domain.name + "]"
description = (
"Failed to update domain "
+ domain.name
+ " with IP ["
+ newIp
+ "]:\n"
+ dhAddResponse.get("data")
)
try:
prowlResult = prowl.notify(event, description)
if prowlResult.get("status") == "success":
logger.debug(
"Successfully sent notification to Prowl... Event: %s, Description: %s",
event,
description,
)
else:
logger.error(
"Failed to send notification to Prowl... Event: %s, Description: %s, Status code: %s %s, Error message: %s",
event,
description,
prowlResult.get("status"),
prowlResult.get("message"),
prowlResult.get("errMsg"),
)
except Exception as e:
logger.error(
"Failed to send notification to Prowl... Event: %s, Description: %s, Error message: %s",
event,
description,
e,
)
currentIp = newIp
logger.info(
"Done checking/updating domains. Sleeping for %i minutes.",
UPDATE_INTERVAL,
)
sleep(UPDATE_INTERVAL * 60)
if __name__ == "__main__":
logger = Logger()
logger.info(
"Logging started with log level %s. Log file: %s.", LOG_LEVEL, "dh-dns.log"
)
domains = []
for x in DOMAINS:
domains.append(Domain(x))
monitor(domains)