steam-protos 0.1.2

Steam protocol protobuf message definitions for Rust (pre-generated, no build script).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358

//! Authentication protobuf messages for steam-session

use prost::Message;

#[allow(unused_imports)]
pub use crate::enums::EAuthTokenRevokeAction;
use crate::{
    enums::{EAuthSessionGuardType, EAuthSessionSecurityHistory, EAuthTokenAppType, EAuthTokenPlatformType, EAuthTokenState, EAuthenticationType, ESessionPersistence, ETokenRenewalType},
    messages::base::CMsgIPAddress,
};

/// Get password RSA public key request
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationGetPasswordRSAPublicKeyRequest {
    #[prost(string, optional, tag = "1")]
    pub account_name: Option<String>,
}

/// Get password RSA public key response
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationGetPasswordRSAPublicKeyResponse {
    #[prost(string, optional, tag = "1")]
    pub publickey_mod: Option<String>,
    #[prost(string, optional, tag = "2")]
    pub publickey_exp: Option<String>,
    #[prost(uint64, optional, tag = "3")]
    pub timestamp: Option<u64>,
}

/// Device details for authentication
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationDeviceDetails {
    #[prost(string, optional, tag = "1")]
    pub device_friendly_name: Option<String>,
    #[prost(enumeration = "EAuthTokenPlatformType", optional, tag = "2")]
    pub platform_type: Option<i32>,
    #[prost(int32, optional, tag = "3")]
    pub os_type: Option<i32>,
    #[prost(uint32, optional, tag = "4")]
    pub gaming_device_type: Option<u32>,
    #[prost(uint32, optional, tag = "5")]
    pub client_count: Option<u32>,
    #[prost(bytes = "vec", optional, tag = "6")]
    pub machine_id: Option<Vec<u8>>,
    #[prost(enumeration = "EAuthTokenAppType", optional, tag = "7")]
    pub app_type: Option<i32>,
}

/// Begin auth session via QR request
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationBeginAuthSessionViaQRRequest {
    #[prost(string, optional, tag = "1")]
    pub device_friendly_name: Option<String>,
    #[prost(enumeration = "EAuthTokenPlatformType", optional, tag = "2")]
    pub platform_type: Option<i32>,
    #[prost(message, optional, tag = "3")]
    pub device_details: Option<CAuthenticationDeviceDetails>,
    #[prost(string, optional, tag = "4")]
    pub website_id: Option<String>,
}

/// Begin auth session via QR response
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationBeginAuthSessionViaQRResponse {
    #[prost(uint64, optional, tag = "1")]
    pub client_id: Option<u64>,
    #[prost(string, optional, tag = "2")]
    pub challenge_url: Option<String>,
    #[prost(bytes = "vec", optional, tag = "3")]
    pub request_id: Option<Vec<u8>>,
    #[prost(float, optional, tag = "4")]
    pub interval: Option<f32>,
    #[prost(message, repeated, tag = "5")]
    pub allowed_confirmations: Vec<CAuthenticationAllowedConfirmation>,
    #[prost(int32, optional, tag = "6")]
    pub version: Option<i32>,
}

/// Allowed confirmation method
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationAllowedConfirmation {
    #[prost(enumeration = "EAuthSessionGuardType", optional, tag = "1")]
    pub confirmation_type: Option<i32>,
    #[prost(string, optional, tag = "2")]
    pub associated_message: Option<String>,
}

/// Begin auth session via credentials request
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationBeginAuthSessionViaCredentialsRequest {
    #[prost(string, optional, tag = "1")]
    pub device_friendly_name: Option<String>,
    #[prost(string, optional, tag = "2")]
    pub account_name: Option<String>,
    #[prost(string, optional, tag = "3")]
    pub encrypted_password: Option<String>,
    #[prost(uint64, optional, tag = "4")]
    pub encryption_timestamp: Option<u64>,
    #[prost(bool, optional, tag = "5")]
    pub remember_login: Option<bool>,
    #[prost(enumeration = "EAuthTokenPlatformType", optional, tag = "6")]
    pub platform_type: Option<i32>,
    #[prost(enumeration = "ESessionPersistence", optional, tag = "7")]
    pub persistence: Option<i32>,
    #[prost(string, optional, tag = "8")]
    pub website_id: Option<String>,
    #[prost(message, optional, tag = "9")]
    pub device_details: Option<CAuthenticationDeviceDetails>,
    #[prost(string, optional, tag = "10")]
    pub guard_data: Option<String>,
    #[prost(uint32, optional, tag = "11")]
    pub language: Option<u32>,
    #[prost(int32, optional, tag = "12")]
    pub qos_level: Option<i32>,
}

