Skip to content

Commit f9c302a

Browse files
committed
Update mTLS documentation
1 parent 3ad9ff6 commit f9c302a

File tree

2 files changed

+5
-10
lines changed

2 files changed

+5
-10
lines changed

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Production ready.
1919
* Request pipelining
2020
* Trailers
2121
* HTTP proxy connections
22+
* mTLS (requires `ngx_lua_http_module` >= v0.10.23)
2223

2324

2425
## API
@@ -176,6 +177,8 @@ The options table has the following fields:
176177
* `ssl_verify`: option as per [OpenResty docs](https://github.com/openresty/lua-nginx-module#tcpsocksslhandshake), except that it defaults to `true`.
177178
* `ssl_server_name`: option as per [OpenResty docs](https://github.com/openresty/lua-nginx-module#tcpsocksslhandshake)
178179
* `ssl_send_status_req`: option as per [OpenResty docs](https://github.com/openresty/lua-nginx-module#tcpsocksslhandshake)
180+
* `ssl_client_cert`: will be passed to `tcpsock:setclientcert`. Requires `ngx_lua_http_module` >= v0.10.23.
181+
* `ssl_client_priv_key`: as above.
179182

180183
## set\_timeout
181184

lib/resty/http_connect.lua

+2-10
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,8 @@ client:connect {
3030
ssl_verify = true, -- NOTE: defaults to true
3131
ctx = nil, -- NOTE: not supported
3232
33-
-- mTLS options (experimental!)
34-
--
35-
-- !!! IMPORTANT !!! These options require support for mTLS in cosockets,
36-
-- which is currently only available in the following unmerged PRs.
37-
--
38-
-- * https://github.com/openresty/lua-nginx-module/pull/1602
39-
-- * https://github.com/openresty/lua-resty-core/pull/278
40-
--
41-
-- The details of this feature may change. You have been warned!
42-
--
33+
-- mTLS options: These require support for mTLS in cosockets, which first
34+
-- appeared in `ngx_http_lua_module` v0.10.23.
4335
ssl_client_cert = nil,
4436
ssl_client_priv_key = nil,
4537

0 commit comments

Comments
 (0)