SimTX API/Packets/ForwardedClientAddress
| Frame | ClientFrame, field 3
|
|---|---|
| Member | forwarded_address
|
| Direction | Client → server |
| Session | Receiver |
| Roles | ROLE_RECEIVER, before the start.
|
| Permission | proxy.forward_client_ip
|
| Defined in | frames.proto
|
ForwardedClientAddress lets a trusted proxy, such as a web receiver that relays SimTX to browsers, tell the server the real address of the person it serves. The server then applies per-address limits, wideband budgets and bans to that address instead of the proxy's. Ordinary clients never send it.
Definition[edit | edit source]
message ForwardedClientAddress { string address = 1; } // trusted proxies only, before ReceiverStart
Fields[edit | edit source]
| # | Field | Type | Description |
|---|---|---|---|
| 1 | address |
string |
Real client IP address as text, 1 to 64 characters after trimming. |
Rules[edit | edit source]
- Only valid on receiver connections, and only as the first frame after the ServerHello, before ReceiverStart.
- The connection must be authenticated with an account holding
proxy.forward_client_ip. Otherwise the connection is refused. - An invalid address, or a banned one, ends the connection.
- The limit of 32 connections per address still applies to the proxy's own address.