YaH3C 技术文档

本文档旨在帮助用户详细了解并使用 YaH3C 项目，内容涵盖安装指南、使用说明、API 使用文档及项目安装方式。

1. 安装指南

依赖

• 主流 Linux 发行版，包括 OpenWrt/DD-WRT
• Python 2

安装步骤

首先，从 GitHub 上下载项目，可以直接利用 git clone，也可以下载压缩包自己解压然后安装。以下以 git 为例：

1. 安装 Git：

   # Ubuntu/Debian
   sudo apt-get install git
   
   # ArchLinux
   sudo pacman -S git
   

2. 从项目中 clone 下来并安装：

   git clone git://github.com/humiaozuzu/YaH3C.git
   cd YaH3C
   sudo python setup.py install
   

注意： ArchLinux 默认安装的 Python 是 Python 3，需要手动安装 Python 2。

2. 项目使用说明

认证

运行程序时必须具有 root 权限：

sudo yah3c

根据程序提示输入账号密码即可开始认证，对于不熟悉的选项，请直接按 Enter。

获取 IP

YaH3C 仅作为认证客户端，认证成功后需要手动获取 IP。项目支持基本的命令行参数，执行 yah3c -h 可以查看支持的命令行参数：

$ yah3c -h
usage: yah3c [-h] [-u USERNAME] [-debug]

Yet Another H3C Authentication Client

optional arguments:
  -h, --help            显示帮助信息并退出
  -u USERNAME, --username USERNAME
                        使用该用户名登录
  -debug                启用调试模式

例如，执行 sudo yah3c -u Maple 可以自动认证用户 Maple。

配置文件格式

用户登录信息以以下格式保存在文件 /etc/yah3c.conf 中：

[account]                  # 你的账户
password = 123456          # 密码
ethernet_interface = eth0  # 使用的网卡，默认为 eth0
dhcp_command = dhcpcd      # 验证成功后使用的 dhcp 命令（dhcpcd/dhclient），默认为空
daemon = True              # 验证成功后是否变成 daemon 进程，默认为是

3. 项目 API 使用文档

本文档未提供具体的 API 使用说明，因为 YaH3C 项目主要是命令行操作，用户可以通过 yah3c -h 查看支持的命令行参数。

4. 项目安装方式

本文档已在上文详细说明了项目的安装方式，用户可以通过 git clone 或下载压缩包的方式进行安装。

---

本文档基于 YaH3C 项目 README 和 GitHub 项目 Wiki 编写而成，旨在帮助用户更好地使用和理解该项目。