Categorygithub.com/subgraph/bulb
modulepackage
0.0.1
Repository: https://github.com/subgraph/bulb.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
20
Dependents
0
Files
844 SLOC

# README

bulb - Is not stem

Yawning Angel (yawning at torproject dot org)

bulb is a Go language interface to the Tor control port. It is considerably lighter in functionality than stem and other controller libraries, and is intended to be used in combination withcontrol-spec.txt.

It was written primarily as a not-invented-here hack, and the base interface is more than likely to stay fairly low level, though useful helpers will be added as I need them.

Things you should probably use instead:

Bugs:

  • bulb does not send the 'QUIT' command before closing the connection.

# Packages

No description provided by the author
Package utils implements useful utilities for dealing with Tor and it's control port.

# Functions

Dial connects to a given network/address and returns a new Conn for the connection.
NewConn returns a new Conn using c for I/O.

# Constants

The various control port StatusCode constants.
The various control port StatusCode constants.
The various control port StatusCode constants.
The various control port StatusCode constants.
The various control port StatusCode constants.
The various control port StatusCode constants.
The various control port StatusCode constants.
The various control port StatusCode constants.
The various control port StatusCode constants.
The various control port StatusCode constants.
The various control port StatusCode constants.
The various control port StatusCode constants.
The various control port StatusCode constants.
The various control port StatusCode constants.
The various control port StatusCode constants.
The various control port StatusCode constants.
The various control port StatusCode constants.

# Variables

ErrNoAsyncReader is the error returned when the asynchronous event handling is requested, but the helper go routine has not been started.

# Structs

Conn is a control port connection instance.
NewOnionConfig is a configuration for NewOnion command.
OnionInfo is the result of the AddOnion command.
OnionPortSpec is a Onion VirtPort/Target pair.
OnionPrivateKey is a unknown Onion private key (crypto.PublicKey).
ProtocolInfo is the result of the ProtocolInfo command.
Response is a response to a control port command, or an asyncrhonous event.