TRKJ/EdgeCommon
2
0
Fork 0
mirror of https://github.com/TeaOSLab/EdgeCommon.git synced 2026-01-07 21:08:48 +08:00
Code Issues Packages Projects Releases Wiki Activity

完善API注释

Browse Source
This commit is contained in:
刘祥超
2023-06-16 18:27:16 +08:00
parent 70bc6e7d8e
commit 6bf017ee22
12 changed files with 519 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
pkg/rpc/jsons/hsts.md Normal file
View File

@@ -0,0 +1,39 @@
# HSTS
## 定义
~~~json
{
"isOn": "是否启用",
"maxAge": "最大有效期，单位秒",
"includeSubDomains": "可选项，是否包含子域名",
"preload": "可选项，是否预加载",
"domains": ["可选项，支持的域名1", "可选项，支持的域名2" ...]
}
~~~
其中：
* `maxAge` 可以填写一天（86400秒）或者更长时间
* 如果不填写 `domains` 则支持所有域名
## 示例
### 不限制任何域名
~~~json
{
"isOn": true,
"maxAge": 86400,
"includeSubDomains":false,
"preload":false,
"domains":[]
}
~~~
### 限制域名
~~~json
{
"isOn": true,
"maxAge": 86400,
"includeSubDomains":false,
"preload":false,
"domains":["example.com", "www.example.com"]
}
~~~

49
pkg/rpc/jsons/http_protocol.md Normal file
View File

@@ -0,0 +1,49 @@
# HTTP协议配置
## 定义
~~~json
{
"isOn": "是否启用",
"listen": [
{
"protocol": "协议",
"host": "主机地址，通常为空",
"portRange": "端口或者端口范围"
},
...
]
}
~~~
## 示例
### 监听80端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "http",
"host": "",
"portRange": "80"
}
]
}
~~~
### 监听80和8080端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "http",
"portRange": "80"
},
{
"protocol": "http",
"portRange": "8080"
}
]
}
~~~

67
pkg/rpc/jsons/https_protocol.md Normal file
View File

@@ -0,0 +1,67 @@
# HTTPS协议配置
## 定义
~~~json
{
"isOn": "是否启用",
"listen": [
{
"protocol": "协议",
"host": "主机地址，通常为空",
"portRange": "端口或者端口范围"
},
...
],
"sslPolicyRef": {
"isOn": "启用SSL策略",
"sslPolicyId": "SSL策略ID"
}
}
~~~
其中 `SSL策略ID` 通过 `/SSLPolicyService/createSSLPolicy` 接口创建。
## 示例
### 监听443端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "https",
"host": "",
"portRange": "443"
}
],
"sslPolicyRef": {
"isOn": true,
"sslPolicyId": 123
}
}
~~~
其中SSL策略ID `123` 通过 `/SSLPolicyService/createSSLPolicy` 接口创建。
### 监听443和8443端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "https",
"portRange": "443"
},
{
"protocol": "https",
"portRange": "8443"
}
],
"sslPolicyRef": {
"isOn": true,
"sslPolicyId": 123
}
}
~~~
其中SSL策略ID `123` 通过 `/SSLPolicyService/createSSLPolicy` 接口创建。

19
pkg/rpc/jsons/ssl_cert_refs.md
View File

@@ -1,7 +1,24 @@
# SSL证书引用
## 示例
可以用来引用一组证书。
## 定义
~~~json
[
{
"isOn": "是否启用",
"certId": "证书ID 1"
},
{
"isOn": "是否启用",
"certId": "证书ID 2"
},
...
]
~~~
## 示例
~~~json
[
{
"isOn": true,

63
pkg/rpc/jsons/tcp_protocol.md Normal file
View File

@@ -0,0 +1,63 @@
# TCP协议配置
## 定义
~~~json
{
"isOn": "是否启用",
"listen": [
{
"protocol": "协议",
"host": "主机地址，通常为空",
"portRange": "端口或者端口范围"
},
...
]
}
~~~
## 示例
### 监听1234端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "tcp",
"host": "",
"portRange": "1234"
}
]
}
~~~
### 监听1234和2345端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "tcp",
"portRange": "1234"
},
{
"protocol": "tcp",
"portRange": "2345"
}
]
}
~~~
### 监听1234到1240之间的所有端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "tcp",
"host": "",
"portRange": "1234-1240"
}
]
}
~~~

