Jump to content

SimTX API v24/Packets/ForwardedClientAddress

From SimTX Wiki
This page documents protocol v24, which current servers no longer accept. See SimTX API for v25.
ForwardedClientAddress
Packet ID 11(0x0B)
Direction Client → server
Session Receiver
Body size 2 + address length
Permission proxy.forward_client_ip
Answered by
Answers

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.
SimTX API v24 reference (protocol v24, archived)
Start OverviewQuick startData typesLimits and errorsPacket list
Account service OverviewDevice loginServer directoryGame ticketsPermissionsPublic endpoints
Game protocol Connection and handshakeReceiver sessionTransmitter sessionControl sessionCatalogModeration
Handshake HandshakeHandshakeResult
Receiver ReceiverSessionRequestReceiverRetuneForwardedClientAddressIqStreamDescriptorIqBlockTimedIqBlock
Transmitter TransmitterSessionRequestSampleBlockTxModeInfoTxUpdateTxQueueTxAcceptTxRejectTxKickTxTelemetryTxUpdateAck
Control ControlAckBannerListStationsStationListServerHealthRequestServerHealthReportCoverageMapRequestCoverageMapResponseWeatherMapRequestWeatherMapResponseStartMonitorStopMonitorMonitorBlockMonitorEnd
Catalog CatalogListRequestCatalogListCatalogFetchCatalogEntryCatalogUploadCatalogUploadResultCatalogDeleteCatalogDeleteResult
Moderation KickRequestKickResultIpModerationRequestIpModerationResultBroadcastBannerModerationErrorStationImpactList
Current Protocol v25 reference