Default package
Get desktop application:
View/edit binary Protocol Buffers messages
/ Describe an ICE candidate address
Used in:
optional string candidate = 3
optional string sdpm_id = 1; optional uint32 sdpm_line_index = 2;
ICE rendezvous message, sent reliably FIXME - should use oneof when it is available in all branches we care about
Used in:
optional auth = 2
optional add_candidate = 1
ICE candidate
optional Candidate remove_candidate = 2;
Auth info used for STUN to avoid crossing the streams. This is sent very early in the handshake (in the ConnectRequest / ConnectOKC)
Used in:
optional string pwd_frag = 1
A public key used for crypto key exchange and identity. This is basically the portion of a certificate over which the signature is generated. (It is broken into a separate message to make it easy to keep the exact bytes that were signed intact during transport.)
Used in:
optional CMsgSteamDatagramCertificate.EKeyType key_type = 1
optional bytes key_data = 2
optional fixed64 legacy_steam_id = 4
Single user key? This might not be set if the key is shared!
optional legacy_identity_binary = 11
optional string identity_string = 12
repeated fixed32 gameserver_datacenter_ids = 5
Allow any server in particular data centers to use it?
optional fixed32 time_created = 8
Restricted time range?
optional fixed32 time_expiry = 9
repeated uint32 app_ids = 10
Restrict key to be used for a particular AppID(s)?
repeated string ip_addresses = 13
Restrict key to be used for a particular IP address ranges? This is a list of strings. At the time of this writing, each string must be a single IPv4 or a single IPv6.
Used in:
INVALID = 0
ED25519 = 1
A request by a client to a CA to issue a cert.
optional cert = 1
An unsigned cert. The requestor will populate the fields appropriate to the request. (Who do you thin you are, what app(s) would you like access for, etc) Most importantly, the caller must fill in the public key they want to use
Certificate signed by a certificate authority.
Used in: , , ,
optional bytes cert = 4
The public key associated with my identity. This is a longer standing key that can be used for multiple connections. It's a serialized version of CMsgSteamDatagramCertificate, but because the signature is based on a particular serialization of that message, we keep the original serialization here.
optional fixed64 ca_key_id = 5
/ The key that was used by the certificate authority to sign / my public key. This might be empty if the key is unsigned. (It's up to the endpoint to decide if they want to accept that or not.)
optional bytes ca_signature = 6
/ Signature over the certificate, using the key identified / by ca_key_id.
optional bytes private_key_data = 1
/ In a few instances, we want to use the same message to include the private / key and the corresponding cert. Most of the time this field should not be / present!
/ Message containing connection quality related messages / (possibly inline with a data packet)
Used in:
optional instantaneous = 1
optional lifetime = 2
optional uint32 seqnum_ack_lifetime = 3;
k_ESteamDatagramMsg_Diagnostic
optional uint32 severity = 1
Standard Steam emit levels: 1 = error, 2 = warning, 3 = info, 4 = verbose
optional string text = 2
Message text
/ Wire version of SteamDatagramLinkInstantaneousStats. / We use integers instead of floats to send this stuff, / so that most fields take 1 or 2 bytes, instead of / always taking 4.
Used in:
optional uint32 out_packets_per_sec_x10 = 1
optional uint32 out_bytes_per_sec = 2
optional uint32 in_packets_per_sec_x10 = 3
optional uint32 in_bytes_per_sec = 4
optional uint32 ping_ms = 5
optional uint32 packets_dropped_pct = 6
0 ... 100
optional uint32 packets_weird_sequence_pct = 7
0 ... 100
optional uint32 peak_jitter_usec = 8
/ Wire version of SteamDatagramLinkLifetimeStats
optional uint32 rms_ping_ms = 1;
Used in:
optional uint32 connected_seconds = 2
Duration of the connection (so far, if we are still connected). This is primarily used when reporting end-to-end stats to relays, who may not have been involved with the connection for its entire duration
optional uint64 packets_sent = 3
Packet counters
optional uint64 kb_sent = 4
optional uint64 packets_recv = 5
optional uint64 kb_recv = 6
optional uint64 packets_recv_sequenced = 7
optional uint64 packets_recv_dropped = 8
optional uint64 packets_recv_out_of_order = 9
optional uint64 packets_recv_out_of_order_corrected = 15
optional uint64 packets_recv_duplicate = 10
optional uint64 packets_recv_lurch = 11
repeated uint64 multipath_packets_recv_sequenced = 12
If multipath send or receive was used, then the samples for how many we received on each path
repeated uint64 multipath_packets_recv_later = 13
How often we received a sequenced packet only this path, but another path one the race and so we discarded this one
optional uint32 multipath_send_enabled = 14
optional uint32 quality_histogram_100 = 21
/ Histogram of connection quality. Here we count up the number / of connection quality measurement intervals (about 5 seconds) / that fell into each quality measurement. Quality measurment / is the percentage of packets that were delivered, in order, / without being duplicated
This means everything was perfect. Even if we delivered over 100 packets in the interval and we should round up to 100, we will use 99% instead.
optional uint32 quality_histogram_99 = 22
99%+
optional uint32 quality_histogram_97 = 23
optional uint32 quality_histogram_95 = 24
optional uint32 quality_histogram_90 = 25
optional uint32 quality_histogram_75 = 26
optional uint32 quality_histogram_50 = 27
optional uint32 quality_histogram_1 = 28
optional uint32 quality_histogram_dead = 29
we received nothing during the interval; it looks like the connection dropped
optional uint32 quality_ntile_2nd = 30
2% of measurement intervals had quality <= N%
optional uint32 quality_ntile_5th = 31
5% of measurement intervals had quality <= N%
optional uint32 quality_ntile_25th = 32
25% of measurement intervals had quality <= N%
optional uint32 quality_ntile_50th = 33
50% of measurement intervals had quality <= N%
optional uint32 ping_histogram_25 = 41
/ Distribution of ping times.
0..25
optional uint32 ping_histogram_50 = 42
26..50
optional uint32 ping_histogram_75 = 43
51..75
optional uint32 ping_histogram_100 = 44
etc
optional uint32 ping_histogram_125 = 45
optional uint32 ping_histogram_150 = 46
optional uint32 ping_histogram_200 = 47
optional uint32 ping_histogram_300 = 48
optional uint32 ping_histogram_max = 49
>300
optional uint32 ping_ntile_5th = 50
5% of ping samples were <= Nms
optional uint32 ping_ntile_50th = 51
50% of ping samples were <= Nms
optional uint32 ping_ntile_75th = 52
70% of ping samples were <= Nms
optional uint32 ping_ntile_95th = 53
95% of ping samples were <= Nms
optional uint32 ping_ntile_98th = 54
98% of ping samples were <= Nms
optional uint32 jitter_histogram_negligible = 61
/ Jitter distribution.
<1ms
optional uint32 jitter_histogram_1 = 62
1..2
optional uint32 jitter_histogram_2 = 63
2..5
optional uint32 jitter_histogram_5 = 64
5..10
optional uint32 jitter_histogram_10 = 65
10..20
optional uint32 jitter_histogram_20 = 66
20+
Used in crypto handshake. Clients describe what they are willing to use, servers decide what will be used, and reply with the negotiated values.
optional CMsgSteamDatagramSessionCryptInfo.EKeyType key_type = 1
optional bytes key_data = 2
optional fixed64 nonce = 3
Additional nonce used for key generation
optional uint32 protocol_version = 4
Protocol version used. Must match the version in the header
repeated ESteamNetworkingSocketsCipher ciphers = 5
/ Clients specify the list of ciphers, in preference order. / Servers will specify only the single cipher they selected (assuming they allowed the connection). / If this list is empty (legacy client), then it should be interpreted the same / as if there were a single entry with k_ESteamNetworkingSocketsCipher_AES_256_GCM
Key used for Diffie-Hellman key exchange. Typically this should be an ephemeral key used only for this connection.
Used in:
INVALID = 0
CURVE25519 = 1
Session keys used in key exchange
Used in: , , ,
optional bytes info = 1
/ Serialized CMsgSteamDatagramSessionCryptInfo
optional bytes signature = 2
/ Signature of encryption_key_data generated using the public key / from the CMsgSteamDatagramCertificate.
A summary of what happened in an ICE session, for analytics
optional uint32 failure_reason_code = 7
What was the overall outcome of ICE? Should always be set. Will be zero if ICE succeeded
ESteamNetConnectionEnd (or special internal value), if we failed in some way
optional uint32 local_candidate_types = 1
What types of candidates were we able to gather? Should always be present if this message is sent
k_EICECandidate_xxx
optional uint32 remote_candidate_types = 2
What types of candidates did we receive from peer?
k_EICECandidate_xxx
optional uint32 initial_route_kind = 3
Initial route type, and ping, when when we first pierced NAT. Will not be present if we never pierced NAT
ESteamNetTransportKind
optional uint32 initial_ping = 4
optional uint32 initial_score = 6
optional uint32 negotiation_ms = 5
How long did it take to get a NAT traversal result (either success or failure)
optional uint32 best_route_kind = 16
Best route and score we ever had over the life of the connection
ESteamNetTransportKind
optional uint32 best_ping = 17
optional uint32 best_score = 18
optional uint32 best_time = 19
seconds into the connections when this happened
optional uint32 selected_seconds = 12
How long were we the selcted transport?
optional uint32 user_settings = 13
User options that were in effect, applied to this connection. (Meaning depends on platform.)
optional uint32 ice_enable_var = 14
Value of the P2P_Transport_ICE_Enable connection configuration value that was set, or determined from user settings
optional uint32 local_candidate_types_allowed = 15
What sorts of candidates were we allowed to gather, based on user settings AND local configuration
// k_EICECandidate_xxx
Legacy binary format. Now the string format is always used, even over the wire. This is a bit wasteful. But the benefit of the string format is that it's must easier to make forward comaptible. So we can add new identity types without updating all old clients that may possibly interact with the new identity type. In many cases, the old client doesn't really need to "understand" the type, and the string format actually works great.
Used in: , ,
optional fixed64 steam_id = 16
optional bytes generic_bytes = 2
optional string generic_string = 3
optional bytes ipv6_and_port = 4
/ Introducer message sent through trusted 3rd party (Steam, or some other custom signaling)
optional string from_identity = 8
Identity of who this is from
optional fixed32 from_connection_id = 9
Connection this is from
optional string to_identity = 10
Destination identity, if I know it. If we are using FakeIP and don't know the destination's real identity, this will be the fake IP.
optional fixed32 to_connection_id = 1
Destination connection ID, if I know it.
optional bytes sdr_routes = 2
SDR routing information. (Serialized CMsgSteamDatagramP2PRoutes)
optional uint32 ack_peer_routes_revision = 3
This is the latest SDR route revision I have for you. On older clients this might not always be present, until they have received some SDR routes. Newer clients always populate this, if they are willing to do SDR peer-to-peer routing.
optional bool ice_enabled = 7
Is ICE enabled?
optional bytes hosted_server_ticket = 14
I'm a hosted dedicated server. Please use the more optimal path to talk to me.
CMsgSteamDatagramSignedRelayAuthTicket
optional connect_request = 4
optional connect_ok = 5
optional connection_closed = 6
optional uint32 ack_reliable_msg = 11
Last message that we have received
optional uint32 first_reliable_msg = 12
ID of first message we are sending (if any)
repeated reliable_messages = 13
repeated application_messages = 15
App messages. In certain circumstances we actually send application messages in the signals, instead of waiting until rendezvous completes.
Used in:
optional bytes data = 1
NOTE: Currently only unreliable messages are supported!
Message bytes
optional uint64 msg_num = 2
Probably a waste of a few bytes
optional uint32 flags = 3
Also probably a waste of a few bytes
optional uint32 lane_idx = 4
Only present if nonzero. (At the time of this writing, it's zero for all use cases.)
Used in:
optional crypt = 5
optional cert = 6
Connect request
Used in:
optional crypt = 6
optional cert = 7
optional uint32 to_virtual_port = 9
optional uint32 from_virtual_port = 10
optional string from_fakeip = 11
From FakeIP. Will only be present if we have a global-allocated FakeIP and we are attempting to connect by FakeIP
Graceful close
Used in:
optional string debug = 5
optional uint32 reason_code = 6
A reliable message. FIXME - should use oneof when it is available in all branches we care about
Used in:
optional ice = 1
Currently only ICE uses the reliable message stream, but this may change
k_ESteamNetworkingUDPMsg_ChallengeReply
optional fixed32 connection_id = 1
optional fixed64 challenge = 2
optional fixed64 your_timestamp = 3
optional uint32 required_proof_of_work_bits = 3;
the my_timestamp you sent to us in ChallengeRequest
optional uint32 protocol_version = 4
Version of the code I'm running
k_ESteamNetworkingUDPMsg_ChallengeRequest
optional fixed32 connection_id = 1
optional fixed64 my_timestamp = 3
optional fixed64 client_steam_id = 2;
Please send this back to me
optional uint32 protocol_version = 4
Version of the code I'm running
k_ESteamDatagramMsg_UDP_ConnectOK
optional fixed32 client_connection_id = 1
optional fixed32 server_connection_id = 5
optional fixed64 your_timestamp = 3
the timestamp (or whatever) you send to us in ConnectRequest
optional uint32 delay_time_usec = 4
number of microseconds between when we received your request and we replied
optional crypt = 7
/ My ephemeral keys, and any crypto parameter negotiation.
optional cert = 8
/ Certificate used to prove my identity
optional string identity_string = 11
Identity of server is in the cert, usually. (Even if cert is unsigned.) But, if cert was not issued to my specific identity (e.g. it is for all gameservers in a data center, etc) then I need to communicate my identity seperately.
optional fixed64 legacy_server_steam_id = 2
optional legacy_identity_binary = 10
optional uint32 protocol_version = 9; // moved into crypt, to prevent tampering
k_ESteamNetworkingUDPMsg_ConnectRequest
optional fixed32 client_connection_id = 1
optional fixed64 challenge = 2
optional fixed64 my_timestamp = 5
optional fixed64 proof_of_work = 4;
Please send this back to me
optional uint32 ping_est_ms = 6
My estimate of the ping time
optional crypt = 7
/ My ephemeral keys, and any crypto parameter negotiation.
optional cert = 4
/ Certificate that contains: / - my public key. / - my identity, if certificate was issued to a single user / - signature of a CA, if authenticated connection is being attempted.
optional uint32 legacy_protocol_version = 8
Version of the code I'm running. This has been moved into the signed crypt parameters so that it could not be forged.
optional string identity_string = 10
Identity of host making connect request is in the cert, usually. (Even if cert is unsigned.) But, if cert was not issued to my specific identity (e.g. it is for all gameservers in a data center, etc) then I need to communicate my identity seperately.
optional fixed64 legacy_client_steam_id = 3
optional legacy_identity_binary = 9
k_ESteamDatagramMsg_UDP_ConnectionClosed
optional fixed32 to_connection_id = 4
optional fixed32 legacy_client_connection_id = 1;
optional fixed32 from_connection_id = 5
optional string debug = 2
optional uint32 reason_code = 3
k_ESteamDatagramMsg_UDP_NoConnection
optional fixed32 from_connection_id = 2
optional fixed32 legacy_client_connection_id = 1; // The client-side connection ID
"My" portion of the connection ID you tried to use (always present), but that connection doesn't exist or has been closed.
optional fixed32 to_connection_id = 3
Your portion of the connection ID you sent (if any)
optional stats = 1
End to end stats
optional uint32 flags = 3
/ Additional flags. Should we try to put these in the / message header and save a few bytes?
ACK_REQUEST_E2E = 2
ACK_REQUEST_RELAY = 1; // Reserved
ACK_REQUEST_IMMEDIATE = 4
NOT_PRIMARY_TRANSPORT_E2E = 16
NOT_PRIMARY_SESSION = 8; // Reserved
Different crypto ciphers we support
Used in:
k_ESteamNetworkingSocketsCipher_INVALID = 0
Dummy value
k_ESteamNetworkingSocketsCipher_NULL = 1
No encryption or authentication
k_ESteamNetworkingSocketsCipher_AES_256_GCM = 2
AES256 in GCM mode with 12-byte security tag. Basically equivalent to TLS_AES_256_GCM_xxx
/ Control message ID.
k_ESteamNetworkingUDPMsg_ChallengeRequest = 32
Steam networking using direct UDP connect
Client->server
k_ESteamNetworkingUDPMsg_ChallengeReply = 33
Server->client
k_ESteamNetworkingUDPMsg_ConnectRequest = 34
Client->server
k_ESteamNetworkingUDPMsg_ConnectOK = 35
Server->client
k_ESteamNetworkingUDPMsg_ConnectionClosed = 36
Client<->server. A reply is requested to this packet
k_ESteamNetworkingUDPMsg_NoConnection = 37
Client<->server. A reply should never be sent to this packet