Skip to content

Commit

Permalink
tls: introduce asynchronous newSession
Browse files Browse the repository at this point in the history
  • Loading branch information
indutny committed Feb 17, 2014
1 parent a4436ba commit 75ea11f
Show file tree
Hide file tree
Showing 9 changed files with 111 additions and 15 deletions.
5 changes: 3 additions & 2 deletions doc/api/tls.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -484,10 +484,11 @@ established - it will be forwarded here.

### Event: 'newSession'

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

Emitted on creation of TLS session. May be used to store sessions in external
storage.
storage. `callback` must be invoked eventually, otherwise no data will be
sent or received from secure connection.

NOTE: adding this event listener will have an effect only on connections
established after addition of event listener.
Expand Down
22 changes: 21 additions & 1 deletion lib/_tls_legacy.js
Original file line number Diff line number Diff line change
Expand Up @@ -653,7 +653,27 @@ function onclienthello(hello) {

function onnewsession(key, session) {
if (!this.server) return;
this.server.emit('newSession', key, session);

var self = this;
var once = false;

self.server.emit('newSession', key, session, function() {
if (once)
return;
once = true;

if (self.ssl)
self.ssl.newSessionDone();
});
}


function onnewsessiondone() {
if (!this.server) return;

// Cycle through data
this.cleartext.read(0);
this.encrypted.read(0);
}


Expand Down
29 changes: 27 additions & 2 deletions lib/_tls_wrap.js
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,25 @@ function onclienthello(hello) {


function onnewsession(key, session) {
if (this.server)
this.server.emit('newSession', key, session);
if (!this.server)
return;

var self = this;
var once = false;

this._newSessionPending = true;
this.server.emit('newSession', key, session, function() {
if (once)
return;
once = true;

self.ssl.newSessionDone();

self._newSessionPending = false;
if (self._securePending)
self._finishInit();
self._securePending = false;
});
}


Expand All @@ -164,6 +181,8 @@ function TLSSocket(socket, options) {

this._tlsOptions = options;
this._secureEstablished = false;
this._securePending = false;
this._newSessionPending = false;
this._controlReleased = false;
this._SNICallback = null;
this.ssl = null;
Expand Down Expand Up @@ -347,6 +366,12 @@ TLSSocket.prototype._releaseControl = function() {
};

TLSSocket.prototype._finishInit = function() {
// `newSession` callback wasn't called yet
if (this._newSessionPending) {
this._securePending = true;
return;
}

if (process.features.tls_npn) {
this.npnProtocol = this.ssl.getNegotiatedProtocol();
}
Expand Down
1 change: 1 addition & 0 deletions src/env.h
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ namespace node {
V(onhandshakestart_string, "onhandshakestart") \
V(onmessage_string, "onmessage") \
V(onnewsession_string, "onnewsession") \
V(onnewsessiondone_string, "onnewsessiondone") \
V(onread_string, "onread") \
V(onselect_string, "onselect") \
V(onsignal_string, "onsignal") \
Expand Down
19 changes: 19 additions & 0 deletions src/node_crypto.cc
Original file line number Diff line number Diff line change
Expand Up @@ -857,6 +857,7 @@ void SSLWrap<Base>::AddMethods(Handle<FunctionTemplate> t) {
NODE_SET_PROTOTYPE_METHOD(t, "renegotiate", Renegotiate);
NODE_SET_PROTOTYPE_METHOD(t, "shutdown", Shutdown);
NODE_SET_PROTOTYPE_METHOD(t, "getTLSTicket", GetTLSTicket);
NODE_SET_PROTOTYPE_METHOD(t, "newSessionDone", NewSessionDone);

#ifdef SSL_set_max_send_fragment
NODE_SET_PROTOTYPE_METHOD(t, "setMaxSendFragment", SetMaxSendFragment);
Expand Down Expand Up @@ -929,6 +930,7 @@ int SSLWrap<Base>::NewSessionCallback(SSL* s, SSL_SESSION* sess) {
reinterpret_cast<char*>(sess->session_id),
sess->session_id_length);
Local<Value> argv[] = { session, buff };
w->new_session_wait_ = true;
w->MakeCallback(env->onnewsession_string(), ARRAY_SIZE(argv), argv);

return 0;
Expand Down Expand Up @@ -1267,6 +1269,16 @@ void SSLWrap<Base>::GetTLSTicket(const FunctionCallbackInfo<Value>& args) {
}


template <class Base>
void SSLWrap<Base>::NewSessionDone(const FunctionCallbackInfo<Value>& args) {
HandleScope scope(args.GetIsolate());

Base* w = Unwrap<Base>(args.This());
w->new_session_wait_ = false;
w->NewSessionDoneCb();
}


#ifdef SSL_set_max_send_fragment
template <class Base>
void SSLWrap<Base>::SetMaxSendFragment(
Expand Down Expand Up @@ -1651,6 +1663,13 @@ void Connection::SetShutdownFlags() {
}


void Connection::NewSessionDoneCb() {
HandleScope scope(env()->isolate());

MakeCallback(env()->onnewsessiondone_string(), 0, NULL);
}


void Connection::Initialize(Environment* env, Handle<Object> target) {
Local<FunctionTemplate> t = FunctionTemplate::New(Connection::New);
t->InstanceTemplate()->SetInternalFieldCount(1);
Expand Down
8 changes: 7 additions & 1 deletion src/node_crypto.h
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,8 @@ class SSLWrap {
: env_(env),
kind_(kind),
next_sess_(NULL),
session_callbacks_(false) {
session_callbacks_(false),
new_session_wait_(false) {
ssl_ = SSL_new(sc->ctx_);
assert(ssl_ != NULL);
}
Expand All @@ -162,6 +163,7 @@ class SSLWrap {
inline void enable_session_callbacks() { session_callbacks_ = true; }
inline bool is_server() const { return kind_ == kServer; }
inline bool is_client() const { return kind_ == kClient; }
inline bool is_waiting_new_session() const { return new_session_wait_; }

protected:
static void InitNPN(SecureContext* sc, Base* base);
Expand All @@ -188,6 +190,7 @@ class SSLWrap {
static void Renegotiate(const v8::FunctionCallbackInfo<v8::Value>& args);
static void Shutdown(const v8::FunctionCallbackInfo<v8::Value>& args);
static void GetTLSTicket(const v8::FunctionCallbackInfo<v8::Value>& args);
static void NewSessionDone(const v8::FunctionCallbackInfo<v8::Value>& args);

#ifdef SSL_set_max_send_fragment
static void SetMaxSendFragment(
Expand Down Expand Up @@ -219,6 +222,7 @@ class SSLWrap {
SSL_SESSION* next_sess_;
SSL* ssl_;
bool session_callbacks_;
bool new_session_wait_;
ClientHelloParser hello_parser_;

#ifdef OPENSSL_NPN_NEGOTIATED
Expand Down Expand Up @@ -291,6 +295,7 @@ class Connection : public SSLWrap<Connection>, public AsyncWrap {

void ClearError();
void SetShutdownFlags();
void NewSessionDoneCb();

Connection(Environment* env,
v8::Local<v8::Object> wrap,
Expand Down Expand Up @@ -319,6 +324,7 @@ class Connection : public SSLWrap<Connection>, public AsyncWrap {

friend class ClientHelloParser;
friend class SecureContext;
friend class SSLWrap<Connection>;
};

class CipherBase : public BaseObject {
Expand Down
10 changes: 10 additions & 0 deletions src/tls_wrap.cc
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ TLSCallbacks::TLSCallbacks(Environment* env,
established_(false),
shutdown_(false),
error_(NULL),
cycle_depth_(0),
eof_(false) {
node::Wrap<TLSCallbacks>(object(), this);

Expand Down Expand Up @@ -158,6 +159,11 @@ bool TLSCallbacks::InvokeQueued(int status) {
}


void TLSCallbacks::NewSessionDoneCb() {
Cycle();
}


void TLSCallbacks::InitSSL() {
// Initialize SSL
enc_in_ = NodeBIO::New();
Expand Down Expand Up @@ -309,6 +315,10 @@ void TLSCallbacks::EncOut() {
if (write_size_ != 0)
return;

// Wait for `newSession` callback to be invoked
if (is_waiting_new_session())
return;

// Split-off queue
if (established_ && !QUEUE_EMPTY(&write_item_queue_))
MakePending();
Expand Down
16 changes: 13 additions & 3 deletions src/tls_wrap.h
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,18 @@ class TLSCallbacks : public crypto::SSLWrap<TLSCallbacks>,
void ClearOut();
void MakePending();
bool InvokeQueued(int status);
void NewSessionDoneCb();

inline void Cycle() {
ClearIn();
ClearOut();
EncOut();
// Prevent recursion
if (++cycle_depth_ > 1)
return;

for (; cycle_depth_ > 0; cycle_depth_--) {
ClearIn();
ClearOut();
EncOut();
}
}

v8::Local<v8::Value> GetSSLError(int status, int* err, const char** msg);
Expand Down Expand Up @@ -144,6 +151,7 @@ class TLSCallbacks : public crypto::SSLWrap<TLSCallbacks>,
bool established_;
bool shutdown_;
const char* error_;
int cycle_depth_;

// If true - delivered EOF to the js-land, either after `close_notify`, or
// after the `UV_EOF` on socket.
Expand All @@ -155,6 +163,8 @@ class TLSCallbacks : public crypto::SSLWrap<TLSCallbacks>,

static size_t error_off_;
static char error_buf_[1024];

friend class SSLWrap<TLSCallbacks>;
};

} // namespace node
Expand Down
16 changes: 10 additions & 6 deletions test/simple/test-tls-session-cache.js
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,16 @@ function doTest(testOptions, callback) {
++requestCount;
cleartext.end();
});
server.on('newSession', function(id, data) {
assert.ok(!session);
session = {
id: id,
data: data
};
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;
Expand Down

0 comments on commit 75ea11f

Please sign in to comment.