coolaj86/acme-dns-01-namecheap.js
1
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity

Compare commits

base: coolaj86:0b387a150fefeb5c555f5db3102f26b7203de3bc
Branches Tags
coolaj86:master
coolaj86:fixes
coolaj86:v3.0.1
coolaj86:v3.0.0
..
compare: coolaj86:9071b0c048645f859cb8bb470df2d5f1c50b4efd
Branches Tags
coolaj86:master
coolaj86:fixes
coolaj86:v3.0.1
coolaj86:v3.0.0

No commits in common. "0b387a150fefeb5c555f5db3102f26b7203de3bc" and "9071b0c048645f859cb8bb470df2d5f1c50b4efd" have entirely different histories.
0b387a150f ... 9071b0c048

7 changed files with 244 additions and 421 deletions
Show Stats Expand all files Collapse all files

80
.gitignore vendored
View File

@ -1,78 +1,2 @@
# ---> Node node_modules
# Logs package-lock.json
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
# Runtime data
pids
*.pid
*.seed
*.pid.lock
# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by tools like istanbul
coverage
# nyc test coverage
.nyc_output
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt
# Bower dependency directory (https://bower.io/)
bower_components
# node-waf configuration
.lock-wscript
# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release
# Dependency directories
node_modules/
jspm_packages/
# TypeScript v1 declaration files
typings/
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
*.tgz
# Yarn Integrity file
.yarn-integrity
# dotenv environment variables file
.env
# parcel-bundler cache (https://parceljs.org/)
.cache
# next.js build output
.next
# nuxt.js build output
.nuxt
# vuepress build output
.vuepress/dist
# Serverless directories
.serverless
# FuseBox cache
.fusebox/

38
README.md
View File

