Skip to content

认证

GOST中可以通过设置单认证信息或认证器进行简单的身份认证。

动态配置

认证器支持通过Web API进行动态配置。

单认证信息

如果不需要多用户认证,则可以通过直接设置单认证信息来进行单用户认证。

服务端

直接通过username:password方式设置

gost -L http://user:pass@:8080
如果认证信息中包含特殊字符,也可以通过auth参数来设置,auth的值为username:password形式的base64编码值。
echo -n user:pass | base64

gost -L http://:8080?auth=dXNlcjpwYXNz
services:
- name: service-0
  addr: ":8080"
  handler:
    type: http
    auth:
      username: user
      password: pass
  listener:
    type: tcp

服务的处理器或监听器上通过auth属性设置单认证信息。

客户端

直接通过username:password方式设置

gost -L http://:8080 -F socks5://user:pass@:1080
如果认证信息中包含特殊字符,也可以通过auth参数来设置,auth的值为username:password形式的base64编码值。

gost -L http://:8080 -F socks5://:1080?auth=dXNlcjpwYXNz

services:
- name: service-0
  addr: ":8080"
  handler:
    type: http
    chain: chain-0
  listener:
    type: tcp
chains:
- name: chain-0
  hops:
  - name: hop-0
    nodes:
    - name: node-0
      addr: :1080
      connector:
        type: socks5
        auth:
          username: user
          password: pass
      dialer:
        type: tcp
节点的连接器或拨号器上通过auth属性设置单认证信息。

认证器

认证器包含一组或多组认证信息。服务通过认证器可以实现多用户认证功能。

Note

认证器仅支持配置文件设置。

services:
- name: service-0
  addr: ":8080"
  handler:
    type: http
    auther: auther-0
  listener:
    type: tcp
authers:
- name: auther-0
  auths:
  - username: user1
    password: pass1
  - username: user2
    password: pass2

服务的处理器或监听器上通过auther属性引用认证器名称(name)来使用指定的认证器。

优先级

如果使用了认证器,则单认证信息会被忽略。

如果设置了auth参数,则路径中直接设置的认证信息会被忽略。

Shadowsocks处理器

Shadowsocks处理器无法使用认证器,仅支持通过设置单认证信息作为加密参数。

数据源

认证器可以配置多个数据源,目前支持的数据源有:内联,文件,redis。

内联

内联数据源是指直接在配置文件中通过auths参数设置数据。

authers:
- name: auther-0
  auths:
  - username: user1
    password: pass1
  - username: user2
    password: pass2

文件

指定外部文件作为数据源。通过file.path参数指定文件路径。

authers:
- name: auther-0
  file:
    path: /path/to/auth/file

文件格式为按行分割的认证信息,每一行认证信息为用空格分割的user-pass对,以#开始的行为注释行。

# username password

admin           #123456
test\user001    123456
test.user@002   12345678

Redis

指定redis服务作为数据源,redis数据类型必须为哈希(Hash)类型

authers:
- name: auther-0
  redis:
    addr: 127.0.0.1:6379
    db: 1
    password: 123456
    key: gost:authers:auther-0
addr (string, required)
redis服务地址
db (int, default=0)
数据库名
password (string)
密码
key (string, default=gost)
redis key

优先级

当同时配置多个数据源时,优先级从高到低为: redis,文件,内联。如果在不同数据源中存在相同的用户名,则优先级高的会覆盖优先级低的数据。

热加载

文件和redis数据源支持热加载。通过设置reload参数开启热加载,reload参数指定同步数据源数据的周期。

authers:
- name: auther-0
  reload: 10s
  file:
    path: /path/to/auth/file
  redis:
    addr: 127.0.0.1:6379
    db: 1
    password: 123456
    key: gost:authers:auther-0

注意

通过命令行设置的认证信息仅会应用到处理器或连接器上,对于ssh和sshd服务则会应用到监听器和拨号器上。

如果通过命令行自动生成配置文件,在metadata中不会出现此参数项。