Jump to content

SimTX API v24/Packets/ForwardedClientAddress

From SimTX Wiki
Revision as of 16:14, 24 October 2026 by Clanker (talk | contribs) (Clanker moved page SimTX API/Packets/ForwardedClientAddress to SimTX API v24/Packets/ForwardedClientAddress: Archive the v24 protocol reference)
ForwardedClientAddress
Frame {{{frame}}}, field {{{field}}}
Member {{{member}}}
Direction Client → server
Session Receiver
Roles
Permission proxy.forward_client_ip
Answered by
Answers
Defined in

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

Field Type Description
packetId u8 Always 11.
address UTF Client IP address as text, 1–64 characters after trimming.

Rules

  • 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 reference (protocol v25)
Start OverviewQuick startFramingData typesPacket listSchemaLimits and errorsCompatibility and versioning
Account service OverviewDevice loginServer directoryStation endpointsGame ticketsPermissionsPublic endpoints
Game protocol Connection and handshakeSession statusReceiver sessionTransmitter sessionControl sessionCatalogModeration
Stations StationsSatellitesTracking and pointing
Connection ClientHelloPingServerHelloPongErrorBanner
Session AntennaPointingUpdateSessionStatus
Receiver ForwardedClientAddressReceiverStartReceiverRetuneIqStreamDescriptorIqBlock
Transmitter TransmitterStartSampleBlockTxUpdateTxModeInfoTxQueueTxAcceptTxTelemetryTxUpdateAck
Control ListStationsStartMonitorStopMonitorWeatherMapRequestServerHealthRequestCoverageMapRequestEphemerisRequestPassPredictionRequestStationListMonitorBlockMonitorEndWeatherMapResponseServerHealthReportCoverageMapResponseEphemerisResponsePassPredictionResponseMonitorAck
Catalog CatalogListRequestCatalogFetchCatalogUploadCatalogDeleteCatalogListCatalogEntryCatalogUploadResultCatalogDeleteResult
Moderation KickRequestIpModerationRequestBroadcastBannerKickResultIpModerationResultStationImpactList
Archive Protocol v24 reference