Skip to content

Repository files navigation

NetworkAuth(网络授权服务)

网络授权服务 (NetworkAuth) 是一个专注于应用鉴权、接口管理和动态逻辑分发的后端系统。它基于 Go 语言开发,提供应用程序管理、API接口管理、变量管理、用户认证等核心服务。

功能特性

🚀 核心功能

  • 应用管理: 支持应用的增删改查、版本管理、状态控制、密钥管理
  • API接口管理: 支持多种加密算法的API接口配置(RC4、RSA、易加密等)
  • 变量管理: 独立的变量系统,支持变量的增删改查和别名管理
  • 函数管理: 支持自定义函数代码管理,可绑定特定应用或全局使用
  • 用户管理: 完整的用户认证和权限管理系统
  • 系统设置: 灵活的系统配置和参数管理
  • 系统初始化: 提供引导式的数据表初始化和默认设置注入
  • 日志审计: 详细的登录日志和操作日志记录,保障系统安全

🔧 技术特性

  • RESTful API: 标准的 REST API 接口设计
  • JWT 认证: 基于 JWT 的安全认证机制
  • 多种加密算法: 支持 RC4、RSA、RSA动态、易加密等多种加密方式
  • 数据库支持: 兼容 MySQL 和 SQLite 数据库 (通过 GORM)
  • Redis 缓存: 集成 Redis 缓存提升性能(可选)
  • 日志系统: 完整的日志记录和管理,支持日志切割 (Logrus + Lumberjack)
  • 配置管理: 基于 Viper 的灵活配置系统
  • 命令行工具: 基于 Cobra 的强悍 CLI 管理工具

技术栈

  • 语言: Go 1.25.0
  • Web 框架: Gin
  • 数据库 ORM: GORM
  • 缓存: Redis(可选)
  • 认证: JWT + 验证码
  • 日志: Logrus + Lumberjack
  • 配置管理: Viper
  • 命令行: Cobra
  • 加密: 自定义加密工具包

项目结构

NetworkAuth/
├── cmd/                    # Cobra 命令行工具定义
├── config/                 # 配置文件模型与校验逻辑
├── constants/              # 全局常量定义 (版本号、状态码等)
├── controllers/            # 控制器层 (处理 HTTP 请求)
├── database/               # 数据库连接、迁移与默认数据填充
├── middleware/             # Gin 中间件 (日志、认证、维护模式等)
├── models/                 # GORM 数据模型定义
├── server/                 # HTTP 服务器路由注册
├── services/               # 核心业务逻辑层
├── utils/                  # 通用工具函数 (加密、日志、时间等)
└── main.go                 # 项目入口

快速开始

环境要求

  • Go 1.25.0 或更高版本
  • MySQL 5.7+ 或 SQLite 3
  • Redis (可选)

安装与运行

  1. 克隆项目

    git clone https://github.com/skyle1995/NetworkAuth.git
    cd NetworkAuth
  2. 安装依赖

    go mod download
  3. 运行服务器

    # 直接运行
    go run main.go server
    
    # 或者编译后运行
    go build -o networkauth main.go
    ./networkauth server

命令行工具

项目基于 Cobra CLI 框架,提供了丰富的命令行工具:

# 查看帮助信息
./networkauth --help

# 启动服务器
./networkauth server

# 指定配置文件启动
./networkauth --config ./config.json server

# 指定端口启动 (覆盖配置文件)
./networkauth server -p 8080

部署

Docker 部署

# 构建镜像
docker build -t networkauth .

# 运行容器
docker run -d -p 8080:8080 networkauth

生产环境部署

  1. 编译生产版本

    go build -o networkauth main.go
  2. 准备配置文件(可参考默认配置)。

  3. 使用进程管理工具(如 systemd 或 supervisor)管理后端服务进程。

反向代理与客户端 IP 识别

客户端 IP 用于 /api/open 限流(120 次/分钟)、IP 绑定与验证(ip_verify)、注册限流、IP 黑名单等场景,识别规则由 config.jsonserver.trusted_proxies 决定:

  • 默认(空数组)= 不信任任何代理,一律取 TCP 直连对端地址。这是安全默认值——攻击者伪造的 X-Forwarded-For 不会被采信。
  • 挂载 Nginx 等反向代理时必须显式配置代理机 IP/CIDR 白名单,否则所有客户端都会被识别为代理 IP:限流被共享误触发、IP 绑定/验证与地区校验全部失真。
{
  "server": {
    "trusted_proxies": ["127.0.0.1/8", "10.0.0.0/8"]
  }
}

