How to set up SVPN

0. Brief

svpn 是一款轻量级分布式架构的高安全SVPN产品，可以提供点对点的安全隧道,支持多种加密算法，支持国密与流量混淆。基于零信任理念提供用户身份验证与分级权限管理，支撑多样化的使用场景，提供安全可靠的访问代理与接入服务。

• Manager/总控平台: 负责网络管理、用户管理、权限管理
• Server/服务端: 负责接入或组网服务提供
• Client/客户端: 接入服务端后可以获取相应服务资源

1. 版本信息

1.1 最新稳定版本

• 最新版本 1.1.5-1
  • 修复部分用户组无法添加用户的问题
  • 修复用户管理系统当用户数为10的整数倍时的显示异常
  • 修复部分虚拟网络状态异常，导致客户端不可见的问题
  • 完善Server异常状态自启动逻辑
  • 用户名与密码支持特殊字符 ！@ $ _ - . -
  • 用户名大小写区分调整
  • 增加登陆超时机制
  • 用户管理页面 在线用户 更改为全局在线用户数
  • 新增接入点配置历史
  • MacOS增加对更多utun的支持，新增对ARM64架构支持

• 历史版本 1.1.5
  • 支持N2N连接
  • 支持权限管理

1.2 如何搭建一个完整的SVPN服务

• 1.搭建一个Manager,得到接入地址(IP:Port)
• 2.搭建一个或多个Server,使用Manager的接入地址将Server连入您的Manager
• 3.安装Client,使用Manager的接入地址来接入控制中心，获取服务列表，并进行连接

2. Manager安装部署指南

2.1 Preparation 准备

1. 可供访问的网络地址（IP:Port）

• 确保客户端能够访问到该地址和端口
• 如您想要建立通过公网地址访问的服务端，请确保公网地址正确，或端口映射关系正确

2. 服务器或虚拟机

• Ubuntu20.04/22.04
• CentOS Stream（TBD）

2.2 Installation 安装

Manager需要通过ASN Apt Repo源进行安装，具体安装部署方法如下：

方式一：通过在线脚本一键安装

