API

Sneak API: How to use this powerful tool?

Documents Outline

• Http
• Tor
• Netool

Tor Module

Tor module provides methods to build TCP proxy.
Also, it has APIs to monitor the working status if TCP proxy.

print_bootstrap_lines()

description
Display the information of starting processes.

seed()

description
The function is used to generate seed for hash password.
It produces a short hash with length 10.

display_msg()

description
Display the processing message of the process.

class Proxy

description
Tor's alias is TCP Proxy

params
socks_port: < int >
The port for SOCKS proxy.

control_port: < int >
Tor uses the control port to communicate.

proxy_host: < string >
The proxy host's ip address. The default is localhost because most of people run Tor on their local machines. Am I right?

exit_country_code: < string >
Decides where the exit nodes should be.

tor_path: < string >
The working directory for the tor process.

run()

description
Run tor as the proxy server.

auth_controller()

description
Initial a tor proxy controller to communicate with Tor proxy.

renew_identity()

description
According to the official document, user's identity is defined by three-hop service. Once renew_identity is performed, process will request tor for a new identity. However, the renew operation does not mean it will always provide new ip addresses. It is quite common to see the exit nodes used previously.

[WARNING] Please do not use this function too frequently because it will cause a huge burden on Tor.

terminate()

description
End the tor process. Before the Tor relay is killed, display how many bytes our relay is read or written.

list_circuits()

description
List all available circuits.