psynet 0.1.2

Rocket League PsyNet API client
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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
use std::collections::HashMap;
use std::sync::{
    atomic::{AtomicU64, Ordering},
    Arc,
};
use std::time::Duration;

use anyhow::{anyhow, bail, Context, Result};
use base64::Engine;
use futures_util::{SinkExt, StreamExt};
use hmac::{Hmac, Mac};
use reqwest::header::{HeaderMap, HeaderValue, CONTENT_TYPE, USER_AGENT};
use serde::{Deserialize, Serialize};
use serde_json::value::RawValue;
use sha2::Sha256;
use tokio::net::TcpStream;
use tokio::sync::{oneshot, Mutex};
use tokio::time::{sleep, timeout};
use tokio_tungstenite::tungstenite::client::IntoClientRequest;
use tokio_tungstenite::tungstenite::http::header::HeaderName;
use tokio_tungstenite::tungstenite::Message;
use tokio_tungstenite::{connect_async, MaybeTlsStream, WebSocketStream};

const BASE_URL: &str = "https://api.rlpp.psynet.gg/rpc";
const GAME_VERSION: &str = "260506.26700.517210";
const FEATURE_SET: &str = "PrimeUpdate58_1";
const PSY_BUILD_ID: &str = "-1652286008";
const PSY_SIG_KEY: &str = "c338bd36fb8c42b1a431d30add939fc7";
const RESPONSE_TIMEOUT: Duration = Duration::from_secs(15);

type WsStream = WebSocketStream<MaybeTlsStream<TcpStream>>;
type WsWrite = futures_util::stream::SplitSink<WsStream, Message>;

#[derive(Debug, Clone)]
pub struct PsyNetClient {
    http: reqwest::Client,
    request_ids: Arc<RequestIdCounter>,
}

impl PsyNetClient {
    pub fn new() -> Self {
        Self {
            http: reqwest::Client::builder()
                .timeout(Duration::from_secs(30))
                .build()
                .expect("valid reqwest client"),
            request_ids: Arc::new(RequestIdCounter::default()),
        }
    }

    pub async fn auth_player(&self, account_id: &str, access_token: &str) -> Result<PsyNetRpc> {
        let player_id = PlayerId::new(PlayerPlatform::Epic, account_id);
        let request = AuthPlayerRequest {
            platform: "Epic".to_string(),
            player_name: String::new(),
            player_id: account_id.to_string(),
            language: "INT".to_string(),
            auth_ticket: access_token.to_string(),
            build_region: String::new(),
            feature_set: FEATURE_SET.to_string(),
            device: "PC".to_string(),
            local_first_player_id: player_id.to_string(),
            skip_auth: false,
            set_as_primary_account: true,
            epic_auth_ticket: access_token.to_string(),
            epic_account_id: account_id.to_string(),
        };

        let response: AuthPlayerResponse = self
            .post_json(&["Auth", "AuthPlayer", "v2"], &request)
            .await?;

        self.establish_socket(
            &response.per_con_url_v2,
            player_id,
            response.psy_token,
            response.session_id,
        )
        .await
    }

    async fn establish_socket(
        &self,
        url: &str,
        local_player_id: PlayerId,
        psy_token: String,
        session_id: String,
    ) -> Result<PsyNetRpc> {
        let mut request = url
            .into_client_request()
            .with_context(|| format!("invalid PsyNet websocket URL {url:?}"))?;
        request.headers_mut().insert(
            HeaderName::from_static("psybuildid"),
            HeaderValue::from_static(PSY_BUILD_ID),
        );
        request.headers_mut().insert(
            USER_AGENT,
            HeaderValue::from_str(&format!("RL Win/{GAME_VERSION} gzip"))?,
        );
        request.headers_mut().insert(
            HeaderName::from_static("psyenvironment"),
            HeaderValue::from_static("Prod"),
        );
        request.headers_mut().insert(
            HeaderName::from_static("psytoken"),
            HeaderValue::from_str(&psy_token)?,
        );
        request.headers_mut().insert(
            HeaderName::from_static("psysessionid"),
            HeaderValue::from_str(&session_id)?,
        );

        let (ws, _) = connect_async(request)
            .await
            .context("failed to establish PsyNet websocket")?;
        let (write, mut read) = ws.split();
        let write = Arc::new(Mutex::new(write));
        let pending: PendingRequests = Arc::new(Mutex::new(HashMap::new()));
        let read_pending = Arc::clone(&pending);

        tokio::spawn(async move {
            while let Some(message) = read.next().await {
                match message {
                    Ok(Message::Text(text)) => {
                        if text.starts_with("PsyPong:") {
                            continue;
                        }
                        match parse_message(&text) {
                            Ok(response) if !response.response_id.is_empty() => {
                                let sender =
                                    read_pending.lock().await.remove(&response.response_id);
                                if let Some(sender) = sender {
                                    let _ = sender.send(response);
                                }
                            }
                            Ok(_) => {
                                tracing::debug!("received unmatched PsyNet message");
                            }
                            Err(error) => {
                                tracing::debug!(%error, message = %text, "failed to parse PsyNet message");
                            }
                        }
                    }
                    Ok(Message::Close(_)) => break,
                    Ok(_) => {}
                    Err(error) => {
                        tracing::debug!(%error, "PsyNet websocket read failed");
                        break;
                    }
                }
            }
        });

        Ok(PsyNetRpc {
            write,
            pending,
            request_ids: Arc::clone(&self.request_ids),
            local_player_id,
        })
    }

