Compare commits

..

7 Commits

Author SHA1 Message Date
AJ ONeal 9f86ee8d32 add .jshintrc 2019-07-07 22:38:56 -06:00
AJ ONeal 54cc80e1e5 v3.0.1: fix link typo 2019-07-03 22:40:47 -06:00
AJ ONeal 9778ac3ccf v3.0.1: fix link typo 2019-07-03 22:33:46 -06:00
AJ ONeal 79a8329179 v3.0.0: initial release 2019-06-15 11:30:02 -06:00
Aneem 96a1f55a08 -- wrapped request to api call. Modified Authors 2019-06-14 11:19:52 +05:45
AJ ONeal 333957ca3d typo fix main linkback 2019-06-13 03:42:00 -06:00
AJ ONeal 6abecd8e12 link again to test 2019-06-13 03:38:50 -06:00
7 changed files with 124 additions and 80 deletions

1
.gitignore vendored
View File

@ -1 +1,2 @@
*secret*
node_modules/

1
.jshintrc Symbolic link
View File

@ -0,0 +1 @@
/Users/aj/dotfiles/dummy/.jshintrc

View File

@ -1 +1,2 @@
AJ ONeal <coolaj86@gmail.com> (https://coolaj86.com/)
Aneem Patrabansha <aneempp@gmail.com> (https://aneem.com.np)

View File

@ -1,8 +1,20 @@
# [acme-dns-01-digitalocean](https://git.rootprojects.org/root/acme-dns-01-digitalocean) | a [Root](https://rootrpojects.org) project
# [acme-dns-01-digitalocean](https://git.rootprojects.org/root/acme-dns-01-digitalocean.js) | a [Root](https://rootprojects.org) project
Digital Ocean DNS + Let's Encrypt for Node.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).
## Features
- Compatible
- [x] Let's Encrypt v2.1 / ACME draft 18 (2019)
- [x] Digital Ocean v2 API
- [x] ACME.js, Greenlock.js, and others
- Quality
- [x] node v6 compatible VanillaJS
- [x] &lt; 150 lines of code
- [x] **Zero Dependencies**
# Install
@ -10,18 +22,22 @@ This handles ACME dns-01 challenges, compatible with ACME.js and Greenlock.js.
npm install --save acme-dns-01-digitalocean@3.x
```
Generate Digital Ocean API Token:
- <https://cloud.digitalocean.com/account/api/tokens>
# Usage
First you create an instance with your credentials:
```js
var dns01 = require('acme-dns-01-digitalocean').create({
baseUrl: 'https://api.digitalocean.com', // default
baseUrl: 'https://api.digitalocean.com/v2/domains', // default
token: 'xxxx'
});
```
Then you can use it with any compatible ACME module,
Then you can use it with any compatible ACME library,
such as Greenlock.js or ACME.js.
### Greenlock.js
@ -36,8 +52,9 @@ var greenlock = Greenlock.create({
});
```
See [Greenlock™ Express](https://git.rootprojects.org/root/greenlock-express.js)
and/or [Greenlock.js](https://git.rootprojects.org/root/greenlock.js) documentation for more details.
See [Greenlock Express](https://git.rootprojects.org/root/greenlock-express.js)
and/or [Greenlock.js](https://git.rootprojects.org/root/greenlock.js)
documentation for more details.
### ACME.js
@ -49,20 +66,29 @@ See the [ACME.js](https://git.rootprojects.org/root/acme-v2.js) for more details
### Build your own
There are only 5 methods:
- `init(config)`
- `zones(opts)`
- `set(opts)`
- `get(opts)`
- `remove(opts)`
```js
dns01
.set({
identifier: { value: 'foo.example.com' },
wildcard: false,
dnsHost: '_acme-challenge.foo.example.com'
dnsAuthorization: 'xxx_secret_xxx'
})
.then(function () {
console.log("TXT record set");
})
.catch(function () {
console.log("Failed to set TXT record");
});
.set({
identifier: { value: 'foo.example.co.uk' },
wildcard: false,
dnsZone: 'example.co.uk',
dnsPrefix: '_acme-challenge.foo',
dnsAuthorization: 'xxx_secret_xxx'
})
.then(function() {
console.log('TXT record set');
})
.catch(function() {
console.log('Failed to set TXT record');
});
```
See [acme-dns-01-test](https://git.rootprojects.org/root/acme-dns-01-test.js)
@ -74,3 +100,23 @@ for more implementation details.
# node ./test.js domain-zone api-token
node ./test.js example.com xxxxxx
```
# Authors
- Aneem Patrabansha
- AJ ONeal
See AUTHORS for contact info.
<!-- {{ if .Legal }} -->
# Legal
[acme-dns-01-digitalocean.js](https://git.coolaj86.com/coolaj86/acme-dns-01-digitalocean.js) |
MPL-2.0 |
[Terms of Use](https://therootcompany.com/legal/#terms) |
[Privacy Policy](https://therootcompany.com/legal/#privacy)
Copyright 2019 The Root Group LLC
<!-- {{ end }} -->

View File

@ -1,31 +1,46 @@
'use strict';
var request = require('@root/request');
request = require('util').promisify(request);
var defaults = {
baseUrl: 'https://api.digitalocean.com'
baseUrl: 'https://api.digitalocean.com/v2/domains'
};
module.exports.create = function(config) {
// config = { baseUrl, token }
var baseUrl = config.baseUrl || defaults.baseUrl;
var baseUrl = (config.baseUrl || defaults.baseUrl).replace(/\/$/, '');
var authtoken = config.token;
var request;
function api(method, path, form) {
var req = {
method: method,
url: baseUrl + path,
headers: {
Authorization: 'Bearer ' + authtoken,
'Content-Type': 'application/json'
},
json: true,
form: form
};
return request(req).then(function(resp) {
if (2 !== Math.floor(resp.statusCode / 100)) {
console.error(resp.statusCode, req.url);
console.error();
console.error('Request:');
console.error(req);
console.error();
console.error('Response:');
console.error(resp.body);
console.error();
throw new Error('Error response. Check token, baseUrl, domains, etc.');
}
return resp;
});
}
var helpers = {
getZonenames: function(/*opts*/) {
// { dnsHosts: [ xxxx.foo.example.com ] }
var url = baseUrl + '/v2/domains/';
return request({
method: 'GET',
url: url,
headers: {
Authorization: 'Bearer ' + authtoken,
'Content-Type': 'application/json'
},
json: true
}).then(function(resp) {
return api('GET', '/').then(function(resp) {
return resp.body.domains.map(function(x) {
return x.name;
});
@ -35,20 +50,11 @@ module.exports.create = function(config) {
// data:{dnsPrefix:"_88-acme-challenge-0e.foo",zone:"example.com",txt:"_cdZWaclIbkP1qYpMkZIURTK--ydQIK6d9axFmftWz0"}
var dnsPrefix = data.dnsPrefix;
var txt = data.txt;
var url = baseUrl + '/v2/domains/' + data.zone + '/records';
// Digital ocean provides the api to fetch records by ID. Since we do not have id, we fetch all the records,
// filter the required TXT record
return request({
method: 'GET',
url: url,
json: true,
headers: {
Authorization: 'Bearer ' + authtoken,
'Content-Type': 'application/json'
}
}).then(function(resp) {
return api('GET', '/' + data.zone + '/records').then(function(resp) {
resp = resp.body;
var entries =
resp &&
@ -62,6 +68,10 @@ module.exports.create = function(config) {
};
return {
init: function(opts) {
request = opts.request;
return null;
},
zones: function(data) {
//console.info('Get zones');
return helpers.getZonenames(data);
@ -69,25 +79,13 @@ module.exports.create = function(config) {
set: function(data) {
var ch = data.challenge;
var txt = ch.dnsAuthorization;
var url = baseUrl + '/v2/domains/' + ch.dnsZone + '/records';
// console.info('Adding TXT', data);
return request({
method: 'POST',
url: url,
headers: {
Authorization: 'Bearer ' + authtoken,
'Content-Type': 'application/json'
},
json: {
type: 'TXT',
// Note: dnsPrefix != dnsHost.split('.')[0]
// _greenlock-dryrun-2277.bar.foo.example.com => _greenlock-dryrun-2277.bar.foo
name: ch.dnsPrefix,
data: txt,
// Note: set a LOW ttl so that responses are not cached so long
ttl: 300
}
return api('POST', '/' + ch.dnsZone + '/records', {
type: 'TXT',
name: ch.dnsPrefix,
data: txt,
ttl: 300
}).then(function(resp) {
resp = resp.body;
if (resp && resp.domain_record && resp.domain_record.data === txt) {
@ -109,17 +107,12 @@ module.exports.create = function(config) {
return helpers.getTXTRecord(payload).then(function(txtRecord) {
if (txtRecord) {
var url =
baseUrl + '/v2/domains/' + ch.dnsZone + '/records/' + txtRecord.id;
var url = baseUrl + '/' + ch.dnsZone + '/records/' + txtRecord.id;
return request({
method: 'DELETE',
url: url,
headers: {
Authorization: 'Bearer ' + authtoken,
'Content-Type': 'application/json'
}
}).then(function(resp) {
return api(
'DELETE',
'/' + ch.dnsZone + '/records/' + txtRecord.id
).then(function(resp) {
resp = resp.body;
return true;
});

14
package-lock.json generated
View File

@ -7,13 +7,17 @@
"@root/request": {
"version": "1.3.11",
"resolved": "https://registry.npmjs.org/@root/request/-/request-1.3.11.tgz",
"integrity": "sha512-3a4Eeghcjsfe6zh7EJ+ni1l8OK9Fz2wL1OjP4UCa0YdvtH39kdXB9RGWuzyNv7dZi0+Ffkc83KfH0WbPMiuJFw=="
"integrity": "sha512-3a4Eeghcjsfe6zh7EJ+ni1l8OK9Fz2wL1OjP4UCa0YdvtH39kdXB9RGWuzyNv7dZi0+Ffkc83KfH0WbPMiuJFw==",
"dev": true
},
"acme-challenge-test": {
"version": "3.2.1",
"resolved": "https://registry.npmjs.org/acme-challenge-test/-/acme-challenge-test-3.2.1.tgz",
"integrity": "sha512-8MwL2oWx7vM/SBIeEQfeoRyW0kYCtLFS4FfgIx3lsQmSKhbDo9J88Ud6DejdupRp2T+DlEkWIBVI3qOCVViUaQ==",
"dev": true
"version": "3.3.1",
"resolved": "https://registry.npmjs.org/acme-challenge-test/-/acme-challenge-test-3.3.1.tgz",
"integrity": "sha512-y7iCHb70hWuFgPvtAWwQd1sz9I2Atu+6PKhN5sIIfqDhkg/sVmlxAVKXn6/SBx9TSrP50xHtiAnMkmt+umemDw==",
"dev": true,
"requires": {
"@root/request": "^1.3.11"
}
},
"acme-dns-01-test": {
"version": "3.2.1",

View File

@ -1,6 +1,6 @@
{
"name": "acme-dns-01-digitalocean",
"version": "3.0.0",
"version": "3.0.1",
"description": "Digital Ocean DNS for Let's Encrypt / ACME dns-01 challenges with ACME.js and Greenlock.js",
"main": "index.js",
"scripts": {
@ -21,10 +21,8 @@
],
"author": "AJ ONeal <coolaj86@gmail.com> (https://coolaj86.com/)",
"license": "MPL-2.0",
"dependencies": {
"@root/request": "^1.3.11"
},
"dependencies": {},
"devDependencies": {
"acme-dns-01-test": "^3.2.0"
"acme-dns-01-test": "^3.2.1"
}
}