This repository has been archived by the owner on Dec 13, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 32
/
tunnel_start.js
executable file
·524 lines (488 loc) · 22.6 KB
/
tunnel_start.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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
var _ = require('lodash'),
utils = require('./utils.js'),
util = require('util'),
cbtSocket = require('./cbt_tunnels'),
argv = require('yargs').env('CBT_TUNNELS').argv,
fs = require('fs'),
gfx = require('./gfx.js'),
Api = require('./api'),
log4js = require('log4js'),
cbts = null,
warn = gfx.warn,
help = gfx.help,
validParameters = ['quiet', 'proxyUser', 'proxyPass', 'httpsProxy', 'httpProxy', '_', 'ready',
'username', 'authkey', '$0', 'simpleproxy', 'tunnel', 'webserver', 'cmd', 'proxyIp',
'proxyPort', 'port', 'dir', 'verbose', 'kill', 'test', 'tunnelname', 'secret', 'pac',
'rejectUnauthorized', 'bypass', 'nokill', 'acceptAllCerts','log','electron','dev'];
//account for logging behavior before tunnel is started
log4js.configure({
appenders: {
log: {type: 'file', filename: 'tunnel.log'}
},
categories: {
default: { appenders: ['log'], level: 'ALL' }
}
});
global.logger = log4js.getLogger();
var validateArgs = function(cmdArgs){
if (global.isLocal) {
// don't worry about auth anymore
return cmdArgs;
}
// make sure that user has provided username/authkey and no extraneous options
if(!cmdArgs.username){
help()
throw new Error('You must specify a username.\n');
}else if(!cmdArgs.authkey){
help()
throw new Error('You must specifiy an authkey.\n');
}
var u = _.union(_.keys(cmdArgs),validParameters);
var v = _.isEqual(u.sort(),validParameters.sort());
if(!v){
help()
throw new Error("I can't make sense of some of the flags you've provided, like: \n "
+ _.difference( u.sort(), validParameters.sort() ) + "\n")
}
return cmdArgs;
}
var determineTunnelType = function(cmdArgs){
// throws errors if args conflict and no valid tunnelType can be determined
var tunnelType;
if(cmdArgs.dir){
if( !cmdArgs.proxyIp && !cmdArgs.proxyPort ){
tunnelType = 'webserver';
}else{
throw new Error("Arguments for both hosting local files and acting as a proxy server are "
+ "provided; only one tunnel type may be specified.");
}
} else if( !!cmdArgs.proxyIp || !!cmdArgs.proxyPort ){
// if user specifies proxyIp or proxyPort, we'll run our 'tunnel' checks
if( cmdArgs.dir && cmdArgs.port ){
// make sure user didn't also specify webserver options
throw new Error("Arguments for both hosting local files and acting as a proxy server are "
+ "provided; only one tunnel type may be specified.");
} else if( !cmdArgs.proxyIp || !cmdArgs.proxyPort ){
// make sure the user specified proxyIp AND proxyPort
throw new Error("You must specify the proxy IP (--proxyIp) AND proxy port (--proxyPort) "
+ "to create a tunnel.");
} else if( !!cmdArgs.proxyUser != !!cmdArgs.proxyPass ){
// make sure user specifies both or neither of proxyUser and proxyPass
throw new Error("You must specify both a proxy user (--proxyUser) and a proxy password "
+ "(--proxyPass) to use basic authentication with the proxy option.");
} else {
tunnelType = 'tunnel';
}
} else {
tunnelType = 'simpleproxy';
}
if (global.isLocal) {
tunnelType = 'local';
// tunnelType = 'simpleproxy';
}
return tunnelType;
}
var pacInit = function(cbtUrls,cmdArgs,cb){
if(cmdArgs.pac){
utils.getPac(cmdArgs.pac,function(err,pac){
if(err){
cb(err);
}
cmdArgs.pac = pac;
utils.determineHost({host:'https://'+cbtUrls.node,port:443},cmdArgs,function(err,hostInfo){
if(err){
return cb(err,null);
}
if(hostInfo.host+':'+hostInfo.port!='https://'+cbtUrls.node+':'+443){
utils.setProxies(true,'http://'+hostInfo.host+':'+hostInfo.port);
}
utils.determineHost({host:'http://'+cbtUrls.node,port:80},cmdArgs,function(err,hostInfo){
if(err){
return cb(err,null);
}
if(hostInfo.host+':'+hostInfo.port!='http://'+cbtUrls.node+':'+80){
utils.setProxies(false,'http://'+hostInfo.host+':'+hostInfo.port);
}
cb(null,pac);
});
});
});
}else{
cb(null,null);
}
}
var startConManTunnelViaApi = function(api, params, cb){
// sends err to callback if LCM is not running
api.getConManager( (err, getConManResult) => {
// console.log("getconmanresult: " + util.inspect(getConManResult));
if ( err ){ return cb(err) };
if ( getConManResult.localConnectionManagerEnabled && !getConManResult.localConnectionManagerRunning ){
// LCM is enabled but NOT running
err = new Error( 'Connection Manager is required for this account to start a tunnel, but it is not running. '
+ 'Please contact your primary account holder or support@crossbrowsertesting.com' );
warn(err);
return cb(err);
} else if ( getConManResult.localConnectionManagerEnabled && getConManResult.localConnectionManagerRunning ){
// this account has a connection manager running
// so ask the api to start a tunnel
return api.startConManagerTunnel(params, cb);
}
});
}
var startTunnel = function(api, params, cb){
api.postTunnel(params.tType, params.tunnelName, params.bypass, params.secret, params.acceptAllCerts, params.electron, params.directory, function(err, postResult){
if( err || (!global.isLocal && !postResult)){
err = err || new Error("Post to CBT failed. Returned falsy value: " + postResult);
return cb(err);
}
var opts = {
tcpPort: postResult.remote_port,
cbtServer: postResult.remote_server,
tp: postResult.tunnel_authkey,
tid: postResult.tunnel_id,
tu: postResult.tunnel_user
}
_.merge(params,opts);
cbts = new cbtSocket(api, params);
cbts.start(function(err,socket){
if(!err && socket){
api.putTunnel(postResult.tunnel_id, params.tType, params.directory, params.proxyIp, params.proxyPort, params.electron, function(err,putResult){
if(!err && putResult){
global.logger.info('Completely connected!');
if(params.kill){
setInterval(function(){
fs.stat(params.kill,function(error,stat){
if(error==null){
fs.unlink(params.kill,function(err){
if(err==null){
cbts.endWrap();
}else{
warn(err);
if (!cbts.nokill){
setTimeout(function(){
process.exit(1);
},10000);
} else {
throw err;
}
}
})
}
})
},1000);
}
cb(null);
}else{
cb(err);
cbts.endWrap();
}
});
}else{
cb(err);
cbts.endWrap();
}
});
});
}
module.exports = {
start: function(cmdArgs, cb){
try {
//remove all null or undefined args and ensure boolean strings turn out booleans
cmdArgs = _(cmdArgs)
.omit(_.isUndefined)
.omit(_.isNull)
.mapValues((property)=>{
return property === 'true' ? true :
property === 'false' ? false :
property
}).value();
var logLevel = cmdArgs.verbose ? 'ALL' :
cmdArgs.quiet ? 'OFF' :
'INFO';
if(cmdArgs.log&&cmdArgs.quiet){
log4js.configure({
appenders: {
console: {type: 'console'},
log: {type: 'file', filename: cmdArgs.log}
},
categories: {
default: { appenders: ['log'], level: 'ALL' }
}
});
}else if(cmdArgs.log){
log4js.configure({
appenders: {
console: {type: 'console'},
log: {type: 'file', filename: cmdArgs.log}
},
categories: {
default: { appenders: ['console','log'], level: logLevel }
}
});
}else{
log4js.configure({
appenders: {
console: {type: 'console'}
},
categories: {
default: { appenders: ['console'], level: logLevel }
}
});
}
global.logger = log4js.getLogger();
if (cmdArgs.local) {
global.logger.info('Running locally');
global.isLocal = true;
}
// console.log(cmdArgs);
// console.log('Using local configuration!');
// cbts = new cbtSocket();
// cbts.start(function(err,socket){
// global.logger.info('Completely connected!');
// });
// }
// throws error if there's an invalid arg
validateArgs(cmdArgs);
// option to not reject unauthorized
if(!cmdArgs.rejectUnauthorized||cmdArgs.rejectUnauthorized==='false'){
process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
}
// throws error if args conflict or no valid tunnelType can be determined
cmdArgs.tType = determineTunnelType(cmdArgs);
if( cmdArgs.tType == 'tunnel' ){
// what does bytecode do? - CC
cmdArgs.bytecode = true;
}
// default tunnelName to null
if(!cmdArgs.tunnelname){
cmdArgs.tunnelName = null;
}
// default port to null
if(!cmdArgs.port){
cmdArgs.port = null;
}
// not sure why we do this
_.merge(argv, cmdArgs);
if ( cmdArgs.test ){
var cbtUrls = {server: "test.crossbrowsertesting.com", node: "testapp.crossbrowsertesting.com"};
} else if ( cmdArgs.dev ){
var cbtUrls = {server: "devawsvnc.crossbrowsertesting.com", node: "devaws.crossbrowsertesting.com"}
} else if ( global.isLocal ) {
var cbtUrls = {server: "localhost", node: "localhost"}
} else {
var cbtUrls = {server: "crossbrowsertesting.com", node: "crossbrowsertesting.com"};
}
pacInit(cbtUrls,cmdArgs,function(err,pac){
if(err){
warn("Failed to initialize PAC");
return cb(err);
}
cmdArgs.pac = pac;
if(cmdArgs.httpProxy){
utils.setProxies(false,cmdArgs.httpProxy);
}
if(cmdArgs.httpsProxy){
utils.setProxies(true,cmdArgs.httpsProxy);
}
var params = {
urls: cbtUrls,
verbose: cmdArgs.verbose,
username: cmdArgs.username,
authkey: cmdArgs.authkey,
directory: cmdArgs.dir,
port: cmdArgs.port,
proxyIp: cmdArgs.proxyIp,
proxyPort: cmdArgs.proxyPort,
proxyUser: cmdArgs.proxyUser,
proxyPass: cmdArgs.proxyPass,
quiet: cmdArgs.quiet,
tType: cmdArgs.tType,
tunnelName: cmdArgs.tunnelname,
cmd: !!cmdArgs.cmd,
ready: cmdArgs.ready,
kill: cmdArgs.kill,
secret: cmdArgs.secret,
pac: cmdArgs.pac,
bypass: !!cmdArgs.bypass,
nokill: cmdArgs.nokill,
acceptAllCerts: !!cmdArgs.acceptAllCerts,
electron: cmdArgs.electron
}
if (global.isLocal) {
if (cmdArgs.wssUrl) {
params.wssUrl = cmdArgs.wssUrl;
} else {
params.wssUrl = 'ws://localhost:10118';
}
}
// This api call just to make sure the credentials are valid.
// We might could remove this and rely on the connection
// manager check to validate credentials.
var api = Api(cmdArgs.username, cmdArgs.authkey, cmdArgs.test, cmdArgs.dev);
// debugger;
api.getAccountInfo(function(err, accountInfo){
if (err){
// console.log('Authentication error! Please check your credentials and try again.');
warn('Authentication error! Please check your credentials and try again.');
return cb(err)
}
// NEED TO PUT USERID IN PARAMS!!
params.userId = accountInfo.user_id;
params.authkey = accountInfo.auth_key;
// LCM users can only use cbt_tunnels to start tunnel if secret is provided
if (global.isLocal) {
global.logger.info('starting tunnel with different params cuz isLocal.');
startTunnel(api, params, ( err ) => { return cb(err) });
} else if( accountInfo.subscription.localConManEnabled && !cmdArgs.secret ) {
// create conman post arguments
var conmanParams = createConmanParams(cmdArgs)
startConManTunnelViaApi(api, conmanParams, ( err, tunnelObject ) => {
if (err){
return cb(err)
} else {
var i = setInterval(()=>{
// console.log(`checking if tunnel ${tunnelObject.tunnel_id} is still alive`)
api.isTunnelAlive(tunnelObject.tunnel_id, (err, isAlive) =>{
if (!isAlive){
// console.log(`tunnel ${tunnelObject.tunnel_id} is dead!`)
clearInterval(i)
}
})
}, 10000);
process.on('SIGINT',function(){
// kill tunnel
api.deleteTunnel(tunnelObject.tunnel_id, (err) => {
if (err) {
warn(err);
}
if (params.ready){
fs.unlinkSync(params.ready);
}
global.logger.info('killed connection manager tunnel, quitting')
clearInterval(i);
if (!params.nokill){
process.exit(0);
}
});
global.logger.info('\nAttempting a graceful shutdown...');
});
process.on('SIGTERM',function(){
global.logger.info('Attempting a graceful shutdown...');
// kill tunnel
api.deleteTunnel(tunnelObject.tunnel_id, (err) => {
if (err) {
warn(err);
}
if (params.ready){
fs.unlinkSync(params.ready);
}
global.logger.info('killed connection manager tunnel, quitting')
clearInterval(i);
if (!params.nokill){
process.exit(0)
}
});
});
if(params.ready){
global.logger.info("SETTING READY FILE!");
fs.open(params.ready,'wx',function(err,fd){
if(err){
warn('The path specified for the "ready" file already exists or cannot be created (likely for permissions issues).');
}
cb(null);
fs.close(fd, function(err){
if(err){
global.logger.info(err);
}
global.logger.info('ready file written: '+params.ready);
});
})
} else {
cb(null);
}
if(params.kill){
setInterval(function(){
fs.stat(params.kill,function(error,stat){
if(error==null){
fs.unlink(params.kill,function(err){
if(err==null){
api.deleteTunnel(tunnelObject.tunnel_id, (err) => {
if (err) {
warn(err);
}
if (params.ready){
fs.unlinkSync(params.ready);
}
global.logger.info('killed connection manager tunnel, quitting')
clearInterval(i);
if (!params.nokill){
process.exit(0);
}
});
}else{
warn(err);
clearInterval(i);
if (!params.nokill){
setTimeout(function(){
process.exit(1);
},10000);
}
}
})
}
})
},1000);
}
}
});
} else {
startTunnel(api, params, ( err ) => { return cb(err) });
}
})
})
} catch (err) {
return cb(err.message)
}
},
stop: function(cb){
if(!_.isNull(cbts)){
cbts.endWrap(cb);
cbts = null;
}else{
warn('You must start the tunnel first by calling the function "start" with the relevant parameters.');
cb(new Error('Tunnel is not started!'),false);
}
},
status: function(){
if(!_.isNull(cbts) && !_.isUndefined(cbts)){
return true;
}else{
return false;
}
}
}
function createConmanParams(params){
// we need something to map between the option names that we get from users
// to the option names that we send to cbt_node
forwardedParams = {
// <cmd arg name>: <cbt api param name>,
"proxyIp": "local_ip",
"proxyPort": "local_port" ,
"dir": "directory",
"tunnelname": "tunnel_name",
"pac": "pac",
"rejectUnauthorized": "rejectUnauthorized",
"acceptAllCerts": "accept_all_certs",
"bypass": "direct_resolution"
};
// apply other_options to our options object
return _.reduce(params, (opts, value, optionName) => {
if(forwardedParams[optionName]){
var newkey = forwardedParams[optionName];
opts[newkey] = value === 'true' ? true :
value === 'false' ? false
: value;
};
return opts;
}, {})
}