    async fn post_json<T: for<'de> Deserialize<'de>>(
        &self,
        path: &[&str],
        params: &impl Serialize,
    ) -> Result<T> {
        let url = format!("{BASE_URL}/{}", path.join("/"));
        let body = serde_json::to_vec(params).context("failed to serialize PsyNet request")?;
        let mut headers = HeaderMap::new();
        headers.insert(
            CONTENT_TYPE,
            HeaderValue::from_static("application/x-www-form-urlencoded"),
        );
        headers.insert(
            USER_AGENT,
            HeaderValue::from_str(&format!(
                "RL Win/{GAME_VERSION} gzip (x86_64-pc-win32) curl-7.67.0 Schannel"
            ))?,
        );
        headers.insert(
            HeaderName::from_static("psybuildid"),
            HeaderValue::from_static(PSY_BUILD_ID),
        );
        headers.insert(
            HeaderName::from_static("psyenvironment"),
            HeaderValue::from_static("Prod"),
        );
        headers.insert(
            HeaderName::from_static("psyrequestid"),
            HeaderValue::from_str(&self.request_ids.next())?,
        );
        headers.insert(
            HeaderName::from_static("psysig"),
            HeaderValue::from_str(&generate_psy_sig(&body))?,
        );

        let response = self
            .http
            .post(&url)
            .headers(headers)
            .body(body)
            .send()
            .await
            .with_context(|| format!("failed to send PsyNet request to {url}"))?;
        let status = response.status();
        let body = response.text().await.unwrap_or_default();
        if !status.is_success() {
            bail!("PsyNet request to {url} failed with {status}: {body}");
        }

        let wrapper: PsyHttpWrapper =
            serde_json::from_str(&body).context("failed to parse PsyNet HTTP response")?;
        if let Some(error) = wrapper.error {
            bail!("PsyNet error {}: {}", error.kind, error.message);
        }
        let result = wrapper
            .result
            .context("PsyNet response did not include Result")?;
        serde_json::from_str(result.get()).context("failed to parse PsyNet Result")
    }
}

impl Default for PsyNetClient {
    fn default() -> Self {
        Self::new()
    }
}

type PendingRequests = Arc<Mutex<HashMap<String, oneshot::Sender<PsyResponse>>>>;

#[derive(Debug, Clone)]
pub struct PsyNetRpc {
    write: Arc<Mutex<WsWrite>>,
    pending: PendingRequests,
    request_ids: Arc<RequestIdCounter>,
    local_player_id: PlayerId,
}

impl PsyNetRpc {
    pub async fn close(&self) -> Result<()> {
        self.write
            .lock()
            .await
            .send(Message::Close(None))
            .await
            .context("failed to close PsyNet websocket")
    }

    pub async fn get_match_history(&self) -> Result<Vec<MatchEntry>> {
        let request = GetMatchHistoryRequest {
            player_id: self.local_player_id.clone(),
        };
        let response: GetMatchHistoryResponse = self
            .send_request("Matches/GetMatchHistory v1", &request)
            .await?;
        Ok(response.matches)
    }

    pub async fn get_profiles(&self, player_ids: Vec<PlayerId>) -> Result<Vec<PlayerData>> {
        let request = GetProfileRequest { player_ids };
        let response: GetProfileResponse =
            self.send_request("Players/GetProfile v1", &request).await?;
        Ok(response.player_data)
    }