/// Begin auth session via credentials response
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationBeginAuthSessionViaCredentialsResponse {
    #[prost(uint64, optional, tag = "1")]
    pub client_id: Option<u64>,
    #[prost(bytes = "vec", optional, tag = "2")]
    pub request_id: Option<Vec<u8>>,
    #[prost(float, optional, tag = "3")]
    pub interval: Option<f32>,
    #[prost(message, repeated, tag = "4")]
    pub allowed_confirmations: Vec<CAuthenticationAllowedConfirmation>,
    #[prost(uint64, optional, tag = "5")]
    pub steamid: Option<u64>,
    #[prost(string, optional, tag = "6")]
    pub weak_token: Option<String>,
    #[prost(string, optional, tag = "7")]
    pub agreement_session_url: Option<String>,
    #[prost(string, optional, tag = "8")]
    pub extended_error_message: Option<String>,
}

/// Poll auth session status request
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationPollAuthSessionStatusRequest {
    #[prost(uint64, optional, tag = "1")]
    pub client_id: Option<u64>,
    #[prost(bytes = "vec", optional, tag = "2")]
    pub request_id: Option<Vec<u8>>,
    #[prost(fixed64, optional, tag = "3")]
    pub token_to_revoke: Option<u64>,
}

/// Poll auth session status response
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationPollAuthSessionStatusResponse {
    #[prost(uint64, optional, tag = "1")]
    pub new_client_id: Option<u64>,
    #[prost(string, optional, tag = "2")]
    pub new_challenge_url: Option<String>,
    #[prost(string, optional, tag = "3")]
    pub refresh_token: Option<String>,
    #[prost(string, optional, tag = "4")]
    pub access_token: Option<String>,
    #[prost(bool, optional, tag = "5")]
    pub had_remote_interaction: Option<bool>,
    #[prost(string, optional, tag = "6")]
    pub account_name: Option<String>,
    #[prost(string, optional, tag = "7")]
    pub new_guard_data: Option<String>,
    #[prost(string, optional, tag = "8")]
    pub agreement_session_url: Option<String>,
}

/// Get auth session info request
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationGetAuthSessionInfoRequest {
    #[prost(uint64, optional, tag = "1")]
    pub client_id: Option<u64>,
}

/// Get auth session info response
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationGetAuthSessionInfoResponse {
    #[prost(string, optional, tag = "1")]
    pub ip: Option<String>,
    #[prost(string, optional, tag = "2")]
    pub geoloc: Option<String>,
    #[prost(string, optional, tag = "3")]
    pub city: Option<String>,
    #[prost(string, optional, tag = "4")]
    pub state: Option<String>,
    #[prost(string, optional, tag = "5")]
    pub country: Option<String>,
    #[prost(enumeration = "EAuthTokenPlatformType", optional, tag = "6")]
    pub platform_type: Option<i32>,
    #[prost(string, optional, tag = "7")]
    pub device_friendly_name: Option<String>,
    #[prost(int32, optional, tag = "8")]
    pub version: Option<i32>,
    #[prost(enumeration = "EAuthSessionSecurityHistory", optional, tag = "9")]
    pub login_history: Option<i32>,
    #[prost(bool, optional, tag = "10")]
    pub requestor_location_mismatch: Option<bool>,
    #[prost(bool, optional, tag = "11")]
    pub high_usage_login: Option<bool>,
    #[prost(enumeration = "ESessionPersistence", optional, tag = "12")]
    pub requested_persistence: Option<i32>,
    #[prost(int32, optional, tag = "13")]
    pub device_trust: Option<i32>,
    #[prost(enumeration = "EAuthTokenAppType", optional, tag = "14")]
    pub app_type: Option<i32>,
}

/// Update auth session with mobile confirmation request
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationUpdateAuthSessionWithMobileConfirmationRequest {
    #[prost(int32, optional, tag = "1")]
    pub version: Option<i32>,
    #[prost(uint64, optional, tag = "2")]
    pub client_id: Option<u64>,
    #[prost(fixed64, optional, tag = "3")]
    pub steamid: Option<u64>,
    #[prost(bytes = "vec", optional, tag = "4")]
    pub signature: Option<Vec<u8>>,
    #[prost(bool, optional, tag = "5")]
    pub confirm: Option<bool>,
    #[prost(enumeration = "ESessionPersistence", optional, tag = "6")]
    pub persistence: Option<i32>,
}

/// Update auth session with mobile confirmation response
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationUpdateAuthSessionWithMobileConfirmationResponse {}

