Amazon AWS Route53 DNS + Let's Encrypt for Node.js - ACME dns-01 challenges w/ ACME.js and Greenlock.js
Go to file
Hitesh 1ec51c635c refactor 2019-08-19 14:40:43 -07:00
lib refactor 2019-08-19 14:40:43 -07:00
.gitignore Initial commit 2019-07-16 03:13:37 +00:00
AUTHORS refactor 2019-08-19 14:40:43 -07:00
LICENSE Initial commit 2019-07-16 03:13:37 +00:00
README.md refactor 2019-08-19 14:40:43 -07:00
example.env project skeleton 2019-07-15 21:24:31 -06:00
index.js project skeleton 2019-07-15 21:24:31 -06:00
package-lock.json all integration tests passed 2019-08-18 22:27:42 -07:00
package.json refactor 2019-08-19 14:40:43 -07:00
test.js all integration tests passed 2019-08-18 22:27:42 -07:00

README.md

acme-dns-01-route53

Amazon AWS Route53 DNS + Let's Encrypt for Node.js - ACME dns-01 challenges w/ ACME.js and Greenlock.js

Features

  • Compatible
    • Lets Encrypt v2.1 / ACME draft 18 (2019)
    • DNSimple v2 API
    • ACME.js, Greenlock.js, and others
  • Quality
    • node v6 compatible VanillaJS

Install

npm install --save acme-dns-01-route53

AWS API keys:

  • Login to your account at: https://console.aws.amazon.com
  • Go to Services > IAM > Users, create a new user and assign AmazonRoute53FullAccess policy.
  • Click Securty credentials tab and then click Create access key.

Usage

First you create an instance with your credentials:

var dns01 = require('acme-dns-01-route53').create({
	key: 'your_key',
	secret: 'your_secret'
});

Then you can use it with any compatible ACME library, such as Greenlock.js or ACME.js.

Greenlock.js

var Greenlock = require('greenlock-express');
var greenlock = Greenlock.create({
	challenges: {
		'dns-01': dns01
		// ...
	}
});

See Greenlock Express and/or Greenlock.js documentation for more details.

ACME.js

// TODO

See the ACME.js for more details.

Build your own

There are only 5 methods:

  • init(config)
  • zones(opts)
  • set(opts)
  • get(opts)
  • remove(opts)
dns01
	.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 for more implementation details.

Tests

# node ./test.js domain-zone key secret
node ./test.js example.com xxxxx yyyyy

Authors

  • AJ ONeal
  • Hitesh Walia

See AUTHORS for contact info.

Legal

acme-dns-01-dnsimple.js | MPL-2.0 | Terms of Use | Privacy Policy

Copyright 2019 Hitesh Walia
Copyright 2019 AJ ONeal
Copyright 2019 The Root Group LLC