Bine 项目教程

1. 项目目录结构及介绍

Bine 项目的目录结构如下：

bine/
├── control/
├── examples/
├── logo/
├── process/
├── tests/
├── torutil/
├── .gitignore
├── LICENSE
├── README.md
├── doc.go
├── go.mod
├── go.sum

目录介绍

• control/: 包含与 Tor 控制相关的代码。
• examples/: 包含使用 Bine 库的示例代码。
• logo/: 包含项目的 Logo 文件。
• process/: 包含与 Tor 进程管理相关的代码。
• tests/: 包含项目的测试代码。
• torutil/: 包含与 Tor 工具相关的代码。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• doc.go: 项目的文档文件。
• go.mod: Go 模块文件，定义项目的依赖。
• go.sum: Go 模块文件，记录依赖的校验和。

2. 项目启动文件介绍

Bine 项目的启动文件是 examples/simple/main.go。这个文件展示了如何使用 Bine 库启动一个简单的 Onion 服务。

主要代码片段

package main

import (
    "context"
    "fmt"
    "log"
    "net/http"
    "time"

    "github.com/cretz/bine/tor"
)

func main() {
    // 启动 Tor 并注册 Onion 服务
    fmt.Println("Starting and registering onion service, please wait a couple of minutes...")
    t, err := tor.Start(nil, nil)
    if err != nil {
        log.Panicf("Unable to start Tor: %v", err)
    }
    defer t.Close()

    // 等待最多几分钟来发布服务
    listenCtx, listenCancel := context.WithTimeout(context.Background(), 3*time.Minute)
    defer listenCancel()

    // 创建一个 v3 Onion 服务，监听任意端口，但显示为 80 端口
    onion, err := t.Listen(listenCtx, &tor.ListenConf{RemotePorts: []int{80}})
    if err != nil {
        log.Panicf("Unable to create onion service: %v", err)
    }
    defer onion.Close()

    fmt.Printf("Open Tor browser and navigate to http://%v.onion\n", onion.ID)
    fmt.Println("Press enter to exit")

    // 从 HTTP 服务当前文件夹
    errCh := make(chan error, 1)
    go func() {
        errCh <- http.Serve(onion, http.FileServer(http.Dir(".")))
    }()

    // 按下回车键结束
    go func() {
        fmt.Scanln()
        errCh <- nil
    }()

    if err = <-errCh; err != nil {
        log.Panicf("Failed serving: %v", err)
    }
}

启动步骤

1. 启动 Tor: 使用 tor.Start 启动 Tor 进程。
2. 创建 Onion 服务: 使用 t.Listen 创建一个 Onion 服务。
3. 启动 HTTP 服务: 使用 http.Serve 启动一个简单的 HTTP 服务。
4. 等待用户输入: 等待用户按下回车键结束服务。

3. 项目配置文件介绍

Bine 项目没有传统的配置文件，但可以通过代码中的配置选项来定制 Tor 的行为。例如，在启动 Tor 时，可以通过 tor.StartConf 结构体来配置 Tor 的启动参数。

配置示例

t, err := tor.Start(nil, &tor.StartConf{
    ProcessCreator: embedded.NewCreator(), // 使用嵌入式 Tor
    UseEmbeddedControlConn: true,          // 使用嵌入式控制连接
})

配置选项

• ProcessCreator: 指定 Tor 进程的创建方式，例如使用嵌入式 Tor。
• UseEmbeddedControlConn: 是否使用嵌入式控制连接，而不是通过控制端口。

通过这些配置选项，可以灵活地控制 Tor 的行为，以满足不同的需求。