package mieru.appctl
Get desktop application:
View/edit binary Protocol Buffers messages
rpc Exit (, )
rpc.proto:32Quit client daemon.
rpc GetHeapProfile (, )
rpc.proto:50Generate a heap profile.
rpc GetMemoryStatistics (, )
rpc.proto:53Get memory statistics of client daemon.
rpc GetMetrics (, )
rpc.proto:35Get client metrics.
rpc GetSessionInfoList (, )
rpc.proto:38Get client session information.
rpc GetStatus (, )
rpc.proto:29Fetch client application status.
rpc GetThreadDump (, )
rpc.proto:41Generate a thread dump of client daemon.
rpc GetVersion (, )
rpc.proto:56Get client version.
rpc StartCPUProfile (, )
rpc.proto:44Start CPU profiling.
rpc StopCPUProfile (, )
rpc.proto:47Stop CPU profiling.
rpc Exit (, )
rpc.proto:79Quit server daemon.
rpc GetConfig (, )
rpc.proto:70Fetch the server config.
rpc GetHeapProfile (, )
rpc.proto:100Generate a heap profile.
rpc GetMemoryStatistics (, )
rpc.proto:103Get memory statistics of server daemon.
rpc GetMetrics (, )
rpc.proto:82Get server metrics.
rpc GetSessionInfoList (, )
rpc.proto:85Get server session information.
rpc GetStatus (, )
rpc.proto:61Fetch server application status.
rpc GetThreadDump (, )
rpc.proto:91Generate a thread dump of server daemon.
rpc GetUsers (, )
rpc.proto:88Get users setting and runtime information.
message
misc.proto:39repeated items = 1
rpc GetVersion (, )
rpc.proto:106Get server version.
rpc Reload (, )
rpc.proto:76Reload server configuration.
rpc SetConfig (, )
rpc.proto:73Update server config.
rpc Start (, )
rpc.proto:64Start proxy in server application.
rpc StartCPUProfile (, )
rpc.proto:94Start CPU profiling.
rpc Stop (, )
rpc.proto:67Stop proxy in server application.
rpc StopCPUProfile (, )
rpc.proto:97Stop CPU profiling.
Used in:
UNKNOWN = 0
IDLE = 1
RPC service is available, but proxy is not started.
STARTING = 2
Proxy is starting.
RUNNING = 3
Proxy is running.
STOPPING = 4
Proxy is being stopped.
message
base.proto:22Used as response type in: ClientManagementService.GetStatus, ServerManagementService.GetStatus
optional AppStatus status = 1
message
base.proto:121Used in: , ,
optional string user = 1
Username used for authentication.
optional string password = 2
Password used for authentication.
message
clientcfg.proto:140Used in:
optional bool noCheckUpdate = 1
Do not check update when client is started.
optional string metricsLoggingInterval = 2
The interval to log metrics. Examples: 30s, 5m, 2h. If empty, the default interval is used.
message
clientcfg.proto:24repeated profiles = 1
A list of known client profiles.
optional string activeProfile = 2
The active profile name.
optional int32 rpcPort = 3
The management RPC port that client is listening in localhost.
optional int32 socks5Port = 4
The socks5 port that mieru is listening.
optional advancedSettings = 5
Client advanced settings.
optional LoggingLevel loggingLevel = 6
Client logging level.
optional bool socks5ListenLAN = 7
If set, the socks5 port listens to LAN rather than localhost.
optional int32 httpProxyPort = 8
The port mieru is listening to provide HTTP / HTTPS proxy.
optional bool httpProxyListenLAN = 9
If set, the HTTP proxy port listens to LAN rather than localhost.
repeated socks5Authentication = 10
A list of accounts that can authenticate mieru socks5 proxy service. If the list is empty, authentication is not required.
message
clientcfg.proto:84Used in:
optional ProxyProtocol protocol = 1
Dialer proxy protocol.
optional string host = 2
Dialer proxy IP address or domain name.
optional int32 port = 3
Dialer proxy port number.
optional bool socks5UDPAssociate = 4
Use socks5 UDP ASSOCIATE for UDP underlays.
optional socks5Authentication = 5
Credential to authenticate socks5 proxy.
message
clientcfg.proto:57Used in:
optional string profileName = 1
Client profile name.
optional user = 2
User information.
repeated servers = 3
A list of servers to connect.
optional int32 mtu = 4
Maximum transmission unit of L2 payload. This setting only applies to UDP protocol egress traffic.
optional multiplexing = 5
Multiplexing behaviors.
optional HandshakeMode handshakeMode = 6
Handshake mode when client open a connection.
optional trafficPattern = 7
Fine tune traffic behaviors.
optional dialer = 8
Optional proxy dialer used by the client to connect to mita.
message
servercfg.proto:121Used in:
optional DualStack dualStack = 1
Pick up IP address from IP version preference.
map<string, string> hosts = 2
Static domain to IP mappings, similar to /etc/hosts.
Used in:
USE_FIRST_IP = 0
PREFER_IPv4 = 1
PREFER_IPv6 = 2
ONLY_IPv4 = 3
ONLY_IPv6 = 4
message
servercfg.proto:66Used in:
repeated proxies = 1
A list of proxies.
repeated rules = 2
A list of rules. If no rule is matched, the default action is DIRECT.
Used in:
PROXY = 0
Use proxy to connect to the destination.
DIRECT = 1
Directly connect to the destination.
REJECT = 2
Do not connect to the destination.
message
servercfg.proto:75Used in:
optional string name = 1
optional ProxyProtocol protocol = 2
optional string host = 3
Proxy IP address or domain name.
optional int32 port = 4
Proxy port number.
optional socks5Authentication = 5
Credential to authenticate egress socks5 proxy. If the proxy protocol is not socks5, this is ignored.
message
servercfg.proto:91Used in:
repeated string ipRanges = 1
A list of CIDR to match the rule. Use "*" to match all IP addresses.
repeated string domainNames = 2
A list of domain names to match the rule. Use "*" to match all domain names.
optional EgressAction action = 3
The action to do when the rule is matched.
repeated string proxyNames = 4
The list of proxies to connect. This must not be empty when the action is PROXY. When multiple proxies are provided, a random one is selected for each request.
Used in:
HANDSHAKE_DEFAULT = 0
HANDSHAKE_STANDARD = 1
Client wait for proxy server to establish connection to the destination before sending the payload. Also known as 1-RTT.
HANDSHAKE_NO_WAIT = 2
Client send payload at the same time when connecting to the proxy server. Also known as 0-RTT.
Used in: ,
DEFAULT = 0
FATAL = 1
ERROR = 2
WARN = 3
INFO = 4
DEBUG = 5
TRACE = 6
message
misc.proto:73Used as response type in: ClientManagementService.GetMemoryStatistics, ServerManagementService.GetMemoryStatistics
optional uint64 heapBytes = 2
optional uint64 heapObjects = 3
optional uint64 maxHeapBytes = 4
optional uint64 targetHeapBytes = 5
optional uint64 stackBytes = 6
message
misc.proto:26Used as response type in: ClientManagementService.GetMetrics, ServerManagementService.GetMetrics
optional string json = 1
JSON dump of metrics.
message
clientcfg.proto:114Used in:
optional MultiplexingLevel level = 1
How frequent a network connection is reused.
Used in:
MULTIPLEXING_DEFAULT = 0
MULTIPLEXING_OFF = 1
MULTIPLEXING_LOW = 2
MULTIPLEXING_MIDDLE = 3
MULTIPLEXING_HIGH = 4
message
base.proto:163Used in:
optional NonceType type = 1
Strategy to manipulate nonce.
optional bool applyToAllUDPPacket = 2
If the pattern applies to each UDP packet, or only applies to the first UDP packet.
optional int32 minLen = 3
Minimum number of bytes to manipulate. It is ignored when NonceType is NONCE_TYPE_RANDOM or NONCE_TYPE_FIXED.
optional int32 maxLen = 4
Maximum number of bytes to manipulate. This value can't exceed 12. It is ignored when NonceType is NONCE_TYPE_RANDOM or NONCE_TYPE_FIXED.
repeated string customHexStrings = 5
A list of hex string (without 0x) that represent customized nonce prefix to use. For example, string "00010203" represent a 4 bytes nonce prefix [0, 1, 2, 3]. Each nonce prefix can't exceed 12 bytes. When multiple strings are provided, a random one is used each time. It has no effect when NonceType is not NONCE_TYPE_FIXED.
Used in:
NONCE_TYPE_RANDOM = 0
Do not make change to the original random nonce.
NONCE_TYPE_PRINTABLE = 1
Use printable ASCII characters from 0x20 to 0x7E.
NONCE_TYPE_PRINTABLE_SUBSET = 2
Use a pre-defined subset of printable ASCII characters.
NONCE_TYPE_FIXED = 3
Use a customized nonce prefix. If field customHexStrings is not set in NoncePattern, the behavior is the same as NONCE_TYPE_RANDOM.
message
base.proto:210Used in:
optional int32 maxMiddlePaddingLen = 1
Maximum number of padding bytes in the middle of a network segment. The valid range is [0, 255]. Set it to 0 to disable middle padding. It not set, an internal value is used.
optional int32 maxEndPaddingLen = 2
Maximum number of padding bytes at the end of a network segment. The valid range is [0, 255]. Set it to 0 to disable end padding. It not set, an internal value is used.
message
base.proto:60Used in: ,
optional int32 port = 1
A single port number. This field can't be set with portRange at the same time.
optional TransportProtocol protocol = 2
optional string portRange = 3
A port number range. For example, "8000-9000" contains 1001 ports from 8000 to 9000. This field can't be set with port at the same time.
message
misc.proto:43Used as request type in: ClientManagementService.GetHeapProfile, ClientManagementService.StartCPUProfile, ServerManagementService.GetHeapProfile, ServerManagementService.StartCPUProfile
optional string filePath = 1
Location to save profile results.
Used in: ,
UNKNOWN_PROXY_PROTOCOL = 0
SOCKS5_PROXY_PROTOCOL = 1
message
base.proto:111Used in:
optional int32 days = 1
Number of days to renew the quota. The renew is rolling based.
optional int32 megabytes = 2
Number of megabytes the user allowed to send and receive.
message
servercfg.proto:52Used in:
optional string metricsLoggingInterval = 2
The interval to log metrics. Examples: 30s, 5m, 2h. If empty, the default interval is used.
optional bool userHintIsMandatory = 3
If true, proxy clients must provide user hint, otherwise proxy server will refuse to decrypt the network packets.
message
servercfg.proto:24Used as request type in: ServerManagementService.SetConfig
Used as response type in: ServerManagementService.GetConfig, ServerManagementService.SetConfig
repeated portBindings = 1
Server's port-protocol bindings.
repeated users = 2
A list of registered users.
optional advancedSettings = 3
Server advanced settings.
optional LoggingLevel loggingLevel = 4
Server logging level.
optional int32 mtu = 5
Maximum transmission unit of L2 payload. This setting only applies to UDP protocol egress traffic.
optional egress = 6
Egress proxies and rules.
optional dns = 7
How to resolve IP address when the client send a request with a domain name.
optional trafficPattern = 8
Fine tune traffic behaviors.
message
clientcfg.proto:101Used in:
optional string ipAddress = 1
String representation of IP address. It can be either IPv4 or IPv6.
optional string domainName = 2
Server's full qualified domain name. When this is set, the `ipAddress` field is ignored.
repeated portBindings = 3
Server's port-protocol bindings.
message
misc.proto:48Used in:
optional string id = 1
optional string protocol = 2
optional string localAddr = 3
optional string remoteAddr = 4
optional string state = 5
optional uint32 recvQ = 6
optional uint32 recvBuf = 7
optional uint32 sendQ = 8
optional uint32 sendBuf = 9
optional lastRecvTime = 10
optional uint32 lastRecvSeq = 11
optional lastSendTime = 12
optional uint32 lastSendSeq = 13
message
misc.proto:64Used as response type in: ClientManagementService.GetSessionInfoList, ServerManagementService.GetSessionInfoList
repeated items = 1
message
base.proto:152Used in:
optional bool enable = 1
Enable additional TCP fragmentation.
optional int32 maxSleepMs = 2
Max sleep time in milliseconds between sending two fragments. This value can't exceed 100. If not set, a reasonable default value is used.
message
misc.proto:68Used as response type in: ClientManagementService.GetThreadDump, ServerManagementService.GetThreadDump
optional string threadDump = 1
Full thread dump of the application.
message
base.proto:130Used in: ,
optional int32 seed = 1
Generate stable implicit traffic patterns that are not explictly set. Generated traffic patterns are also influenced by "unlockAll" below.
optional bool unlockAll = 2
If true, implicit traffic patterns can use all possible options, which may not be desired. Otherwise, implicit traffic patterns only use limited options. All explicitly set traffic patterns are available regardless of this.
optional tcpFragment = 3
Split TCP packets by fragmentation.
optional nonce = 4
Manipulate nonce prefix.
optional padding = 5
Define padding behavior.
Used in:
UNKNOWN_TRANSPORT_PROTOCOL = 0
UDP = 1
TCP = 2
message
base.proto:84Used in: , ,
optional string name = 1
User name is also the ID of user. Typically this is an email address.
optional string password = 2
Raw password. For safety this shouldn't be persisted at the server side.
optional string hashedPassword = 3
Hashed password. Stored with hex encoding.
repeated quotas = 4
User quotas. This field has no effect at the client side.
optional bool allowPrivateIP = 5
Allow user to use private IP as the destination. This field has no effect at the client side.
optional bool allowLoopbackIP = 6
Allow user to use loopback IP as the destination. This field has no effect at the client side.
message
misc.proto:31Used in:
optional user = 1
User information.
repeated metrics = 2
User runtime information.
message
misc.proto:83Used as response type in: ClientManagementService.GetVersion, ServerManagementService.GetVersion
optional uint32 major = 1
optional uint32 minor = 2
optional uint32 patch = 3