diff --git a/README.markdown b/README.markdown index 997706d0e..a976367a8 100644 --- a/README.markdown +++ b/README.markdown @@ -36,6 +36,7 @@ Table of Contents * [ngx.ssl](#ngxssl) * [ngx.ssl.clienthello](#ngxsslclienthello) * [ngx.ssl.session](#ngxsslsession) + * [ngx.ssl.verify](#ngxsslverify) * [ngx.re](#ngxre) * [ngx.resp](#ngxresp) * [ngx.pipe](#ngxpipe) @@ -364,6 +365,15 @@ See the [documentation](./lib/ngx/ssl/session.md) for this Lua module for more d [Back to TOC](#table-of-contents) +## ngx.ssl.verify + +This Lua module provides a Lua API for post-processing SSL client certificate message +for NGINX downstream SSL connections. + +See the [documentation](./lib/ngx/ssl/verify.md) for this Lua module for more details. + +[Back to TOC](#table-of-contents) + ## ngx.re This Lua module provides a Lua API which implements convenience utilities for diff --git a/lib/ngx/ssl/verify.lua b/lib/ngx/ssl/verify.lua new file mode 100644 index 000000000..a63229b88 --- /dev/null +++ b/lib/ngx/ssl/verify.lua @@ -0,0 +1,134 @@ +-- Copyright (C) Yichun Zhang (agentzh) + + +local base = require "resty.core.base" +base.allows_subsystem('http', 'stream') + + +local ffi = require "ffi" +local C = ffi.C +local ffi_gc = ffi.gc +local ffi_str = ffi.string +local get_request = base.get_request +local error = error +local errmsg = base.get_errmsg_ptr() + +local FFI_OK = base.FFI_OK +local FFI_ERROR = base.FFI_ERROR +local subsystem = ngx.config.subsystem +local ngx_phase = ngx.get_phase + +local ngx_lua_ffi_ssl_set_verify_result +local ngx_lua_ffi_ssl_get_verify_result +local ngx_lua_ffi_ssl_get_verify_cert +local ngx_lua_ffi_ssl_free_verify_cert + + +if subsystem == 'http' then + ffi.cdef[[ + int ngx_http_lua_ffi_ssl_set_verify_result(ngx_http_request_t *r, + int verify_result, char **err); + + int ngx_http_lua_ffi_ssl_get_verify_result(ngx_http_request_t *r, + char **err); + + void *ngx_http_lua_ffi_ssl_get_verify_cert(ngx_http_request_t *r, + char **err); + + void ngx_http_lua_ffi_ssl_free_verify_cert(void *cdata); + ]] + + ngx_lua_ffi_ssl_set_verify_result = C.ngx_http_lua_ffi_ssl_set_verify_result + ngx_lua_ffi_ssl_get_verify_result = C.ngx_http_lua_ffi_ssl_get_verify_result + ngx_lua_ffi_ssl_get_verify_cert = C.ngx_http_lua_ffi_ssl_get_verify_cert + ngx_lua_ffi_ssl_free_verify_cert = C.ngx_http_lua_ffi_ssl_free_verify_cert + + + +elseif subsystem == 'stream' then + ffi.cdef[[ + int ngx_stream_lua_ffi_ssl_set_verify_result( + ngx_stream_lua_request_t *r, int verify_result, char **err); + + int ngx_stream_lua_ffi_ssl_get_verify_result( + ngx_stream_lua_request_t *r, char **err); + + void *ngx_stream_lua_ffi_ssl_get_verify_cert( + ngx_stream_lua_request_t *r, char **err); + + void ngx_stream_lua_ffi_ssl_free_verify_cert(void *cdata); + ]] + + ngx_lua_ffi_ssl_set_verify_result = + C.ngx_stream_lua_ffi_ssl_set_verify_result + ngx_lua_ffi_ssl_get_verify_result = + C.ngx_stream_lua_ffi_ssl_get_verify_result + ngx_lua_ffi_ssl_get_verify_cert = C.ngx_stream_lua_ffi_ssl_get_verify_cert + ngx_lua_ffi_ssl_free_verify_cert = C.ngx_stream_lua_ffi_ssl_free_verify_cert +end + + +local _M = { version = base.version } + + +-- return ok, err +function _M.set_verify_result(verify_result) + local r = get_request() + if not r then + error("no request found") + end + + if ngx_phase() ~= "ssl_verify" then + error("API disabled in the current context") + end + + local rc = ngx_lua_ffi_ssl_set_verify_result(r, verify_result, errmsg) + if rc == FFI_OK then + return true + end + + return nil, ffi_str(errmsg[0]) +end + + +-- return verify_result, err +function _M.get_verify_result() + local r = get_request() + if not r then + error("no request found") + end + + if ngx_phase() ~= "ssl_verify" then + error("API disabled in the current context") + end + + local rc = ngx_lua_ffi_ssl_get_verify_result(r, errmsg) + if rc == FFI_ERROR then + return nil, ffi_str(errmsg[0]) + end + + return rc +end + + +-- return cert, err +function _M.get_verify_cert() + local r = get_request() + if not r then + error("no request found") + end + + if ngx_phase() ~= "ssl_verify" then + error("API disabled in the current context") + end + + local cert = ngx_lua_ffi_ssl_get_verify_cert(r, errmsg) + if cert ~= nil then + return ffi_gc(cert, ngx_lua_ffi_ssl_free_verify_cert) + end + + return nil, ffi_str(errmsg[0]) +end + + +return _M diff --git a/lib/ngx/ssl/verify.md b/lib/ngx/ssl/verify.md new file mode 100644 index 000000000..26e412046 --- /dev/null +++ b/lib/ngx/ssl/verify.md @@ -0,0 +1,190 @@ +Name +==== + +ngx.ssl.verify - Lua API for post-processing SSL client certificate message for NGINX downstream SSL connections. + +Table of Contents +================= + +* [Name](#name) +* [Status](#status) +* [Synopsis](#synopsis) +* [Description](#description) +* [Methods](#methods) + * [set_verify_result](#set_verify_result) + * [get_verify_result](#get_verify_result) + * [get_verify_cert](#get_verify_cert) +* [Community](#community) + * [English Mailing List](#english-mailing-list) + * [Chinese Mailing List](#chinese-mailing-list) +* [Bugs and Patches](#bugs-and-patches) +* [Author](#author) +* [Copyright and License](#copyright-and-license) +* [See Also](#see-also) + +Status +====== + +This Lua module is production ready. + +Synopsis +======== + +```nginx +# nginx.conf + +server { + listen 443 ssl; + + server_name test.com; + ssl_verify_client on; + ssl_certificate /path/to/cert.crt; + ssl_certificate_key /path/to/key.key; + + ssl_verify_by_lua_block { + local ssl_vfy = require "ngx.ssl.verify" + + local cert, err = ssl_vfy.get_verify_cert() + + -- ocsp to verify cert + -- check crl + + ssl_vfy.set_verify_result(0) + } + + location /t { + proxy_ssl_certificate /path/to/cert.crt; + proxy_ssl_certificate_key /path/to/key.key; + proxy_pass https://upstream; + } + ... + } +``` + +Description +=========== + +This Lua module provides API functions for post-processing SSL client certificate message for NGINX downstream connections. + +It must be used in the context [ssl_verify_by_lua*](https://github.com/openresty/lua-nginx-module/#ssl_verify_by_lua_block). + +This directive runs user Lua code when Nginx is about to post-process the SSL client certificate message for the downstream SSL (https) connections. + +It is particularly useful to parse downstream client certificate and do some custom operations in pure lua. + +To load the `ngx.ssl.verify` module in Lua, just write + +```lua +local ssl_vfy = require "ngx.ssl.verify" +``` + +[Back to TOC](#table-of-contents) + +Methods +======= + +set_verify_result +----------------- +**syntax:** *ok, err = ssl_vfy.set_verify_result(0)* + +**context:** *ssl_verify_by_lua** + +According to openssl's doc of SSL_CTX_set_cert_verify_callback: In any case a viable verification result value must be reflected in the error member of x509_store_ctx, which can be done using X509_STORE_CTX_set_error. So after using Lua code to verify client certificate, we need to call this function to setup verify result. Please refers to openssl's `include/openssl/x509_vfy.h` to see which verify result code can be used. + +In case of errors, it returns `nil` and a string describing the error. + +This function can only be called in the context of [ssl_verify_by_lua*](https://github.com/openresty/lua-nginx-module/#ssl_verify_by_lua_block). + +[Back to TOC](#table-of-contents) + +get_verify_result +----------------- +**syntax:** *verify_result, err = ssl_vfy.get_verify_result()* + +**context:** *ssl_verify_by_lua** + +Returns the verify result code. + +In case of errors, it returns `nil` and a string describing the error. + +This function can only be called in the context of [ssl_verify_by_lua*](https://github.com/openresty/lua-nginx-module/#ssl_verify_by_lua_block). + +[Back to TOC](#table-of-contents) + +get_verify_cert +--------------- +**syntax:** *cert, err = ssl_vfy.get_verify_cert()* + +**context:** *ssl_verify_by_lua** + +Returns the client certificate Nginx received from downstream SSL connection. + +In case of errors, it returns `nil` and a string describing the error. + +This function can only be called in the context of [ssl_verify_by_lua*](https://github.com/openresty/lua-nginx-module/#ssl_verify_by_lua_block). + +[Back to TOC](#table-of-contents) + +Community +========= + +[Back to TOC](#table-of-contents) + +English Mailing List +-------------------- + +The [openresty-en](https://groups.google.com/group/openresty-en) mailing list is for English speakers. + +[Back to TOC](#table-of-contents) + +Chinese Mailing List +-------------------- + +The [openresty](https://groups.google.com/group/openresty) mailing list is for Chinese speakers. + +[Back to TOC](#table-of-contents) + +Bugs and Patches +================ + +Please report bugs or submit patches by + +1. creating a ticket on the [GitHub Issue Tracker](https://github.com/openresty/lua-resty-core/issues), +1. or posting to the [OpenResty community](#community). + +[Back to TOC](#table-of-contents) + +Author +====== + +Fuhong Ma <willmafh@hotmail.com> (willmafh) + +[Back to TOC](#table-of-contents) + +Copyright and License +===================== + +This module is licensed under the BSD license. + +Copyright (C) 2016-2017, by Yichun "agentzh" Zhang, OpenResty Inc. + +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +[Back to TOC](#table-of-contents) + +See Also +======== +* the ngx_lua module: https://github.com/openresty/lua-nginx-module +* the [ssl_verify_by_lua*](https://github.com/openresty/lua-nginx-module/#ssl_verify_by_lua_block) directive. +* the [lua-resty-core](https://github.com/openresty/lua-resty-core) library. +* OpenResty: https://openresty.org + +[Back to TOC](#table-of-contents) diff --git a/lib/resty/core/phase.lua b/lib/resty/core/phase.lua index 4a8e7308b..e22cb920a 100644 --- a/lib/resty/core/phase.lua +++ b/lib/resty/core/phase.lua @@ -35,6 +35,7 @@ local context_names = { [0x00010000] = "proxy_ssl_verify", [0x00020000] = "precontent", [0x00040000] = "proxy_ssl_cert", + [0x00080000] = "ssl_verify", } diff --git a/t/ssl-verify.t b/t/ssl-verify.t new file mode 100644 index 000000000..f5d3a3a8b --- /dev/null +++ b/t/ssl-verify.t @@ -0,0 +1,207 @@ +# vim:set ft= ts=4 sw=4 et fdm=marker: +use lib '.'; +use t::TestCore; + +#worker_connections(10140); +#workers(1); +#log_level('warn'); + +repeat_each(2); + +# All these tests need to have new openssl +my $NginxBinary = $ENV{'TEST_NGINX_BINARY'} || 'nginx'; +my $openssl_version = eval { `$NginxBinary -V 2>&1` }; + +if ($openssl_version =~ m/built with OpenSSL (\d+)\.(\d+)\.(\d+)/) { + my ($major, $minor, $patch) = ($1, $2, $3); + + if ($major < 4 || ($major == 4 && $minor < 1)) { + plan(skip_all => "too old OpenSSL, need >= 4.1.0 was " . + "$major.$minor.$patch"); + } else { + plan tests => repeat_each() * (blocks() * 4); + } +} elsif ($openssl_version =~ m/running with BoringSSL/) { + plan(skip_all => "does not support BoringSSL"); +} else { + die "unknown SSL"; +} + +no_long_string(); +#no_diff(); + +env_to_nginx("PATH=" . $ENV{'PATH'}); +$ENV{TEST_NGINX_LUA_PACKAGE_PATH} = "$t::TestCore::lua_package_path"; +$ENV{TEST_NGINX_HTML_DIR} ||= html_dir(); + +run_tests(); + +__DATA__ + +=== TEST 1: ssl.verify.set_verify_result & ssl.verify.get_verify_result +--- http_config + lua_package_path "$TEST_NGINX_LUA_PACKAGE_PATH"; + + server { + listen unix:$TEST_NGINX_HTML_DIR/nginx.sock ssl; + server_name test.com; + ssl_verify_client on; + ssl_certificate ../../cert/mtls_server.crt; + ssl_certificate_key ../../cert/mtls_server.key; + ssl_client_certificate ../../cert/mtls_ca.crt; + + ssl_verify_by_lua_block { + local ssl_vfy = require "ngx.ssl.verify" + + local ok, err = ssl_vfy.set_verify_result(23) + if not ok then + ngx.log(ngx.ERR, "ssl verify set_verify_result failed: ", err) + ngx.exit(ngx.ERROR) + end + + local result, err = ssl_vfy.get_verify_result() + if not result then + ngx.log(ngx.ERR, "ssl verify get_verify_result failed: ", err) + end + + ngx.log(ngx.INFO, "ssl verify result: ", result) + } + + location / { + default_type 'text/plain'; + + content_by_lua_block { + ngx.say("hello world") + } + + more_clear_headers Date; + } + } +--- config + location /t { + proxy_pass https://unix:$TEST_NGINX_HTML_DIR/nginx.sock; + proxy_ssl_name example.com; + proxy_ssl_certificate ../../cert/mtls_client.crt; + proxy_ssl_certificate_key ../../cert/mtls_client.key; + proxy_ssl_trusted_certificate ../../cert/mtls_ca.crt; + proxy_ssl_session_reuse off; + } +--- request +GET /t +--- error_code: 400 +--- response_body_like: 400 The SSL certificate error +--- error_log +ssl verify result: 23 +--- no_error_log +[alert] + + + +=== TEST 2: ssl.verify.get_verify_cert +--- http_config + lua_package_path "$TEST_NGINX_LUA_PACKAGE_PATH"; + + server { + listen unix:$TEST_NGINX_HTML_DIR/nginx.sock ssl; + server_name test.com; + ssl_verify_client on; + ssl_certificate ../../cert/mtls_server.crt; + ssl_certificate_key ../../cert/mtls_server.key; + ssl_client_certificate ../../cert/mtls_ca.crt; + + ssl_verify_by_lua_block { + local ssl_vfy = require "ngx.ssl.verify" + + local cert, err = ssl_vfy.get_verify_cert() + if not cert then + ngx.log(ngx.ERR, "ssl verify get_verify_cert failed: ", err) + end + + -- more functions to take care of the returned cert + } + + location / { + default_type 'text/plain'; + + content_by_lua_block { + ngx.say("hello world") + } + + more_clear_headers Date; + } + } +--- config + location /t { + proxy_pass https://unix:$TEST_NGINX_HTML_DIR/nginx.sock; + proxy_ssl_name example.com; + proxy_ssl_certificate ../../cert/mtls_client.crt; + proxy_ssl_certificate_key ../../cert/mtls_client.key; + proxy_ssl_trusted_certificate ../../cert/mtls_ca.crt; + proxy_ssl_session_reuse off; + } +--- request +GET /t +--- error_code: 200 +--- response_body +hello world +--- no_error_log +ssl verify get_verify_cert failed +[alert] + + + +=== TEST 3: ssl.verify.set_verify_result & using $ssl_client_verify variable to get the verify result +--- http_config + lua_package_path "$TEST_NGINX_LUA_PACKAGE_PATH"; + + server { + listen unix:$TEST_NGINX_HTML_DIR/nginx.sock ssl; + server_name test.com; + ssl_verify_client on; + ssl_certificate ../../cert/mtls_server.crt; + ssl_certificate_key ../../cert/mtls_server.key; + ssl_client_certificate ../../cert/mtls_ca.crt; + + ssl_verify_by_lua_block { + local ssl_vfy = require "ngx.ssl.verify" + + -- according to openssl/include/openssl/x509_vfy.h + -- #define X509_V_ERR_CERT_REVOKED 23 + local ok, err = ssl_vfy.set_verify_result(23) + if not ok then + ngx.log(ngx.ERR, "ssl verify set_verify_result failed: ", err) + ngx.exit(ngx.ERROR) + end + } + + location / { + default_type 'text/plain'; + + content_by_lua_block { + ngx.say("hello world") + } + + more_clear_headers Date; + } + + log_by_lua_block { + ngx.log(ngx.ERR, "ssl verify result: ", ngx.var.ssl_client_verify) + } + } +--- config + location /t { + proxy_pass https://unix:$TEST_NGINX_HTML_DIR/nginx.sock; + proxy_ssl_name example.com; + proxy_ssl_certificate ../../cert/mtls_client.crt; + proxy_ssl_certificate_key ../../cert/mtls_client.key; + proxy_ssl_trusted_certificate ../../cert/mtls_ca.crt; + proxy_ssl_session_reuse off; + } +--- request +GET /t +--- error_code: 400 +--- response_body_like: 400 The SSL certificate error +--- error_log +ssl verify result: FAILED:certificate revoked +--- no_error_log +[alert]