doc: add TLS session resumption example
authorRoman Reiss <me@silverwind.io>
Tue, 6 Oct 2015 18:50:45 +0000 (20:50 +0200)
committerJames M Snell <jasnell@gmail.com>
Thu, 8 Oct 2015 03:39:18 +0000 (20:39 -0700)
Using TLS session resumption correctly is not obvious. This added
example code should help new users understand how to use it correctly.

Related issue: https://github.com/nodejs/node/issues/3132
PR-URL: https://github.com/nodejs/node/pull/3147
Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com>
doc/api/tls.markdown

index 93779e5..eb98328 100644 (file)
@@ -603,6 +603,16 @@ perform lookup in external storage using given `sessionId`, and invoke
 NOTE: adding this event listener will have an effect only on connections
 established after addition of event listener.
 
+Here's an example for using TLS session resumption:
+
+  var tlsSessionStore = {};
+  server.on('newSession', function(id, data, cb) {
+    tlsSessionStore[id.toString('hex')] = data;
+    cb();
+  });
+  server.on('resumeSession', function(id, cb) {
+    cb(null, tlsSessionStore[id.toString('hex')] || null);
+  });
 
 ### Event: 'OCSPRequest'