README

Granax

Complete client implementation of the Tor Control Protocol. Control a running Tor instance from Node.js!

Usage

Install via NPM:

npm install @deadcanaries/granax --save

As part of the installation process, Granax will download the Tor Browser Bundle local to itself and use the included Tor executable, however you may opt for Granax to use the system Tor installed using your distribution's package manager by setting GRANAX_USE_SYSTEM_TOR=1.

You can also tell Granax to install the latest alpha release of Tor instead of the latest stable release, with GRANAX_USE_TOR_ALPHA=1.

const tor = require('@deadcanaries/granax')();

tor.on('ready', function() {
  tor.createHiddenService('127.0.0.1:8080', (err, result) => {
    console.info(`Service URL: ${result.serviceId}.onion`);
    console.info(`Private Key: ${result.privateKey}`);
  });
});

tor.on('error', function(err) {
  console.error(err);
});

Using System Tor Package

Make sure that ControlPort=9051 (or your preferred port) is set in your torrc, then you may open the control socket and issue commands:

const { connect } = require('net');
const { TorController } = require('@deadcanaries/granax');
const tor = new TorController(connect(9051), options);

tor.on('ready', function() {
  // party!
});

Note that if using cookie authentication, the Node.js process must have the appropriate privileges to read the cookie file. Usually, this means running as the same user that is running Tor.

Resources

License

Granax - Complete client implementation of the Tor Control Protocol
Copyright (C) 2019 Dead Canaries, Inc.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

@kickscondor/granax

Usage no npm install needed!