Files
proxy/nodejs/models/dns_provider/cloudflare.js
T
wmantly a2d194f855 Add dynamic DNS: keep A records pointed at the current public IP
For deployments on WAN DHCP, operators can declare A records in the DNS section
that the app updates to this box's current public IP every 4 hours (and
immediately on create).

- utils/public_ip.js: getPublicIp() queries external echo services (ipify +
  fallbacks, configurable) with pure isIPv4/extractIp helpers.
- utils/dns_records.js: pure planARecordUpdate() reconciliation decision.
- models/dns_provider.js: Domain.upsertARecord(name, ip) — provider-agnostic
  upsert via getRecords + deleteRecordById + createRecord (createRecord alone is
  not a reliable cross-provider upsert). Apex ('@') handling added to each
  provider (CloudFlare uses the domain name, Porkbun an empty name, DigitalOcean
  '@') via a new DnsApi.apexName().
- models/dynamic_record.js: DynamicRecord model (deterministic id per host,
  apply()/refreshAll()), registered + ModelPs-wrapped for live UI updates.
- services/dynamic_dns.js + conf: 4h scheduler mirroring host_scheduler.
- routes/dns.js: /dynamic CRUD + /dynamic/ip, gated to domain managers/admins.
- views/dns.ejs: "Dynamic A Records (WAN IP)" card with add form + list.
- test/unit/dynamic_record.test.js: public-IP parsing + reconciliation logic.

Verified end-to-end against a live Porkbun domain (create, idempotent, IP-change,
cleanup) plus unit suite (111 pass).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-10 23:55:56 -04:00

155 lines
4.6 KiB
JavaScript

'use strict';
const axios = require('axios');
const {DnsApi} = require('./common');
//like the options obj will always use domain data and type
// change content to data
// change name to domain
class CloudFlare extends DnsApi{
static _keyMap = {
token: {isRequired: true, type: 'string', isPrivate: true, displayName: 'API Token'},
}
static displayName = 'CloudFlare'
static displayIconHtml = `
<svg viewBox="0 0 1024 1024" xmlns="http://www.w3.org/2000/svg">
<circle cx="512" cy="512" r="512" style="fill:#f38020"/>
<path d="M608.2 592.4c3.1-10.8 1.9-20.7-3.3-28.1-4.8-6.7-12.9-10.6-22.6-11.1l-184.7-2.4c-1.1 0-2.2-.6-2.8-1.5-.6-.9-.7-2.1-.4-3.3.6-1.8 2.4-3.2 4.3-3.3l186.4-2.4c22.1-1 46.1-18.9 54.5-40.8l10.6-27.8c.5-1.2.6-2.4.3-3.6-12-54.3-60.5-94.8-118.4-94.8-53.4 0-98.7 34.5-114.9 82.4-10.5-7.8-23.9-12-38.3-10.6-25.7 2.5-46.2 23.1-48.8 48.8-.6 6.6-.1 13.1 1.4 19.1-41.9 1.2-75.3 35.4-75.3 77.6 0 3.7.3 7.5.8 11.2.3 1.8 1.8 3.1 3.6 3.1h340.9c1.9 0 3.8-1.4 4.3-3.3l2.4-9.2zM667 473.7c-1.6 0-3.4 0-5.1.2-1.2 0-2.2.9-2.7 2.1l-7.2 25c-3.1 10.8-2 20.7 3.3 28.1 4.8 6.7 12.9 10.6 22.7 11.1l39.3 2.4c1.2 0 2.3.6 2.8 1.5.6.9.7 2.3.5 3.3-.6 1.8-2.4 3.2-4.4 3.3l-41 2.4c-22.2 1-46 18.9-54.5 40.8l-3 7.6c-.6 1.5.5 3 2.1 3h140.8c1.6 0 3.1-1 3.6-2.7 2.4-8.7 3.7-17.9 3.7-27.3 0-55.5-45.3-100.8-101-100.8" style="fill:#fff"/>
</svg>`
// Cloud icon for cloudflare
static displayIconUni = '&#xf0c2;'
constructor(token){
super()
this.token = token.token || token;
}
__typeCheck(type){
if(!type) return;
if(!['A', 'MX', 'CNAME', 'ALIAS', 'TXT', 'NS', 'AAAA', 'SRV', 'TLSA', 'CAA', 'HTTPS', 'SVCB'].includes(type)) throw new Error(`${this.constructor.name} API: Invalid 'type' passed`)
}
async axios(method, ...args){
try{
let a = axios.create({
baseURL: 'https://api.cloudflare.com/client/v4/zones',
headers: {Authorization: `Bearer ${this.token}`}
});
return await a[method](...args);
}catch(error){
if(!error.response) throw error;
if(error.response.data && error.response.data.errors[0].code == 10000){
throw this.errors.unauthorized();
}
throw this.errors.other(error.response.status, error.response.data.errors[0].message, error.response.data.errors[0].code, error);
}
}
async listDomains(){
let res = await this.axios('get');
for(let domain of res.data.result){
domain.domain = domain.name
domain.zoneId = domain.id
}
return res.data.result;
}
/*
The API and the generic class interface have different opinions of what keys
hold what data, the __parseOptions and __pastseRes normal the keys to what
the class expects
What the the API calls it : What the class wants it as.
*/
__apiKeyMap = {
'content': 'data',
}
//get records
async getRecords(domain, options){
let res = await this.axios('get',
`${domain.zoneId}/dns_records`,
);
let records = this.__parseRes(res.data.result);
if(!options) return records;
return records.filter((record)=>{
let matchCount = 0
for(let key in options){
if(record[key] === options[key] && ++matchCount === Object.keys(options).length){
return true;
}
}
});
}
// CloudFlare names an apex record with the full domain (e.g. example.com).
apexName(domainName){
return domainName;
}
async createRecord(domain, options){
try{
if(options.name === '@') options.name = this.apexName(domain.domain);
let res = await this.axios('post',
`${domain.zoneId}/dns_records`,
this.__parseOptions(options, ['type', 'name', 'data'])
);
return this.__parseRes([res.data.result])[0];
}catch(error){
if(error.APIcode == 81058){
return (await this.getRecords(domain, options))[0];
}
throw error;
}
}
async deleteRecordById(domain, id){
let res = await this.axios('delete', `${domain.zoneId}/dns_records/${id}`);
}
async deleteRecords(domain, options){
let records = await this.getRecords(domain, options)
for(let record of records){
}
return true;
}
}
module.exports = CloudFlare;
if(require.main === module){(async function(){try{
// let cf = new CloudFlare("");
// let domain = {
// domain: "example.uk",
// zoneId: "5eb25c12cd7d22f11252330a29a0dd77"
// }
// console.log(await cf.listDomains())
//content = ip
//name = domain
// console.log('get', await cf.getRecords(domain, {content: '172.206.221.130'}))
// console.log('post', await cf.createRecord(domain, {name:'test', content: '10.0.0.1', type: "TXT"}))
// console.log('delete', await cf.deleteRecordById(domain , "5c0e958c3406a34d011459933d538b78"))
// console.log('delete', await cf.deleteRecords(domain, {type: 'A'}))
}catch(error){
console.log('IIFE Error:', error)
}})()}