Skip to content

Proxy Service

The Proxy Service is a gRPC & Go based proxy configuration service. The proxy settings of the Edge Devices are configured through this service.

This service configures a Redsocks transparent proxy on the device, enabling communication with HTTP proxy servers using the http-connect mode. Only connections via HTTP proxies are supported.

Table of Contents

SysProxy.proto

ProxyConfig

Interface type holds settings for a proxy server.

Field Type Label Description
proxyAddress string Hostname/IP and port (separated by colon) of the proxy server
auth Authentication Authentication details for accessing the proxy
noProxyAddresses string repeated List of addresses or domains to bypass the proxy
httpCustomPorts int32 repeated Custom HTTP ports for the proxy server (optional)
httpsCustomPorts int32 repeated Custom HTTPS ports for the proxy server (optional)

Authentication

Type that contains authentication details for the proxy server.

Field Type Label Description
userName string
password string

ProxyConfigService

ProxyConfigService uses a UNIX Domain Socket "/var/run/devicemodel/sysproxy.sock" for GRPC communication. protoc generates both client and server instance for this Service. GRPC Status codes : https://developers.google.com/maps-booking/reference/grpc-api/status_codes .

Method Name Request Type Response Type Description
SetConfig ProxyConfig .google.protobuf.Empty Set the proxy server configuration
RemoveConfig .google.protobuf.Empty .google.protobuf.Empty Remove the proxy server configuration
GetConfig .google.protobuf.Empty ProxyConfig Returns the proxy server configuration

Scalar Value Types

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)