68
pkg/rpc/jsons/tls_protocol.md Normal file
View File

@@ -0,0 +1,68 @@
# TLS协议配置
## 定义
~~~json
{
"isOn": "是否启用",
"listen": [
{
"protocol": "协议",
"host": "主机地址，通常为空",
"portRange": "端口或者端口范围"
},
...
],
"sslPolicyRef": {
"isOn": "启用SSL策略",
"sslPolicyId": "SSL策略ID"
}
}
~~~
其中 `SSL策略ID` 通过 `/SSLPolicyService/createSSLPolicy` 接口创建。
## 示例
### 监听8443端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "tls",
"host": "",
"portRange": "8443"
}
],
"sslPolicyRef": {
"isOn": true,
"sslPolicyId": 123
}
}
~~~
其中SSL策略ID `123` 通过 `/SSLPolicyService/createSSLPolicy` 接口创建。
### 监听8443和8543端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "tls",
"portRange": "8443"
},
{
"protocol": "tls",
"portRange": "8543"
}
],
"sslPolicyRef": {
"isOn": true,
"sslPolicyId": 123
}
}
~~~
其中SSL策略ID `123` 通过 `/SSLPolicyService/createSSLPolicy` 接口创建。

63
pkg/rpc/jsons/udp_protocol.md Normal file
View File

@@ -0,0 +1,63 @@
# UDP协议配置
## 定义
~~~json
{
"isOn": "是否启用",
"listen": [
{
"protocol": "协议",
"host": "主机地址，通常为空",
"portRange": "端口或者端口范围"
},
...
]
}
~~~
## 示例
### 监听1234端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "udp",
"host": "",
"portRange": "1234"
}
]
}
~~~
### 监听1234和2345端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "udp",
"portRange": "1234"
},
{
"protocol": "udp",
"portRange": "2345"
}
]
}
~~~
### 监听1234到1240之间的所有端口
~~~json
{
"isOn": true,
"listen": [
{
"protocol": "udp",
"host": "",
"portRange": "1234-1240"
}
]
}
~~~

46
pkg/rpc/pb/service_server.pb.go
View File

