From ee01340133db5676236c103a3f33cfe115de21c6 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Tue, 19 Apr 2016 04:29:03 +0000 Subject: [PATCH] first commit --- .github/ISSUE_TEMPLATE.md | 11 +++ .gitignore | 33 +++++++ LICENSE | 201 ++++++++++++++++++++++++++++++++++++++ README.md | 97 ++++++++++++++++++ example.js | 69 +++++++++++++ 5 files changed, 411 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 example.js diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..58fc23e --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,11 @@ +========== +ATTENTION! +========== + +Please report issues at https://github.com/Daplie/letsencrypt-express + +======== +ACHTUNG! +======== + +Bitte melden Sie Probleme bei https://github.com/Daplie/letsencrypt-express diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e920c16 --- /dev/null +++ b/.gitignore @@ -0,0 +1,33 @@ +# Logs +logs +*.log +npm-debug.log* + +# Runtime data +pids +*.pid +*.seed + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directory +node_modules + +# Optional npm cache directory +.npm + +# Optional REPL history +.node_repl_history diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + 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. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..a58b079 --- /dev/null +++ b/README.md @@ -0,0 +1,97 @@ +# letsencrypt-hapi + +Free SSL and Automatic HTTPS for node.js with hapi.js and other middleware systems via Let's Encrypt + +* Automatic Registration via SNI (`httpsOptions.SNICallback`) + * **registrations** require an **approval callback** in *production* +* Automatic Renewal (around 80 days) + * **renewals** are *fully automatic* and happen in the *background*, with **no downtime** +* Automatic vhost / virtual hosting + +All you have to do is start the webserver and then visit it at it's domain name. + +## Install + +``` +npm install --save letsencrypt-express +``` + +*Pay no attention to the man behind the curtain.* (just ignore that the name of the module is letsencrypt-express) + +### Part 1: Configure LetsEncrypt + +```javascript +'use strict'; + +var LEX = require('letsencrypt-express').testing(); + +var lex = LEX.create({ + configDir: require('os').homedir() + '/letsencrypt/etc' +, approveRegistration: function (hostname, cb) { + cb(null, { + domains: [hostname] + , email: 'CHANGE_ME' // user@example.com + , agreeTos: true + }); + } +}); +``` + +WARNING: If you don't do any checks and simply complete `approveRegistration` callback, +an attacker will spoof SNI packets with bad hostnames and that will cause you to be rate-limited +and/or blocked from the ACME server. +Alternatively, You can run registration *manually*: + +```bash +npm install -g letsencrypt-cli + +letsencrypt certonly --standalone \ + --config-dir ~/letsencrypt/etc \ + --agree-tos --domains example.com --email user@example.com + +# Note: the '--webrootPath' option is also available if you don't want to shut down your webserver to get the cert. +``` + +### Part 2: Just add Hapi + +```javascript +var hapi = require('hapi'); +var https = require('spdy'); +var server = new hapi.Server(); +var acmeResponder = LEX.createAcmeResponder(lex); +var httpsServer = https.createServer(lex.httpsOptions).listen(443); + +server.connection({ listener: httpsServer, autoListen: false, tls: true }); + +server.route({ + method: 'GET' +, path: '/.well-known/acme-challenge' +, handler: function (request, reply) { + var req = request.raw.req; + var res = request.raw.res; + + reply.close(false); + acmeResponder(req, res); + } +}); + +server.route({ + method: 'GET' +, path: '/' +, handler: function (request, reply) { + reply("Hello, I'm so Hapi!"); + } +}); +``` + +### Part 3: Redirect http to https + +```javascript +var http = require('http'); + +http.createServer(LEX.createAcmeResponder(lex, function redirectHttps(req, res) { + res.setHeader('Location', 'https://' + req.headers.host + req.url); + res.statusCode = 302; + res.end(''); +})).listen(80); +``` diff --git a/example.js b/example.js new file mode 100644 index 0000000..72d7d10 --- /dev/null +++ b/example.js @@ -0,0 +1,69 @@ +'use strict'; + + +// +// Configure LetsEncrypt +// +var LEX = require('letsencrypt-express').testing(); +var leConfDir = require('os').homedir() + '/letsencrypt/etc'; + +throw new Error( + "You must edit the example to change the email address (and remove this error)." + + " Also, you'll need to remove .testing() and rm -rf '" + leConfDir + "'" + + " to get actual, trusted production certificates."); + +var lex = LEX.create({ + configDir: leConfDir + // leave `null` to disable automatic registration +, approveRegistration: function (hostname, cb) { + // Note: this is the place to check your database + // to get the user associated with this domain + cb(null, { + domains: [hostname] + , email: 'CHANGE_ME' // user@example.com + , agreeTos: true + }); + } +}); + + +// +// Be Hapi +// +var hapi = require('hapi'); +var https = require('spdy'); +var server = new hapi.Server(); +var acmeResponder = LEX.createAcmeResponder(lex); +var httpsServer = https.createServer(lex.httpsOptions).listen(443); + +server.connection({ listener: httpsServer, autoListen: false, tls: true }); +server.route({ + method: 'GET' +, path: '/.well-known/acme-challenge' +, handler: function (request, reply) { + var req = request.raw.req; + var res = request.raw.res; + + reply.close(false); + acmeResponder(req, res); + } +}); + +server.route({ + method: 'GET' +, path: '/' +, handler: function (request, reply) { + reply("Hello, I'm so Hapi!"); + } +}); + + +// +// Redirect HTTP to HTTPS +// +var http = require('http'); +http.createServer(LEX.createAcmeResponder(lex, function redirectHttps(req, res) { + res.setHeader('Location', 'https://' + req.headers.host + req.url); + res.statusCode = 302; + res.end(''); +})).listen(80);