Split Python methods in own files

This commit is contained in:
Thomas Kleinendorst 2024-04-10 19:14:52 +02:00
parent 6409f8c31c
commit d88904e105
4 changed files with 77 additions and 66 deletions

1
.gitignore vendored
View file

@ -2,3 +2,4 @@ cloudflare ddns/ddns_config.ini
.vscode
.vault_pass
.ansible_facts.json
__pycache__

View file

@ -0,0 +1,43 @@
import requests
import logging
class CloudFlare:
def __init__(self, api_token):
self.headers = {'Content-Type': 'application/json', 'Authorization': f'Bearer {api_token}'}
def get_zone_id(self, domain):
response = requests.get(f'https://api.cloudflare.com/client/v4/zones?name={domain}', headers=self.headers)
if response.status_code != 200:
raise Exception('Something went wrong requesting the zone of the domain on Cloudflare...')
zone_id = response.json()['result'][0]['id']
return zone_id
def get_record_id(self, zoneId, record):
logging.debug('Getting record id...')
response = requests.get(f'https://api.cloudflare.com/client/v4/zones/{zoneId}/dns_records?name={record}', headers=self.headers)
if response.status_code != 200:
raise Exception('Something went wrong requesting the record id of the domain name on Cloudflare...')
return response.json()['result'][0]['id']
def change_record(self, subdomain, zoneId, recordId, targetIp):
logging.info(f'Changing record for {subdomain} to point to {targetIp}...')
dns_change_response = requests.put(f'https://api.cloudflare.com/client/v4/zones/{zoneId}ffff/dns_records/{recordId}',
headers=self.headers,
json={
'content': targetIp,
'name': subdomain,
'proxied': False,
'type': 'A',
'comment': 'Is set to change with my DDNS script (on the Raspberry Pi).',
'ttl': 1 # Meaning "Automatic", see: https://developers.cloudflare.com/api/operations/dns-records-for-a-zone-update-dns-record
})
if dns_change_response.status_code != 200:
raise Exception('Something went wrong updating the dns record...')
logging.info('Succesfully updated the record ✅!')

View file

@ -1,76 +1,16 @@
#!/usr/bin/python3
# Fetches the public IP and updates the record on Cloudflare which is provided as an argument
# to match this public record.
import requests
import logging
import sys
import configparser
import argparse
import dns.resolver
from cloudflare_api import CloudFlare
from ip_helpers import get_public_IP, resolve_name
logging.basicConfig(stream=sys.stdout, level=logging.INFO, format='%(levelname)s - %(message)s')
def get_public_IP():
logging.info('Retrieving the public IP for this machine...')
response = requests.get('https://api.ipify.org?format=json')
if response.status_code != 200:
raise Exception('Something went wrong requesting the public ip, exiting...')
public_ip = response.json()['ip']
logging.info(f'The public IP address for this machine is: {public_ip}.')
return public_ip
def resolve_name(domain):
logging.info(f'Resolving {domain}...')
try:
result = dns.resolver.resolve(domain, 'A')
except dns.resolver.NXDOMAIN:
logging.error(f'No DNS record exists for {domain}, configure it first before using this ddns script. Exiting...')
exit(1)
resolved_address = result[0].address
logging.info(f'Resolved {domain} to: {resolved_address}.')
return resolved_address
def get_zone_id(domain):
response = requests.get(f'https://api.cloudflare.com/client/v4/zones?name={domain}', headers=cloudflare_request_headers)
if response.status_code != 200:
raise Exception('Something went wrong requesting the zone of the domain on Cloudflare...')
zone_id = response.json()['result'][0]['id']
return zone_id
def get_record_id(zoneId, record):
logging.debug('Getting record id...')
response = requests.get(f'https://api.cloudflare.com/client/v4/zones/{zoneId}/dns_records?name={record}', headers=cloudflare_request_headers)
if response.status_code != 200:
raise Exception('Something went wrong requesting the record id of the domain name on Cloudflare...')
return response.json()['result'][0]['id']
def change_record(subdomain, zoneId, recordId):
logging.info(f'Changing record for {subdomain} to point to {publicIP}...')
dns_change_response = requests.put(f'https://api.cloudflare.com/client/v4/zones/{zoneId}/dns_records/{recordId}',
headers=cloudflare_request_headers,
json={
'content': publicIP,
'name': subdomain,
'proxied': False,
'type': 'A',
'comment': 'Is set to change with my DDNS script (on the Raspberry Pi).',
'ttl': 1 # Meaning "Automatic", see: https://developers.cloudflare.com/api/operations/dns-records-for-a-zone-update-dns-record
})
if dns_change_response.status_code != 200:
raise Exception('Something went wrong updating the dns record...')
logging.info('Succesfully updated the record ✅!')
parser = argparse.ArgumentParser()
parser.add_argument('subdomain')
parser.add_argument('-c', '--config-file', dest='config')
@ -87,7 +27,7 @@ config = configparser.ConfigParser()
config.read(config_file_path)
cloudflare_api_credentials = config['credentials']['dns_cloudflare_token']
cloudflare_request_headers = {'Content-Type': 'application/json', 'Authorization': f'Bearer {cloudflare_api_credentials}'}
cloudflare = CloudFlare(cloudflare_api_credentials)
log_path = config.get('log_changes', 'log_path', fallback=None)
if log_path is not None:
@ -100,9 +40,9 @@ if resolvedIP == publicIP:
logging.info(f'Currently resolved name already matches the public ip ({publicIP}), exiting...')
exit(0)
zoneId = get_zone_id(fixedTopLevelDomain)
recordId = get_record_id(zoneId, fullDomainName)
change_record(subdomain, zoneId, recordId)
zoneId = cloudflare.get_zone_id(fixedTopLevelDomain)
recordId = cloudflare.get_record_id(zoneId, fullDomainName)
cloudflare.change_record(subdomain, zoneId, recordId, publicIP)
with open(log_path, 'a+') as log_file:
msg = f'Address for FQDN {fullDomainName} altered from: {resolvedIP} - {publicIP}.'

View file

@ -0,0 +1,27 @@
import logging
import requests
import dns.resolver
def get_public_IP():
logging.info('Retrieving the public IP for this machine...')
response = requests.get('https://api.ipify.org?format=json')
if response.status_code != 200:
raise Exception('Something went wrong requesting the public ip, exiting...')
public_ip = response.json()['ip']
logging.info(f'The public IP address for this machine is: {public_ip}.')
return public_ip
def resolve_name(domain):
logging.info(f'Resolving {domain}...')
try:
result = dns.resolver.resolve(domain, 'A')
except dns.resolver.NXDOMAIN:
logging.error(f'No DNS record exists for {domain}, configure it first before using this ddns script. Exiting...')
exit(1)
resolved_address = result[0].address
logging.info(f'Resolved {domain} to: {resolved_address}.')
return resolved_address