commit	c51f54e2617554fe8e4b133a2fe4451886fe5ad6	[log] [download]
author	Aline Freitas <a.freitas@doubleleft.com>	Tue Apr 15 19:32:55 2014 -0300
committer	Aline Freitas <a.freitas@doubleleft.com>	Tue Apr 15 19:32:55 2014 -0300
tree	1afa6a58c9e2be72adb18fadf97b692a51f61a1d
parent	b15406457fb2772dc8c576902669377cc1ee5abe [diff]

tree: 1afa6a58c9e2be72adb18fadf97b692a51f61a1d

README.md

nginx-polarssl

Overview

This is a fork of the nginx development branch that allows the user to use PolarSSL instead of OpenSSL. This may be useful for those seeking to further minimise the memory footprint of the webserver, or for those that happen to dislike OpenSSL for some reason.

Motivation

PolarSSL seemed like an amazing library and the author felt that a simple project to get used to the APIs was the best way to learn it's internals. Additionally there are not many webservers that use SSL libraries other than OpenSSL (Hiawatha is a notable exception), and there should be more.

Installation

See nginx's installation options for how to configure/install nginx.

This fork adds:

--with-polarssl - Attempt to use the system PolarSSL installation.
--with-polarssl=path - Compile nginx statically with the PolarSSL source code located at "path".

For example:

./configure --with-http_ssl_module --with-polarssl=~/Packages/polarssl-1.2.5
gmake
gmake install

Note that due to the Makefiles shipped by PolarSSL using GNU make style conditionals, GNU make must be used if --with-polarssl=path is used.

Configuration

With a few exceptions configuration is identical to the standard SSL support.

ssl_protocols does not support “SSLv2”.
ssl_engine is not a valid config option when using PolarSSL.
ssl_prefer_server_ciphers has no effect.
ssl_session_cache builtin is not supported.
ssl_ciphers_list expects a ‘:’ separated list of cipher suites.
ssl_stapling and related options are not supported.

Supported Ciphersuites

TLS-RSA-WITH-RC4-128-MD5
TLS-RSA-WITH-RC4-128-SHA
TLS-RSA-WITH-3DES-EDE-CBC-SHA
TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA
TLS-RSA-WITH-AES-128-CBC-SHA
TLS-DHE-RSA-WITH-AES-128-CBC-SHA
TLS-RSA-WITH-AES-256-CBC-SHA
TLS-DHE-RSA-WITH-AES-256-CBC-SHA
TLS-RSA-WITH-AES-128-CBC-SHA256
TLS-RSA-WITH-AES-256-CBC-SHA256
TLS-DHE-RSA-WITH-AES-128-CBC-SHA256
TLS-DHE-RSA-WITH-AES-256-CBC-SHA256
TLS-RSA-WITH-CAMELLIA-128-CBC-SHA
TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA
TLS-RSA-WITH-CAMELLIA-256-CBC-SHA
TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA
TLS-RSA-WITH-CAMELLIA-128-CBC-SHA256
TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256
TLS-RSA-WITH-CAMELLIA-256-CBC-SHA256
TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256
TLS-RSA-WITH-AES-128-GCM-SHA256
TLS-RSA-WITH-AES-256-GCM-SHA384
TLS-DHE-RSA-WITH-AES-128-GCM-SHA256
TLS-DHE-RSA-WITH-AES-256-GCM-SHA384

Note: This depends on what ciphers were compiled into PolarSSL at build time. Additionally certain extremely weak ciphersuites are explicitly not supported by nginx-polarssl.

Know Issues/Implementation Differences

nginx-polarssl Issues:

See the github issue tracker

PolarSSL Issues:

PolarSSL 1.2.5 has a memory leak. (Fix: https://github.com/polarssl/polarssl/commit/c0463502ff89db15c9bcfee33878678b7fd14cef)
Support for SSL v2.0 ClientHello was removed from PolarSSL 1.2.x. Some applications rely on this to be supported or will not handshake correctly. This is scheduled to be fixed in a future version of PolarSSL.

Implementation differences:

SSLv2.0 is not supported, and will not be supported.
OCSP stapling is not and more than likely will not be supported.
ECDH is not yet supported by PolarSSL.

License

The changes added by nginx-polarssl are distrubuted under the nginx license (Also see https://polarssl.org/foss-license-exception and https://twitter.com/polarssl/status/302083038261678080).