-
Notifications
You must be signed in to change notification settings - Fork 7
/
index.js
297 lines (260 loc) · 8.78 KB
/
index.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
/*jslint node:true*/
'use strict';
var net = require('net');
var EventEmitter = require('events').EventEmitter;
var stream = require('stream');
/**
* Tor control class
* @link https://gitweb.torproject.org/torspec.git/tree/control-spec.txt
* @param {{}} [opts] - Options
* @param {string} [opts.host="localhost"] - Host address to tor-control
* @param {number} [opts.port=9051] - Port of tor-control
* @param {string} [opts.password=""] - Host address to tor-control (default localhost)
* @param {string} [opts.path] - Connect by path (alternative way to opts.host and opts.port)
* @constructor
*/
var TorControl = function TorControl(opts) {
var self = this;
EventEmitter.apply(this);
opts = opts || {};
if (!opts.hasOwnProperty('path')) {
opts.port = opts.port || 9051;
opts.host = opts.host || 'localhost';
}
opts.password = opts.password || '';
if (!opts.hasOwnProperty('persistent')) {
opts.persistent = false;
}
this.connect = function connectTorControl(params, cb) {
params = params || opts;
if (this.connection) {
if (cb) {
return cb(null, this.connection);
}
return;
}
if (!params.hasOwnProperty('path')) {
if (opts.hasOwnProperty('path')) {
params.path = opts.path;
} else {
params.host = params.host || opts.host;
params.port = params.port || opts.port;
}
}
this.connection = net.connect(params);
//Handling connection errors
this.connection.once('error', function(err){
if (cb) {
cb(new Error("Error connecting to control port: " + err));
}
});
// piping events
this.connection.on('data', function (data) {
self.emit('data', data);
});
this.connection.on('end', function () {
self.connection = null;
self.emit('end');
});
if (cb) {
this.connection.once('data', function (data) {
data = data.toString();
if (data.substr(0, 3) === '250') {
return cb(null, self.connection);
}
return cb(new Error('Authentication failed with message: ' + data));
});
}
this.connection.write('AUTHENTICATE "' + (params.password || opts.password) + '"\r\n'); // Chapter 3.5
return this;
};
this.disconnect = function disconnectTorControl(cb, force) {
if (!this.connection) {
if (cb) {
return cb();
}
return;
}
if (cb) {
this.connection.once('end', function () {
return cb();
});
}
if (force) {
return this.connection.end();
}
this.connection.write('QUIT\r\n');
return this;
};
this.isPersistent = function isTorControlPersistent() {
return !!opts.persistent;
};
this.setPersistent = function setTorControlPersistent(value) {
opts.persistent = !!value;
return this;
};
};
TorControl.prototype = {
'__proto__': EventEmitter.prototype,
sendCommand: function sendCommandToTorCOntrol(command, cb, keepConnection) {
var self = this,
tryDisconnect = function (callback) {
if (keepConnection || self.isPersistent() || !self.connection) {
return callback();
}
return self.disconnect(callback);
};
return this.connect(null, function (err, connection) {
if (err) {
return cb(err);
}
connection.once('data', function (data) {
return tryDisconnect(function () {
var messages = [],
arr,
i;
if (cb) {
data = data.toString();
if (/250 OK\r?\n/.test(data)) {
arr = data.split(/\r?\n/);
for (i = 0; i < arr.length; i += 1) {
if (arr[i] !== '') {
var message = /^250./.test(arr[i]) ? arr[i].substr(4) : arr[i]
messages.push(message);
}
}
return cb(null, {
code: 250,
messages: messages,
data: data
});
}
return cb(new Error(data), {
code: parseInt(data.substr(0, 3), 10),
message: data.substr(4),
data: data
});
}
});
});
connection.write(command + '\r\n');
});
},
// Config
setConf: function setConf(request, cb) { // Chapter 3.1
return this.sendCommand('SETCONF ' + request, cb);
},
resetConf: function resetConf(request, cb) { // Chapter 3.2
return this.sendCommand('RESETCONF ' + request, cb);
},
getConf: function getConf(request, cb) { // Chapter 3.3
return this.sendCommand('GETCONF ' + request, cb);
},
getEvents: function getEvents(request, cb) { // Chapter 3.4
return this.sendCommand('GETEVENTS ' + request, cb);
},
saveConf: function saveConf(request, cb) { // Chapter 3.6
return this.sendCommand('SAVECONF ' + request, cb);
},
// Signals:
signal: function sendSignalToTorCOntrol(signal, cb, keepConnection) { // Chapter 3.7
return this.sendCommand('SIGNAL ' + signal, cb, keepConnection);
},
signalReload: function sendSignalReload(cb) {
return this.signal('RELOAD', cb, true);
},
signalHup: function sendSignalHup(cb) {
return this.signal('HUP', cb);
},
signalShutdown: function sendSignalShutdown(cb) {
return this.signal('SHUTDOWN', cb, true);
},
signalDump: function sendSignalDump(cb) {
return this.signal('DUMP', cb);
},
signalUsr1: function sendSignalUsr1(cb) {
return this.signal('USR1', cb);
},
signalDebug: function sendSignalDegug(cb) {
return this.signal('DEBUG', cb);
},
signalUsr2: function sendSignalUsr2(cb) {
return this.signal('USR2', cb);
},
signalHalt: function sendSignalHalt(cb) {
return this.signal('HALT', cb, true);
},
signalTerm: function sendSignalTerm(cb) {
return this.signal('TERM', cb, true);
},
signalInt: function sendSignalInt(cb) {
return this.signal('INT', cb);
},
signalNewnym: function sendSignalNewNym(cb) {
return this.signal('NEWNYM', cb);
},
signalCleardnscache: function sendSignalClearDnsCache(cb) {
return this.signal('CLEARDNSCACHE', cb);
},
// MapAddress
mapAddress: function mapAddress(address, cb) { // Chapter 3.8
return this.sendCommand('MAPADDRESS ' + address, cb);
},
// GetInfo
getInfo: function (request, cb) { // Chapter 3.9
if (!Array.prototype.isPrototypeOf(request)) {
request = [request];
}
return this.sendCommand('GETINFO ' + request.join(' '), cb);
},
// Circuit
extendCircuit: function (id, superspec, purpose, cb) { // Chapter 3.10
var str = 'EXTENDCIRCUIT ' + id;
if (superspec) {
str += ' ' + superspec;
}
if (purpose) {
str += ' ' + purpose;
}
return this.sendCommand(str, cb);
},
setCircuitPurpose: function (id, purpose, cb) { // Chapter 3.11
return this.sendCommand('SETCIRCUITPURPOSE ' + id + ' purpose=' + purpose, cb);
},
setRouterPurpose: function (nicknameOrKey, purpose, cb) { // Chapter 3.12
return this.sendCommand('SETROUTERPURPOSE ' + nicknameOrKey + ' ' + purpose, cb);
},
attachStream: function (streamId, circuitId, hop, cb) { // Chapter 3.13
var str = 'ATTACHSTREAM ' + streamId + ' ' + circuitId;
if (hop) {
str += ' ' + hop;
}
return this.sendCommand(str, cb);
},
// Alias
getNewCircuit: function sendSignalNewNym(cb) {
return this.sendSignalNewNym(cb);
},
/**
* @type {stream}
*/
connection: null,
// Methods with usage of private vars (opts)
/**
* @type {function}
*/
connect: null,
/**
* @type {function}
*/
disconnect: null,
/**
* @type {function}
*/
isPersistent: null,
/**
* @type {function}
*/
setPersistent: null
};
module.exports = TorControl;