https://github.com/161chihuahuas/bulb
🧅 embedded tor for node.js
https://github.com/161chihuahuas/bulb
anonymity hidden-services nodejs onion-service privacy tor
Last synced: 4 months ago
JSON representation
🧅 embedded tor for node.js
- Host: GitHub
- URL: https://github.com/161chihuahuas/bulb
- Owner: 161chihuahuas
- Created: 2024-11-04T01:35:42.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-06-09T22:43:24.000Z (4 months ago)
- Last Synced: 2025-06-09T22:48:17.112Z (4 months ago)
- Topics: anonymity, hidden-services, nodejs, onion-service, privacy, tor
- Language: JavaScript
- Homepage: http://chihuahua.rodeo/bulb/
- Size: 1.08 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🧅 bulb ~ *embedded tor for node.js*
Bulb is a complete client implementation of the [Tor Control Protocol](https://gitweb.torproject.org/torspec.git/plain/control-spec.txt).
It is designed to allow developers simple integration of the privacy-preserving properties of the [Tor](https://torprojects.org) network into their applications.
This library is focused on completeness of the protocol as well as simplicity and idiomatic interfaces for common use cases (see the ~8 LOC example hidden echo server).
## install
```
npm install @tacticalchihuahua/bulb --save
```
> As part of the installation process, it will download the Tor Expert
> Bundle and use the included Tor executable.
## usage
Complete documentation can be [found here](https://lilyanne.me/bulb).
### example: hidden tcp echo server
```js
const { TorContext } = require('@tacticalchihuahua/bulb');
const tor = await TorContext.create();
const server = tor.createServer((socket) => socket.pipe(socket));
const address = await server.listen(); // { host, port}
const client = tor.createConnection();
client.write('hello from bulb');
client.pipe(process.stdout); // hello from bulb
await client.connect(address);
```
## links
* [Tor Control Specification](https://github.com/torproject/torspec/blob/main/control-spec.txt)
* [Tor Documentation](https://www.torproject.org/docs/documentation.html.en)
## copying
> bulb - embedded tor for node.js
> anti-copyright 2025, tactical chihuahua
Licensed under the GNU Lesser General Public License 3.0.