sshego 项目使用教程

1. 项目目录结构及介绍

sshego 项目的目录结构如下：

sshego/
├── cmd/
│   ├── sshego/
│   │   └── main.go
├── config/
│   ├── config.go
│   └── example_config.toml
├── docs/
│   ├── README.md
│   └── ...
├── internal/
│   ├── auth/
│   ├── client/
│   ├── server/
│   └── ...
├── pkg/
│   ├── crypto/
│   ├── ssh/
│   └── ...
├── vendor/
│   └── ...
├── go.mod
├── go.sum
└── README.md

目录结构介绍

• cmd/: 包含项目的命令行工具入口文件。
  • sshego/: 包含 main.go 文件，是项目的启动文件。
• config/: 包含项目的配置文件和配置相关的代码。
  • config.go: 配置文件的解析和处理代码。
  • example_config.toml: 示例配置文件。
• docs/: 包含项目的文档文件。
  • README.md: 项目的基本介绍文档。
• internal/: 包含项目的内部实现代码，通常不对外公开。
  • auth/: 认证相关的代码。
  • client/: 客户端相关的代码。
  • server/: 服务器相关的代码。
• pkg/: 包含项目的公共库代码，可以被其他项目引用。
  • crypto/: 加密相关的代码。
  • ssh/: SSH 协议相关的代码。
• vendor/: 包含项目的依赖包。
• go.mod: Go 模块文件，定义了项目的依赖。
• go.sum: Go 模块的校验文件。
• README.md: 项目的基本介绍文档。

2. 项目启动文件介绍

项目的启动文件位于 cmd/sshego/main.go。该文件是整个项目的入口，负责初始化配置、启动服务器或客户端等操作。

main.go 文件内容概述

package main

import (
    "fmt"
    "os"
    "sshego/config"
    "sshego/internal/server"
)

func main() {
    // 解析命令行参数
    cfg, err := config.ParseConfig()
    if err != nil {
        fmt.Println("配置解析失败:", err)
        os.Exit(1)
    }

    // 启动服务器
    server.Start(cfg)
}

启动流程

1. 解析配置: 通过 config.ParseConfig() 函数解析配置文件。
2. 启动服务器: 调用 server.Start(cfg) 启动服务器。

3. 项目配置文件介绍

项目的配置文件位于 config/example_config.toml，是一个 TOML 格式的文件。该文件定义了项目的各种配置参数，如服务器地址、端口、认证方式等。

example_config.toml 文件内容概述

[server]
address = "0.0.0.0"
port = 2222

[auth]
method = "password"
users = [
    { username = "admin", password = "admin123" },
    { username = "user", password = "user123" }
]

[logging]
level = "info"
file = "sshego.log"

配置项说明

• [server]: 服务器配置。
  • address: 服务器监听的地址。
  • port: 服务器监听的端口。
• [auth]: 认证配置。
  • method: 认证方式，如 password 或 publickey。
  • users: 用户列表，包含用户名和密码。
• [logging]: 日志配置。
  • level: 日志级别，如 info、debug 等。
  • file: 日志文件路径。

通过修改配置文件，可以灵活地调整项目的运行参数。