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.
NOTICE
The repository for this package is not available on the Siemens Industrial Edge public GitHub. Source code access can be granted to device builder partners upon request, subject to review of their implementation plans.
SysProxy.proto¶
ProxyConfig¶
Interface type holds settings for a proxy server.
| Field | Type | Label | Description |
|---|---|---|---|
| proxyAddress | [string](#string) | Hostname/IP and port (separated by colon) of the proxy server | |
| auth | [Authentication](#string) | Authentication details for accessing the proxy | |
| noProxyAddresses | [string](#string) | repeated | List of addresses or domains to bypass the proxy |
| httpCustomPorts | [int32](#int32) | repeated | Custom HTTP ports for the proxy server (optional) |
| httpsCustomPorts | [int32](#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](#string) | ||
| password | [string](#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](#siemens.iedge.dmapi.sysproxy.v1.proxy) | [.google.protobuf.Empty](#google.protobuf.Empty) | Set the proxy server configuration |
| RemoveConfig | [.google.protobuf.Empty](#siemens.iedge.dmapi.sysproxy.v1.proxy) | [.google.protobuf.Empty](#google.protobuf.Empty) | Remove the proxy server configuration |
| GetConfig | [.google.protobuf.Empty](#siemens.iedge.dmapi.sysproxy.v1.proxy) | [ProxyConfig](#siemens.iedge.dmapi.sysproxy.v1.proxy) | Returns the proxy server configuration |
Scalar Value Types¶
NOTICE
Funding Acknowledgment: Funded by the Federal Ministry for Economic Affairs and Energy based on a decision by the German Bundestag | Your funding provider: Kicks for Edge as part of the EU funding program IPCEI-CIS (FKZ:13IPC008)