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

Compare commits

base: coolaj86:d80562fbf7be59a3ef5d950591d601477c2b6ef8
Branches Tags
coolaj86:master
coolaj86:prettier
coolaj86:prod
coolaj86:v3.0.0
..
compare: coolaj86:1b30c9751f7c98f59afda853616b8938ae078b7c
Branches Tags
coolaj86:prettier
coolaj86:master
coolaj86:prod
coolaj86:v3.0.0

No commits in common. "d80562fbf7be59a3ef5d950591d601477c2b6ef8" and "1b30c9751f7c98f59afda853616b8938ae078b7c" have entirely different histories.
d80562fbf7 ... 1b30c9751f

6 changed files with 117 additions and 208 deletions
Show Stats Expand all files Collapse all files

2
.gitignore vendored
View File

@ -1,5 +1,3 @@
.env
# ---> Node
# Logs
logs

70
README.md
View File

@ -1,47 +1,39 @@
# [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
This handles ACME dns-01 challenges, compatible with ACME.js and Greenlock.js. Passes acme-dns-01-test.
###### 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.
# Features
- Compatible
- Let’s Encrypt v2.1 / ACME draft 18 (2019)
- Gandi.net LiveDNS API
- ACME.js, Greenlock.js, and others
- Quality
- node v6 compatible VanillaJS
- < 150 lines of code
- Zero Dependencies
* Compatible
* Let’s Encrypt v2.1 / ACME draft 18 (2019)
* Gandi.net LiveDNS API
* ACME.js, Greenlock.js, and others
* Quality
* node v6 compatible VanillaJS
* < 150 lines of code
* Zero Dependencies
# Install
```js
npm install --save acme-dns-01-gandi
```
`npm install --save acme-dns-01-gandi`
Generate Gandi LiveDNS API Token:
- 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.
* 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.
# Usage
First you create an instance with your credentials:
```js
```
var dns01 = require('acme-dns-01-gandi').create({
baseUrl: 'https://dns.api.gandi.net/api/v5/', // default
token: 'xxxx'
});
```
Then you can use it with any compatible ACME library, such as Greenlock.js or ACME.js.
## Greenlock.js
```js
```
var Greenlock = require('greenlock-express');
var greenlock = Greenlock.create({
challenges: {
@ -50,28 +42,28 @@ 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.
## ACME.js
```js
```
// TODO
```
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)`
* ```init(config)```
* ```zones(opts)```
* ```set(opts)```
* ```get(opts)```
* ```remove(opts)```
```js
```
dns01
.set({
identifier: { value: 'foo.example.co.uk' },
@ -87,27 +79,19 @@ dns01
console.log('Failed to set TXT record');
});
```
See acme-dns-01-test for more implementation details.
# Tests
```bash
```
# node ./test.js domain-zone api-token
node ./test.js example.com xxxxxx
```
# Authors
- Jarom Bridges
- AJ ONeal
* Jarom Bridges
* AJ ONeal
See AUTHORS for contact info.
# 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)
Copyright 2019 Jarom Bridges
Copyright 2019 AJ ONeal
Copyright 2019 The Root Group LLC

150
lib/index.js
View File

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

29
package-lock.json generated
View File

@ -1,29 +0,0 @@
{
"name": "acme-dns-01-gandi",
"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==",
"dev": true
},
"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"
}
},
"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
}
}
}

3
package.json
View File

@ -1,6 +1,6 @@
{
"name": "acme-dns-01-gandi",
"version": "3.0.0",
"version": "0.0.1",
"description": "Gandi + Let's Encrypt for Node.js - ACME dns-01 challenges w/ ACME.js and Greenlock.js",
"main": "index.js",
"scripts": {
@ -22,7 +22,6 @@
"author": "AJ ONeal <coolaj86@gmail.com> (https://coolaj86.com/)",
"license": "MPL-2.0",
"devDependencies": {
"acme-challenge-test": "^3.3.2",
"dotenv": "^8.0.0"
}
}

1
test.js
View File

@ -3,7 +3,6 @@
// See https://git.coolaj86.com/coolaj86/acme-challenge-test.js
var tester = require('acme-challenge-test');
require('dotenv').config();
// Usage: node ./test.js example.com xxxxxxxxx
var zone = process.argv[2] || process.env.ZONE;