acme-dns-01-digitalocean - npm Package Compare versions

Comparing version 0.0.1-security to 3.0.0

package.json

 {
-  "name": "acme-dns-01-digitalocean",
-  "version": "0.0.1-security",
-  "description": "security holding package",
-  "repository": "npm/security-holder",
-  "dependencies": {}
+	"name": "acme-dns-01-digitalocean",
+	"version": "3.0.0",
+	"description": "Digital Ocean DNS for Let's Encrypt / ACME dns-01 challenges with ACME.js and Greenlock.js",
+	"main": "index.js",
+	"scripts": {
+		"test": "node ./test.js"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://git.rootprojects.org/root/acme-dns-01-digitalocean.git"
+	},
+	"keywords": [
+		"digitalocean",
+		"digital-ocean",
+		"dns",
+		"dns-01",
+		"letsencrypt",
+		"acme",
+		"greenlock"
+	],
+	"author": "AJ ONeal <[e-mail]> (https://coolaj86.com/)",
+	"license": "MPL-2.0",
+	"dependencies": {
+	},
+	"devDependencies": {
+		"acme-dns-01-test": "^3.2.0"
+	}
 }

README.md

@@ -1,9 +0,122 @@
-# Security holding package
+# [acme-dns-01-digitalocean](https://git.rootprojects.org/root/acme-dns-01-digitalocean.js) | a [Root](https://rootrpojects.org) project
 
-This package name is not currently in use, but was formerly occupied
-by another package. To avoid malicious use, npm is hanging on to the
-package name, but loosely, and we'll probably give it to you if you
-want it.
+Digital Ocean DNS + Let's Encrypt for Node.js
 
-You may adopt this package by contacting [e-mail] and
-requesting the name.
+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] < 150 lines of code
+  - [x] **Zero Dependencies**
+
+# Install
+
+```bash
+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/v2/domains', // 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: {
+		'dns-01': dns01
+		// ...
+	}
+});
+```
+
+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)`
+
+```js
+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](https://git.rootprojects.org/root/acme-dns-01-test.js)
+for more implementation details.
+
+# Tests
+
+```bash
+# 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 }} -->

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Copyleft License

License

(Experimental) Copyleft license information was found.

Found 1 instance in 1 package

Non-permissive License

License

(Experimental) A license not known to be considered permissive was found.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

Found 1 instance in 1 package

No License Found

License

(Experimental) License information could not be found.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

24547

increased by4751.19%

Number of package files

8

increased by300%

Lines of code

152

increased byInfinity%

Number of low maintenance alerts

2

decreased by-33.33%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

123

increased by1130%

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

1

increased byInfinity%

Number of low license alerts

2

increased by100%

License quality

70

decreased by-30%

No dependency changes