tls: deprecate newSession/resumeSession events#5774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
indutny wants to merge 1 commit into from
Closed

tls: deprecate newSession/resumeSession events #5774

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions doc/api/tls.markdown
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -194,6 +194,9 @@ established it will be forwarded here.

### Event: 'newSession'

Stability: 0 - Deprecated: Use synchronous `newSession` option-callback of
[`tls.createServer`][] instead.

`function (sessionId, sessionData, callback) { }`

Emitted on creation of TLS session. May be used to store sessions in external
Expand DownExpand Up@@ -243,6 +246,9 @@ certificates.

### Event: 'resumeSession'

Stability: 0 - Deprecated: Use synchronous `resumeSession` option-callback of
[`tls.createServer`][] instead.

`function (sessionId, callback) { }`

Emitted when client wants to resume previous TLS session. Event listener may
Expand DownExpand Up@@ -898,6 +904,13 @@ automatically set as a listener for the [`'secureConnection'`][] event. The
SSL version 3. The possible values depend on your installation of
OpenSSL and are defined in the constant [SSL_METHODS][].

- `newSession`: A callback to invoke when creating new TLS session
(Signature: `newSession(sessionId, sessionData)`).

- `resumeSession`: A callback to invoke when client attempts to resume some
TLS session by id (Signature: `resumeSession(sessionId)`, should return
`undefined` or `Buffer` instance with `sessionData` from `newSession`).

Here is a simple example echo server:

```js
Expand Down
11 changes: 11 additions & 0 deletions lib/_tls_common.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,3 +173,14 @@ exports.translatePeerCertificate = function translatePeerCertificate(c) {
}
return c;
};

exports.deprecateAsyncSessionAPI = function deprecateAsyncSessionAPI(server) {
const asyncSessionWarning = internalUtil.deprecate(() => {},
'server.on(\'newSession\')/server.on(\'resumeSession\') are deprecated.' +
' Please upgrade to synchronous API and pass these callbacks in ' +
'options.newSession (options.resumeSession).');
server.on('newListener', (type) => {
if (/^(new|resume)Session$/.test(type))
asyncSessionWarning();
});
};
29 changes: 24 additions & 5 deletions lib/_tls_wrap.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,10 +72,16 @@ function loadSession(self, hello, cb) {
cb(null, ret);
}

if (hello.sessionId.length <= 0 ||
hello.tlsTicket ||
self.server &&
!self.server.emit('resumeSession', hello.sessionId, onSession)) {
if (hello.sessionId.length <= 0 || hello.tlsTicket) {
return cb(null);
}

assert(self.server);
if (self.server.onResumeSession) {
return onSession(null, self.server.onResumeSession(hello.sessionId));
}

if (!self.server.emit('resumeSession', hello.sessionId, onSession)) {
cb(null);
}
}
Expand DownExpand Up@@ -183,6 +189,12 @@ function onnewsession(key, session) {
var once = false;

this._newSessionPending = true;
if (this.server.onNewSession) {
this.server.onNewSession(key, session);
done();
return;
}

if (!this.server.emit('newSession', key, session, done))
done();

Expand DownExpand Up@@ -398,7 +410,9 @@ TLSSocket.prototype._init = function(socket, wrap) {
ssl.handshakes = 0;

if (this.server) {
if (this.server.listenerCount('resumeSession') > 0 ||
if (this.server.onNewSession ||
this.server.onResumeSession ||
this.server.listenerCount('resumeSession') > 0 ||
this.server.listenerCount('newSession') > 0) {
ssl.enableSessionCallbacks();
}
Expand DownExpand Up@@ -828,6 +842,8 @@ function Server(/* [options], listener */) {
if (listener) {
this.on('secureConnection', listener);
}

common.deprecateAsyncSessionAPI(this);
}

util.inherits(Server, net.Server);
Expand DownExpand Up@@ -902,6 +918,9 @@ Server.prototype.setOptions = function(options) {
.digest('hex')
.slice(0, 32);
}

if (options.newSession) this.onNewSession = options.newSession;
if (options.resumeSession) this.onResumeSession = options.resumeSession;
};

// SNI Contexts High-Level API
Expand Down
95 changes: 58 additions & 37 deletions test/parallel/test-tls-session-cache.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,13 +11,7 @@ if (!common.hasCrypto) {
return;
}

doTest({ tickets: false }, function() {
doTest({ tickets: true }, function() {
console.error('all done');
});
});

function doTest(testOptions, callback) {
const doTest = (testOptions, callback) => {
var assert = require('assert');
var tls = require('tls');
var fs = require('fs');
Expand All@@ -38,8 +32,23 @@ function doTest(testOptions, callback) {
var resumeCount = 0;
var session;

var server = tls.createServer(options, function(cleartext) {
cleartext.on('error', function(er) {
if (testOptions.sync) {
options.newSession = (id, data) => {
assert.ok(!session);
session = { id: id, data: data };
};

options.resumeSession = (id) => {
++resumeCount;
assert.ok(session);
assert.equal(session.id.toString('hex'), id.toString('hex'));

return session.data;
};
}

var server = tls.createServer(options, (cleartext) => {
cleartext.on('error', (er) => {
// We're ok with getting ECONNRESET in this test, but it's
// timing-dependent, and thus unreliable. Any other errors
// are just failures, though.
Expand All@@ -49,27 +58,30 @@ function doTest(testOptions, callback) {
++requestCount;
cleartext.end();
});
server.on('newSession', function(id, data, cb) {
// Emulate asynchronous store
setTimeout(function() {
assert.ok(!session);
session = {
id: id,
data: data
};
cb();
}, 1000);
});
server.on('resumeSession', function(id, callback) {
++resumeCount;
assert.ok(session);
assert.equal(session.id.toString('hex'), id.toString('hex'));

// Just to check that async really works there
setTimeout(function() {
callback(null, session.data);
}, 100);
});

if (!testOptions.sync) {
server.on('newSession', (id, data, cb) => {
// Emulate asynchronous store
setTimeout(() => {
assert.ok(!session);
session = {
id: id,
data: data
};
cb();
}, 1000);
});
server.on('resumeSession', (id, callback) => {
++resumeCount;
assert.ok(session);
assert.equal(session.id.toString('hex'), id.toString('hex'));

// Just to check that async really works there
setTimeout(() => {
callback(null, session.data);
}, 100);
});
}

var args = [
's_client',
Expand All@@ -85,25 +97,25 @@ function doTest(testOptions, callback) {
if (common.isWindows)
args.push('-no_rand_screen');

server.listen(common.PORT, function() {
server.listen(common.PORT, () => {
var client = spawn(common.opensslCli, args, {
stdio: [ 0, 1, 'pipe' ]
stdio: [ 0, 'ignore', 'pipe' ]
});
var err = '';
client.stderr.setEncoding('utf8');
client.stderr.on('data', function(chunk) {
client.stderr.on('data', (chunk) => {
err += chunk;
});
client.on('exit', function(code) {
client.on('exit', (code) => {
console.error('done');
assert.equal(code, 0);
server.close(function() {
server.close(() => {
setTimeout(callback, 100);
});
});
});

process.on('exit', function() {
process.on('exit', () => {
if (testOptions.tickets) {
assert.equal(requestCount, 6);
assert.equal(resumeCount, 0);
Expand All@@ -114,4 +126,13 @@ function doTest(testOptions, callback) {
assert.equal(resumeCount, 5);
}
});
}
};

doTest({ tickets: false, sync: false }, () => {
doTest({ tickets: true, sync: false }, () => {
doTest({ tickets: false, sync: true }, () => {
console.error('all done');
});
});
});

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
tls: deprecate newSession/resumeSession events#5774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

indutny
wants to merge
1
commit into

from

 Closed


tls: deprecate newSession/resumeSession events
#5774
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
doc/api/tls.markdown

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -194,6 +194,9 @@ established it will be forwarded here.

### Event: 'newSession'

Stability: 0 - Deprecated: Use synchronous `newSession` option-callback of
[`tls.createServer`][] instead.

`function (sessionId, sessionData, callback) { }`

Emitted on creation of TLS session. May be used to store sessions in external
Expand DownExpand Up@@ -243,6 +246,9 @@ certificates.

### Event: 'resumeSession'

Stability: 0 - Deprecated: Use synchronous `resumeSession` option-callback of
[`tls.createServer`][] instead.

`function (sessionId, callback) { }`

Emitted when client wants to resume previous TLS session. Event listener may
Expand DownExpand Up@@ -898,6 +904,13 @@ automatically set as a listener for the [`'secureConnection'`][] event. The
 SSL version 3. The possible values depend on your installation of
 OpenSSL and are defined in the constant [SSL_METHODS][].

 - `newSession`: A callback to invoke when creating new TLS session
 (Signature: `newSession(sessionId, sessionData)`).

 - `resumeSession`: A callback to invoke when client attempts to resume some
 TLS session by id (Signature: `resumeSession(sessionId)`, should return
 `undefined` or `Buffer` instance with `sessionData` from `newSession`).

Here is a simple example echo server:

```js
Expand Down

