shadowChain 0.0.3

3.1 启动节点

$ SCStart confg.json

3.2 配置文件说明

配置文件为JSON格式，样例如下：

{
  "in_protocol": [
    "Socks5"
  ],
  "server_host": "0.0.0.0",
  "server_port": 3333,
  "out_protocol": [
    {
      "name": "SCSProxy",
      "host": "108.61.171.167",
      "port": 443
    },
    {
      "name": "SC"
    }
  ],
  "password": "you_password",
  "is_reverse_server": false,
  "is_reverse_client": false
}

• in_protocol为输入协议栈，必需，详情见3.3 协议栈。

• out_protocol为输出协议栈，必需，详情见3.3 协议栈。

• server_host节点监听的地址，必须。

• server_port节点监听的端口，必须。

• password为用户密码，必需。

• is_reverse_server，非必需，表示本服务器为NAT穿透时处在内网中的server端。此时指定server_host，server_port作为公网的转发服务器地址。(测试中..)

• is_reverse_client，非必需，表示本服务器在作为公网转发服务器,接受来自内网的连接，此时out_protocol中最后一个被指定的地址作为服务器的监听地址。(测试中..)

3.3 协议栈

在协议栈中的代理协议分为三种类型， base类型，client类型，server类型。

• base类型值不具有代理转发的功能。纯粹只对数据进行一定的变换，通常为全局的加密协议。

• client类型作为代理协议的客户端部分，其特点是需要知道与次客户端对应的服务端的地址。所以需要指定两个额外的参数host与port来表明服务端地址。

• server类型作为协议的服务端部分，通常会解析出连接需要转发到的实际地址。

配置文件中的in_protocol和out_protocol为协议栈的具体配置选项。二者皆为数组，接受object（有额外参数）或者纯字符串（无额外参数）的代理协议配置。

若协议配置为object，则需要使用name参数来指定代理协议的名字。若其为client类型，则必须有额外的name,port参数来表明对应服务端地址。同时，除了必须指定的参数外，根据代理协议不同，某些协议可能具备一些额外的配置参数。详情请查看协议相关文档。

in_protocol接受一个server类型的协议和多个base类型的协议，且server类型协议必须为第一个协议； 如此，端口接受到的网络数据将按照从后往前的顺序经过各个协议解码，最后解析出发送的源数据与需要到达的目标。

out_protocol接受任意数量的client协议与base协议； 若为client协议，则需要使用object来一并传入服务端地址host和port。 此地址会作为要转发的目标地址传递给下一个client协议，以此完成出口代理栈。 通过多层封装，可以让数据经过多台不同协议网络节点的转发最终达到目标地址。 注意，协议栈中的最后一个client协议的目的地址即为该服务器的时间连接地址。 代理栈中第一个代理协议的转发地址为server协议解析出的目的地址，若协议栈中无client协议，则此地址也是协议栈中最后一个地址，则直接连接目的地址，实现代理链的最终出口访问。 虽然此时可以添加base协议以编码输出，但通常会产生错误。

4.1 socks5协议

基础的socks5代理协议，可以实现socks5转发。

协议类型：server、client；根据协议出现位置决定。

socks5协议支持基本的USERNAME/PASSWORD代理认证。在配置文件socks5协议配置字典中指定username和password字段即可开启。

不建议使用socks5作为向公网转发的协议，因为socks5为明文协议且特征明显。只推荐作为高性能的本机转发协议。

4.2 SC协议

ShadowChain特有协议。主要作用是加密流量，隐藏流量特征。SC协议配置中可以传入额外的参数timeout用以控制包超时时间。由于防重放算法的原因，若包的发送时间与服务器接受到此包的时间超过timeout设定的误差，则直接断开连接。请保证timeout时间在本机与代理服务器延迟之上。默认值为300s，若设为0。则关闭防重放检测。

协议类型：base；

注意，timeout过大容易造成偶然的协议认证失败与过大的内存消耗。 强烈推荐将SC协议作为协议栈的最终协议，进行全局的数据加密，以保障安全。

具体请查阅SC协议文档.pdf

4.3 SCProxy协议

与socks5类似的简化代理协议，删除了socks5中不必要的内容。

协议类型：server、client；根据协议出现位置决定。

推荐将其与SC协议配套使用，作为代理转发协议！

4.4 PF协议

端口转发协议，且具有额外的host和port参数。所有发送到此协议的数据其目标地址均为host和port指定地址。可以保证数据最终发往此地址，作为端口转发协议使用。

协议类型：server；