    async fn send_request<T: for<'de> Deserialize<'de>>(
        &self,
        service: &str,
        data: &impl Serialize,
    ) -> Result<T> {
        let request_id = self.request_ids.next();
        let (sender, receiver) = oneshot::channel();

        let mut headers = HashMap::new();
        headers.insert("PsyService".to_string(), service.to_string());
        headers.insert("PsyRequestID".to_string(), request_id.clone());
        let message = build_message(&headers, Some(data))?;

        self.pending.lock().await.insert(request_id.clone(), sender);
        let send_result = self
            .write
            .lock()
            .await
            .send(Message::Text(message.into()))
            .await;

        if let Err(error) = send_result {
            self.pending.lock().await.remove(&request_id);
            return Err(error).context("failed to send PsyNet websocket request");
        }

        let response = timeout(RESPONSE_TIMEOUT, receiver)
            .await
            .context("timed out waiting for PsyNet response")?
            .context("PsyNet response channel closed")?;
        if let Some(error) = response.error {
            bail!("PsyNet error {}: {}", error.kind, error.message);
        }
        let result = response
            .result
            .context("PsyNet response did not include Result")?;
        serde_json::from_str(result.get()).context("failed to parse PsyNet response Result")
    }
}

impl Drop for PsyNetRpc {
    fn drop(&mut self) {
        let write = Arc::clone(&self.write);
        tokio::spawn(async move {
            let _ = write.lock().await.send(Message::Close(None)).await;
            sleep(Duration::from_millis(10)).await;
        });
    }
}

#[derive(Debug, Default)]
struct RequestIdCounter {
    next_id: AtomicU64,
}

impl RequestIdCounter {
    fn next(&self) -> String {
        let id = self.next_id.fetch_add(1, Ordering::Relaxed);
        format!("PsyNetMessage_X_{id}")
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Hash)]
pub struct PlayerId(String);

impl PlayerId {
    pub fn new(platform: PlayerPlatform, id: &str) -> Self {
        Self(format!("{}|{id}|0", platform.as_psynet_platform()))
    }
}

impl std::fmt::Display for PlayerId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(&self.0)
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub enum PlayerPlatform {
    Epic,
    Steam,
    PlayStation,
    Xbox,
    Nintendo,
}

impl PlayerPlatform {
    fn as_psynet_platform(&self) -> &'static str {
        match self {
            Self::Epic => "Epic",
            Self::Steam => "Steam",
            Self::PlayStation => "PS4",
            Self::Xbox => "XboxOne",
            Self::Nintendo => "Switch",
        }
    }
}

#[derive(Debug, Clone, Deserialize, PartialEq)]
pub struct MatchEntry {
    #[serde(rename = "ReplayUrl")]
    pub replay_url: String,
    #[serde(rename = "Match")]
    pub match_info: Match,
}

#[derive(Debug, Clone, Deserialize, PartialEq)]
pub struct Match {
    #[serde(rename = "MatchGUID")]
    pub match_guid: String,
    #[serde(rename = "RecordStartTimestamp")]
    pub record_start_timestamp: i64,
    #[serde(rename = "MapName")]
    pub map_name: String,
    #[serde(rename = "Playlist")]
    pub playlist: i64,
    #[serde(rename = "Team0Score")]
    pub team0_score: i64,
    #[serde(rename = "Team1Score")]
    pub team1_score: i64,
}

#[derive(Debug, Clone, Deserialize, PartialEq, Eq)]
pub struct PlayerData {
    #[serde(rename = "PlayerID")]
    pub player_id: String,
    #[serde(rename = "PlayerName")]
    pub player_name: String,
    #[serde(rename = "PresenceState")]
    pub presence_state: String,
    #[serde(rename = "PresenceInfo")]
    pub presence_info: String,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "PascalCase")]
struct AuthPlayerRequest {
    platform: String,
    player_name: String,
    #[serde(rename = "PlayerID")]
    player_id: String,
    language: String,
    auth_ticket: String,
    build_region: String,
    feature_set: String,
    device: String,
    #[serde(rename = "LocalFirstPlayerID")]
    local_first_player_id: String,
    #[serde(rename = "bSkipAuth")]
    skip_auth: bool,
    #[serde(rename = "bSetAsPrimaryAccount")]
    set_as_primary_account: bool,
    epic_auth_ticket: String,
    #[serde(rename = "EpicAccountID")]
    epic_account_id: String,
}

#[derive(Debug, Deserialize)]
struct AuthPlayerResponse {
    #[serde(rename = "SessionID")]
    session_id: String,
    #[serde(rename = "PerConURLv2")]
    per_con_url_v2: String,
    #[serde(rename = "PsyToken")]
    psy_token: String,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "PascalCase")]
struct GetMatchHistoryRequest {
    #[serde(rename = "PlayerID")]
    player_id: PlayerId,
}

#[derive(Debug, Deserialize)]
struct GetMatchHistoryResponse {
    #[serde(rename = "Matches")]
    matches: Vec<MatchEntry>,
}

#[derive(Debug, Serialize)]
struct GetProfileRequest {
    #[serde(rename = "PlayerIDs")]
    player_ids: Vec<PlayerId>,
}