@@ -29,34 +29,34 @@ const (
// of the legacy proto package is being used.
const _ = proto.ProtoPackageIsVersion4
// 创建服务
// 创建网站
type CreateServerRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
UserId int64 `protobuf:"varint,1,opt,name=userId,proto3" json:"userId,omitempty"`
AdminId int64 `protobuf:"varint,2,opt,name=adminId,proto3" json:"adminId,omitempty"`
Type string `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
UserId int64 `protobuf:"varint,1,opt,name=userId,proto3" json:"userId,omitempty"` // 可选参数，用户ID，如果不想指定用户，此值可以为0
AdminId int64 `protobuf:"varint,2,opt,name=adminId,proto3" json:"adminId,omitempty"` // 可选参数，管理员ID
Type string `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"` // 类型：httpProxy（HTTP反向代理，一般CDN服务都选这个）、httpWeb（静态文件服务，只会从服务器上读取文件内容，不会转发到源站）、tcpProxy（TCP反向代理）、udpProxy（UDP反向代理）
Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"` // 网站名称，通常可以是一个域名
Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"` // 可选参数，网站描述
// 配置相关
ServerNamesJSON []byte `protobuf:"bytes,8,opt,name=serverNamesJSON,proto3" json:"serverNamesJSON,omitempty"` // @link json:server_names
ServerNamesJSON []byte `protobuf:"bytes,8,opt,name=serverNamesJSON,proto3" json:"serverNamesJSON,omitempty"` // 域名列表 @link json:server_names
// Deprecated: Do not use.
ServerNamesJON []byte `protobuf:"bytes,19,opt,name=serverNamesJON,proto3" json:"serverNamesJON,omitempty"` // 已过期，请使用 serverNamesJSON 代替
HttpJSON []byte `protobuf:"bytes,9,opt,name=httpJSON,proto3" json:"httpJSON,omitempty"`
HttpsJSON []byte `protobuf:"bytes,10,opt,name=httpsJSON,proto3" json:"httpsJSON,omitempty"`
TcpJSON []byte `protobuf:"bytes,11,opt,name=tcpJSON,proto3" json:"tcpJSON,omitempty"`
TlsJSON []byte `protobuf:"bytes,12,opt,name=tlsJSON,proto3" json:"tlsJSON,omitempty"`
UnixJSON []byte `protobuf:"bytes,13,opt,name=unixJSON,proto3" json:"unixJSON,omitempty"`
UdpJSON []byte `protobuf:"bytes,14,opt,name=udpJSON,proto3" json:"udpJSON,omitempty"`
WebId int64 `protobuf:"varint,15,opt,name=webId,proto3" json:"webId,omitempty"`
ReverseProxyJSON []byte `protobuf:"bytes,16,opt,name=reverseProxyJSON,proto3" json:"reverseProxyJSON,omitempty"`
ServerGroupIds []int64 `protobuf:"varint,17,rep,packed,name=serverGroupIds,proto3" json:"serverGroupIds,omitempty"`
UserPlanId int64 `protobuf:"varint,18,opt,name=userPlanId,proto3" json:"userPlanId,omitempty"`
NodeClusterId int64 `protobuf:"varint,30,opt,name=nodeClusterId,proto3" json:"nodeClusterId,omitempty"`
IncludeNodesJSON []byte `protobuf:"bytes,31,opt,name=includeNodesJSON,proto3" json:"includeNodesJSON,omitempty"`
ExcludeNodesJSON []byte `protobuf:"bytes,32,opt,name=excludeNodesJSON,proto3" json:"excludeNodesJSON,omitempty"`
ServerNamesJON []byte `protobuf:"bytes,19,opt,name=serverNamesJON,proto3" json:"serverNamesJON,omitempty"` // 已过期，请使用 serverNamesJSON 代替
HttpJSON []byte `protobuf:"bytes,9,opt,name=httpJSON,proto3" json:"httpJSON,omitempty"` // HTTP协议，当type为httpProxy或者httpWeb时填写 @link json:http_protocol
HttpsJSON []byte `protobuf:"bytes,10,opt,name=httpsJSON,proto3" json:"httpsJSON,omitempty"` // HTTPS协议，当type为httpProxy或者httpWeb时填写 @link json:https_protocol
TcpJSON []byte `protobuf:"bytes,11,opt,name=tcpJSON,proto3" json:"tcpJSON,omitempty"` // TCP协议，当type为tcpProxy时填写 @link json:tcp_protocol
TlsJSON []byte `protobuf:"bytes,12,opt,name=tlsJSON,proto3" json:"tlsJSON,omitempty"` // TLS协议，当type为tcpProxy时填写 @link json:tls_protocol
UnixJSON []byte `protobuf:"bytes,13,opt,name=unixJSON,proto3" json:"unixJSON,omitempty"` // 备用参数，不用填写
UdpJSON []byte `protobuf:"bytes,14,opt,name=udpJSON,proto3" json:"udpJSON,omitempty"` // UDP协议，当type为udpProxy时填写 @link json:udp_protocol
WebId int64 `protobuf:"varint,15,opt,name=webId,proto3" json:"webId,omitempty"` // 可选参数，Web配置ID，当type为httpProxy或者httpWeb时填写，可以通过 /HTTPWebService/createHTTPWeb 接口创建；如果你需要配置缓存等信息时需要在 HTTPWebService 接口操作
ReverseProxyJSON []byte `protobuf:"bytes,16,opt,name=reverseProxyJSON,proto3" json:"reverseProxyJSON,omitempty"` // 反向代理（包含源站）设置
ServerGroupIds []int64 `protobuf:"varint,17,rep,packed,name=serverGroupIds,proto3" json:"serverGroupIds,omitempty"` // 所属网站分组ID列表
UserPlanId int64 `protobuf:"varint,18,opt,name=userPlanId,proto3" json:"userPlanId,omitempty"` // 可选参数，套餐ID
NodeClusterId int64 `protobuf:"varint,30,opt,name=nodeClusterId,proto3" json:"nodeClusterId,omitempty"` // 所部署的集群ID
IncludeNodesJSON []byte `protobuf:"bytes,31,opt,name=includeNodesJSON,proto3" json:"includeNodesJSON,omitempty"` // 备用参数，不用填写
ExcludeNodesJSON []byte `protobuf:"bytes,32,opt,name=excludeNodesJSON,proto3" json:"excludeNodesJSON,omitempty"` // 备用参数，不用填写
}
func (x *CreateServerRequest) Reset() {
@@ -7266,7 +7266,7 @@ const _ = grpc.SupportPackageIsVersion6
//
// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type ServerServiceClient interface {
// 创建服务
// 创建网站
CreateServer(ctx context.Context, in *CreateServerRequest, opts ...grpc.CallOption) (*CreateServerResponse, error)
// 修改服务基本信息
UpdateServerBasic(ctx context.Context, in *UpdateServerBasicRequest, opts ...grpc.CallOption) (*RPCSuccess, error)
@@ -7883,7 +7883,7 @@ func (c *serverServiceClient) CopyServerConfig(ctx context.Context, in *CopyServ
// ServerServiceServer is the server API for ServerService service.
type ServerServiceServer interface {
// 创建服务
// 创建网站
CreateServer(context.Context, *CreateServerRequest) (*CreateServerResponse, error)
// 修改服务基本信息
UpdateServerBasic(context.Context, *UpdateServerBasicRequest) (*RPCSuccess, error)

66
pkg/rpc/pb/service_ssl_policy.pb.go
View File

@@ -29,22 +29,22 @@ const (
// of the legacy proto package is being used.
const _ = proto.ProtoPackageIsVersion4
// 创建Policy
// 创建策略
type CreateSSLPolicyRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
Http2Enabled bool `protobuf:"varint,1,opt,name=http2Enabled,proto3" json:"http2Enabled,omitempty"` // 是否启用HTTP/2
Http3Enabled bool `protobuf:"varint,10,opt,name=http3Enabled,proto3" json:"http3Enabled,omitempty"` // 是否启用HTTP/3（在满足条件的基础上）
MinVersion string `protobuf:"bytes,2,opt,name=minVersion,proto3" json:"minVersion,omitempty"` // 支持的最低SSL版本
SslCertsJSON []byte `protobuf:"bytes,3,opt,name=sslCertsJSON,proto3" json:"sslCertsJSON,omitempty"` // 证书内容
HstsJSON []byte `protobuf:"bytes,4,opt,name=hstsJSON,proto3" json:"hstsJSON,omitempty"` // HSTS配置
ClientAuthType int32 `protobuf:"varint,5,opt,name=clientAuthType,proto3" json:"clientAuthType,omitempty"` //
ClientCACertsJSON []byte `protobuf:"bytes,6,opt,name=clientCACertsJSON,proto3" json:"clientCACertsJSON,omitempty"` // CA证书内容
CipherSuites []string `protobuf:"bytes,7,rep,name=cipherSuites,proto3" json:"cipherSuites,omitempty"` // 自定义加密套件
CipherSuitesIsOn bool `protobuf:"varint,8,opt,name=cipherSuitesIsOn,proto3" json:"cipherSuitesIsOn,omitempty"` // 是否启用自定义加密套件
OcspIsOn bool `protobuf:"varint,9,opt,name=ocspIsOn,proto3" json:"ocspIsOn,omitempty"` // 是否启用OCSP
Http2Enabled bool `protobuf:"varint,1,opt,name=http2Enabled,proto3" json:"http2Enabled,omitempty"` // 可选项，是否启用HTTP/2
Http3Enabled bool `protobuf:"varint,10,opt,name=http3Enabled,proto3" json:"http3Enabled,omitempty"` // 可选项，是否启用HTTP/3（在满足条件的基础上）
MinVersion string `protobuf:"bytes,2,opt,name=minVersion,proto3" json:"minVersion,omitempty"` // 支持的最低SSL版本，可选择值： SSL 3.0, TLS 1.0, TLS 1.1, TLS 1.2, TLS 1.3
SslCertsJSON []byte `protobuf:"bytes,3,opt,name=sslCertsJSON,proto3" json:"sslCertsJSON,omitempty"` // 可选项，关联的证书信息，可以在创建后再通过修改策略来配置 @link json:ssl_cert_refs
HstsJSON []byte `protobuf:"bytes,4,opt,name=hstsJSON,proto3" json:"hstsJSON,omitempty"` // 可选项，HSTS配置 @link json:hsts
ClientAuthType int32 `protobuf:"varint,5,opt,name=clientAuthType,proto3" json:"clientAuthType,omitempty"` // 可选项，客户端校验类型：0 无需证书，1 需要客户端证书，2 需要任一客户端证书，3 如果客户端上传了证书才校验，4 需要客户端证书而且需要校验
ClientCACertsJSON []byte `protobuf:"bytes,6,opt,name=clientCACertsJSON,proto3" json:"clientCACertsJSON,omitempty"` // 可选项，CA证书内容
CipherSuites []string `protobuf:"bytes,7,rep,name=cipherSuites,proto3" json:"cipherSuites,omitempty"` // 可选项，自定义加密套件
CipherSuitesIsOn bool `protobuf:"varint,8,opt,name=cipherSuitesIsOn,proto3" json:"cipherSuitesIsOn,omitempty"` // 可选项，是否启用自定义加密套件
OcspIsOn bool `protobuf:"varint,9,opt,name=ocspIsOn,proto3" json:"ocspIsOn,omitempty"` // 可选项，是否启用OCSP
}
func (x *CreateSSLPolicyRequest) Reset() {
@@ -154,7 +154,7 @@ type CreateSSLPolicyResponse struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
SslPolicyId int64 `protobuf:"varint,1,opt,name=sslPolicyId,proto3" json:"sslPolicyId,omitempty"`
SslPolicyId int64 `protobuf:"varint,1,opt,name=sslPolicyId,proto3" json:"sslPolicyId,omitempty"` // 创建的策略ID
}
func (x *CreateSSLPolicyResponse) Reset() {
@@ -196,23 +196,23 @@ func (x *CreateSSLPolicyResponse) GetSslPolicyId() int64 {
return 0
}
// 修改Policy
// 修改策略
type UpdateSSLPolicyRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
SslPolicyId int64 `protobuf:"varint,1,opt,name=sslPolicyId,proto3" json:"sslPolicyId,omitempty"`
Http2Enabled bool `protobuf:"varint,2,opt,name=http2Enabled,proto3" json:"http2Enabled,omitempty"`
Http3Enabled bool `protobuf:"varint,11,opt,name=http3Enabled,proto3" json:"http3Enabled,omitempty"` // 是否启用HTTP/3（在满足条件的基础上）
MinVersion string `protobuf:"bytes,3,opt,name=minVersion,proto3" json:"minVersion,omitempty"`
SslCertsJSON []byte `protobuf:"bytes,4,opt,name=sslCertsJSON,proto3" json:"sslCertsJSON,omitempty"`
HstsJSON []byte `protobuf:"bytes,5,opt,name=hstsJSON,proto3" json:"hstsJSON,omitempty"`
ClientAuthType int32 `protobuf:"varint,6,opt,name=clientAuthType,proto3" json:"clientAuthType,omitempty"`
ClientCACertsJSON []byte `protobuf:"bytes,7,opt,name=clientCACertsJSON,proto3" json:"clientCACertsJSON,omitempty"`
CipherSuites []string `protobuf:"bytes,8,rep,name=cipherSuites,proto3" json:"cipherSuites,omitempty"`
CipherSuitesIsOn bool `protobuf:"varint,9,opt,name=cipherSuitesIsOn,proto3" json:"cipherSuitesIsOn,omitempty"`
OcspIsOn bool `protobuf:"varint,10,opt,name=ocspIsOn,proto3" json:"ocspIsOn,omitempty"`
SslPolicyId int64 `protobuf:"varint,1,opt,name=sslPolicyId,proto3" json:"sslPolicyId,omitempty"` // 策略ID
Http2Enabled bool `protobuf:"varint,2,opt,name=http2Enabled,proto3" json:"http2Enabled,omitempty"` // 可选项，是否启用HTTP/2
Http3Enabled bool `protobuf:"varint,11,opt,name=http3Enabled,proto3" json:"http3Enabled,omitempty"` // 可选项，是否启用HTTP/3（在满足条件的基础上）
MinVersion string `protobuf:"bytes,3,opt,name=minVersion,proto3" json:"minVersion,omitempty"` // 支持的最低SSL版本，可选择值： SSL 3.0, TLS 1.0, TLS 1.1, TLS 1.2, TLS 1.3
SslCertsJSON []byte `protobuf:"bytes,4,opt,name=sslCertsJSON,proto3" json:"sslCertsJSON,omitempty"` // 关联的证书信息 @link json:ssl_cert_refs
HstsJSON []byte `protobuf:"bytes,5,opt,name=hstsJSON,proto3" json:"hstsJSON,omitempty"` // 可选项，HSTS配置 @link json:hsts
ClientAuthType int32 `protobuf:"varint,6,opt,name=clientAuthType,proto3" json:"clientAuthType,omitempty"` // 可选项，客户端校验类型：0 无需证书，1 需要客户端证书，2 需要任一客户端证书，3 如果客户端上传了证书才校验，4 需要客户端证书而且需要校验
ClientCACertsJSON []byte `protobuf:"bytes,7,opt,name=clientCACertsJSON,proto3" json:"clientCACertsJSON,omitempty"` // 可选项，CA证书内容
CipherSuites []string `protobuf:"bytes,8,rep,name=cipherSuites,proto3" json:"cipherSuites,omitempty"` // 可选项，自定义加密套件
CipherSuitesIsOn bool `protobuf:"varint,9,opt,name=cipherSuitesIsOn,proto3" json:"cipherSuitesIsOn,omitempty"` // 可选项，是否启用自定义加密套件
OcspIsOn bool `protobuf:"varint,10,opt,name=ocspIsOn,proto3" json:"ocspIsOn,omitempty"` // 可选项，是否启用OCSP
}
func (x *UpdateSSLPolicyRequest) Reset() {
@@ -324,14 +324,14 @@ func (x *UpdateSSLPolicyRequest) GetOcspIsOn() bool {
return false
}
// 查找Policy
// 查找策略
type FindEnabledSSLPolicyConfigRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
SslPolicyId int64 `protobuf:"varint,1,opt,name=sslPolicyId,proto3" json:"sslPolicyId,omitempty"` // SSL策略ID
IgnoreData bool `protobuf:"varint,2,opt,name=ignoreData,proto3" json:"ignoreData,omitempty"` // 忽略证书内容数据
IgnoreData bool `protobuf:"varint,2,opt,name=ignoreData,proto3" json:"ignoreData,omitempty"` // 是否忽略证书内容数据
}
func (x *FindEnabledSSLPolicyConfigRequest) Reset() {
@@ -385,7 +385,7 @@ type FindEnabledSSLPolicyConfigResponse struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
SslPolicyJSON []byte `protobuf:"bytes,1,opt,name=sslPolicyJSON,proto3" json:"sslPolicyJSON,omitempty"`
SslPolicyJSON []byte `protobuf:"bytes,1,opt,name=sslPolicyJSON,proto3" json:"sslPolicyJSON,omitempty"` // 策略配置信息
}
func (x *FindEnabledSSLPolicyConfigResponse) Reset() {
@@ -655,11 +655,11 @@ const _ = grpc.SupportPackageIsVersion6
//
// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type SSLPolicyServiceClient interface {
// 创建Policy
// 创建策略
CreateSSLPolicy(ctx context.Context, in *CreateSSLPolicyRequest, opts ...grpc.CallOption) (*CreateSSLPolicyResponse, error)
// 修改Policy
// 修改策略
UpdateSSLPolicy(ctx context.Context, in *UpdateSSLPolicyRequest, opts ...grpc.CallOption) (*RPCSuccess, error)
// 查找Policy
// 查找策略
FindEnabledSSLPolicyConfig(ctx context.Context, in *FindEnabledSSLPolicyConfigRequest, opts ...grpc.CallOption) (*FindEnabledSSLPolicyConfigResponse, error)
}
@@ -700,11 +700,11 @@ func (c *sSLPolicyServiceClient) FindEnabledSSLPolicyConfig(ctx context.Context,
// SSLPolicyServiceServer is the server API for SSLPolicyService service.
type SSLPolicyServiceServer interface {
// 创建Policy
// 创建策略
CreateSSLPolicy(context.Context, *CreateSSLPolicyRequest) (*CreateSSLPolicyResponse, error)
// 修改Policy
// 修改策略
UpdateSSLPolicy(context.Context, *UpdateSSLPolicyRequest) (*RPCSuccess, error)
// 查找Policy
// 查找策略
FindEnabledSSLPolicyConfig(context.Context, *FindEnabledSSLPolicyConfigRequest) (*FindEnabledSSLPolicyConfigResponse, error)
}

42
pkg/rpc/protos/service_server.proto
View File

@@ -11,7 +11,7 @@ import "models/model_user_plan.proto";
// 网站服务相关服务
service ServerService {
// 创建服务
// 创建网站
rpc createServer (CreateServerRequest) returns (CreateServerResponse);
// 修改服务基本信息
@@ -177,31 +177,31 @@ service ServerService {
rpc copyServerConfig(CopyServerConfigRequest) returns (RPCSuccess);
}
// 创建服务
// 创建网站
message CreateServerRequest {
int64 userId = 1;
int64 adminId = 2;
string type = 3;
string name = 4;
string description = 5;
int64 userId = 1; // 可选参数，用户ID，如果不想指定用户，此值可以为0
int64 adminId = 2; // 可选参数，管理员ID
string type = 3; // 类型：httpProxy（HTTP反向代理，一般CDN服务都选这个）、httpWeb（静态文件服务，只会从服务器上读取文件内容，不会转发到源站）、tcpProxy（TCP反向代理）、udpProxy（UDP反向代理）
string name = 4; // 网站名称，通常可以是一个域名
string description = 5; // 可选参数，网站描述
// 配置相关
bytes serverNamesJSON = 8; // @link json:server_names
bytes serverNamesJSON = 8; // 域名列表 @link json:server_names
bytes serverNamesJON = 19 [deprecated = true]; // 已过期，请使用 serverNamesJSON 代替
bytes httpJSON = 9;
bytes httpsJSON = 10;
bytes tcpJSON = 11;
bytes tlsJSON = 12;
bytes unixJSON = 13;
bytes udpJSON = 14;
int64 webId = 15;
bytes reverseProxyJSON = 16;
repeated int64 serverGroupIds = 17;
int64 userPlanId = 18;
bytes httpJSON = 9; // HTTP协议，当type为httpProxy或者httpWeb时填写 @link json:http_protocol
bytes httpsJSON = 10; // HTTPS协议，当type为httpProxy或者httpWeb时填写 @link json:https_protocol
bytes tcpJSON = 11; // TCP协议，当type为tcpProxy时填写 @link json:tcp_protocol
bytes tlsJSON = 12; // TLS协议，当type为tcpProxy时填写 @link json:tls_protocol
bytes unixJSON = 13; // 备用参数，不用填写
bytes udpJSON = 14; // UDP协议，当type为udpProxy时填写 @link json:udp_protocol
int64 webId = 15; // 可选参数，Web配置ID，当type为httpProxy或者httpWeb时填写，可以通过 /HTTPWebService/createHTTPWeb 接口创建；如果你需要配置缓存等信息时需要在 HTTPWebService 接口操作
bytes reverseProxyJSON = 16; // 反向代理（包含源站）设置
repeated int64 serverGroupIds = 17; // 所属网站分组ID列表
int64 userPlanId = 18; // 可选参数，套餐ID
int64 nodeClusterId = 30;
bytes includeNodesJSON = 31;
bytes excludeNodesJSON = 32;
int64 nodeClusterId = 30; // 所部署的集群ID
bytes includeNodesJSON = 31; // 备用参数，不用填写
bytes excludeNodesJSON = 32; // 备用参数，不用填写
}
message CreateServerResponse {

60
pkg/rpc/protos/service_ssl_policy.proto
View File

@@ -7,55 +7,55 @@ import "models/rpc_messages.proto";
// SSL/TLS策略管理服务
service SSLPolicyService {
// 创建Policy
// 创建策略
rpc createSSLPolicy (CreateSSLPolicyRequest) returns (CreateSSLPolicyResponse);
// 修改Policy
// 修改策略
rpc updateSSLPolicy (UpdateSSLPolicyRequest) returns (RPCSuccess);
// 查找Policy
// 查找策略
rpc findEnabledSSLPolicyConfig (FindEnabledSSLPolicyConfigRequest) returns (FindEnabledSSLPolicyConfigResponse);
}
// 创建Policy
// 创建策略
message CreateSSLPolicyRequest {
bool http2Enabled = 1; // 是否启用HTTP/2
bool http3Enabled = 10; // 是否启用HTTP/3（在满足条件的基础上）
string minVersion = 2; // 支持的最低SSL版本
bytes sslCertsJSON = 3; // 证书内容
bytes hstsJSON = 4; // HSTS配置
int32 clientAuthType = 5; //
bytes clientCACertsJSON = 6; // CA证书内容
repeated string cipherSuites = 7; // 自定义加密套件
bool cipherSuitesIsOn = 8; // 是否启用自定义加密套件
bool ocspIsOn = 9; // 是否启用OCSP
bool http2Enabled = 1; // 可选项，是否启用HTTP/2
bool http3Enabled = 10; // 可选项，是否启用HTTP/3（在满足条件的基础上）
string minVersion = 2; // 支持的最低SSL版本，可选择值： SSL 3.0, TLS 1.0, TLS 1.1, TLS 1.2, TLS 1.3
bytes sslCertsJSON = 3; // 可选项，关联的证书信息，可以在创建后再通过修改策略来配置 @link json:ssl_cert_refs
bytes hstsJSON = 4; // 可选项，HSTS配置 @link json:hsts
int32 clientAuthType = 5; // 可选项，客户端校验类型：0 无需证书，1 需要客户端证书，2 需要任一客户端证书，3 如果客户端上传了证书才校验，4 需要客户端证书而且需要校验
bytes clientCACertsJSON = 6; // 可选项，CA证书内容
repeated string cipherSuites = 7; // 可选项，自定义加密套件
bool cipherSuitesIsOn = 8; // 可选项，是否启用自定义加密套件
bool ocspIsOn = 9; // 可选项，是否启用OCSP
}
message CreateSSLPolicyResponse {
int64 sslPolicyId = 1;
int64 sslPolicyId = 1; // 创建的策略ID
}
// 修改Policy
// 修改策略
message UpdateSSLPolicyRequest {
int64 sslPolicyId = 1;
bool http2Enabled = 2;
bool http3Enabled = 11; // 是否启用HTTP/3（在满足条件的基础上）
string minVersion = 3;
bytes sslCertsJSON = 4;
bytes hstsJSON = 5;
int32 clientAuthType = 6;
bytes clientCACertsJSON = 7;
repeated string cipherSuites = 8;
bool cipherSuitesIsOn = 9;
bool ocspIsOn = 10;
int64 sslPolicyId = 1; // 策略ID
bool http2Enabled = 2; // 可选项，是否启用HTTP/2
bool http3Enabled = 11; // 可选项，是否启用HTTP/3（在满足条件的基础上）
string minVersion = 3; // 支持的最低SSL版本，可选择值： SSL 3.0, TLS 1.0, TLS 1.1, TLS 1.2, TLS 1.3
bytes sslCertsJSON = 4; // 关联的证书信息 @link json:ssl_cert_refs
bytes hstsJSON = 5; // 可选项，HSTS配置 @link json:hsts
int32 clientAuthType = 6; // 可选项，客户端校验类型：0 无需证书，1 需要客户端证书，2 需要任一客户端证书，3 如果客户端上传了证书才校验，4 需要客户端证书而且需要校验
bytes clientCACertsJSON = 7; // 可选项，CA证书内容
repeated string cipherSuites = 8; // 可选项，自定义加密套件
bool cipherSuitesIsOn = 9; // 可选项，是否启用自定义加密套件
bool ocspIsOn = 10; // 可选项，是否启用OCSP
}
// 查找Policy
// 查找策略
message FindEnabledSSLPolicyConfigRequest {
int64 sslPolicyId = 1; // SSL策略ID
bool ignoreData = 2; // 忽略证书内容数据
bool ignoreData = 2; // 是否忽略证书内容数据
}
message FindEnabledSSLPolicyConfigResponse {
bytes sslPolicyJSON = 1;
bytes sslPolicyJSON = 1; // 策略配置信息
}