241 lines
9.7 KiB
JavaScript
241 lines
9.7 KiB
JavaScript
'use strict';
|
|
|
|
exports = module.exports = {
|
|
removePrivateFields,
|
|
injectPrivateFields,
|
|
upsert,
|
|
get,
|
|
del,
|
|
wait,
|
|
verifyDomainConfig
|
|
};
|
|
|
|
const assert = require('assert'),
|
|
BoxError = require('../boxerror.js'),
|
|
constants = require('../constants.js'),
|
|
debug = require('debug')('box:dns/porkbun'),
|
|
dig = require('../dig.js'),
|
|
dns = require('../dns.js'),
|
|
safe = require('safetydance'),
|
|
superagent = require('superagent'),
|
|
timers = require('timers/promises'),
|
|
waitForDns = require('./waitfordns.js');
|
|
|
|
// Rate limit note: Porkbun return 503 when it hits rate limits. It's as low as 1 req/second
|
|
// https://github.com/cullenmcdermott/terraform-provider-porkbun/issues/23#issuecomment-1366859999
|
|
const PORKBUN_API = 'https://porkbun.com/api/json/v3/dns';
|
|
|
|
function formatError(response) {
|
|
return `Porkbun DNS error ${response.statusCode} ${JSON.stringify(response.body)}`;
|
|
}
|
|
|
|
function removePrivateFields(domainObject) {
|
|
domainObject.config.secretapikey = constants.SECRET_PLACEHOLDER;
|
|
return domainObject;
|
|
}
|
|
|
|
function injectPrivateFields(newConfig, currentConfig) {
|
|
if (newConfig.secretapikey === constants.SECRET_PLACEHOLDER) newConfig.secretapikey = currentConfig.secretapikey;
|
|
}
|
|
|
|
async function getDnsRecords(domainConfig, zoneName, name, type) {
|
|
assert.strictEqual(typeof domainConfig, 'object');
|
|
assert.strictEqual(typeof zoneName, 'string');
|
|
assert.strictEqual(typeof name, 'string');
|
|
assert.strictEqual(typeof type, 'string');
|
|
|
|
debug(`get: ${name} in zone ${zoneName} of type ${type}`);
|
|
|
|
const data = {
|
|
secretapikey: domainConfig.secretapikey,
|
|
apikey: domainConfig.apikey,
|
|
};
|
|
|
|
const [error, response] = await safe(superagent.post(`${PORKBUN_API}/retrieveByNameType/${zoneName}/${type}/${name}`)
|
|
.retry(5)
|
|
.send(data)
|
|
.timeout(30 * 1000)
|
|
.ok(() => true));
|
|
|
|
if (error) throw new BoxError(BoxError.NETWORK_ERROR, error.message);
|
|
if (response.statusCode !== 200) throw new BoxError(BoxError.EXTERNAL_ERROR, formatError(response));
|
|
if (response.body.status !== 'SUCCESS') throw new BoxError(BoxError.EXTERNAL_ERROR, `Invalid status in response: ${JSON.stringify(response.body)}`);
|
|
if (!Array.isArray(response.body.records)) throw new BoxError(BoxError.EXTERNAL_ERROR, `Invalid records in response: ${JSON.stringify(response.body)}`);
|
|
|
|
// TXT records are returned without quoting. When no records match, it returns empty records array
|
|
return response.body.records;
|
|
}
|
|
|
|
async function delDnsRecords(domainConfig, zoneName, name, type) {
|
|
assert.strictEqual(typeof domainConfig, 'object');
|
|
assert.strictEqual(typeof zoneName, 'string');
|
|
assert.strictEqual(typeof name, 'string');
|
|
assert.strictEqual(typeof type, 'string');
|
|
|
|
const data = {
|
|
secretapikey: domainConfig.secretapikey,
|
|
apikey: domainConfig.apikey,
|
|
};
|
|
|
|
// deletes all the records matching type+name
|
|
const [error, response] = await safe(superagent.post(`${PORKBUN_API}/deleteByNameType/${zoneName}/${type}/${name}`)
|
|
.retry(5)
|
|
.send(data)
|
|
.timeout(30 * 1000)
|
|
.ok(() => true));
|
|
|
|
if (error) throw new BoxError(BoxError.NETWORK_ERROR, error.message);
|
|
if (response.statusCode === 400) return; // not found, "Could not delete record."
|
|
if (response.statusCode !== 200) throw new BoxError(BoxError.EXTERNAL_ERROR, formatError(response));
|
|
if (response.body.status !== 'SUCCESS') throw new BoxError(BoxError.EXTERNAL_ERROR, `Invalid status in response: ${JSON.stringify(response.body)}`);
|
|
}
|
|
|
|
async function upsert(domainObject, location, type, values) {
|
|
assert.strictEqual(typeof domainObject, 'object');
|
|
assert.strictEqual(typeof location, 'string');
|
|
assert.strictEqual(typeof type, 'string');
|
|
assert(Array.isArray(values));
|
|
|
|
const domainConfig = domainObject.config,
|
|
zoneName = domainObject.zoneName,
|
|
name = dns.getName(domainObject, location, type) || '';
|
|
|
|
debug(`upsert: ${name} in zone ${zoneName} of type ${type} with values ${JSON.stringify(values)}`);
|
|
|
|
await delDnsRecords(domainConfig, zoneName, name, type);
|
|
|
|
for (const value of values) {
|
|
const data = {
|
|
secretapikey: domainConfig.secretapikey,
|
|
apikey: domainConfig.apikey,
|
|
ttl: '10', // 600 seems to be minimum anyway
|
|
type,
|
|
name
|
|
};
|
|
|
|
if (type === 'MX') {
|
|
data.prio = value.split(' ')[0]; // string
|
|
data.content = value.split(' ')[1];
|
|
} else if (type === 'TXT') { // strip quotes
|
|
data.content = value.startsWith('"') && value.endsWith('"') ? value.slice(1, value.length-1) : value;
|
|
} else {
|
|
data.content = value;
|
|
}
|
|
|
|
const [error, response] = await safe(superagent.post(`${PORKBUN_API}/create/${zoneName}`)
|
|
.retry(5)
|
|
.timeout(30 * 1000)
|
|
.send(data)
|
|
.ok(() => true));
|
|
|
|
if (error) throw new BoxError(BoxError.NETWORK_ERROR, error.message);
|
|
if (response.statusCode !== 200) throw new BoxError(BoxError.EXTERNAL_ERROR, formatError(response));
|
|
if (response.body.status !== 'SUCCESS') throw new BoxError(BoxError.EXTERNAL_ERROR, `Invalid status in response: ${JSON.stringify(response.body)}`);
|
|
if (!response.body.id) throw new BoxError(BoxError.EXTERNAL_ERROR, `Invalid id in response: ${JSON.stringify(response.body)}`);
|
|
|
|
debug(`upsert: created record with id ${response.body.id}`);
|
|
|
|
await timers.setTimeout(1500); // see rate limit note at top of file
|
|
}
|
|
}
|
|
|
|
async function get(domainObject, location, type) {
|
|
assert.strictEqual(typeof domainObject, 'object');
|
|
assert.strictEqual(typeof location, 'string');
|
|
assert.strictEqual(typeof type, 'string');
|
|
|
|
const domainConfig = domainObject.config,
|
|
zoneName = domainObject.zoneName,
|
|
name = dns.getName(domainObject, location, type) || '';
|
|
|
|
const records = await getDnsRecords(domainConfig, zoneName, name, type);
|
|
return records.map(r => r.content);
|
|
}
|
|
|
|
async function del(domainObject, location, type, values) {
|
|
assert.strictEqual(typeof domainObject, 'object');
|
|
assert.strictEqual(typeof location, 'string');
|
|
assert.strictEqual(typeof type, 'string');
|
|
assert(Array.isArray(values));
|
|
|
|
const domainConfig = domainObject.config,
|
|
zoneName = domainObject.zoneName,
|
|
name = dns.getName(domainObject, location, type) || '';
|
|
|
|
debug(`del: ${name} in zone ${zoneName} of type ${type} with values ${JSON.stringify(values)}`);
|
|
|
|
const data = {
|
|
secretapikey: domainConfig.secretapikey,
|
|
apikey: domainConfig.apikey,
|
|
};
|
|
|
|
// note that deleteByNameType deletes all the records matching type+name. we only want to delete records matching values
|
|
const records = await getDnsRecords(domainConfig, zoneName, name, type);
|
|
const ids = records.filter(r => values.includes(r.content)).map(r => r.id);
|
|
|
|
for (const id of ids) {
|
|
const [error, response] = await safe(superagent.post(`${PORKBUN_API}/delete/${zoneName}/${id}`)
|
|
.retry(5)
|
|
.send(data)
|
|
.timeout(30 * 1000)
|
|
.ok(() => true));
|
|
|
|
if (error) throw new BoxError(BoxError.NETWORK_ERROR, error.message);
|
|
if (response.statusCode === 400) continue; // not found! "Invalid record id."
|
|
if (response.statusCode !== 200) throw new BoxError(BoxError.EXTERNAL_ERROR, formatError(response));
|
|
if (response.body.status !== 'SUCCESS') throw new BoxError(BoxError.EXTERNAL_ERROR, `Invalid status in response: ${JSON.stringify(response.body)}`);
|
|
|
|
await timers.setTimeout(1500); // see rate limit note at top of file
|
|
}
|
|
}
|
|
|
|
async function wait(domainObject, subdomain, type, value, options) {
|
|
assert.strictEqual(typeof domainObject, 'object');
|
|
assert.strictEqual(typeof subdomain, 'string');
|
|
assert.strictEqual(typeof type, 'string');
|
|
assert.strictEqual(typeof value, 'string');
|
|
assert(options && typeof options === 'object'); // { interval: 5000, times: 50000 }
|
|
|
|
const fqdn = dns.fqdn(subdomain, domainObject.domain);
|
|
|
|
await waitForDns(fqdn, domainObject.zoneName, type, value, options);
|
|
}
|
|
|
|
async function verifyDomainConfig(domainObject) {
|
|
assert.strictEqual(typeof domainObject, 'object');
|
|
|
|
const domainConfig = domainObject.config,
|
|
zoneName = domainObject.zoneName;
|
|
|
|
if (!domainConfig.secretapikey || typeof domainConfig.secretapikey !== 'string') throw new BoxError(BoxError.BAD_FIELD, 'secretapikey must be a non-empty string');
|
|
if (!domainConfig.apikey || typeof domainConfig.apikey !== 'string') throw new BoxError(BoxError.BAD_FIELD, 'apikey must be a non-empty string');
|
|
|
|
const ip = '127.0.0.1';
|
|
|
|
const credentials = {
|
|
secretapikey: domainConfig.secretapikey,
|
|
apikey: domainConfig.apikey
|
|
};
|
|
|
|
if (process.env.BOX_ENV === 'test') return credentials; // this shouldn't be here
|
|
|
|
const [error, nameservers] = await safe(dig.resolve(zoneName, 'NS', { timeout: 5000 }));
|
|
if (error && error.code === 'ENOTFOUND') throw new BoxError(BoxError.BAD_FIELD, 'Unable to resolve nameservers for this domain');
|
|
if (error || !nameservers) throw new BoxError(BoxError.BAD_FIELD, error ? error.message : 'Unable to get nameservers');
|
|
|
|
if (!nameservers.every(function (n) { return n.toLowerCase().indexOf('.ns.porkbun.com') !== -1; })) {
|
|
debug('verifyDomainConfig: %j does not contain Porkbun NS', nameservers);
|
|
throw new BoxError(BoxError.BAD_FIELD, 'Domain nameservers are not set to Porkbun');
|
|
}
|
|
|
|
const location = 'cloudrontestdns';
|
|
|
|
await upsert(domainObject, location, 'A', [ ip ]);
|
|
debug('verifyDomainConfig: Test A record added');
|
|
|
|
await del(domainObject, location, 'A', [ ip ]);
|
|
debug('verifyDomainConfig: Test A record removed again');
|
|
|
|
return credentials;
|
|
}
|