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

make prettier #1

Merged
Ghost merged 1 commits from prettier into master 2019-07-12 04:19:14 +00:00
Conversation 0 Commits 1 Files Changed 3 +128 -82
3 changed files with 128 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -1,27 +1,31 @@
# [acme-dns-01-gandi.js](https://git.rootprojects.org/root/acme-dns-01-gandi.js) | a [Root](https://rootprojects.org/) project # [acme-dns-01-gandi.js](https://git.rootprojects.org/root/acme-dns-01-gandi.js) | a [Root](https://rootprojects.org/) project
###### Gandi LiveDNS + Let's Encrypt for Node.js - ACME dns-01 challenges w/ ACME.js and Greenlock.js ###### Gandi LiveDNS + Let's Encrypt for Node.js - ACME dns-01 challenges w/ ACME.js and Greenlock.js
###### This handles ACME dns-01 challenges, compatible with ACME.js and Greenlock.js. Passes acme-dns-01-test. ###### This handles ACME dns-01 challenges, compatible with ACME.js and Greenlock.js. Passes acme-dns-01-test.
# Features # Features
* Compatible
* Let’s Encrypt v2.1 / ACME draft 18 (2019) - Compatible
* Gandi.net LiveDNS API - Let’s Encrypt v2.1 / ACME draft 18 (2019)
* ACME.js, Greenlock.js, and others - Gandi.net LiveDNS API
* Quality - ACME.js, Greenlock.js, and others
* node v6 compatible VanillaJS - Quality
* < 150 lines of code - node v6 compatible VanillaJS
* Zero Dependencies - < 150 lines of code
- Zero Dependencies
# Install # Install
`npm install --save acme-dns-01-gandi` `npm install --save acme-dns-01-gandi`
Generate Gandi LiveDNS API Token: Generate Gandi LiveDNS API Token:
* Login to your account at: https://account.gandi.net/ - Login to your account at: https://account.gandi.net/
* Under the Security section, click the link next to 'Production API key' to generate a token. - Under the Security section, click the link next to 'Production API key' to generate a token.
# Usage # Usage
First you create an instance with your credentials: First you create an instance with your credentials:
``` ```
@ -30,9 +34,11 @@ var dns01 = require('acme-dns-01-gandi').create({
token: 'xxxx' token: 'xxxx'
}); });
``` ```
Then you can use it with any compatible ACME library, such as Greenlock.js or ACME.js. Then you can use it with any compatible ACME library, such as Greenlock.js or ACME.js.
## Greenlock.js ## Greenlock.js
``` ```
var Greenlock = require('greenlock-express'); var Greenlock = require('greenlock-express');
var greenlock = Greenlock.create({ var greenlock = Greenlock.create({
@ -42,6 +48,7 @@ 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 ## ACME.js
@ -55,13 +62,14 @@ See [Greenlock Express](https://git.rootprojects.org/root/greenlock-express.js)
See the [ACME.js](https://git.rootprojects.org/root/acme-v2.js) for more details. See the [ACME.js](https://git.rootprojects.org/root/acme-v2.js) for more details.
## Build your own ## Build your own
There are only 5 methods: There are only 5 methods:
* ```init(config)``` - `init(config)`
* ```zones(opts)``` - `zones(opts)`
* ```set(opts)``` - `set(opts)`
* ```get(opts)``` - `get(opts)`
* ```remove(opts)``` - `remove(opts)`
``` ```
dns01 dns01
@ -79,19 +87,24 @@ dns01
console.log('Failed to set TXT record'); console.log('Failed to set TXT record');
}); });
``` ```
See acme-dns-01-test for more implementation details. See acme-dns-01-test for more implementation details.
# Tests # Tests
``` ```
# node ./test.js domain-zone api-token # node ./test.js domain-zone api-token
node ./test.js example.com xxxxxx node ./test.js example.com xxxxxx
``` ```
# Authors # Authors
* Jarom Bridges
* AJ ONeal - Jarom Bridges
See AUTHORS for contact info. - AJ ONeal
See AUTHORS for contact info.
# Legal # Legal
[acme-dns-01-gandi.js](https://git.coolaj86.com/coolaj86/acme-dns-01-gandi.js) | MPL-2.0 | [Terms of Use](https://therootcompany.com/legal/#terms) | [Privacy Policy](https://therootcompany.com/legal/#privacy) [acme-dns-01-gandi.js](https://git.coolaj86.com/coolaj86/acme-dns-01-gandi.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 Copyright 2019 The Root Group LLC

107
lib/index.js
View File

@ -4,18 +4,18 @@ var defaults = {
baseUrl: 'https://dns.api.gandi.net/api/v5/' baseUrl: 'https://dns.api.gandi.net/api/v5/'
}; };
module.exports.create = function (config) { module.exports.create = function(config) {
var baseUrl = (config.baseUrl || defaults.baseUrl).replace(/\/$/, ''); var baseUrl = (config.baseUrl || defaults.baseUrl).replace(/\/$/, '');
var authtoken = config.token; var authtoken = config.token;
var request; var request;
return { return {
init: function (opts) { init: function(opts) {
request = opts.request; request = opts.request;
return null; return null;
}, },
zones: function (opts) { zones: function(opts) {
console.log(opts); console.log(opts);
return request({ return request({
@ -25,97 +25,130 @@ module.exports.create = function (config) {
'X-Api-Key': authtoken 'X-Api-Key': authtoken
}, },
json: true json: true
}).then(function (resp) { }).then(function(resp) {
return resp.body.map(function (zone) { return resp.body.map(function(zone) {
return zone.name; return zone.name;
});; });
});; });
}, },
set: function (opts) { set: function(opts) {
console.log(opts); console.log(opts);
return request({ return request({
method: 'GET', method: 'GET',
url: baseUrl + '/domains/' + opts.challenge.dnsZone + '/records/' + opts.challenge.dnsPrefix + '/TXT', url:
baseUrl +
'/domains/' +
opts.challenge.dnsZone +
'/records/' +
opts.challenge.dnsPrefix +
'/TXT',
headers: { headers: {
'X-Api-Key': authtoken 'X-Api-Key': authtoken
}, },
json: true json: true
}).then(function (resp) { }).then(function(resp) {
if (resp.body.cause === 'Not Found') { if (resp.body.cause === 'Not Found') {
return request({ return request({
method: 'POST', method: 'POST',
url: baseUrl + '/domains/' + opts.challenge.dnsZone + '/records', url:
baseUrl +
'/domains/' +
opts.challenge.dnsZone +
'/records',
headers: { headers: {
'X-Api-Key': authtoken 'X-Api-Key': authtoken
}, },
json: { json: {
'rrset_name': opts.challenge.dnsPrefix, rrset_name: opts.challenge.dnsPrefix,
'rrset_type': 'TXT', rrset_type: 'TXT',
'rrset_ttl': 300, rrset_ttl: 300,
'rrset_values': [opts.challenge.dnsAuthorization] rrset_values: [opts.challenge.dnsAuthorization]
} }
}) });
} else { } else {
const body = resp.body const body = resp.body;
let value = body.rrset_values.map(x => JSON.parse(x)) let value = body.rrset_values.map(x => JSON.parse(x));
if (body.rrset_values) { if (body.rrset_values) {
return request({ return request({
method: 'PUT', method: 'PUT',
url: baseUrl + '/domains/' + opts.challenge.dnsZone + '/records/' + opts.challenge.dnsPrefix + '/TXT', url:
baseUrl +
'/domains/' +
opts.challenge.dnsZone +
'/records/' +
opts.challenge.dnsPrefix +
'/TXT',
headers: { headers: {
'X-Api-Key': authtoken 'X-Api-Key': authtoken
}, },
json: { json: {
'rrset_ttl': 300, rrset_ttl: 300,
'rrset_values': value.concat([opts.challenge.dnsAuthorization]) rrset_values: value.concat([
opts.challenge.dnsAuthorization
])
} }
}) });
} }
} }
});; });
}, },
remove: function (opts) { remove: function(opts) {
console.log(opts); console.log(opts);
return request({ return request({
method: 'DELETE', method: 'DELETE',
url: baseUrl + '/domains/' + opts.challenge.dnsZone + '/records/' + opts.challenge.dnsPrefix + '/TXT', url:
baseUrl +
'/domains/' +
opts.challenge.dnsZone +
'/records/' +
opts.challenge.dnsPrefix +
'/TXT',
headers: { headers: {
'X-Api-Key': authtoken 'X-Api-Key': authtoken
}, },
json: true json: true
}) });
}, },
get: function (opts) { get: function(opts) {
console.log(opts); console.log(opts);
return request({ return request({
method: 'GET', method: 'GET',
url: baseUrl + '/domains/' + opts.challenge.dnsZone + '/records/' + opts.challenge.dnsPrefix, url:
baseUrl +
'/domains/' +
opts.challenge.dnsZone +
'/records/' +
opts.challenge.dnsPrefix,
headers: { headers: {
'X-Api-Key': authtoken 'X-Api-Key': authtoken
}, },
json: true json: true
}).then(function (resp) { }).then(function(resp) {
const body = resp.body const body = resp.body;
if (body.length > 0) { if (body.length > 0) {
let value = body[0].rrset_values.map(x => JSON.parse(x)).filter(field => field === opts.challenge.dnsAuthorization) let value = body[0].rrset_values
.map(x => JSON.parse(x))
.filter(
field => field === opts.challenge.dnsAuthorization
);
if (value !== []) { if (value !== []) {
return { return {
dnsAuthorization: value[0] dnsAuthorization: value[0]
} };
} else { } else {
return null return null;
} }
} else { } else {
return null return null;
} }
}) });
} }
} };
}; };

50
package.json
View File

@ -1,27 +1,27 @@
{ {
"name": "acme-dns-01-gandi", "name": "acme-dns-01-gandi",
"version": "0.0.1", "version": "0.0.1",
"description": "Gandi + Let's Encrypt for Node.js - ACME dns-01 challenges w/ ACME.js and Greenlock.js", "description": "Gandi + Let's Encrypt for Node.js - ACME dns-01 challenges w/ ACME.js and Greenlock.js",
"main": "index.js", "main": "index.js",
"scripts": { "scripts": {
"test": "node test.js" "test": "node test.js"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://git.coolaj86.com/coolaj86/acme-dns-01-gandi.js.git" "url": "https://git.coolaj86.com/coolaj86/acme-dns-01-gandi.js.git"
}, },
"keywords": [ "keywords": [
"digitalocean", "digitalocean",
"digital-ocean", "digital-ocean",
"dns", "dns",
"dns-01", "dns-01",
"letsencrypt", "letsencrypt",
"acme", "acme",
"greenlock" "greenlock"
], ],
"author": "AJ ONeal <coolaj86@gmail.com> (https://coolaj86.com/)", "author": "AJ ONeal <coolaj86@gmail.com> (https://coolaj86.com/)",
"license": "MPL-2.0", "license": "MPL-2.0",
"devDependencies": { "devDependencies": {
"dotenv": "^8.0.0" "dotenv": "^8.0.0"
} }
} }