#[derive(Debug, Deserialize)]
struct GetProfileResponse {
    #[serde(rename = "PlayerData")]
    player_data: Vec<PlayerData>,
}

#[derive(Debug, Deserialize)]
struct PsyError {
    #[serde(rename = "Type")]
    kind: String,
    #[serde(rename = "Message")]
    message: String,
}

#[derive(Debug, Deserialize)]
struct PsyHttpWrapper {
    #[serde(rename = "Result")]
    result: Option<Box<RawValue>>,
    #[serde(rename = "Error")]
    error: Option<PsyError>,
}

#[derive(Debug)]
struct PsyResponse {
    response_id: String,
    result: Option<Box<RawValue>>,
    error: Option<PsyError>,
}

#[derive(Debug, Deserialize)]
struct PsyResponsePayload {
    #[serde(rename = "Result")]
    result: Option<Box<RawValue>>,
    #[serde(rename = "Error")]
    error: Option<PsyError>,
}

fn generate_psy_sig(body: &[u8]) -> String {
    let mut mac = Hmac::<Sha256>::new_from_slice(PSY_SIG_KEY.as_bytes())
        .expect("HMAC accepts keys of any size");
    mac.update(b"-");
    mac.update(body);
    base64::engine::general_purpose::STANDARD.encode(mac.finalize().into_bytes())
}

fn build_message(
    headers: &HashMap<String, String>,
    body: Option<&impl Serialize>,
) -> Result<String> {
    let body = match body {
        Some(body) => Some(serde_json::to_vec(body).context("failed to serialize PsyNet body")?),
        None => None,
    };
    let mut headers = headers.clone();
    if let Some(body) = body.as_deref() {
        headers.insert("PsySig".to_string(), generate_psy_sig(body));
    }

    let mut message = String::new();
    let mut keys = headers.keys().collect::<Vec<_>>();
    keys.sort();
    for key in keys {
        let value = headers.get(key).expect("key collected from map");
        message.push_str(key);
        message.push_str(": ");
        message.push_str(value);
        message.push_str("\r\n");
    }
    message.push_str("\r\n");
    if let Some(body) = body {
        message.push_str(std::str::from_utf8(&body).context("PsyNet body was not UTF-8 JSON")?);
    }
    Ok(message)
}

fn parse_message(message: &str) -> Result<PsyResponse> {
    let (headers, payload) = message
        .split_once("\r\n\r\n")
        .ok_or_else(|| anyhow!("message does not contain expected delimiter"))?;
    let mut response_id = String::new();
    for line in headers.split("\r\n") {
        let Some((key, value)) = line.split_once(':') else {
            continue;
        };
        if key.trim() == "PsyResponseID" {
            response_id = value.trim().to_string();
        }
    }
    let payload: PsyResponsePayload =
        serde_json::from_str(payload).context("failed to parse PsyNet payload")?;
    Ok(PsyResponse {
        response_id,
        result: payload.result,
        error: payload.error,
    })
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn request_ids_match_rlapi_shape() {
        let ids = RequestIdCounter::default();

        assert_eq!(ids.next(), "PsyNetMessage_X_0");
        assert_eq!(ids.next(), "PsyNetMessage_X_1");
    }

    #[test]
    fn player_id_uses_psynet_platform_names() {
        assert_eq!(
            PlayerId::new(PlayerPlatform::Epic, "abc").to_string(),
            "Epic|abc|0"
        );
        assert_eq!(
            PlayerId::new(PlayerPlatform::Xbox, "abc").to_string(),
            "XboxOne|abc|0"
        );
    }

    #[test]
    fn parse_psynet_message_extracts_response_id_and_result() {
        let message = "PsyTime: 1\r\nPsySig: sig\r\nPsyResponseID: PsyNetMessage_X_1\r\n\r\n{\"Result\":{\"ok\":true}}";

        let response = parse_message(message).unwrap();

        assert_eq!(response.response_id, "PsyNetMessage_X_1");
        assert_eq!(response.result.unwrap().get(), "{\"ok\":true}");
    }

    #[test]
    fn build_message_adds_signature_and_json_body() {
        let mut headers = HashMap::new();
        headers.insert("PsyRequestID".to_string(), "PsyNetMessage_X_1".to_string());

        let message =
            build_message(&headers, Some(&serde_json::json!({"PlayerID": "Epic|a|0"}))).unwrap();

        assert!(message.contains("PsyRequestID: PsyNetMessage_X_1\r\n"));
        assert!(message.contains("PsySig: "));
        assert!(message.ends_with("{\"PlayerID\":\"Epic|a|0\"}"));
    }
}