-
Notifications
You must be signed in to change notification settings - Fork 686
/
connection.js
419 lines (368 loc) · 11.4 KB
/
connection.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
var Errors = require('./errors');
var fs = require('fs');
var q = require('q');
var tls = require('tls');
var util = require('./util');
var debug = function() {};
if(process.env.DEBUG) {
try {
debug = require('debug')('apn');
}
catch (e) {
console.log("Notice: 'debug' module is not available. This should be installed with `npm install debug` to enable debug messages", e);
debug = function() {};
}
}
/**
* Create a new connection to the APN service.
* @constructor
* @param {Object} [options]
* @config {String} [cert="cert.pem"] The filename of the connection certificate to load from disk
* @config {Buffer|String} [certData] The certificate data. If supplied, will be used instead of loading from disk.
* @config {String} [key="key.pem"] The filename of the connection key to load from disk
* @config {Buffer|String} [keyData] The key data. If supplied will be used instead of loading from disk.
* @config {Buffer[]|String[]} [ca] An array of strings or Buffers of trusted certificates. If this is omitted several well known "root" CAs will be used, like VeriSign. - You may need to use this as some environments don't include the CA used by Apple.
* @config {String} [pfx] File path for private key, certificate and CA certs in PFX or PKCS12 format. If supplied will be used instead of certificate and key above
* @config {Buffer|String} [pfxData] PFX or PKCS12 format data containing the private key, certificate and CA certs. If supplied will be used instead of loading from disk.
* @config {String} [passphrase] The passphrase for the connection key, if required
* @config {String} [gateway="gateway.push.apple.com"] The gateway server to connect to.
* @config {Number} [port=2195] Gateway port
* @config {Boolean} [rejectUnauthorized=true] Reject Unauthorized property to be passed through to tls.connect()
* @config {Boolean} [enhanced=true] Whether to use the enhanced notification format (recommended)
* @config {Function} [errorCallback] A callback which accepts 2 parameters (err, notification). Recommended when using enhanced format.
* @config {Number} [cacheLength] Number of notifications to cache for error purposes (See Readme)
*/
function Connection (options) {
this.options = {
cert: 'cert.pem',
certData: null,
key: 'key.pem',
keyData: null,
ca: null,
pfx: null,
pfxData: null,
passphrase: null,
gateway: 'gateway.push.apple.com',
port: 2195,
rejectUnauthorized: true,
enhanced: true,
errorCallback: undefined,
cacheLength: 100
};
util.extend(this.options, options);
this.certData = null;
this.keyData = null;
this.pfxData = null;
this.deferredInitialize = null;
this.deferredConnection = null;
this.currentId = 0;
this.cachedNotifications = [];
this.notificationBuffer = [];
this.connectionTimeout = null;
};
/**
* @private
*/
Connection.prototype.checkInitialized = function () {
if ((this.keyData && this.certData) || this.pfxData) {
this.deferredInitialize.resolve();
}
};
/**
* You should never need to call this method, initialisation and connection is handled by {@link Connection#sendNotification}
* @private
*/
Connection.prototype.initialize = function () {
if (this.deferredInitialize) {
return this.deferredInitialize.promise;
}
debug("Initialising module");
this.deferredInitialize = q.defer();
if(this.options.pfx != null || this.options.pfxData != null) {
if(this.options.pxfData) {
this.pfxData = this.options.pfxData;
}
else {
fs.readFile(this.options.pfx, function (err, data) {
if (err) {
this.deferredInitialize.reject(err);
return;
}
this.pfxData = data;
this.checkInitialized();
}.bind(this));
}
}
else {
if (this.options.certData) {
this.certData = this.options.certData;
}
else {
fs.readFile(this.options.cert, function (err, data) {
if (err) {
this.deferredInitialize.reject(err);
return;
}
this.certData = data.toString();
this.checkInitialized();
}.bind(this));
}
if (this.options.keyData) {
this.keyData = this.options.keyData;
}
else {
fs.readFile(this.options.key, function (err, data) {
if (err) {
this.deferredInitialize.reject(err);
return;
}
this.keyData = data.toString();
this.checkInitialized();
}.bind(this));
}
}
this.checkInitialized();
return this.deferredInitialize.promise;
};
/**
* You should never need to call this method, initialisation and connection is handled by {@link Connection#sendNotification}
* @private
*/
Connection.prototype.connect = function () {
if (this.deferredConnection) {
return this.deferredConnection.promise;
}
debug("Initialising connection");
this.deferredConnection = q.defer();
this.initialize().then(function () {
var socketOptions = {};
if(this.pfxData) {
socketOptions.pfx = this.pfxData;
}
else {
socketOptions.key = this.keyData;
socketOptions.cert = this.certData;
socketOptions.ca = this.options.ca;
}
socketOptions.passphrase = this.options.passphrase;
socketOptions.rejectUnauthorized = this.options.rejectUnauthorized;
this.socket = tls.connect(
this.options['port'],
this.options['gateway'],
socketOptions,
function () {
if (this.connectionTimeout) {
clearTimeout(this.connectionTimeout);
}
if (this.options.connectionTimeout > 0) {
this.connectionTimeout = setTimeout(this.destroyConnection.bind(this), this.options.connectionTimeout);
}
debug("Connection established");
this.deferredConnection.resolve();
}.bind(this));
this.socket.on('data', this.handleTransmissionError.bind(this));
this.socket.on("drain", this.socketDrained.bind(this));
this.socket.on('clientError', this.errorOccurred.bind(this));
this.socket.on("error", this.errorOccurred.bind(this));
this.socket.on("end", this.restartConnection.bind(this));
this.socket.once('close', this.restartConnection.bind(this));
}.bind(this)).fail(function (error) {
debug("Module initialisation error:", error);
this.deferredConnection.reject(error);
this.deferredConnection = null;
}.bind(this));
return this.deferredConnection.promise;
};
/**
* @private
*/
Connection.prototype.errorOccurred = function(err) {
debug("Socket error occurred", err);
if(!this.deferredConnection.promise.isResolved()) {
this.deferredConnection.reject(err);
}
else {
this.raiseError(err, null);
}
this.destroyConnection();
};
/**
* @private
*/
Connection.prototype.socketDrained = function() {
debug("Socket drained");
if (this.socket && (this.socket.socket.bufferSize != 0 || !this.socket.writable)) {
return;
}
debug("Socket writeable");
if (this.notificationBuffer.length > 0) {
debug("Sending notification from buffer");
this.sendNotification(this.notificationBuffer.shift());
}
};
/**
* @private
*/
Connection.prototype.destroyConnection = function() {
debug("Destroying connection");
if (this.socket) {
this.socket.destroy();
}
};
/**
* @private
*/
Connection.prototype.restartConnection = function() {
debug("Restarting connection");
if (this.socket) {
this.socket.removeAllListeners();
}
if(!this.deferredConnection.promise.isResolved()) {
debug("Connection error occurred before TLS Handshake");
this.deferredConnection.reject(new Error("Unable to connect"));
}
this.socket = undefined;
this.deferredConnection = undefined;
if (this.connectionTimeout) {
clearTimeout(this.connectionTimeout);
}
if (this.notificationBuffer.length) {
debug("Notification queue has %d items, resending the first", this.notificationBuffer.length);
this.sendNotification(this.notificationBuffer.shift());
}
};
/**
* @private
*/
Connection.prototype.bufferNotification = function (notification) {
this.notificationBuffer.push(notification);
};
/**
* @private
*/
Connection.prototype.cacheNotification = function (notification) {
this.cachedNotifications.push(notification);
if (this.cachedNotifications.length > this.options.cacheLength) {
debug("Clearing notification %d from the cache", this.cachedNotifications[0]['_uid']);
this.cachedNotifications.shift();
}
};
/**
* @private
*/
Connection.prototype.handleTransmissionError = function (data) {
if (data[0] == 8) {
if (!this.options.enhanced) {
return;
}
var errorCode = data[1];
var identifier = data.readUInt32BE(2);
var notification = undefined;
var foundNotification = false;
var temporaryCache = [];
debug("Notification %d caused an error: %d", identifier, errorCode);
while (this.cachedNotifications.length) {
notification = this.cachedNotifications.shift();
if (notification['_uid'] == identifier) {
foundNotification = true;
break;
}
temporaryCache.push(notification);
}
if (foundNotification) {
while (temporaryCache.length) {
temporaryCache.shift();
}
this.raiseError(errorCode, notification);
}
else {
this.cachedNotifications = temporaryCache;
this.raiseError(Errors["none"], null);
}
var count = this.cachedNotifications.length;
debug("Buffering %d notifications", count);
for (var i = 0; i < count; ++i) {
notification = this.cachedNotifications.shift();
this.bufferNotification(notification);
}
this.destroyConnection();
}
};
/**
* @private
*/
Connection.prototype.raiseError = function(errorCode, notification) {
debug("Raising error:", errorCode, notification);
if (notification && typeof notification.errorCallback == 'function' ) {
notification.errorCallback(errorCode);
} else if (typeof this.options.errorCallback == 'function') {
this.options.errorCallback(errorCode, notification);
}
};
/**
* Send a notification to the APN service
* @param {Notification} notification The notification object to be sent
*/
Connection.prototype.sendNotification = function (notification) {
this.connect().then(function() {
debug("Sending notification");
if (this.socket.socket.bufferSize !== 0 || !this.socket.writable) {
debug("Buffering notification");
this.bufferNotification(notification);
return;
}
var token = notification.device.token;
var encoding = notification.encoding || 'utf8';
var message = JSON.stringify(notification);
var messageLength = Buffer.byteLength(message, encoding);
var position = 0;
var data;
if (token === undefined) {
this.raiseError(Errors['missingDeviceToken'], notification);
return;
}
if (messageLength > 255) {
this.raiseError(Errors['invalidPayloadSize'], notification);
return;
}
notification._uid = this.currentId++;
if (this.currentId > 0xffffffff) {
this.currentId = 0;
}
if (this.options.enhanced) {
data = new Buffer(1 + 4 + 4 + 2 + token.length + 2 + messageLength);
// Command
data[position] = 1;
position++;
// Identifier
data.writeUInt32BE(notification._uid, position);
position += 4;
// Expiry
data.writeUInt32BE(notification.expiry, position);
position += 4;
this.cacheNotification(notification);
}
else {
data = new Buffer(1 + 2 + token.length + 2 + messageLength);
//Command
data[position] = 0;
position++;
}
// Token Length
data.writeUInt16BE(token.length, position);
position += 2;
// Device Token
position += token.copy(data, position, 0);
// Payload Length
data.writeUInt16BE(messageLength, position);
position += 2;
//Payload
position += data.write(message, position, encoding);
if(this.socket.write(data)) {
this.socketDrained();
}
}.bind(this)).fail(function (error) {
this.raiseError(error, notification);
}.bind(this));
};
module.exports = Connection;