SimTX API v24/Packets/ForwardedClientAddress: Difference between revisions
SimTX API documentation |
Archive the v24 protocol reference: use the v24 templates, links and categories |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{SimTX API navigation}} | {{SimTX API v24 navigation}} | ||
{{SimTX packet | {{SimTX packet v24 | ||
| name = ForwardedClientAddress | | name = ForwardedClientAddress | ||
| id = 11 | | id = 11 | ||
| hex = 0x0B | | hex = 0x0B | ||
| direction = c2s | | direction = c2s | ||
| session = [[SimTX API/Receiver session|Receiver]] | | session = [[SimTX API v24/Receiver session|Receiver]] | ||
| size = 2 + address length | | size = 2 + address length | ||
| permission = <code>proxy.forward_client_ip</code> | | permission = <code>proxy.forward_client_ip</code> | ||
| Line 22: | Line 22: | ||
== Rules == | == Rules == | ||
* Only valid on receiver connections (roles 1 and 6), and only as the '''first''' packet after the handshake, before the [[SimTX API/Packets/ReceiverSessionRequest|ReceiverSessionRequest]]. | * Only valid on receiver connections (roles 1 and 6), and only as the '''first''' packet after the handshake, before the [[SimTX API v24/Packets/ReceiverSessionRequest|ReceiverSessionRequest]]. | ||
* The connection must be authenticated with an account that holds <code>proxy.forward_client_ip</code>. Otherwise the server closes the connection. | * The connection must be authenticated with an account that holds <code>proxy.forward_client_ip</code>. Otherwise the server closes the connection. | ||
* An invalid address, or an address that is banned, closes the connection. | * An invalid address, or an address that is banned, closes the connection. | ||
* The connection count limit of 32 per IP address still applies to the proxy's own address. | * The connection count limit of 32 per IP address still applies to the proxy's own address. | ||
{{SimTX API navbox}} | {{SimTX API v24 navbox}} | ||
[[Category:SimTX API]] | [[Category:SimTX API v24]] | ||
Latest revision as of 16:15, 24 October 2026
| Packet ID | 11(0x0B)
|
|---|---|
| Direction | Client → server |
| Session | Receiver |
| Body size | 2 + address length |
| Permission | proxy.forward_client_ip
|
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 is serving. The server then applies per-IP limits, wideband budgets and bans to that address instead of the proxy's. Ordinary clients never send it.
Layout[edit | edit source]
| Field | Type | Description |
|---|---|---|
packetId |
u8 |
Always 11.
|
address |
UTF |
Client IP address as text, 1–64 characters after trimming. |
Rules[edit | edit source]
- Only valid on receiver connections (roles 1 and 6), and only as the first packet after the handshake, before the ReceiverSessionRequest.
- The connection must be authenticated with an account that holds
proxy.forward_client_ip. Otherwise the server closes the connection. - An invalid address, or an address that is banned, closes the connection.
- The connection count limit of 32 per IP address still applies to the proxy's own address.