Tor.rb 技术文档

1. 安装指南

1.1 依赖项

• Ruby：版本 >= 1.8.7 或 >= 1.8.1（需安装 Backports）
• Tor：版本 >= 0.2.1

1.2 安装方法

推荐使用 RubyGems 进行安装。根据你的 Ruby 版本选择以下命令之一：

• 对于 Ruby 1.8.7+ 或 1.9.x：

  [sudo] gem install tor
  

• 对于 Ruby 1.8.1+：

  [sudo] gem install backports tor
  

1.3 下载开发版本

如果你想获取开发版本的本地副本，可以使用以下命令：

git clone git://github.com/bendiken/tor-ruby.git

或者下载最新的开发版本 tarball：

wget http://github.com/bendiken/tor-ruby/tarball/master

2. 项目使用说明

2.1 检查 Tor 是否安装及版本

require 'rubygems'
require 'tor'

Tor.available?                                     #=> true
Tor.version                                        #=> "0.2.1.25"

2.2 解析 Tor 配置文件

torrc = Tor::Config.load("/etc/tor/torrc")

或者使用块方式：

Tor::Config.open("/etc/tor/torrc") do |torrc|
  puts "Tor SOCKS port: #{torrc['SOCKSPort']}"
  puts "Tor control port: #{torrc['ControlPort']}"
  puts "Tor exit policy:"
  torrc.each('ExitPolicy') do |key, value|
    puts "  #{value}"
  end
end

2.3 与运行中的 Tor 进程通信

Tor::Controller.connect(:port => 9051) do |tor|
  puts "Tor version: #{tor.version}"
  puts "Tor config file: #{tor.config_file}"
end

2.4 检查特定主机是否为 Tor 出口节点

Tor::DNSEL.include?("185.220.101.21")               #=> true
Tor::DNSEL.include?("1.2.3.4")                     #=> false

3. 项目 API 使用文档

3.1 Tor 类

• Tor.available?：检查 Tor 是否安装在当前 PATH 中。
• Tor.version：返回 Tor 的版本号。

3.2 Tor::Config 类

• Tor::Config.load(file_path)：加载并解析 Tor 配置文件。
• Tor::Config.open(file_path)：以块方式加载并解析 Tor 配置文件。

3.3 Tor::Controller 类

• Tor::Controller.connect(options)：连接到本地运行的 Tor 进程，options 可以包含 :port 或 :socket。

3.4 Tor::DNSEL 类

• Tor::DNSEL.include?(ip_address)：检查给定的 IP 地址是否为 Tor 出口节点。

4. 项目安装方式

4.1 使用 RubyGems 安装

[sudo] gem install tor

或者：

[sudo] gem install backports tor

4.2 下载开发版本

git clone git://github.com/bendiken/tor-ruby.git

或者：

wget http://github.com/bendiken/tor-ruby/tarball/master