Skip to content

Commit 3c6624d

Browse files
committed
feat(doc) add stream api subsystem in tls doc
1 parent b01d6c9 commit 3c6624d

File tree

2 files changed

+13
-12
lines changed

2 files changed

+13
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ resty.kong.tls.request\_client\_certificate
148148

149149
**context:** *ssl_certificate_by_lua**
150150

151-
**subsystems:** *http*
151+
**subsystems:** *http* *stream*
152152

153153
Requests client to present its client-side certificate to initiate mutual TLS
154154
authentication between server and client.
@@ -171,7 +171,7 @@ resty.kong.tls.disable\_session\_reuse
171171

172172
**context:** *ssl_certificate_by_lua**
173173

174-
**subsystems:** *http*
174+
**subsystems:** *http* *stream*
175175

176176
Prevents the TLS session for the current connection from being reused by
177177
disabling session ticket and session ID for the current TLS connection.
@@ -185,9 +185,9 @@ resty.kong.tls.get\_full\_client\_certificate\_chain
185185
----------------------------------------------------
186186
**syntax:** *pem_chain, err = resty.kong.tls.get\_full\_client\_certificate\_chain()*
187187

188-
**context:** *rewrite_by_lua*, access_by_lua*, content_by_lua*, log_by_lua**
188+
**context:** *rewrite_by_lua*, access_by_lua*, content_by_lua*, log_by_lua**, *preread_by_lua**
189189

190-
**subsystems:** *http*
190+
**subsystems:** *http* *stream*
191191

192192
Returns the PEM encoded downstream client certificate chain with the client certificate
193193
at the top and intermediate certificates (if any) at the bottom.
@@ -215,9 +215,9 @@ resty.kong.tls.set\_upstream\_cert\_and\_key
215215
--------------------------------------------
216216
**syntax:** *ok, err = resty.kong.tls.set\_upstream\_cert\_and\_key(chain, key)*
217217

218-
**context:** *rewrite_by_lua*, access_by_lua*, balancer_by_lua**
218+
**context:** *rewrite_by_lua*, access_by_lua*, balancer_by_lua**, *preread_by_lua**
219219

220-
**subsystems:** *http*
220+
**subsystems:** *http* *stream*
221221

222222
Overrides and enables sending client certificate while connecting to the
223223
upstream in the current request.
@@ -241,9 +241,9 @@ resty.kong.tls.set\_upstream\_ssl\_trusted\_store
241241
-------------------------------------------------
242242
**syntax:** *ok, err = resty.kong.tls.set\_upstream\_ssl\_trusted\_store(store)*
243243

244-
**context:** *rewrite_by_lua*, access_by_lua*, balancer_by_lua**
244+
**context:** *rewrite_by_lua*, access_by_lua*, balancer_by_lua**, *preread_by_lua**
245245

246-
**subsystems:** *http*
246+
**subsystems:** *http* *stream*
247247

248248
Set upstream ssl verification trusted store of current request. Global setting set by
249249
`proxy_ssl_trusted_certificate` will be overwritten for the current request.
@@ -303,9 +303,9 @@ resty.kong.tls.set\_upstream\_ssl\_verify
303303
-----------------------------------------
304304
**syntax:** *ok, err = resty.kong.tls.set\_upstream\_ssl\_verify(verify)*
305305

306-
**context:** *rewrite_by_lua*, access_by_lua*, balancer_by_lua**
306+
**context:** *rewrite_by_lua*, access_by_lua*, balancer_by_lua**, *preread_by_lua**
307307

308-
**subsystems:** *http*
308+
**subsystems:** *http* *stream*
309309

310310
Set upstream ssl verification enablement of current request to the given boolean
311311
argument `verify`. Global setting set by `proxy_ssl_verify` will be overwritten.
@@ -322,9 +322,9 @@ resty.kong.tls.set\_upstream\_ssl\_verify\_depth
322322
------------------------------------------------
323323
**syntax:** *ok, err = resty.kong.tls.set\_upstream\_ssl\_verify\_depth(depth)*
324324

325-
**context:** *rewrite_by_lua*, access_by_lua*, balancer_by_lua**
325+
**context:** *rewrite_by_lua*, access_by_lua*, balancer_by_lua**, *preread_by_lua**
326326

327-
**subsystems:** *http*
327+
**subsystems:** *http* *stream*
328328

329329
Set upstream ssl verification depth of current request to the given non-negative integer
330330
argument `depth`. Global setting set by `proxy_ssl_verify_depth` will be overwritten.

lualib/resty/kong/tls.lua

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,7 @@ do
143143
['access'] = true,
144144
['content'] = true,
145145
['log'] = true,
146+
['preread'] = true,
146147
}
147148

148149
function _M.get_full_client_certificate_chain()

0 commit comments

Comments
 (0)