11 changes: 11 additions & 0 deletions
lib/_tls_common.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,3 +173,14 @@ exports.translatePeerCertificate = function translatePeerCertificate(c) {
 }
 return c;
};

exports.deprecateAsyncSessionAPI = function deprecateAsyncSessionAPI(server) {
 const asyncSessionWarning = internalUtil.deprecate(() => {},
 'server.on(\'newSession\')/server.on(\'resumeSession\') are deprecated.' +
 ' Please upgrade to synchronous API and pass these callbacks in ' +
 'options.newSession (options.resumeSession).');
 server.on('newListener', (type) => {
 if (/^(new|resume)Session$/.test(type))
 asyncSessionWarning();
 });
};

29 changes: 24 additions & 5 deletions
lib/_tls_wrap.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -72,10 +72,16 @@ function loadSession(self, hello, cb) {
 cb(null, ret);
 }

 if (hello.sessionId.length <= 0 ||
 hello.tlsTicket ||
 self.server &&
 !self.server.emit('resumeSession', hello.sessionId, onSession)) {
 if (hello.sessionId.length <= 0 || hello.tlsTicket) {
 return cb(null);
 }

 assert(self.server);
 if (self.server.onResumeSession) {
 return onSession(null, self.server.onResumeSession(hello.sessionId));
 }

 if (!self.server.emit('resumeSession', hello.sessionId, onSession)) {
 cb(null);
 }
}
Expand DownExpand Up@@ -183,6 +189,12 @@ function onnewsession(key, session) {
 var once = false;

 this._newSessionPending = true;
 if (this.server.onNewSession) {
 this.server.onNewSession(key, session);
 done();
 return;
 }

 if (!this.server.emit('newSession', key, session, done))
 done();

Expand DownExpand Up@@ -398,7 +410,9 @@ TLSSocket.prototype._init = function(socket, wrap) {
 ssl.handshakes = 0;

 if (this.server) {
 if (this.server.listenerCount('resumeSession') > 0 ||
 if (this.server.onNewSession ||
 this.server.onResumeSession ||
 this.server.listenerCount('resumeSession') > 0 ||
 this.server.listenerCount('newSession') > 0) {
 ssl.enableSessionCallbacks();
 }
Expand DownExpand Up@@ -828,6 +842,8 @@ function Server(/* [options], listener */) {
 if (listener) {
 this.on('secureConnection', listener);
 }

 common.deprecateAsyncSessionAPI(this);
}

util.inherits(Server, net.Server);
Expand DownExpand Up@@ -902,6 +918,9 @@ Server.prototype.setOptions = function(options) {
 .digest('hex')
 .slice(0, 32);
 }

 if (options.newSession) this.onNewSession = options.newSession;
 if (options.resumeSession) this.onResumeSession = options.resumeSession;
};

// SNI Contexts High-Level API
Expand Down

95 changes: 58 additions & 37 deletions
test/parallel/test-tls-session-cache.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,13 +11,7 @@ if (!common.hasCrypto) {
 return;
}

doTest({ tickets: false }, function() {
 doTest({ tickets: true }, function() {
 console.error('all done');
 });
});

function doTest(testOptions, callback) {
const doTest = (testOptions, callback) => {
 var assert = require('assert');
 var tls = require('tls');
 var fs = require('fs');
Expand All@@ -38,8 +32,23 @@ function doTest(testOptions, callback) {
 var resumeCount = 0;
 var session;

 var server = tls.createServer(options, function(cleartext) {
 cleartext.on('error', function(er) {
 if (testOptions.sync) {
 options.newSession = (id, data) => {
 assert.ok(!session);
 session = { id: id, data: data };
 };

 options.resumeSession = (id) => {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 return session.data;
 };
 }

 var server = tls.createServer(options, (cleartext) => {
 cleartext.on('error', (er) => {
 // We're ok with getting ECONNRESET in this test, but it's
 // timing-dependent, and thus unreliable. Any other errors
 // are just failures, though.
Expand All@@ -49,27 +58,30 @@ function doTest(testOptions, callback) {
 ++requestCount;
 cleartext.end();
 });
 server.on('newSession', function(id, data, cb) {
 // Emulate asynchronous store
 setTimeout(function() {
 assert.ok(!session);
 session = {
 id: id,
 data: data
 };
 cb();
 }, 1000);
 });
 server.on('resumeSession', function(id, callback) {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 // Just to check that async really works there
 setTimeout(function() {
 callback(null, session.data);
 }, 100);
 });

 if (!testOptions.sync) {
 server.on('newSession', (id, data, cb) => {
 // Emulate asynchronous store
 setTimeout(() => {
 assert.ok(!session);
 session = {
 id: id,
 data: data
 };
 cb();
 }, 1000);
 });
 server.on('resumeSession', (id, callback) => {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 // Just to check that async really works there
 setTimeout(() => {
 callback(null, session.data);
 }, 100);
 });
 }

 var args = [
 's_client',
Expand All@@ -85,25 +97,25 @@ function doTest(testOptions, callback) {
 if (common.isWindows)
 args.push('-no_rand_screen');

 server.listen(common.PORT, function() {
 server.listen(common.PORT, () => {
 var client = spawn(common.opensslCli, args, {
 stdio: [ 0, 1, 'pipe' ]
 stdio: [ 0, 'ignore', 'pipe' ]
 });
 var err = '';
 client.stderr.setEncoding('utf8');
 client.stderr.on('data', function(chunk) {
 client.stderr.on('data', (chunk) => {
 err += chunk;
 });
 client.on('exit', function(code) {
 client.on('exit', (code) => {
 console.error('done');
 assert.equal(code, 0);
 server.close(function() {
 server.close(() => {
 setTimeout(callback, 100);
 });
 });
 });

 process.on('exit', function() {
 process.on('exit', () => {
 if (testOptions.tickets) {
 assert.equal(requestCount, 6);
 assert.equal(resumeCount, 0);
Expand All@@ -114,4 +126,13 @@ function doTest(testOptions, callback) {
 assert.equal(resumeCount, 5);
 }
 });
}
};

doTest({ tickets: false, sync: false }, () => {
 doTest({ tickets: true, sync: false }, () => {
 doTest({ tickets: false, sync: true }, () => {
 console.error('all done');
 });
 });
});


, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
tls: deprecate newSession/resumeSession events#5774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

indutny
wants to merge
1
commit into

from

 Closed


tls: deprecate newSession/resumeSession events
#5774
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
doc/api/tls.markdown

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -194,6 +194,9 @@ established it will be forwarded here.

### Event: 'newSession'

Stability: 0 - Deprecated: Use synchronous `newSession` option-callback of
[`tls.createServer`][] instead.

`function (sessionId, sessionData, callback) { }`

Emitted on creation of TLS session. May be used to store sessions in external
Expand DownExpand Up@@ -243,6 +246,9 @@ certificates.

### Event: 'resumeSession'

Stability: 0 - Deprecated: Use synchronous `resumeSession` option-callback of
[`tls.createServer`][] instead.

`function (sessionId, callback) { }`

Emitted when client wants to resume previous TLS session. Event listener may
Expand DownExpand Up@@ -898,6 +904,13 @@ automatically set as a listener for the [`'secureConnection'`][] event. The
 SSL version 3. The possible values depend on your installation of
 OpenSSL and are defined in the constant [SSL_METHODS][].

 - `newSession`: A callback to invoke when creating new TLS session
 (Signature: `newSession(sessionId, sessionData)`).

 - `resumeSession`: A callback to invoke when client attempts to resume some
 TLS session by id (Signature: `resumeSession(sessionId)`, should return
 `undefined` or `Buffer` instance with `sessionData` from `newSession`).

Here is a simple example echo server:

```js
Expand Down

11 changes: 11 additions & 0 deletions
lib/_tls_common.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,3 +173,14 @@ exports.translatePeerCertificate = function translatePeerCertificate(c) {
 }
 return c;
};

exports.deprecateAsyncSessionAPI = function deprecateAsyncSessionAPI(server) {
 const asyncSessionWarning = internalUtil.deprecate(() => {},
 'server.on(\'newSession\')/server.on(\'resumeSession\') are deprecated.' +
 ' Please upgrade to synchronous API and pass these callbacks in ' +
 'options.newSession (options.resumeSession).');
 server.on('newListener', (type) => {
 if (/^(new|resume)Session$/.test(type))
 asyncSessionWarning();
 });
};

29 changes: 24 additions & 5 deletions
lib/_tls_wrap.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -72,10 +72,16 @@ function loadSession(self, hello, cb) {
 cb(null, ret);
 }

 if (hello.sessionId.length <= 0 ||
 hello.tlsTicket ||
 self.server &&
 !self.server.emit('resumeSession', hello.sessionId, onSession)) {
 if (hello.sessionId.length <= 0 || hello.tlsTicket) {
 return cb(null);
 }

 assert(self.server);
 if (self.server.onResumeSession) {
 return onSession(null, self.server.onResumeSession(hello.sessionId));
 }

 if (!self.server.emit('resumeSession', hello.sessionId, onSession)) {
 cb(null);
 }
}
Expand DownExpand Up@@ -183,6 +189,12 @@ function onnewsession(key, session) {
 var once = false;

 this._newSessionPending = true;
 if (this.server.onNewSession) {
 this.server.onNewSession(key, session);
 done();
 return;
 }

 if (!this.server.emit('newSession', key, session, done))
 done();

Expand DownExpand Up@@ -398,7 +410,9 @@ TLSSocket.prototype._init = function(socket, wrap) {
 ssl.handshakes = 0;

 if (this.server) {
 if (this.server.listenerCount('resumeSession') > 0 ||
 if (this.server.onNewSession ||
 this.server.onResumeSession ||
 this.server.listenerCount('resumeSession') > 0 ||
 this.server.listenerCount('newSession') > 0) {
 ssl.enableSessionCallbacks();
 }
Expand DownExpand Up@@ -828,6 +842,8 @@ function Server(/* [options], listener */) {
 if (listener) {
 this.on('secureConnection', listener);
 }

 common.deprecateAsyncSessionAPI(this);
}

util.inherits(Server, net.Server);
Expand DownExpand Up@@ -902,6 +918,9 @@ Server.prototype.setOptions = function(options) {
 .digest('hex')
 .slice(0, 32);
 }

 if (options.newSession) this.onNewSession = options.newSession;
 if (options.resumeSession) this.onResumeSession = options.resumeSession;
};

// SNI Contexts High-Level API
Expand Down

95 changes: 58 additions & 37 deletions
test/parallel/test-tls-session-cache.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,13 +11,7 @@ if (!common.hasCrypto) {
 return;
}

doTest({ tickets: false }, function() {
 doTest({ tickets: true }, function() {
 console.error('all done');
 });
});

function doTest(testOptions, callback) {
const doTest = (testOptions, callback) => {
 var assert = require('assert');
 var tls = require('tls');
 var fs = require('fs');
Expand All@@ -38,8 +32,23 @@ function doTest(testOptions, callback) {
 var resumeCount = 0;
 var session;

 var server = tls.createServer(options, function(cleartext) {
 cleartext.on('error', function(er) {
 if (testOptions.sync) {
 options.newSession = (id, data) => {
 assert.ok(!session);
 session = { id: id, data: data };
 };

 options.resumeSession = (id) => {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 return session.data;
 };
 }

 var server = tls.createServer(options, (cleartext) => {
 cleartext.on('error', (er) => {
 // We're ok with getting ECONNRESET in this test, but it's
 // timing-dependent, and thus unreliable. Any other errors
 // are just failures, though.
Expand All@@ -49,27 +58,30 @@ function doTest(testOptions, callback) {
 ++requestCount;
 cleartext.end();
 });
 server.on('newSession', function(id, data, cb) {
 // Emulate asynchronous store
 setTimeout(function() {
 assert.ok(!session);
 session = {
 id: id,
 data: data
 };
 cb();
 }, 1000);
 });
 server.on('resumeSession', function(id, callback) {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 // Just to check that async really works there
 setTimeout(function() {
 callback(null, session.data);
 }, 100);
 });

 if (!testOptions.sync) {
 server.on('newSession', (id, data, cb) => {
 // Emulate asynchronous store
 setTimeout(() => {
 assert.ok(!session);
 session = {
 id: id,
 data: data
 };
 cb();
 }, 1000);
 });
 server.on('resumeSession', (id, callback) => {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 // Just to check that async really works there
 setTimeout(() => {
 callback(null, session.data);
 }, 100);
 });
 }

 var args = [
 's_client',
Expand All@@ -85,25 +97,25 @@ function doTest(testOptions, callback) {
 if (common.isWindows)
 args.push('-no_rand_screen');

 server.listen(common.PORT, function() {
 server.listen(common.PORT, () => {
 var client = spawn(common.opensslCli, args, {
 stdio: [ 0, 1, 'pipe' ]
 stdio: [ 0, 'ignore', 'pipe' ]
 });
 var err = '';
 client.stderr.setEncoding('utf8');
 client.stderr.on('data', function(chunk) {
 client.stderr.on('data', (chunk) => {
 err += chunk;
 });
 client.on('exit', function(code) {
 client.on('exit', (code) => {
 console.error('done');
 assert.equal(code, 0);
 server.close(function() {
 server.close(() => {
 setTimeout(callback, 100);
 });
 });
 });

 process.on('exit', function() {
 process.on('exit', () => {
 if (testOptions.tickets) {
 assert.equal(requestCount, 6);
 assert.equal(resumeCount, 0);
Expand All@@ -114,4 +126,13 @@ function doTest(testOptions, callback) {
 assert.equal(resumeCount, 5);
 }
 });
}
};

doTest({ tickets: false, sync: false }, () => {
 doTest({ tickets: true, sync: false }, () => {
 doTest({ tickets: false, sync: true }, () => {
 console.error('all done');
 });
 });
});


, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
tls: deprecate newSession/resumeSession events#5774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

indutny
wants to merge
1
commit into

from

 Closed


tls: deprecate newSession/resumeSession events
#5774
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
doc/api/tls.markdown

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -194,6 +194,9 @@ established it will be forwarded here.

### Event: 'newSession'

Stability: 0 - Deprecated: Use synchronous `newSession` option-callback of
[`tls.createServer`][] instead.

`function (sessionId, sessionData, callback) { }`

Emitted on creation of TLS session. May be used to store sessions in external
Expand DownExpand Up@@ -243,6 +246,9 @@ certificates.

### Event: 'resumeSession'

Stability: 0 - Deprecated: Use synchronous `resumeSession` option-callback of
[`tls.createServer`][] instead.

`function (sessionId, callback) { }`

Emitted when client wants to resume previous TLS session. Event listener may
Expand DownExpand Up@@ -898,6 +904,13 @@ automatically set as a listener for the [`'secureConnection'`][] event. The
 SSL version 3. The possible values depend on your installation of
 OpenSSL and are defined in the constant [SSL_METHODS][].

 - `newSession`: A callback to invoke when creating new TLS session
 (Signature: `newSession(sessionId, sessionData)`).

 - `resumeSession`: A callback to invoke when client attempts to resume some
 TLS session by id (Signature: `resumeSession(sessionId)`, should return
 `undefined` or `Buffer` instance with `sessionData` from `newSession`).

Here is a simple example echo server:

```js
Expand Down

11 changes: 11 additions & 0 deletions
lib/_tls_common.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,3 +173,14 @@ exports.translatePeerCertificate = function translatePeerCertificate(c) {
 }
 return c;
};

exports.deprecateAsyncSessionAPI = function deprecateAsyncSessionAPI(server) {
 const asyncSessionWarning = internalUtil.deprecate(() => {},
 'server.on(\'newSession\')/server.on(\'resumeSession\') are deprecated.' +
 ' Please upgrade to synchronous API and pass these callbacks in ' +
 'options.newSession (options.resumeSession).');
 server.on('newListener', (type) => {
 if (/^(new|resume)Session$/.test(type))
 asyncSessionWarning();
 });
};

29 changes: 24 additions & 5 deletions
lib/_tls_wrap.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -72,10 +72,16 @@ function loadSession(self, hello, cb) {
 cb(null, ret);
 }

 if (hello.sessionId.length <= 0 ||
 hello.tlsTicket ||
 self.server &&
 !self.server.emit('resumeSession', hello.sessionId, onSession)) {
 if (hello.sessionId.length <= 0 || hello.tlsTicket) {
 return cb(null);
 }

 assert(self.server);
 if (self.server.onResumeSession) {
 return onSession(null, self.server.onResumeSession(hello.sessionId));
 }

 if (!self.server.emit('resumeSession', hello.sessionId, onSession)) {
 cb(null);
 }
}
Expand DownExpand Up@@ -183,6 +189,12 @@ function onnewsession(key, session) {
 var once = false;

 this._newSessionPending = true;
 if (this.server.onNewSession) {
 this.server.onNewSession(key, session);
 done();
 return;
 }

 if (!this.server.emit('newSession', key, session, done))
 done();

Expand DownExpand Up@@ -398,7 +410,9 @@ TLSSocket.prototype._init = function(socket, wrap) {
 ssl.handshakes = 0;

 if (this.server) {
 if (this.server.listenerCount('resumeSession') > 0 ||
 if (this.server.onNewSession ||
 this.server.onResumeSession ||
 this.server.listenerCount('resumeSession') > 0 ||
 this.server.listenerCount('newSession') > 0) {
 ssl.enableSessionCallbacks();
 }
Expand DownExpand Up@@ -828,6 +842,8 @@ function Server(/* [options], listener */) {
 if (listener) {
 this.on('secureConnection', listener);
 }

 common.deprecateAsyncSessionAPI(this);
}

util.inherits(Server, net.Server);
Expand DownExpand Up@@ -902,6 +918,9 @@ Server.prototype.setOptions = function(options) {
 .digest('hex')
 .slice(0, 32);
 }

 if (options.newSession) this.onNewSession = options.newSession;
 if (options.resumeSession) this.onResumeSession = options.resumeSession;
};

// SNI Contexts High-Level API
Expand Down

95 changes: 58 additions & 37 deletions
test/parallel/test-tls-session-cache.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,13 +11,7 @@ if (!common.hasCrypto) {
 return;
}

doTest({ tickets: false }, function() {
 doTest({ tickets: true }, function() {
 console.error('all done');
 });
});

function doTest(testOptions, callback) {
const doTest = (testOptions, callback) => {
 var assert = require('assert');
 var tls = require('tls');
 var fs = require('fs');
Expand All@@ -38,8 +32,23 @@ function doTest(testOptions, callback) {
 var resumeCount = 0;
 var session;

 var server = tls.createServer(options, function(cleartext) {
 cleartext.on('error', function(er) {
 if (testOptions.sync) {
 options.newSession = (id, data) => {
 assert.ok(!session);
 session = { id: id, data: data };
 };

 options.resumeSession = (id) => {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 return session.data;
 };
 }

 var server = tls.createServer(options, (cleartext) => {
 cleartext.on('error', (er) => {
 // We're ok with getting ECONNRESET in this test, but it's
 // timing-dependent, and thus unreliable. Any other errors
 // are just failures, though.
Expand All@@ -49,27 +58,30 @@ function doTest(testOptions, callback) {
 ++requestCount;
 cleartext.end();
 });
 server.on('newSession', function(id, data, cb) {
 // Emulate asynchronous store
 setTimeout(function() {
 assert.ok(!session);
 session = {
 id: id,
 data: data
 };
 cb();
 }, 1000);
 });
 server.on('resumeSession', function(id, callback) {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 // Just to check that async really works there
 setTimeout(function() {
 callback(null, session.data);
 }, 100);
 });

 if (!testOptions.sync) {
 server.on('newSession', (id, data, cb) => {
 // Emulate asynchronous store
 setTimeout(() => {
 assert.ok(!session);
 session = {
 id: id,
 data: data
 };
 cb();
 }, 1000);
 });
 server.on('resumeSession', (id, callback) => {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 // Just to check that async really works there
 setTimeout(() => {
 callback(null, session.data);
 }, 100);
 });
 }

 var args = [
 's_client',
Expand All@@ -85,25 +97,25 @@ function doTest(testOptions, callback) {
 if (common.isWindows)
 args.push('-no_rand_screen');

 server.listen(common.PORT, function() {
 server.listen(common.PORT, () => {
 var client = spawn(common.opensslCli, args, {
 stdio: [ 0, 1, 'pipe' ]
 stdio: [ 0, 'ignore', 'pipe' ]
 });
 var err = '';
 client.stderr.setEncoding('utf8');
 client.stderr.on('data', function(chunk) {
 client.stderr.on('data', (chunk) => {
 err += chunk;
 });
 client.on('exit', function(code) {
 client.on('exit', (code) => {
 console.error('done');
 assert.equal(code, 0);
 server.close(function() {
 server.close(() => {
 setTimeout(callback, 100);
 });
 });
 });

 process.on('exit', function() {
 process.on('exit', () => {
 if (testOptions.tickets) {
 assert.equal(requestCount, 6);
 assert.equal(resumeCount, 0);
Expand All@@ -114,4 +126,13 @@ function doTest(testOptions, callback) {
 assert.equal(resumeCount, 5);
 }
 });
}
};

doTest({ tickets: false, sync: false }, () => {
 doTest({ tickets: true, sync: false }, () => {
 doTest({ tickets: false, sync: true }, () => {
 console.error('all done');
 });
 });
});


, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
tls: deprecate newSession/resumeSession events#5774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

indutny
wants to merge
1
commit into

from

 Closed


tls: deprecate newSession/resumeSession events
#5774
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
doc/api/tls.markdown

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -194,6 +194,9 @@ established it will be forwarded here.

### Event: 'newSession'

Stability: 0 - Deprecated: Use synchronous `newSession` option-callback of
[`tls.createServer`][] instead.

`function (sessionId, sessionData, callback) { }`

Emitted on creation of TLS session. May be used to store sessions in external
Expand DownExpand Up@@ -243,6 +246,9 @@ certificates.

### Event: 'resumeSession'

Stability: 0 - Deprecated: Use synchronous `resumeSession` option-callback of
[`tls.createServer`][] instead.

`function (sessionId, callback) { }`

Emitted when client wants to resume previous TLS session. Event listener may
Expand DownExpand Up@@ -898,6 +904,13 @@ automatically set as a listener for the [`'secureConnection'`][] event. The
 SSL version 3. The possible values depend on your installation of
 OpenSSL and are defined in the constant [SSL_METHODS][].

 - `newSession`: A callback to invoke when creating new TLS session
 (Signature: `newSession(sessionId, sessionData)`).

 - `resumeSession`: A callback to invoke when client attempts to resume some
 TLS session by id (Signature: `resumeSession(sessionId)`, should return
 `undefined` or `Buffer` instance with `sessionData` from `newSession`).

Here is a simple example echo server:

```js
Expand Down

11 changes: 11 additions & 0 deletions
lib/_tls_common.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,3 +173,14 @@ exports.translatePeerCertificate = function translatePeerCertificate(c) {
 }
 return c;
};

exports.deprecateAsyncSessionAPI = function deprecateAsyncSessionAPI(server) {
 const asyncSessionWarning = internalUtil.deprecate(() => {},
 'server.on(\'newSession\')/server.on(\'resumeSession\') are deprecated.' +
 ' Please upgrade to synchronous API and pass these callbacks in ' +
 'options.newSession (options.resumeSession).');
 server.on('newListener', (type) => {
 if (/^(new|resume)Session$/.test(type))
 asyncSessionWarning();
 });
};

29 changes: 24 additions & 5 deletions
lib/_tls_wrap.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -72,10 +72,16 @@ function loadSession(self, hello, cb) {
 cb(null, ret);
 }

 if (hello.sessionId.length <= 0 ||
 hello.tlsTicket ||
 self.server &&
 !self.server.emit('resumeSession', hello.sessionId, onSession)) {
 if (hello.sessionId.length <= 0 || hello.tlsTicket) {
 return cb(null);
 }

 assert(self.server);
 if (self.server.onResumeSession) {
 return onSession(null, self.server.onResumeSession(hello.sessionId));
 }

 if (!self.server.emit('resumeSession', hello.sessionId, onSession)) {
 cb(null);
 }
}
Expand DownExpand Up@@ -183,6 +189,12 @@ function onnewsession(key, session) {
 var once = false;

 this._newSessionPending = true;
 if (this.server.onNewSession) {
 this.server.onNewSession(key, session);
 done();
 return;
 }

 if (!this.server.emit('newSession', key, session, done))
 done();

Expand DownExpand Up@@ -398,7 +410,9 @@ TLSSocket.prototype._init = function(socket, wrap) {
 ssl.handshakes = 0;

 if (this.server) {
 if (this.server.listenerCount('resumeSession') > 0 ||
 if (this.server.onNewSession ||
 this.server.onResumeSession ||
 this.server.listenerCount('resumeSession') > 0 ||
 this.server.listenerCount('newSession') > 0) {
 ssl.enableSessionCallbacks();
 }
Expand DownExpand Up@@ -828,6 +842,8 @@ function Server(/* [options], listener */) {
 if (listener) {
 this.on('secureConnection', listener);
 }

 common.deprecateAsyncSessionAPI(this);
}

util.inherits(Server, net.Server);
Expand DownExpand Up@@ -902,6 +918,9 @@ Server.prototype.setOptions = function(options) {
 .digest('hex')
 .slice(0, 32);
 }

 if (options.newSession) this.onNewSession = options.newSession;
 if (options.resumeSession) this.onResumeSession = options.resumeSession;
};

// SNI Contexts High-Level API
Expand Down

95 changes: 58 additions & 37 deletions
test/parallel/test-tls-session-cache.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,13 +11,7 @@ if (!common.hasCrypto) {
 return;
}

doTest({ tickets: false }, function() {
 doTest({ tickets: true }, function() {
 console.error('all done');
 });
});

function doTest(testOptions, callback) {
const doTest = (testOptions, callback) => {
 var assert = require('assert');
 var tls = require('tls');
 var fs = require('fs');
Expand All@@ -38,8 +32,23 @@ function doTest(testOptions, callback) {
 var resumeCount = 0;
 var session;

 var server = tls.createServer(options, function(cleartext) {
 cleartext.on('error', function(er) {
 if (testOptions.sync) {
 options.newSession = (id, data) => {
 assert.ok(!session);
 session = { id: id, data: data };
 };

 options.resumeSession = (id) => {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 return session.data;
 };
 }

 var server = tls.createServer(options, (cleartext) => {
 cleartext.on('error', (er) => {
 // We're ok with getting ECONNRESET in this test, but it's
 // timing-dependent, and thus unreliable. Any other errors
 // are just failures, though.
Expand All@@ -49,27 +58,30 @@ function doTest(testOptions, callback) {
 ++requestCount;
 cleartext.end();
 });
 server.on('newSession', function(id, data, cb) {
 // Emulate asynchronous store
 setTimeout(function() {
 assert.ok(!session);
 session = {
 id: id,
 data: data
 };
 cb();
 }, 1000);
 });
 server.on('resumeSession', function(id, callback) {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 // Just to check that async really works there
 setTimeout(function() {
 callback(null, session.data);
 }, 100);
 });

 if (!testOptions.sync) {
 server.on('newSession', (id, data, cb) => {
 // Emulate asynchronous store
 setTimeout(() => {
 assert.ok(!session);
 session = {
 id: id,
 data: data
 };
 cb();
 }, 1000);
 });
 server.on('resumeSession', (id, callback) => {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 // Just to check that async really works there
 setTimeout(() => {
 callback(null, session.data);
 }, 100);
 });
 }

 var args = [
 's_client',
Expand All@@ -85,25 +97,25 @@ function doTest(testOptions, callback) {
 if (common.isWindows)
 args.push('-no_rand_screen');

 server.listen(common.PORT, function() {
 server.listen(common.PORT, () => {
 var client = spawn(common.opensslCli, args, {
 stdio: [ 0, 1, 'pipe' ]
 stdio: [ 0, 'ignore', 'pipe' ]
 });
 var err = '';
 client.stderr.setEncoding('utf8');
 client.stderr.on('data', function(chunk) {
 client.stderr.on('data', (chunk) => {
 err += chunk;
 });
 client.on('exit', function(code) {
 client.on('exit', (code) => {
 console.error('done');
 assert.equal(code, 0);
 server.close(function() {
 server.close(() => {
 setTimeout(callback, 100);
 });
 });
 });

 process.on('exit', function() {
 process.on('exit', () => {
 if (testOptions.tickets) {
 assert.equal(requestCount, 6);
 assert.equal(resumeCount, 0);
Expand All@@ -114,4 +126,13 @@ function doTest(testOptions, callback) {
 assert.equal(resumeCount, 5);
 }
 });
}
};

doTest({ tickets: false, sync: false }, () => {
 doTest({ tickets: true, sync: false }, () => {
 doTest({ tickets: false, sync: true }, () => {
 console.error('all done');
 });
 });
});


, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
tls: deprecate newSession/resumeSession events#5774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

indutny
wants to merge
1
commit into

from

 Closed


tls: deprecate newSession/resumeSession events
#5774
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
doc/api/tls.markdown

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -194,6 +194,9 @@ established it will be forwarded here.

### Event: 'newSession'

Stability: 0 - Deprecated: Use synchronous `newSession` option-callback of
[`tls.createServer`][] instead.

`function (sessionId, sessionData, callback) { }`

Emitted on creation of TLS session. May be used to store sessions in external
Expand DownExpand Up@@ -243,6 +246,9 @@ certificates.

### Event: 'resumeSession'

Stability: 0 - Deprecated: Use synchronous `resumeSession` option-callback of
[`tls.createServer`][] instead.

`function (sessionId, callback) { }`

Emitted when client wants to resume previous TLS session. Event listener may
Expand DownExpand Up@@ -898,6 +904,13 @@ automatically set as a listener for the [`'secureConnection'`][] event. The
 SSL version 3. The possible values depend on your installation of
 OpenSSL and are defined in the constant [SSL_METHODS][].

 - `newSession`: A callback to invoke when creating new TLS session
 (Signature: `newSession(sessionId, sessionData)`).

 - `resumeSession`: A callback to invoke when client attempts to resume some
 TLS session by id (Signature: `resumeSession(sessionId)`, should return
 `undefined` or `Buffer` instance with `sessionData` from `newSession`).

Here is a simple example echo server:

```js
Expand Down

11 changes: 11 additions & 0 deletions
lib/_tls_common.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,3 +173,14 @@ exports.translatePeerCertificate = function translatePeerCertificate(c) {
 }
 return c;
};

exports.deprecateAsyncSessionAPI = function deprecateAsyncSessionAPI(server) {
 const asyncSessionWarning = internalUtil.deprecate(() => {},
 'server.on(\'newSession\')/server.on(\'resumeSession\') are deprecated.' +
 ' Please upgrade to synchronous API and pass these callbacks in ' +
 'options.newSession (options.resumeSession).');
 server.on('newListener', (type) => {
 if (/^(new|resume)Session$/.test(type))
 asyncSessionWarning();
 });
};

29 changes: 24 additions & 5 deletions
lib/_tls_wrap.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -72,10 +72,16 @@ function loadSession(self, hello, cb) {
 cb(null, ret);
 }

 if (hello.sessionId.length <= 0 ||
 hello.tlsTicket ||
 self.server &&
 !self.server.emit('resumeSession', hello.sessionId, onSession)) {
 if (hello.sessionId.length <= 0 || hello.tlsTicket) {
 return cb(null);
 }

 assert(self.server);
 if (self.server.onResumeSession) {
 return onSession(null, self.server.onResumeSession(hello.sessionId));
 }

 if (!self.server.emit('resumeSession', hello.sessionId, onSession)) {
 cb(null);
 }
}
Expand DownExpand Up@@ -183,6 +189,12 @@ function onnewsession(key, session) {
 var once = false;

 this._newSessionPending = true;
 if (this.server.onNewSession) {
 this.server.onNewSession(key, session);
 done();
 return;
 }

 if (!this.server.emit('newSession', key, session, done))
 done();

Expand DownExpand Up@@ -398,7 +410,9 @@ TLSSocket.prototype._init = function(socket, wrap) {
 ssl.handshakes = 0;

 if (this.server) {
 if (this.server.listenerCount('resumeSession') > 0 ||
 if (this.server.onNewSession ||
 this.server.onResumeSession ||
 this.server.listenerCount('resumeSession') > 0 ||
 this.server.listenerCount('newSession') > 0) {
 ssl.enableSessionCallbacks();
 }
Expand DownExpand Up@@ -828,6 +842,8 @@ function Server(/* [options], listener */) {
 if (listener) {
 this.on('secureConnection', listener);
 }

 common.deprecateAsyncSessionAPI(this);
}

util.inherits(Server, net.Server);
Expand DownExpand Up@@ -902,6 +918,9 @@ Server.prototype.setOptions = function(options) {
 .digest('hex')
 .slice(0, 32);
 }

 if (options.newSession) this.onNewSession = options.newSession;
 if (options.resumeSession) this.onResumeSession = options.resumeSession;
};

// SNI Contexts High-Level API
Expand Down

95 changes: 58 additions & 37 deletions
test/parallel/test-tls-session-cache.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,13 +11,7 @@ if (!common.hasCrypto) {
 return;
}

doTest({ tickets: false }, function() {
 doTest({ tickets: true }, function() {
 console.error('all done');
 });
});

function doTest(testOptions, callback) {
const doTest = (testOptions, callback) => {
 var assert = require('assert');
 var tls = require('tls');
 var fs = require('fs');
Expand All@@ -38,8 +32,23 @@ function doTest(testOptions, callback) {
 var resumeCount = 0;
 var session;

 var server = tls.createServer(options, function(cleartext) {
 cleartext.on('error', function(er) {
 if (testOptions.sync) {
 options.newSession = (id, data) => {
 assert.ok(!session);
 session = { id: id, data: data };
 };

 options.resumeSession = (id) => {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 return session.data;
 };
 }

 var server = tls.createServer(options, (cleartext) => {
 cleartext.on('error', (er) => {
 // We're ok with getting ECONNRESET in this test, but it's
 // timing-dependent, and thus unreliable. Any other errors
 // are just failures, though.
Expand All@@ -49,27 +58,30 @@ function doTest(testOptions, callback) {
 ++requestCount;
 cleartext.end();
 });
 server.on('newSession', function(id, data, cb) {
 // Emulate asynchronous store
 setTimeout(function() {
 assert.ok(!session);
 session = {
 id: id,
 data: data
 };
 cb();
 }, 1000);
 });
 server.on('resumeSession', function(id, callback) {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 // Just to check that async really works there
 setTimeout(function() {
 callback(null, session.data);
 }, 100);
 });

 if (!testOptions.sync) {
 server.on('newSession', (id, data, cb) => {
 // Emulate asynchronous store
 setTimeout(() => {
 assert.ok(!session);
 session = {
 id: id,
 data: data
 };
 cb();
 }, 1000);
 });
 server.on('resumeSession', (id, callback) => {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 // Just to check that async really works there
 setTimeout(() => {
 callback(null, session.data);
 }, 100);
 });
 }

 var args = [
 's_client',
Expand All@@ -85,25 +97,25 @@ function doTest(testOptions, callback) {
 if (common.isWindows)
 args.push('-no_rand_screen');

 server.listen(common.PORT, function() {
 server.listen(common.PORT, () => {
 var client = spawn(common.opensslCli, args, {
 stdio: [ 0, 1, 'pipe' ]
 stdio: [ 0, 'ignore', 'pipe' ]
 });
 var err = '';
 client.stderr.setEncoding('utf8');
 client.stderr.on('data', function(chunk) {
 client.stderr.on('data', (chunk) => {
 err += chunk;
 });
 client.on('exit', function(code) {
 client.on('exit', (code) => {
 console.error('done');
 assert.equal(code, 0);
 server.close(function() {
 server.close(() => {
 setTimeout(callback, 100);
 });
 });
 });

 process.on('exit', function() {
 process.on('exit', () => {
 if (testOptions.tickets) {
 assert.equal(requestCount, 6);
 assert.equal(resumeCount, 0);
Expand All@@ -114,4 +126,13 @@ function doTest(testOptions, callback) {
 assert.equal(resumeCount, 5);
 }
 });
}
};

doTest({ tickets: false, sync: false }, () => {
 doTest({ tickets: true, sync: false }, () => {
 doTest({ tickets: false, sync: true }, () => {
 console.error('all done');
 });
 });
});


, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
tls: deprecate newSession/resumeSession events#5774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

indutny
wants to merge
1
commit into

from

 Closed


tls: deprecate newSession/resumeSession events
#5774
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
doc/api/tls.markdown

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -194,6 +194,9 @@ established it will be forwarded here.

### Event: 'newSession'

Stability: 0 - Deprecated: Use synchronous `newSession` option-callback of
[`tls.createServer`][] instead.

`function (sessionId, sessionData, callback) { }`

Emitted on creation of TLS session. May be used to store sessions in external
Expand DownExpand Up@@ -243,6 +246,9 @@ certificates.

### Event: 'resumeSession'

Stability: 0 - Deprecated: Use synchronous `resumeSession` option-callback of
[`tls.createServer`][] instead.

`function (sessionId, callback) { }`

Emitted when client wants to resume previous TLS session. Event listener may
Expand DownExpand Up@@ -898,6 +904,13 @@ automatically set as a listener for the [`'secureConnection'`][] event. The
 SSL version 3. The possible values depend on your installation of
 OpenSSL and are defined in the constant [SSL_METHODS][].

 - `newSession`: A callback to invoke when creating new TLS session
 (Signature: `newSession(sessionId, sessionData)`).

 - `resumeSession`: A callback to invoke when client attempts to resume some
 TLS session by id (Signature: `resumeSession(sessionId)`, should return
 `undefined` or `Buffer` instance with `sessionData` from `newSession`).

Here is a simple example echo server:

```js
Expand Down

11 changes: 11 additions & 0 deletions
lib/_tls_common.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,3 +173,14 @@ exports.translatePeerCertificate = function translatePeerCertificate(c) {
 }
 return c;
};

exports.deprecateAsyncSessionAPI = function deprecateAsyncSessionAPI(server) {
 const asyncSessionWarning = internalUtil.deprecate(() => {},
 'server.on(\'newSession\')/server.on(\'resumeSession\') are deprecated.' +
 ' Please upgrade to synchronous API and pass these callbacks in ' +
 'options.newSession (options.resumeSession).');
 server.on('newListener', (type) => {
 if (/^(new|resume)Session$/.test(type))
 asyncSessionWarning();
 });
};

29 changes: 24 additions & 5 deletions
lib/_tls_wrap.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -72,10 +72,16 @@ function loadSession(self, hello, cb) {
 cb(null, ret);
 }

 if (hello.sessionId.length <= 0 ||
 hello.tlsTicket ||
 self.server &&
 !self.server.emit('resumeSession', hello.sessionId, onSession)) {
 if (hello.sessionId.length <= 0 || hello.tlsTicket) {
 return cb(null);
 }

 assert(self.server);
 if (self.server.onResumeSession) {
 return onSession(null, self.server.onResumeSession(hello.sessionId));
 }

 if (!self.server.emit('resumeSession', hello.sessionId, onSession)) {
 cb(null);
 }
}
Expand DownExpand Up@@ -183,6 +189,12 @@ function onnewsession(key, session) {
 var once = false;

 this._newSessionPending = true;
 if (this.server.onNewSession) {
 this.server.onNewSession(key, session);
 done();
 return;
 }

 if (!this.server.emit('newSession', key, session, done))
 done();

Expand DownExpand Up@@ -398,7 +410,9 @@ TLSSocket.prototype._init = function(socket, wrap) {
 ssl.handshakes = 0;

 if (this.server) {
 if (this.server.listenerCount('resumeSession') > 0 ||
 if (this.server.onNewSession ||
 this.server.onResumeSession ||
 this.server.listenerCount('resumeSession') > 0 ||
 this.server.listenerCount('newSession') > 0) {
 ssl.enableSessionCallbacks();
 }
Expand DownExpand Up@@ -828,6 +842,8 @@ function Server(/* [options], listener */) {
 if (listener) {
 this.on('secureConnection', listener);
 }

 common.deprecateAsyncSessionAPI(this);
}

util.inherits(Server, net.Server);
Expand DownExpand Up@@ -902,6 +918,9 @@ Server.prototype.setOptions = function(options) {
 .digest('hex')
 .slice(0, 32);
 }

 if (options.newSession) this.onNewSession = options.newSession;
 if (options.resumeSession) this.onResumeSession = options.resumeSession;
};

// SNI Contexts High-Level API
Expand Down

95 changes: 58 additions & 37 deletions
test/parallel/test-tls-session-cache.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,13 +11,7 @@ if (!common.hasCrypto) {
 return;
}

doTest({ tickets: false }, function() {
 doTest({ tickets: true }, function() {
 console.error('all done');
 });
});

function doTest(testOptions, callback) {
const doTest = (testOptions, callback) => {
 var assert = require('assert');
 var tls = require('tls');
 var fs = require('fs');
Expand All@@ -38,8 +32,23 @@ function doTest(testOptions, callback) {
 var resumeCount = 0;
 var session;

 var server = tls.createServer(options, function(cleartext) {
 cleartext.on('error', function(er) {
 if (testOptions.sync) {
 options.newSession = (id, data) => {
 assert.ok(!session);
 session = { id: id, data: data };
 };

 options.resumeSession = (id) => {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 return session.data;
 };
 }

 var server = tls.createServer(options, (cleartext) => {
 cleartext.on('error', (er) => {
 // We're ok with getting ECONNRESET in this test, but it's
 // timing-dependent, and thus unreliable. Any other errors
 // are just failures, though.
Expand All@@ -49,27 +58,30 @@ function doTest(testOptions, callback) {
 ++requestCount;
 cleartext.end();
 });
 server.on('newSession', function(id, data, cb) {
 // Emulate asynchronous store
 setTimeout(function() {
 assert.ok(!session);
 session = {
 id: id,
 data: data
 };
 cb();
 }, 1000);
 });
 server.on('resumeSession', function(id, callback) {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 // Just to check that async really works there
 setTimeout(function() {
 callback(null, session.data);
 }, 100);
 });

 if (!testOptions.sync) {
 server.on('newSession', (id, data, cb) => {
 // Emulate asynchronous store
 setTimeout(() => {
 assert.ok(!session);
 session = {
 id: id,
 data: data
 };
 cb();
 }, 1000);
 });
 server.on('resumeSession', (id, callback) => {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 // Just to check that async really works there
 setTimeout(() => {
 callback(null, session.data);
 }, 100);
 });
 }

 var args = [
 's_client',
Expand All@@ -85,25 +97,25 @@ function doTest(testOptions, callback) {
 if (common.isWindows)
 args.push('-no_rand_screen');

 server.listen(common.PORT, function() {
 server.listen(common.PORT, () => {
 var client = spawn(common.opensslCli, args, {
 stdio: [ 0, 1, 'pipe' ]
 stdio: [ 0, 'ignore', 'pipe' ]
 });
 var err = '';
 client.stderr.setEncoding('utf8');
 client.stderr.on('data', function(chunk) {
 client.stderr.on('data', (chunk) => {
 err += chunk;
 });
 client.on('exit', function(code) {
 client.on('exit', (code) => {
 console.error('done');
 assert.equal(code, 0);
 server.close(function() {
 server.close(() => {
 setTimeout(callback, 100);
 });
 });
 });

 process.on('exit', function() {
 process.on('exit', () => {
 if (testOptions.tickets) {
 assert.equal(requestCount, 6);
 assert.equal(resumeCount, 0);
Expand All@@ -114,4 +126,13 @@ function doTest(testOptions, callback) {
 assert.equal(resumeCount, 5);
 }
 });
}
};

doTest({ tickets: false, sync: false }, () => {
 doTest({ tickets: true, sync: false }, () => {
 doTest({ tickets: false, sync: true }, () => {
 console.error('all done');
 });
 });
});


, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
tls: deprecate newSession/resumeSession events#5774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

indutny
wants to merge
1
commit into

from

 Closed


tls: deprecate newSession/resumeSession events
#5774
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
doc/api/tls.markdown

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -194,6 +194,9 @@ established it will be forwarded here.

### Event: 'newSession'

Stability: 0 - Deprecated: Use synchronous `newSession` option-callback of
[`tls.createServer`][] instead.

`function (sessionId, sessionData, callback) { }`

Emitted on creation of TLS session. May be used to store sessions in external
Expand DownExpand Up@@ -243,6 +246,9 @@ certificates.

### Event: 'resumeSession'

Stability: 0 - Deprecated: Use synchronous `resumeSession` option-callback of
[`tls.createServer`][] instead.

`function (sessionId, callback) { }`

Emitted when client wants to resume previous TLS session. Event listener may
Expand DownExpand Up@@ -898,6 +904,13 @@ automatically set as a listener for the [`'secureConnection'`][] event. The
 SSL version 3. The possible values depend on your installation of
 OpenSSL and are defined in the constant [SSL_METHODS][].

 - `newSession`: A callback to invoke when creating new TLS session
 (Signature: `newSession(sessionId, sessionData)`).

 - `resumeSession`: A callback to invoke when client attempts to resume some
 TLS session by id (Signature: `resumeSession(sessionId)`, should return
 `undefined` or `Buffer` instance with `sessionData` from `newSession`).

Here is a simple example echo server:

```js
Expand Down

11 changes: 11 additions & 0 deletions
lib/_tls_common.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,3 +173,14 @@ exports.translatePeerCertificate = function translatePeerCertificate(c) {
 }
 return c;
};

exports.deprecateAsyncSessionAPI = function deprecateAsyncSessionAPI(server) {
 const asyncSessionWarning = internalUtil.deprecate(() => {},
 'server.on(\'newSession\')/server.on(\'resumeSession\') are deprecated.' +
 ' Please upgrade to synchronous API and pass these callbacks in ' +
 'options.newSession (options.resumeSession).');
 server.on('newListener', (type) => {
 if (/^(new|resume)Session$/.test(type))
 asyncSessionWarning();
 });
};

29 changes: 24 additions & 5 deletions
lib/_tls_wrap.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -72,10 +72,16 @@ function loadSession(self, hello, cb) {
 cb(null, ret);
 }

 if (hello.sessionId.length <= 0 ||
 hello.tlsTicket ||
 self.server &&
 !self.server.emit('resumeSession', hello.sessionId, onSession)) {
 if (hello.sessionId.length <= 0 || hello.tlsTicket) {
 return cb(null);
 }

 assert(self.server);
 if (self.server.onResumeSession) {
 return onSession(null, self.server.onResumeSession(hello.sessionId));
 }

 if (!self.server.emit('resumeSession', hello.sessionId, onSession)) {
 cb(null);
 }
}
Expand DownExpand Up@@ -183,6 +189,12 @@ function onnewsession(key, session) {
 var once = false;

 this._newSessionPending = true;
 if (this.server.onNewSession) {
 this.server.onNewSession(key, session);
 done();
 return;
 }

 if (!this.server.emit('newSession', key, session, done))
 done();

Expand DownExpand Up@@ -398,7 +410,9 @@ TLSSocket.prototype._init = function(socket, wrap) {
 ssl.handshakes = 0;

 if (this.server) {
 if (this.server.listenerCount('resumeSession') > 0 ||
 if (this.server.onNewSession ||
 this.server.onResumeSession ||
 this.server.listenerCount('resumeSession') > 0 ||
 this.server.listenerCount('newSession') > 0) {
 ssl.enableSessionCallbacks();
 }
Expand DownExpand Up@@ -828,6 +842,8 @@ function Server(/* [options], listener */) {
 if (listener) {
 this.on('secureConnection', listener);
 }

 common.deprecateAsyncSessionAPI(this);
}

util.inherits(Server, net.Server);
Expand DownExpand Up@@ -902,6 +918,9 @@ Server.prototype.setOptions = function(options) {
 .digest('hex')
 .slice(0, 32);
 }

 if (options.newSession) this.onNewSession = options.newSession;
 if (options.resumeSession) this.onResumeSession = options.resumeSession;
};

// SNI Contexts High-Level API
Expand Down

95 changes: 58 additions & 37 deletions
test/parallel/test-tls-session-cache.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,13 +11,7 @@ if (!common.hasCrypto) {
 return;
}

doTest({ tickets: false }, function() {
 doTest({ tickets: true }, function() {
 console.error('all done');
 });
});

function doTest(testOptions, callback) {
const doTest = (testOptions, callback) => {
 var assert = require('assert');
 var tls = require('tls');
 var fs = require('fs');
Expand All@@ -38,8 +32,23 @@ function doTest(testOptions, callback) {
 var resumeCount = 0;
 var session;

 var server = tls.createServer(options, function(cleartext) {
 cleartext.on('error', function(er) {
 if (testOptions.sync) {
 options.newSession = (id, data) => {
 assert.ok(!session);
 session = { id: id, data: data };
 };

 options.resumeSession = (id) => {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 return session.data;
 };
 }

 var server = tls.createServer(options, (cleartext) => {
 cleartext.on('error', (er) => {
 // We're ok with getting ECONNRESET in this test, but it's
 // timing-dependent, and thus unreliable. Any other errors
 // are just failures, though.
Expand All@@ -49,27 +58,30 @@ function doTest(testOptions, callback) {
 ++requestCount;
 cleartext.end();
 });
 server.on('newSession', function(id, data, cb) {
 // Emulate asynchronous store
 setTimeout(function() {
 assert.ok(!session);
 session = {
 id: id,
 data: data
 };
 cb();
 }, 1000);
 });
 server.on('resumeSession', function(id, callback) {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 // Just to check that async really works there
 setTimeout(function() {
 callback(null, session.data);
 }, 100);
 });

 if (!testOptions.sync) {
 server.on('newSession', (id, data, cb) => {
 // Emulate asynchronous store
 setTimeout(() => {
 assert.ok(!session);
 session = {
 id: id,
 data: data
 };
 cb();
 }, 1000);
 });
 server.on('resumeSession', (id, callback) => {
 ++resumeCount;
 assert.ok(session);
 assert.equal(session.id.toString('hex'), id.toString('hex'));

 // Just to check that async really works there
 setTimeout(() => {
 callback(null, session.data);
 }, 100);
 });
 }

 var args = [
 's_client',
Expand All@@ -85,25 +97,25 @@ function doTest(testOptions, callback) {
 if (common.isWindows)
 args.push('-no_rand_screen');

 server.listen(common.PORT, function() {
 server.listen(common.PORT, () => {
 var client = spawn(common.opensslCli, args, {
 stdio: [ 0, 1, 'pipe' ]
 stdio: [ 0, 'ignore', 'pipe' ]
 });
 var err = '';
 client.stderr.setEncoding('utf8');
 client.stderr.on('data', function(chunk) {
 client.stderr.on('data', (chunk) => {
 err += chunk;
 });
 client.on('exit', function(code) {
 client.on('exit', (code) => {
 console.error('done');
 assert.equal(code, 0);
 server.close(function() {
 server.close(() => {
 setTimeout(callback, 100);
 });
 });
 });

 process.on('exit', function() {
 process.on('exit', () => {
 if (testOptions.tickets) {
 assert.equal(requestCount, 6);
 assert.equal(resumeCount, 0);
Expand All@@ -114,4 +126,13 @@ function doTest(testOptions, callback) {
 assert.equal(resumeCount, 5);
 }
 });
}
};

doTest({ tickets: false, sync: false }, () => {
 doTest({ tickets: true, sync: false }, () => {
 doTest({ tickets: false, sync: true }, () => {
 console.error('all done');
 });
 });
});