/// Update auth session with Steam Guard code request
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationUpdateAuthSessionWithSteamGuardCodeRequest {
    #[prost(uint64, optional, tag = "1")]
    pub client_id: Option<u64>,
    #[prost(fixed64, optional, tag = "2")]
    pub steamid: Option<u64>,
    #[prost(string, optional, tag = "3")]
    pub code: Option<String>,
    #[prost(enumeration = "EAuthSessionGuardType", optional, tag = "4")]
    pub code_type: Option<i32>,
}

/// Update auth session with Steam Guard code response
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationUpdateAuthSessionWithSteamGuardCodeResponse {
    #[prost(string, optional, tag = "7")]
    pub agreement_session_url: Option<String>,
}

/// Generate access token for app request
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationAccessTokenGenerateForAppRequest {
    #[prost(string, optional, tag = "1")]
    pub refresh_token: Option<String>,
    #[prost(fixed64, optional, tag = "2")]
    pub steamid: Option<u64>,
    #[prost(enumeration = "ETokenRenewalType", optional, tag = "3")]
    pub renewal_type: Option<i32>,
}

/// Generate access token for app response
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationAccessTokenGenerateForAppResponse {
    #[prost(string, optional, tag = "1")]
    pub access_token: Option<String>,
    #[prost(string, optional, tag = "2")]
    pub refresh_token: Option<String>,
}

/// Enumerate refresh tokens request
#[derive(Clone, PartialEq, Message)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
pub struct CAuthenticationRefreshTokenEnumerateRequest {
    #[prost(bool, optional, tag = "1")]
    pub include_revoked: Option<bool>,
}

/// Event information for token usage
#[derive(Clone, PartialEq, Message)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
pub struct TokenUsageEvent {
    #[prost(uint32, optional, tag = "1")]
    pub time: Option<u32>,
    #[prost(message, optional, tag = "2")]
    pub ip: Option<CMsgIPAddress>,
    #[prost(string, optional, tag = "3")]
    pub locale: Option<String>,
    #[prost(string, optional, tag = "4")]
    pub country: Option<String>,
    #[prost(string, optional, tag = "5")]
    pub state: Option<String>,
    #[prost(string, optional, tag = "6")]
    pub city: Option<String>,
}

/// Refresh token description
#[derive(Clone, PartialEq, Message)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
pub struct RefreshTokenDescription {
    #[prost(fixed64, optional, tag = "1")]
    pub token_id: Option<u64>,
    #[prost(string, optional, tag = "2")]
    pub token_description: Option<String>,
    #[prost(uint32, optional, tag = "3")]
    pub time_updated: Option<u32>,
    #[prost(enumeration = "EAuthTokenPlatformType", optional, tag = "4")]
    pub platform_type: Option<i32>,
    #[prost(bool, optional, tag = "5")]
    pub logged_in: Option<bool>,
    #[prost(uint32, optional, tag = "6")]
    pub os_platform: Option<u32>,
    #[prost(uint32, optional, tag = "7")]
    pub auth_type: Option<u32>,
    #[prost(uint32, optional, tag = "8")]
    pub gaming_device_type: Option<u32>,
    #[prost(message, optional, tag = "9")]
    pub first_seen: Option<TokenUsageEvent>,
    #[prost(message, optional, tag = "10")]
    pub last_seen: Option<TokenUsageEvent>,
    #[prost(int32, optional, tag = "11")]
    pub os_type: Option<i32>,
    #[prost(enumeration = "EAuthenticationType", optional, tag = "12")]
    pub authentication_type: Option<i32>,
    #[prost(enumeration = "EAuthTokenState", optional, tag = "13")]
    pub effective_token_state: Option<i32>,
}

/// Enumerate refresh tokens response
#[derive(Clone, PartialEq, Message)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(default))]
pub struct CAuthenticationRefreshTokenEnumerateResponse {
    #[prost(message, repeated, tag = "1")]
    pub refresh_tokens: Vec<RefreshTokenDescription>,
    #[prost(fixed64, optional, tag = "2")]
    pub requesting_token: Option<u64>,
}

/// Refresh token revoke request
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationRefreshTokenRevokeRequest {
    #[prost(fixed64, optional, tag = "1")]
    pub token_id: Option<u64>,
    #[prost(fixed64, optional, tag = "2")]
    pub steamid: Option<u64>,
    #[prost(enumeration = "EAuthTokenRevokeAction", optional, tag = "3")]
    pub revoke_action: Option<i32>,
    #[prost(bytes = "vec", optional, tag = "4")]
    pub signature: Option<Vec<u8>>,
}

/// Refresh token revoke response
#[derive(Clone, PartialEq, Message)]
pub struct CAuthenticationRefreshTokenRevokeResponse {}