From b98f29bf3e0e981dcb1d55eb9b2d663c1b5366bf Mon Sep 17 00:00:00 2001 From: zonescape <44441590+zonescape@users.noreply.github.com> Date: Thu, 7 Nov 2024 19:00:04 +0300 Subject: [PATCH] Chore: Fix some comments (#3979) --- transport/internet/config.pb.go | 6 +++--- transport/internet/config.proto | 6 +++--- transport/internet/kcp/config.pb.go | 4 +++- transport/internet/kcp/config.proto | 4 +++- 4 files changed, 12 insertions(+), 8 deletions(-) diff --git a/transport/internet/config.pb.go b/transport/internet/config.pb.go index 98e408e9..2cd58fe1 100644 --- a/transport/internet/config.pb.go +++ b/transport/internet/config.pb.go @@ -152,9 +152,9 @@ type TransportConfig struct { sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - // Type of network that this settings supports. + // Transport protocol name. ProtocolName string `protobuf:"bytes,3,opt,name=protocol_name,json=protocolName,proto3" json:"protocol_name,omitempty"` - // Specific settings. Must be of the transports. + // Specific transport protocol settings. Settings *serial.TypedMessage `protobuf:"bytes,2,opt,name=settings,proto3" json:"settings,omitempty"` } @@ -214,7 +214,7 @@ type StreamConfig struct { TransportSettings []*TransportConfig `protobuf:"bytes,2,rep,name=transport_settings,json=transportSettings,proto3" json:"transport_settings,omitempty"` // Type of security. Must be a message name of the settings proto. SecurityType string `protobuf:"bytes,3,opt,name=security_type,json=securityType,proto3" json:"security_type,omitempty"` - // Settings for transport security. For now the only choice is TLS. + // Transport security settings. They can be either TLS or REALITY. SecuritySettings []*serial.TypedMessage `protobuf:"bytes,4,rep,name=security_settings,json=securitySettings,proto3" json:"security_settings,omitempty"` SocketSettings *SocketConfig `protobuf:"bytes,6,opt,name=socket_settings,json=socketSettings,proto3" json:"socket_settings,omitempty"` } diff --git a/transport/internet/config.proto b/transport/internet/config.proto index 008e33c6..61812644 100644 --- a/transport/internet/config.proto +++ b/transport/internet/config.proto @@ -24,10 +24,10 @@ enum DomainStrategy { } message TransportConfig { - // Type of network that this settings supports. + // Transport protocol name. string protocol_name = 3; - // Specific settings. Must be of the transports. + // Specific transport protocol settings. xray.common.serial.TypedMessage settings = 2; } @@ -43,7 +43,7 @@ message StreamConfig { // Type of security. Must be a message name of the settings proto. string security_type = 3; - // Settings for transport security. For now the only choice is TLS. + // Transport security settings. They can be either TLS or REALITY. repeated xray.common.serial.TypedMessage security_settings = 4; SocketConfig socket_settings = 6; diff --git a/transport/internet/kcp/config.pb.go b/transport/internet/kcp/config.pb.go index 0d2a9697..506a2dcd 100644 --- a/transport/internet/kcp/config.pb.go +++ b/transport/internet/kcp/config.pb.go @@ -342,7 +342,9 @@ func (x *ConnectionReuse) GetEnable() bool { return false } -// Maximum Transmission Unit, in bytes. +// Pre-shared secret between client and server. It is used for traffic obfuscation. +// Note that if seed is absent in the config, the traffic will still be obfuscated, +// but by a predefined algorithm. type EncryptionSeed struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache diff --git a/transport/internet/kcp/config.proto b/transport/internet/kcp/config.proto index a9806e6f..8690f09f 100644 --- a/transport/internet/kcp/config.proto +++ b/transport/internet/kcp/config.proto @@ -42,7 +42,9 @@ message ConnectionReuse { bool enable = 1; } -// Maximum Transmission Unit, in bytes. +// Pre-shared secret between client and server. It is used for traffic obfuscation. +// Note that if seed is absent in the config, the traffic will still be obfuscated, +// but by a predefined algorithm. message EncryptionSeed { string seed = 1; }