仅来自白名单地址的请求才会解析 X-Forwarded-For(从右向左跳过可信节点,取最近的不可信节点作为真实客户端 IP)。配置项非法时服务会直接启动失败,避免带着错误的信任策略上线。


Git 版本发布(Tag)

本项目的发布通常以 Tag 为触发点(例如在 CI/CD 中自动构建并创建 Release)。建议使用语义化版本号(SemVer),并统一以 v 前缀命名,例如 v1.2.3

发布一个 Tag 版本

# 0) 同步远端 Tag(推荐)
#    目的:避免本地残留 Tag(远端已删除)被误推回去并触发工作流
#    Git 版本需支持 --prune-tags(不支持时看下方兼容方案)
git fetch origin --tags --prune --prune-tags

# 1) 确保代码已提交且工作区干净
git status

# 2) 确认远端不存在同名 Tag(避免误复用)
git ls-remote --tags origin v1.2.3

# 3) 创建“附注(annotated)”Tag(推荐)
git tag -a v1.2.3 -m "release: v1.2.3"

# 4) 推送 Tag 到远端(推荐:仅推送本次发布的 Tag)
git push origin v1.2.3

注意:不建议直接使用 git push origin --tags。如果远端曾删除某些 Tag,但本地仍保留,这条命令会把这些 Tag 重新推送回远端,从而可能再次触发 Release/工作流。

如你的 Git 不支持 --prune-tags,可用“清空本地 Tag → 重新从远端拉取 Tag”的方式确保对齐后再发布:

git tag -l | xargs -n 1 git tag -d
git fetch origin --tags
git tag | ForEach-Object { git tag -d $_ }
git fetch origin --tags

重新发布同名 Tag 版本(修正打错的 Tag)

同名 Tag 一般不建议复用;如确需修正(例如 Tag 指向了错误提交),请先删除远端 Tag,再重新创建并推送。

# 假设要修正的 Tag 为 v1.2.3

# 1) 删除本地 Tag
git tag -d v1.2.3

# 2) 删除远端 Tag
git push origin --delete v1.2.3

# 3) 在正确的提交上重建 Tag(<commit> 可省略,默认当前 HEAD)
git tag -a v1.2.3 <commit> -m "release: v1.2.3"

# 4) 重新推送到远端
git push origin v1.2.3

如果远端已基于该 Tag 生成了 Release(例如 Gitea/GitHub Release),通常也需要同步删除并重新创建对应 Release,避免附件与版本信息不一致。


CI/CD Secrets 配置

以下变量需在仓库 Settings → Actions → Secrets 中配置。

必选(缺一不可)

Secret 名称 说明
RELEASE_TOKEN Gitea 访问令牌,权限需包含 repo。用于自动创建 Release 并上传附件

对象存储上传(可选,未配置则跳过)

以下凭据需在 Settings → Actions → Secrets 中配置,其余配置项在 Settings → Actions → Variables 中配置。

腾讯云 COS

Secrets(凭据)

Secret 名称 必填 说明
COS_SECRET_ID API 密钥 SecretId
COS_SECRET_KEY API 密钥 SecretKey

Variables(配置)

Variable 名称 必填 说明
COS_BUCKET 存储桶名称(不含 AppId 后缀)
COS_REGION 地域,如 ap-guangzhou
COS_UPLOAD_PATH 上传路径前缀,如 releases;留空则放桶根目录
COS_CLEAR_BEFORE_UPLOAD 上传前清空目标路径;默认 false,设为 true 启用

阿里云 OSS

Secrets(凭据)

Secret 名称 必填 说明
OSS_ACCESS_KEY_ID RAM 用户 AccessKey ID
OSS_ACCESS_KEY_SECRET RAM 用户 AccessKey Secret

Variables(配置)

Variable 名称 必填 说明
OSS_BUCKET Bucket 名称
OSS_ENDPOINT Endpoint,如 oss-cn-hangzhou.aliyuncs.com
OSS_UPLOAD_PATH 上传路径前缀,同上
OSS_CLEAR_BEFORE_UPLOAD 上传前清空目标路径;默认 false,设为 true 启用

优先级:COS > OSS。两类同时配置时仅使用 COS。全部未配置则跳过存储上传(Release 仍正常创建)。


许可证

本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情。

About

一个基于 Golang 开发的网络验证系统

Resources

Stars

7 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages