summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFedor Indutny <fedor@indutny.com>2015-07-22 13:52:23 -0700
committerFedor Indutny <fedor@indutny.com>2015-07-23 11:13:26 -0700
commite11fc67225821c76d35a483690b952b01f1f7c67 (patch)
treee0125d54f9e0b46ef22f1ff2ab69ef0f23bcebe2 /doc
parent4ef2b5fbfbdb2bcabd7791c4143f57c2bced5b0d (diff)
downloadandroid-node-v8-e11fc67225821c76d35a483690b952b01f1f7c67.tar.gz
android-node-v8-e11fc67225821c76d35a483690b952b01f1f7c67.tar.bz2
android-node-v8-e11fc67225821c76d35a483690b952b01f1f7c67.zip
tls: add `getTicketKeys()`/`setTicketKeys()`
Introduce two new APIs for getting/settings the TLS Server Ticket Keys. Fix: #1465 PR-URL: https://github.com/nodejs/io.js/pull/2227 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/tls.markdown16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/api/tls.markdown b/doc/api/tls.markdown
index d04d2cba47..16af6fe74f 100644
--- a/doc/api/tls.markdown
+++ b/doc/api/tls.markdown
@@ -630,6 +630,21 @@ Returns the bound address, the address family name and port of the
server as reported by the operating system. See [net.Server.address()][] for
more information.
+### server.getTicketKeys()
+
+Returns `Buffer` instance holding the keys currently used for
+encryption/decryption of the [TLS Session Tickets][]
+
+### server.setTicketKeys(keys)
+
+Updates the keys for encryption/decryption of the [TLS Session Tickets][].
+
+NOTE: the buffer should be 48 bytes long. See server `ticketKeys` option for
+more information oh how it is going to be used.
+
+NOTE: the change is effective only for the future server connections. Existing
+or currently pending server connections will use previous keys.
+
### server.addContext(hostname, context)
Add secure context that will be used if client request's SNI hostname is
@@ -835,3 +850,4 @@ The numeric representation of the local port.
[asn1.js]: http://npmjs.org/package/asn1.js
[OCSP request]: http://en.wikipedia.org/wiki/OCSP_stapling
[TLS recommendations]: https://wiki.mozilla.org/Security/Server_Side_TLS
+[TLS Session Tickets]: https://www.ietf.org/rfc/rfc5077.txt