mozilla / mwos-letsencrypt-2015

Nginx module that implements ACME for automated TLS configuration

Let's Encrypt module for Nginx

Introduction

[TODO]

Dependencies

Makefile dependencies

To build this module you need all the tools installed which you would also need to build the Nginx server alone. In addition you need curl if you download the source code of Nginx using make source (recommended).

Libraries

The module uses libcurl for making the HTTP calls to the ACME server and libjansson for parsing and creating the JSON strings according to the ACME protocol.

Installation

1. Download the NginX source code using:

   make source

2. Configure, build and install the server with the module:

   make install

   With this step the server is compiled and installed in the ./run directory. Don't worry, nothing is installed on your system outside this directory.

3. Run the server:

   make run

You can later stop the server with:

    make kill

Configuration

• The build process and the directories can be configured in the first few lines of the Makefile.

• The server will run with a copy of the configuration file example/nginx.conf

mwos-letsencrypt-2015's Issues

jansson slow

• http://zserge.com/jsmn.html
• https://github.com/miloyip/nativejson-benchmark#sample-results

Error

/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c: In function 'ngx_http_acme':
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c:212: error: 'ngx_http_ssl_srv_conf_t' has no member named 'certificates'
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c:213: error: 'ngx_http_ssl_srv_conf_t' has no member named 'certificates'
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c:216: error: 'ngx_http_ssl_srv_conf_t' has no member named 'certificates'
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c:219: error: 'ngx_http_ssl_srv_conf_t' has no member named 'certificate_keys'
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c:220: error: 'ngx_http_ssl_srv_conf_t' has no member named 'certificate_keys'
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c:223: error: 'ngx_http_ssl_srv_conf_t' has no member named 'certificate_keys'
cc1: warnings being treated as errors
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c: In function 'ngx_http_acme_sign_json':
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c:620: error: ignoring return value of 'fwrite', declared with attribute warn_unused_result
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c:620: error: ignoring return value of 'fwrite', declared with attribute warn_unused_result
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c:620: error: ignoring return value of 'fwrite', declared with attribute warn_unused_result
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c:620: error: ignoring return value of 'fwrite', declared with attribute warn_unused_result
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c: In function 'ngx_http_acme_plain_request':
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c:919: error: ignoring return value of 'fwrite', declared with attribute warn_unused_result
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c:919: error: ignoring return value of 'fwrite', declared with attribute warn_unused_result
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c:919: error: ignoring return value of 'fwrite', declared with attribute warn_unused_result
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c:919: error: ignoring return value of 'fwrite', declared with attribute warn_unused_result
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c:977: error: ignoring return value of 'fwrite', declared with attribute warn_unused_result
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c:977: error: ignoring return value of 'fwrite', declared with attribute warn_unused_result
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c:977: error: ignoring return value of 'fwrite', declared with attribute warn_unused_result
/opt/nginx-1.9.15/mwos-letsencrypt-2015/ngx_http_acme_module.c:977: error: ignoring return value of 'fwrite', declared with attribute warn_unused_result
make[1]: *** [objs/addon/mwos-letsencrypt-2015/ngx_http_acme_module.o] Error 1
make[1]: Leaving directory `/opt/nginx-1.9.15'
make: *** [build] Error 2

Rename to ngx_[letsencrypt|acme|certbot]

Please add a LICENSE file to the repository.

Please add a LICENSE file to this repository, so that it is well-known what rights are permitted to the community for this work.

Ideally, MPL2 in plain text form, since that's the recommended code license for Mozilla projects, but any LICENSE file would be fine in this instance.

Support Dynamic Module

• https://www.nginx.com/blog/dynamic-modules-nginx-1-9-11/
• https://www.nginx.com/resources/wiki/extending/converting/
• https://www.nginx.com/blog/dynamic-modules-development/

Shared library:

$ ./configure … --add-dynamic-module=…/ngx_letsencrypt && make -j4
$ ls ./objs/*letsencrypt*.so
./objs/ngx_letsencrypt.so
$ cp -v ./objs/ngx_letsencrypt.so {/usr/local,}/etc/nginx/modules/

$ ./configure … --add-module=…/ngx_letsencrypt && make -j4

---

etc/nginx/nginx.conf

load_module modules/ngx_letsencrypt.so;

#user  nobody;
worker_processes  1;

#error_log  logs/error.log;
#error_log  logs/error.log  notice;
#error_log  logs/error.log  info;
…

CODE_OF_CONDUCT.md file missing

As of January 1 2019, Mozilla requires that all GitHub projects include this CODE_OF_CONDUCT.md file in the project root. The file has two parts:

1. Required Text - All text under the headings Community Participation Guidelines and How to Report, are required, and should not be altered.
2. Optional Text - The Project Specific Etiquette heading provides a space to speak more specifically about ways people can work effectively and inclusively together. Some examples of those can be found on the Firefox Debugger project, and Common Voice. (The optional part is commented out in the raw template file, and will not be visible until you modify and uncomment that part.)

If you have any questions about this file, or Code of Conduct policies and procedures, please see Mozilla-GitHub-Standards or email [email protected].

(Message COC001)

Wiki changes

FYI: The following changes were made to this repository's wiki:

• defacing spam has been removed

• Restricting write access to contributors is strongly encouraged. Please make that change (documentation).

These were made as the result of a recent automated defacement of publically writeable wikis.

Secure & Open implementation Let's Encrypt client in C

letskencrypt with goop to allow compilation and secure operation on Linux, Mac OS X, and FreeBSD (hence "-portable").

• Info: https://kristaps.bsd.lv/letskencrypt/
• Source Code:
  • https://github.com/kristapsdz/letskencrypt
  • https://github.com/kristapsdz/letskencrypt-portable