bash <(curl -s http://svpn.amianetworks.com.cn:20016/install_svpn_manager_linux.sh)

方式二：手动配置安装

• step1: 安装ASN Repo密钥

  curl http://pkg-d.amianetworks.com.cn:20016/pgp-key.public | sudo apt-key add -

• step2: 配置ASN Repo

  echo "deb [arch=amd64] http://pkg-d.amianetworks.com.cn:20016/apt-repo stable main" | sudo tee /etc/apt/sources.list.d/asnrepo.list

  配置完成进行一次Repo更新：

  sudo apt update

• step3: 安装部署

  sudo apt install svpn-manager

  至此SVPN Manager 安装完成

2.3 Remove 卸载

使用sudo apt remove svpn-manager进行卸载

2.4 Configuration 配置

2.4.1 如何打开管理页面

• 配置网址为http://localhost:18080，您也可以通过其它机器通过可访问的IP地址远程进行配置管理
• 例如若您的Server本机地址为172.171.1.1，那么您可以在其它与之连通的机器上使用http://172.171.1.1:18080进行配置与管理

2.4.2 配置指南

若您是首次安装配置SVPN Manager,需要注意如下内容：

• AccessPoint/接入点

  • 您可以创建自己的接入点，接入地址需要配置为客户端可访问的地址或公网地址，接入地址很重要，客户端的服务获取以及其他服务节点的加入均基于该地址

  • 示例：假设A机器作为Manager,其有两个ip地址：172.171.1.1以及192.168.1.1;

    若您想两个网络内的机器均能访问到接入点可以配置接入点为 0.0.0.0:2000;

    若您只想172网段的设备连接到您的接入点可以配置接入点为 172.171.1.1:2000

• Network/虚拟网络

  • 虚拟网络是互联互通的一张虚拟局域网，您可以创建一个虚拟网络并让Server节点加入进来，在同一张虚拟网络中的Server节点会互联，共享代理的网络资源
  • 虚拟网络有三种属性：public 表示Server节点可以自由加入该网络； private 表示Server节点需要通过验证码才能加入该网络； system 表示该网络由系统自动生成，用户无法管理

• Network Group/虚拟网络分组

  • 虚拟网络分组是虚拟网络的集合，方便进行权限管控
  • 可以做管理平台页面进行便捷的虚拟网络分组管理

• User Group/用户分组

  • 用户分组是客户端用户的集合，可以与虚拟网络分组进行关联，从未进行权限的划分与管控
  • 可以做管理平台页面进行便捷的用户分组管理

• User/用户 创建

  • 您可以根据提示进行批量用户生成，生成的用户名和密码可分发给客户端用户进行登录验证，确保客户端的合法性

3. Server安装部署指南

3.1 Preparation 准备

1. 可供访问的网络地址与端口池（ IP & Port Range ）

• 确保客户端能够访问到该地址和端口池
• 如您想要建立通过公网地址访问的服务端，请确保公网地址正确，或端口映射关系正确

2. 服务器或虚拟机

• Ubuntu20.04/22.04
• CentOS Stream（TBD）

3.2 Installation 安装

Server需要通过ASN Apt Repo源进行安装，具体安装部署方法如下：

方式一：通过在线脚本一键安装

bash <(curl -s http://svpn.amianetworks.com.cn:20016/install_svpn_server_linux.sh)

方式二：手动配置安装

• step1: 安装ASN Repo密钥

  curl http://pkg-d.amianetworks.com.cn:20016/pgp-key.public | sudo apt-key add -

• step2: 配置ASN Repo

  echo "deb [arch=amd64] http://pkg-d.amianetworks.com.cn:20016/apt-repo stable main" | sudo tee /etc/apt/sources.list.d/asnrepo.list

  配置完成进行一次Repo更新：

  sudo apt update

• step3: 安装部署

  sudo apt install svpn-server

  至此SVPN Server 安装完成

3.3 Remove 卸载

使用sudo apt remove svpn-server进行卸载

3.4 Configuration 配置

3.4.1 如何打开管理页面

• 配置网址为http://localhost:18088，您也可以通过其它机器通过可访问的IP地址远程进行配置管理
• 例如若您的Server本机地址为172.171.1.1，那么您可以在其它与之连通的机器上使用http://172.171.1.1:18088进行配置与管理

3.4.2 配置指南

若您是首次安装配置SVPN Server,需要注意如下内容：

• AccessPoint/接入点
  • 接入点为您在Manager中创建的接入地址，一般以IP:Port的形式连接
• Network/虚拟网络
  • Server可以选择加入虚拟网络，一个Server可以加入多个虚拟网络
  • 若您有两个Server节点，可以将其加入同一个Network进行组网，比如您有两个办公网络，分别有一个Server,那么将这两个Server加入同一个Network可以让连上该网络的所有用户同时访问到这两个Server背后的网络资源，达到组网目的
  • 为了方便使用，系统会默认为Server创建一个Auto-前缀的system属性的虚拟网络，并让当前节点加入其中
• Server Port Range/服务端口范围
  • 服务端口用于与Client以及与其它Server建立安全隧道，一般不少于3个，请确保端口通畅
  • 服务端口不足可能导致加入虚拟网络失败
• Server Networks/服务网段
  • 服务网段代表了当前服务节点所代理的网络服务资源
  • 示例：若您当前节点用于提供办公接入，且办公网络为172.171.0.0/16,那么只需在服务网段配置该网络地址即可；若有多个服务网段以分号分隔即可
• Work Mode/工作模式
  • 性能模式，速度最快，吞吐量最大，首选
  • 稳定模式，适合跨境网络或网络质量较差的网络环境，牺牲部分性能换取稳定连接
• User/用户 创建
  • 您可以根据提示进行批量用户生成，生成的用户名和密码可分发给客户端用户进行登录验证，确保客户端的合法性

4. Client安装部署指南

4.1 Preparation 准备

主机或虚拟机

• Ubuntu20.04+
• MacOS
• Windows10+

4.2 Installation/Remove 安装/卸载

Linux

• 方式一：在线脚本一键安装

  bash <(curl -s http://svpn.amianetworks.com.cn:20016/install_svpn_client_linux.sh)

• 方式二：手动配置安装
  • 通过ASN Apt Repo安装
  • 安装过程与Server相同，sudo apt install svpn-client即可
• 卸载时使用sudo apt remove svpn-client

MacOS

• 通过点击下载MacOS_amd64安装包 点击下载MacOS_arm64安装包 下载相应dmg安装包进行安装
  下载完成后打开app即可

• 卸载时将svpn app移入废纸篓即可

Windows

• 通过通过点击下载Windows安装包 下载相应msi安装包进行安装
  下载完成后，双击svpn_windows_amd64.msi进行安装，安装完成后桌面和开始菜单会有相应的快捷方式，双击即可启动服务

• 卸载方式一 在“开始菜单” ，然后在显示的列表中找到start svpn。 长按（或右键单击）应用，然后选择“卸载”。
• 卸载方式二 选择 “设置 ”> 应用 > 应用&功能。 选择svpn，然后选择“卸载”。

4.3 Configuration 配置

4.3.1 如何进行配置与管理

• 配置网址为http://localhost:18088，您也可以通过其它机器通过可访问的IP地址远程进行配置管理
• 例如若您的Client本机地址为172.171.1.1，那么您可以在其它与之连通的机器上使用http://172.171.1.1:18088进行配置与管理

4.3.2 客户端配置管理

• 配置接入地址 在客户端的登录界面进行接入地址配置，若您是首次安装使用，该地址为空，将管理员告知的接入地址IP:Port配置进去。同理若后续想要变更接入地址也在同样的地方进行地址变更
• 登录验证 使用Server管理员分配给您的用户名和密码进行登录验证，登录完成后可以进行密码修改
• 网络管理 登录完成后您可以在页面上查看当前Server管理的所有虚拟网络，您只需选中您想要连接的虚拟网络点击Connect即可接入该虚拟网络，访问目标Server提供的网络资源