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

Compare commits

merge into: coolaj86:fixes
Branches Tags
coolaj86:master
coolaj86:fixes
coolaj86:v3.0.1
coolaj86:v3.0.0
...
pull from: coolaj86:master
Branches Tags
coolaj86:master
coolaj86:fixes
coolaj86:v3.0.1
coolaj86:v3.0.0

6 Commits
fixes ... master

Author SHA1 Message Date
AJ ONeal
4ad4cf29f4 v3.0.1: fix typo in URL 2019-09-21 14:34:08 -06:00
AJ ONeal
d9b9b0fcd6 v3.0.0: NameCheap DNS + Let's Encrypt for Node.js 2019-07-23 02:25:11 -06:00
AJ ONeal
705902ff32 bugfix: list all zones 2019-07-23 02:24:47 -06:00
AJ ONeal
91a8c8b237 doc and cleanup 2019-07-23 02:24:03 -06:00
AJ ONeal
4b8a7d2e00 minor cleanup 2019-07-23 02:12:08 -06:00
AJ ONeal
ff8c41b994 make prettier 2019-07-23 01:59:52 -06:00
5 changed files with 314 additions and 261 deletions
Show Stats Expand all files Collapse all files

12
README.md
View File

@ -1,4 +1,4 @@
# [acme-dns-01-namecheap](https://git.rootprojects.org/root/acme-dns-01-namecheap) | a [Root](https://rootrpojects.org) project
# [acme-dns-01-namecheap](https://git.rootprojects.org/root/acme-dns-01-namecheap.js) | a [Root](https://rootrpojects.org) project
NameCheap DNS + Let's Encrypt
@ -17,11 +17,11 @@ First you create an instance with your credentials:
```js
var dns01 = require('acme-dns-01-namecheap').create({
apiUser: 'username',
apiKey: 'xxxx',
clientIp: 'public ip',
username: 'api user',
baseUrl: 'sandbox or production' // default production
apiUser: 'jdoe',
apiKey: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
clientIp: '121.22.123.22',
username: 'jdoe',
baseUrl: 'https://api.namecheap.com/xml.response' // default
});
```

2
example.env
View File

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

178
lib/index.js
View File

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

6
package-lock.json generated
View File

@ -35,6 +35,12 @@
"acme-challenge-test": "^3.3.1"
}
},
"dotenv": {
"version": "8.0.0",
"resolved": "https://registry.npmjs.org/dotenv/-/dotenv-8.0.0.tgz",
"integrity": "sha512-30xVGqjLjiUOArT4+M5q9sYdvuR4riM6yK9wMcas9Vbp6zZa+ocC9dp6QoftuhTPhFAiLK/0C5Ni2nou/Bk8lg==",
"dev": true
},
"sax": {
"version": "1.2.4",
"resolved": "https://registry.npmjs.org/sax/-/sax-1.2.4.tgz",

9
package.json
View File

@ -1,8 +1,12 @@
{
"name": "acme-dns-01-namecheap",
"version": "3.0.0",
"version": "3.0.1",
"description": "Namecheap DNS for Let's Encrypt / ACME dns-01 challenges with ACME.js and Greenlock.js",
"main": "index.js",
"files": [
"lib",
"test.js"
],
"scripts": {
"test": "node ./test.js"
},
@ -31,6 +35,7 @@
},
"devDependencies": {
"acme-challenge-test": "^3.3.2",
"acme-dns-01-test": "^3.2.1"
"acme-dns-01-test": "^3.2.1",
"dotenv": "^8.0.0"
}
}