@ -2,6 +2,7 @@
NameCheap DNS + Let's Encrypt NameCheap DNS + Let's Encrypt
This handles ACME dns-01 challenges, compatible with ACME.js and Greenlock.js. This handles ACME dns-01 challenges, compatible with ACME.js and Greenlock.js.
Passes [acme-dns-01-test](https://git.rootprojects.org/root/acme-dns-01-test.js). Passes [acme-dns-01-test](https://git.rootprojects.org/root/acme-dns-01-test.js).
@ -17,11 +18,11 @@ First you create an instance with your credentials:
```js ```js
var dns01 = require('acme-dns-01-namecheap').create({ var dns01 = require('acme-dns-01-namecheap').create({
apiUser: 'username', apiUser:'username',
apiKey: 'xxxx', apiKey : 'xxxx',
clientIp: 'public ip', clientIp:'public ip',
username: 'api user', username: 'api user',
baseUrl: 'sandbox or production' // default production baseUrl: 'sandbox or production', // default production
}); });
``` ```
@ -55,18 +56,18 @@ See the [ACME.js](https://git.rootprojects.org/root/acme-v2.js) for more details
```js ```js
dns01 dns01
.set({ .set({
identifier: { value: 'foo.example.com' }, identifier: { value: 'foo.example.com' },
wildcard: false, wildcard: false,
dnsHost: '_acme-challenge.foo.example.com', dnsHost: '_acme-challenge.foo.example.com',
dnsAuthorization: 'xxx_secret_xxx' dnsAuthorization: 'xxx_secret_xxx'
}) })
.then(function() { .then(function () {
console.log('TXT record set'); console.log("TXT record set");
}) })
.catch(function() { .catch(function () {
console.log('Failed to set TXT record'); console.log("Failed to set TXT record");
}); });
``` ```
See [acme-dns-01-test](https://git.rootprojects.org/root/acme-dns-01-test.js) See [acme-dns-01-test](https://git.rootprojects.org/root/acme-dns-01-test.js)
@ -76,5 +77,6 @@ for more implementation details.
```bash ```bash
# node ./test.js domain-zone api-user api-key client-ip username [username is optional if similar to api-user] # node ./test.js domain-zone api-user api-key client-ip username [username is optional if similar to api-user]
node ./test.js example.com demo d41474b94e7d4536baabb074a09c96bd 45.77.4.126 node ./test.js example.com demo 45.77.4.126 d41474b94e7d4536baabb074a09c96bd
``` ```

6
example.env
View File

@ -1,6 +0,0 @@
ZONE=example.co.uk
API_USER=exampleuser
API_KEY=xxxxxxxxxxxxxxx
USERNAME=exampleuser
CLIENT_IP=121.22.123.22

387
lib/index.js
View File

@ -5,263 +5,222 @@ var request; // = require('@root/request');
var parseString = require('xml2js').parseString; var parseString = require('xml2js').parseString;
parseString = util.promisify(parseString); parseString = util.promisify(parseString);
const SANDBOX_URL = 'https://api.sandbox.namecheap.com/xml.response'; const SANDBOX_URL = 'https://api.sandbox.namecheap.com/xml.response';
const PRODUCTION_URL = 'https://api.namecheap.com/xml.response'; const PRODUCTION_URL = 'https://api.namecheap.com/xml.response';
var defaults = { var defaults = {
baseUrl: SANDBOX_URL baseUrl: SANDBOX_URL
}; };
function extend(obj) { function extend(obj) {
var newObj = {}; var newObj = {};
for (var i in obj) { for (var i in obj) {
if (obj.hasOwnProperty(i)) { if (obj.hasOwnProperty(i)) {
newObj[i] = obj[i]; newObj[i] = obj[i];
} }
} }
return newObj; return newObj;
} }
function assign(obj1, obj2) { function assign(obj1,obj2) {
for (var attrname in obj2) { for (var attrname in obj2) { obj1[attrname] = obj2[attrname]; }
obj1[attrname] = obj2[attrname];
}
} }
function requestUrl(baseUrl, params) { function requestUrl(baseUrl, params) {
var queryString = Object.keys(params) var queryString = Object.keys(params).map(function (key) {
.map(function(key) { return encodeURIComponent(key) + '=' + encodeURIComponent(params[key]);
return ( }).join('&');
encodeURIComponent(key) + '=' + encodeURIComponent(params[key]) // console.debug(queryString);
); return baseUrl + '?' + queryString;
})
.join('&');
// console.debug(queryString);
return baseUrl + '?' + queryString;
} }
module.exports.create = function(config) { module.exports.create = function (config) {
// config = { baseUrl, token } // config = { baseUrl, token }
var baseUrl = config.baseUrl || defaults.baseUrl; var baseUrl = config.baseUrl || defaults.baseUrl;
var globalParams = { var globalParams = {
apiUser: config.apiUser, apiUser: config.apiUser,
apiKey: config.apiKey, apiKey: config.apiKey,
username: config.username, username: config.username,
ClientIp: config.clientIp ClientIp: config.clientIp
}; };
function api(command, params) { function api(command, params) {
var requestParams = extend(globalParams); var requestParams = extend(globalParams);
requestParams['Command'] = command; requestParams['Command'] = command;
assign(requestParams, params); assign(requestParams,params);
var url = requestUrl(baseUrl, requestParams); var url = requestUrl(baseUrl, requestParams);
console.log('DEBUG >>> url: ' + url); console.log('DEBUG >>> url: ' + url);
console.log( console.log('DEBUG >>> requestParams: ' + JSON.stringify(requestParams, null, 2));
'DEBUG >>> requestParams: ' + JSON.stringify(requestParams, null, 2)
);
return request({ return request({
method: 'POST', method: 'POST',
url: url url: url,
}).then(function(response) { }).then(function (response) {
var responseBody = response.body; var responseBody = response.body;
// console.log(responseBody); // console.log(responseBody);
return parseString(responseBody).then(function(result) { return parseString(responseBody).then(function (result) {
// check response status // check response status
if (result['ApiResponse']['$']['Status'] === 'ERROR') { if (result['ApiResponse']['$']['Status'] === 'ERROR') {
for ( for (let i = 0; i < result['ApiResponse']['Errors'].length; i++) {
let i = 0; console.log('DEBUG >>> error: ' + JSON.stringify(result['ApiResponse']['Errors'][i]['Error'][0], null, 2));
i < result['ApiResponse']['Errors'].length; }
i++ throw new Error('API Error');
) { } else { // Status="OK"
console.log( return result['ApiResponse']['CommandResponse'][0]
'DEBUG >>> error: ' + }
JSON.stringify( });
result['ApiResponse']['Errors'][i][ });
'Error' }
][0],
null,
2
)
);
}
throw new Error('API Error');
} else {
// Status="OK"
return result['ApiResponse']['CommandResponse'][0];
}
});
});
}
return { return {
init: function(deps) { init: function (deps) {
request = deps.request; request = deps.request;
return null; return null;
}, },
zones: function(data) { zones: function(data) {
return api('namecheap.domains.getList', {}).then(function( return api('namecheap.domains.getList',{}).then(function (zonesResponse) {
zonesResponse // console.log('zones');
) { // console.log(zonesResponse);
// console.log('zones'); return zonesResponse['DomainGetListResult'].map(function (x) {
// console.log(zonesResponse); return x['Domain'][0]['$']['Name'];
return zonesResponse['DomainGetListResult'].map(function(x) { });
return x['Domain'][0]['$']['Name'];
});
});
},
set: function(data) { });
console.log(`DEBUG >>> data: ${JSON.stringify(data, null, 2)}`); },
var ch = data.challenge;
var txt = ch.dnsAuthorization;
var params = {}; set: function (data) {
// var zone = ch.dnsZone; console.log(`DEBUG >>> data: ${JSON.stringify(data, null, 2)}`);
var zone = ch.identifier.value; var ch = data.challenge;
console.log(`DEBUG >>> zone: ${zone}`); var txt = ch.dnsAuthorization;
// the domain is the first part var params = {};
// params['SLD'] = zone.split('.')[0]; // var zone = ch.dnsZone;
// the rest of the components are the TLD var zone = ch.identifier.value;
// params['TLD'] = zone.split('.').splice(1).join('.'); console.log(`DEBUG >>> zone: ${zone}`);
var domains = zone.split('.'); // the domain is the first part
console.log('DEBUG >>> ' + domains); // params['SLD'] = zone.split('.')[0];
// the rest of the components are the TLD
// params['TLD'] = zone.split('.').splice(1).join('.');
// if you have subdomain foo.blah.com, SLD = blah and TLD = com var domains = zone.split('.');
params['TLD'] = domains[domains.length - 1]; console.log('DEBUG >>> ' + domains);
params['SLD'] = domains[domains.length - 2];
console.log(`DEBUG >>> SLD: ${params['SLD']}`); // if you have subdomain foo.blah.com, SLD = blah and TLD = com
console.log(`DEBUG >>> TLD: ${params['TLD']}`); params['TLD'] = domains[domains.length - 1];
params['SLD'] = domains[domains.length - 2];
// setting a host record overwrites all existing, console.log(`DEBUG >>> SLD: ${params['SLD']}`);
// adding a new records means you've have to send back all previous records too console.log(`DEBUG >>> TLD: ${params['TLD']}`);
return api('namecheap.domains.dns.getHosts', params).then(function( // setting a host record overwrites all existing,
hostsResponse // adding a new records means you've have to send back all previous records too
) {
var currentHostRecordsCount =
hostsResponse['DomainDNSGetHostsResult'][0]['host'].length;
for (var i = 0; i < currentHostRecordsCount; i++) { return api('namecheap.domains.dns.getHosts',params).then(function (hostsResponse) {
// console.log(hostsResponse['DomainDNSGetHostsResult'][i]['host'][0]); var currentHostRecordsCount = hostsResponse['DomainDNSGetHostsResult'][0]['host'].length;
var currentEntry =
hostsResponse['DomainDNSGetHostsResult'][0]['host'][i][
'$'
];
params['HostName' + (i + 1)] = currentEntry['Name']; for (var i = 0; i < currentHostRecordsCount; i++) {
params['RecordType' + (i + 1)] = currentEntry['Type']; // console.log(hostsResponse['DomainDNSGetHostsResult'][i]['host'][0]);
params['Address' + (i + 1)] = currentEntry['Address']; var currentEntry = hostsResponse['DomainDNSGetHostsResult'][0]['host'][i]['$'];
params['TTL' + (i + 1)] = currentEntry['TTL'];
}
params['HostName' + (currentHostRecordsCount + 1)] = params['HostName'+(i+1)] = currentEntry['Name'];
ch.dnsPrefix; params['RecordType'+(i+1)] = currentEntry['Type'];
params['RecordType' + (currentHostRecordsCount + 1)] = 'TXT'; params['Address'+(i+1)] = currentEntry['Address'];
params['Address' + (currentHostRecordsCount + 1)] = txt; params['TTL'+(i+1)] = currentEntry['TTL'];
params['TTL' + (currentHostRecordsCount + 1)] = 100; // in minutes }
// console.log(params); params['HostName'+(currentHostRecordsCount+1)] = ch.dnsPrefix;
params['RecordType'+(currentHostRecordsCount+1)] = 'TXT';
params['Address'+(currentHostRecordsCount+1)] = txt;
params['TTL'+(currentHostRecordsCount+1)] = 100; // in minutes
return api('namecheap.domains.dns.setHosts', params) // console.log(params);
.then(function(setHostResponse) {
// console.log('setHost');
// console.log(setHostResponse);
return true;
})
.catch(function(err) {
throw new Error(
'record did not set. check subdomain, api key, etc'
);
});
});
},
remove: function(data) {
var ch = data.challenge;
var params = {}; return api('namecheap.domains.dns.setHosts',params).then(function (setHostResponse) {
var zone = ch.identifier.value; // console.log('setHost');
var domains = zone.split('.'); // console.log(setHostResponse);
return true
}).catch(function (err) {
throw new Error('record did not set. check subdomain, api key, etc');
});
});
params['TLD'] = domains[domains.length - 1]; },
params['SLD'] = domains[domains.length - 2]; remove: function (data) {
var ch = data.challenge;
// setting a host record overwrites all existing, var params = {};
// removing a new records means you've have to send back all previous records without removed var zone = ch.identifier.value;
var domains = zone.split('.');
return api('namecheap.domains.dns.getHosts', params).then(function( params['TLD'] = domains[domains.length - 1];
hostsResponse params['SLD'] = domains[domains.length - 2];
) {
var currentHostRecordsCount =
hostsResponse['DomainDNSGetHostsResult'][0]['host'].length;
for (var i = 0; i < currentHostRecordsCount; i++) { // setting a host record overwrites all existing,
// console.log(hostsResponse['DomainDNSGetHostsResult'][i]['host'][0]); // removing a new records means you've have to send back all previous records without removed
var currentEntry =
hostsResponse['DomainDNSGetHostsResult'][0]['host'][i][
'$'
];
if (currentEntry['Address'] != ch.dnsAuthorization) {
params['HostName' + (i + 1)] = currentEntry['Name'];
params['RecordType' + (i + 1)] = currentEntry['Type'];
params['Address' + (i + 1)] = currentEntry['Address'];
params['TTL' + (i + 1)] = currentEntry['TTL'];
}
}
return api('namecheap.domains.dns.setHosts', params) return api('namecheap.domains.dns.getHosts',params).then(function (hostsResponse) {
.then(function(setHostResponse) { var currentHostRecordsCount = hostsResponse['DomainDNSGetHostsResult'][0]['host'].length;
// console.log('setHost');
// console.log(setHostResponse);
return true;
})
.catch(function(err) {
throw new Error(
'record did not remove. check subdomain, api key, etc'
);
});
});
},
get: function(data) {
var ch = data.challenge;
var params = {}; for (var i = 0; i < currentHostRecordsCount; i++) {
var zone = ch.identifier.value; // console.log(hostsResponse['DomainDNSGetHostsResult'][i]['host'][0]);
var domains = zone.split('.'); var currentEntry = hostsResponse['DomainDNSGetHostsResult'][0]['host'][i]['$'];
if(currentEntry['Address'] != ch.dnsAuthorization){
params['HostName'+(i+1)] = currentEntry['Name'];
params['RecordType'+(i+1)] = currentEntry['Type'];
params['Address'+(i+1)] = currentEntry['Address'];
params['TTL'+(i+1)] = currentEntry['TTL'];
}
}
params['TLD'] = domains[domains.length - 1]; return api('namecheap.domains.dns.setHosts',params).then(function (setHostResponse) {
params['SLD'] = domains[domains.length - 2]; // console.log('setHost');
// console.log(setHostResponse);
return true
}).catch(function (err) {
throw new Error('record did not remove. check subdomain, api key, etc');
});
});
return api('namecheap.domains.dns.getHosts', params).then(function( },
hostsResponse get: function (data) {
) { var ch = data.challenge;
// console.log('hosts');
// console.log(hostsResponse);
var currentHostRecords =
hostsResponse['DomainDNSGetHostsResult'][0]['host'];
var entries = currentHostRecords.filter(function(x) { var params = {};
return x['$']['Type'] === 'TXT'; var zone = ch.identifier.value;
}); var domains = zone.split('.');
var entry = entries.filter(function(x) { params['TLD'] = domains[domains.length - 1];
// console.log('data', x.data); params['SLD'] = domains[domains.length - 2];
// console.log('dnsAuth', ch.dnsAuthorization, ch);
return x['$']['Address'] === ch.dnsAuthorization;
})[0];
if (entry) { return api('namecheap.domains.dns.getHosts',params).then(function (hostsResponse) {
return { dnsAuthorization: entry['$']['Address'] }; // console.log('hosts');
} else { // console.log(hostsResponse);
return null; var currentHostRecords = hostsResponse['DomainDNSGetHostsResult'][0]['host'];
}
}); var entries = currentHostRecords.filter(function (x) {
} return x['$']['Type'] === 'TXT';
}; });
var entry = entries.filter(function (x) {
// console.log('data', x.data);
// console.log('dnsAuth', ch.dnsAuthorization, ch);
return x['$']['Address'] === ch.dnsAuthorization;
})[0];
if (entry) {
return {dnsAuthorization: entry['$']['Address']};
} else {
return null;
}
});
}
};
}; };

49
package-lock.json generated
View File

@ -1,49 +0,0 @@
{
"name": "acme-dns-01-namecheap",
"version": "3.0.0",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
"@root/request": {
"version": "1.3.11",
"resolved": "https://registry.npmjs.org/@root/request/-/request-1.3.11.tgz",
"integrity": "sha512-3a4Eeghcjsfe6zh7EJ+ni1l8OK9Fz2wL1OjP4UCa0YdvtH39kdXB9RGWuzyNv7dZi0+Ffkc83KfH0WbPMiuJFw=="
},
"acme-challenge-test": {
"version": "3.3.2",
"resolved": "https://registry.npmjs.org/acme-challenge-test/-/acme-challenge-test-3.3.2.tgz",
"integrity": "sha512-0AbMcaON20wpI5vzFDAqwcv2VerY4xIlNCqX0w1xEJUIu/EQtQNmkje+rKNuy2TUl2KBMdIaR6YBbJUdaEiC4w==",
"dev": true,
"requires": {
"@root/request": "^1.3.11"
},
"dependencies": {
"@root/request": {
"version": "1.3.11",
"resolved": "https://registry.npmjs.org/@root/request/-/request-1.3.11.tgz",
"integrity": "sha512-3a4Eeghcjsfe6zh7EJ+ni1l8OK9Fz2wL1OjP4UCa0YdvtH39kdXB9RGWuzyNv7dZi0+Ffkc83KfH0WbPMiuJFw==",
"dev": true
}
}
},
"sax": {
"version": "1.2.4",
"resolved": "https://registry.npmjs.org/sax/-/sax-1.2.4.tgz",
"integrity": "sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw=="
},
"xml2js": {
"version": "0.4.19",
"resolved": "https://registry.npmjs.org/xml2js/-/xml2js-0.4.19.tgz",
"integrity": "sha512-esZnJZJOiJR9wWKMyuvSE1y6Dq5LCuJanqhxslH2bxM6duahNZ+HMpCLhBQGZkbX6xRf8x1Y2eJlgt2q3qo49Q==",
"requires": {
"sax": ">=0.6.0",
"xmlbuilder": "~9.0.1"
}
},
"xmlbuilder": {
"version": "9.0.7",
"resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-9.0.7.tgz",
"integrity": "sha1-Ey7mPS7FVlxVfiD0wi35rKaGsQ0="
}
}
}

70
package.json
View File

@ -1,39 +1,35 @@
{ {
"name": "acme-dns-01-namecheap", "name": "acme-dns-01-namecheap",
"version": "3.0.0", "version": "3.0.0",
"description": "Namecheap DNS for Let's Encrypt / ACME dns-01 challenges with ACME.js and Greenlock.js", "description": "Namecheap DNS for Let's Encrypt / ACME dns-01 challenges with ACME.js and Greenlock.js",
"main": "index.js", "main": "index.js",
"files": [ "scripts": {
"lib", "test": "node ./test.js"
"test.js" },
], "repository": {
"scripts": { "type": "git",
"test": "node ./test.js" "url": "https://git.coolaj86.com/coolaj86/acme-dns-01-namecheap.js.git"
}, },
"repository": { "keywords": [
"type": "git", "namecheap",
"url": "https://git.coolaj86.com/coolaj86/acme-dns-01-namecheap.js.git" "name-cheap",
}, "dns",
"keywords": [ "dns-01",
"namecheap", "letsencrypt",
"name-cheap", "acme",
"dns", "greenlock"
"dns-01", ],
"letsencrypt", "author": "AJ ONeal <coolaj86@gmail.com> (https://coolaj86.com/)",
"acme", "contributors": [
"greenlock" "Nyaundi Brian <danleyb2@gmail.com> (https://git.coolaj86.com/danleyb2/)",
], "Archie Baer <archie@abaer.dev> (https://abaer.dev)"
"author": "AJ ONeal <coolaj86@gmail.com> (https://coolaj86.com/)", ],
"contributors": [ "license": "MPL-2.0",
"Nyaundi Brian <danleyb2@gmail.com> (https://git.coolaj86.com/danleyb2/)", "dependencies": {
"Archie Baer <archie@abaer.dev> (https://abaer.dev)" "@root/request": "^1.3.11",
], "xml2js": "^0.4.19"
"license": "MPL-2.0", },
"dependencies": { "devDependencies": {
"@root/request": "^1.3.11", "acme-dns-01-test": "^3.2.1"
"xml2js": "^0.4.19" }
},
"devDependencies": {
"acme-challenge-test": "^3.3.2"
}
} }

33
test.js
View File

@ -3,31 +3,28 @@
// https://git.rootprojects.org/root/acme-dns-01-test.js // https://git.rootprojects.org/root/acme-dns-01-test.js
var tester = require('acme-challenge-test'); var tester = require('acme-challenge-test');
require('dotenv').config();
// Usage: node ./test.js example.com xxxxxxxxx // Usage: node ./test.js example.com xxxxxxxxx
var zone = process.argv[2] || process.env.ZONE; var zone = process.argv[2];
var challenger = require('./index.js').create({ var challenger = require('./index.js').create({
apiUser: process.argv[3] || process.env.API_USER, apiUser:process.argv[3],
apiKey: process.argv[4] || process.env.API_KEY || process.env.TOKEN, apiKey : process.argv[4],
clientIp: process.argv[5] || process.env.CLIENT_IP, clientIp:process.argv[5],
username: username: process.argv[6] || process.argv[3]
process.argv[6] ||
process.env.USERNAME ||
process.argv[3] ||
process.env.API_USER
}); });
// The dry-run tests can pass on, literally, 'example.com' // The dry-run tests can pass on, literally, 'example.com'
// but the integration tests require that you have control over the domain // but the integration tests require that you have control over the domain
tester tester
.testZone('dns-01', zone, challenger) .testZone('dns-01', zone, challenger)
.then(function() { .then(function() {
console.info('PASS', zone); console.info('PASS', zone);
}) })
.catch(function(e) { .catch(function(e) {
console.info('FAIL', zone); console.info('FAIL', zone);
console.error(e.message); console.error(e.message);
console.error(e.stack); console.error(e.stack);
}); });