Compare commits

..

No commits in common. "master" and "v2.1.2" have entirely different histories.

5 changed files with 60 additions and 66 deletions

View File

@ -2,11 +2,10 @@
ATTENTION!
==========
Please report issues at https://git.coolaj86.com/coolaj86/greenlock-express.js
Please report issues at https://github.com/Daplie/letsencrypt-express
========
ACHTUNG!
========
Bitte melden Sie Probleme bei
https://git.coolaj86.com/coolaj86/greenlock-express.js
Bitte melden Sie Probleme bei https://github.com/Daplie/letsencrypt-express

31
LICENSE
View File

@ -1,32 +1,3 @@
At your option you may choose either of the following licenses:
* The MIT License (MIT)
* The Apache License 2.0 (Apache-2.0)
The MIT License (MIT)
Copyright (c) 2016-2018 AJ ONeal
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
@ -215,7 +186,7 @@ SOFTWARE.
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2015 AJ ONeal
Copyright {yyyy} {name of copyright owner}
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.

View File

@ -1,6 +1,6 @@
# Greenlock™ for rill
# Greenlock™ for Koa
An Automated HTTPS ACME client (Let's Encrypt v2) for rill
An Automated HTTPS ACME client (Let's Encrypt v2) for Koa
Greenlock™ for
[Browsers](https://git.coolaj86.com/coolaj86/greenlock.html),
@ -9,8 +9,8 @@ Greenlock™ for
[Express.js](https://git.coolaj86.com/coolaj86/greenlock-express.js),
[Node.js Cluster](https://git.coolaj86.com/coolaj86/greenlock-cluster.js),
[hapi](https://git.coolaj86.com/coolaj86/greenlock-hapi.js),
[Koa](https://git.coolaj86.com/coolaj86/greenlock-koa.js),
and **rill**
**Koa**,
and [rill](https://git.coolaj86.com/coolaj86/greenlock-rill.js)
| Sponsered by [ppl](https://ppl.family)
Features
@ -29,7 +29,7 @@ which works with any middleware system.
## Install
```
npm install --save greenlock-rill@2.x
npm install --save greenlock-koa@2.x
```
QuickStart
@ -42,7 +42,7 @@ QuickStart
// Greenlock Setup //
//////////////////////
var greenlock = require('greenlock-rill').create({
var greenlock = require('greenlock-koa').create({
version: 'draft-11' // Let's Encrypt v2
// You MUST change this to 'https://acme-v02.api.letsencrypt.org/directory' in production
, server: 'https://acme-staging-v02.api.letsencrypt.org/directory'
@ -61,21 +61,21 @@ var greenlock = require('greenlock-rill').create({
});
///////////////////
// Just add rill //
///////////////////
//////////////////
// Just add Koa //
//////////////////
var http = require('http');
var https = require('https');
var Rill = require('rill');
var app = new Rill();
var koa = require('koa');
var app = koa();
app.use(({ req, res }, next)=> {
res.body = 'Hello, World!';
app.use(function *() {
this.body = 'Hello World';
});
// https server
var server = https.createServer(greenlock.tlsOptions, greenlock.middleware(app.handler()));
var server = https.createServer(greenlock.tlsOptions, greenlock.middleware(app.callback()));
server.listen(443, function () {
console.log('Listening at https://localhost:' + this.address().port);
@ -84,31 +84,56 @@ server.listen(443, function () {
// http redirect to https
var http = require('http');
var redirectHttps = require('redirect-https')();
var redirectHttps = koa().use(require('koa-sslify')()).callback();
http.createServer(greenlock.middleware(redirectHttps)).listen(80, function () {
console.log('Listening on port 80 to handle ACME http-01 challenge and redirect to https');
});
```
Usage & Troubleshooting
============================
See <https://git.coolaj86.com/coolaj86/greenlock-express.js>
Handling a dynamic list of domains
========================
In the oversimplified exapmple above we handle a static list of domains.
If you add domains programmatically you'll want to use the `approveDomains`
callback.
If you handle multiple domains and you dynamically add new ones,
you'll want to replace the static list of domains in `approveDomains`
with a function like this:
```js
function approveDomains(opts, certs, cb) {
// This is where you check your database and associated
// email addresses with domains and agreements and such
// The domains being approved for the first time are listed in opts.domains
// Certs being renewed are listed in certs.altnames
if (certs) {
opts.domains = certs.altnames;
}
else {
// Do something to
opts.email = 'john.doe@example.com';
opts.agreeTos = true;
}
opts.communityMember = true;
// NOTE: you can also change other options such as `challengeType` and `challenge`
// opts.challengeType = 'http-01';
// opts.challenge = require('le-challenge-fs').create({});
cb(null, { options: opts, certs: certs });
}
```
**SECURITY**: Be careful with this.
If you don't check that the domains being requested are the domains you
allow an attacker can make you hit your rate limit for failed verification
attempts.
We have a
See the
[vhost example](https://git.coolaj86.com/coolaj86/greenlock-express.js/src/branch/master/examples/vhost.js)
that allows any domain for which there is a folder on the filesystem in a specific location.
for an idea of how this is done.
See that example for an idea of how this is done.
More Usage & Troubleshooting
============================
See <https://git.coolaj86.com/coolaj86/greenlock-express.js>

View File

@ -3,6 +3,6 @@
module.exports = require('greenlock-express');
module.exports._greenlockExpressCreate = module.exports.create;
module.create = function (opts) {
opts._communityPackage = opts._communityPackage || 'greenlock-rill';
opts._communityPackage = opts._communityPackage || 'greenlock-koa';
return module.exports._greenlockExpressCreate(opts);
};

View File

@ -1,15 +1,14 @@
{
"name": "greenlock-rill",
"homepage": "https://git.coolaj86.com/coolaj86/greenlock-rill.js",
"version": "2.1.4",
"description": "An Automated HTTPS ACME client (Let's Encrypt v2) for rill",
"name": "greenlock-koa",
"version": "2.1.2",
"description": "An Automated HTTPS ACME client (Let's Encrypt v2) for Koa",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+https://git.coolaj86.com/coolaj86/greenlock-rill.js.git"
"url": "git+https://git.coolaj86.com/coolaj86/greenlock-koa.js.git"
},
"keywords": [
"acme",
@ -20,7 +19,7 @@
"freessl",
"free ssl",
"https",
"rill",
"koa",
"le",
"letsencrypt",
"node",