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
use std::{
collections::{HashMap, HashSet},
sync::Arc,
};
use chrono::{Local, NaiveDateTime};
use reqwest::{header::*, Client};
use serde::{Deserialize, Serialize};
use serde_json::Value;
use tokio::sync::Mutex;
use url::Url;
use crate::{
error::SFError,
misc::sha1_hash,
session::{reqwest_client, ConnectionOptions, PWHash, Session},
};
#[derive(Debug)]
#[allow(dead_code)]
enum SSOAuthData {
SF { pw_hash: PWHash },
Google,
Steam,
}
#[derive(Debug)]
pub struct SFAccount {
pub(super) username: String,
auth: SSOAuthData,
pub(super) session: AccountSession,
pub(super) client: Client,
pub(super) options: ConnectionOptions,
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct AccountSession {
pub(super) uuid: String,
pub(super) bearer_token: String,
}
// This could just be a Login/Characters thing, but who knows what else will be
// integrated into this API. Maybe Register?
#[derive(Debug)]
enum APIRequest {
Get,
Post {
parameters: Vec<&'static str>,
form_data: HashMap<String, String>,
},
}
#[derive(Debug, Default, Serialize, Deserialize)]
pub struct SSOCharacter {
pub(super) id: String,
pub(super) name: String,
pub(super) server_id: i32,
}
impl SFAccount {
/// Returns the username of this S&F account
#[must_use]
pub fn username(&self) -> &str {
&self.username
}
/// Initializes a `SFAccount` by logging the user in using the supplied
/// clear text credentials
///
/// # Errors
/// May return basically every possible `SFError` variant, because we are
/// both sending a command and parsing the result
// TODO: Document what wring pw returns
pub async fn login(
username: String,
password: String,
) -> Result<SFAccount, SFError> {
Self::login_with_options(
username,
password,
ConnectionOptions::default(),
)
.await
}
/// Initializes a `SFAccount` by logging the user in using the supplied
/// clear text credentials and the provided options to use for the
/// communication with the server
///
/// # Errors
/// May return basically every possible `SFError` variant, because we are
/// both sending a command and parsing the result
pub async fn login_with_options(
username: String,
password: String,
options: ConnectionOptions,
) -> Result<SFAccount, SFError> {
let pw_hash = PWHash::new(&password);
Self::login_hashed_with_options(username, pw_hash, options).await
}
/// Initializes a `SFAccount` by logging the user in using the hashed
/// password
///
/// # Errors
/// May return basically every possible `SFError` variant, because we are
/// both sending a command and parsing the result
pub async fn login_hashed(
username: String,
pw_hash: PWHash,
) -> Result<SFAccount, SFError> {
Self::login_hashed_with_options(
username,
pw_hash,
ConnectionOptions::default(),
)
.await
}
/// Initializes a `SFAccount` by logging the user in using the hashed
/// password and the provided options to use for communication
///
/// # Errors
/// May return basically every possible `SFError` variant, because we are
/// both sending a command and parsing the result
pub async fn login_hashed_with_options(
username: String,
pw_hash: PWHash,
options: ConnectionOptions,
) -> Result<SFAccount, SFError> {
let mut tmp_self = Self {
username,
auth: SSOAuthData::SF { pw_hash },
session: AccountSession {
uuid: String::new(),
bearer_token: String::new(),
},
client: reqwest_client(&options).ok_or(SFError::ConnectionError)?,
options,
};
tmp_self.refresh_login().await?;
Ok(tmp_self)
}
/// Refreshes the SSO session by logging in again with the stored
/// credentials. This can be used when the server removed our session
/// either for being connected too long, or the server was
/// restarted/cache cleared and forgot us
///
/// # Errors
/// `InvalidRequest` if you call this with anything else then a SSO/SF
/// account character. Even Google/Steam accounts will not work.
pub async fn refresh_login(&mut self) -> Result<(), SFError> {
let SSOAuthData::SF { pw_hash } = &self.auth else {
// I do not think there is a way to reauth without going through
// the SSO process again for these
return Err(SFError::InvalidRequest(
"Refreshing the SSO-login is only supported for SSO-Accounts",
));
};
let mut form_data = HashMap::new();
form_data.insert("username".to_string(), self.username.clone());
form_data.insert(
"password".to_string(),
sha1_hash(&(pw_hash.get().to_string() + "0")),
);
let res = self
.send_api_request(
"json/login",
APIRequest::Post {
parameters: vec![
"client_id=i43nwwnmfc5tced4jtuk4auuygqghud2yopx",
"auth_type=access_token",
],
form_data,
},
)
.await?;
#[allow(clippy::indexing_slicing)]
let (Some(bearer_token), Some(uuid)) = (
val_to_string(&res["token"]["access_token"]),
val_to_string(&res["account"]["uuid"]),
) else {
return Err(SFError::ParsingError(
"missing auth value in api response",
format!("{res:?}"),
));
};
self.session = AccountSession { uuid, bearer_token };
Ok(())
}
/// Queries the SSO for all characters associated with this account. This
/// consumes the Account, as the character sessions may need to refresh
/// the accounts session, which they are only allowed to do, if they own it
/// (in an Arc<Mutex<_>>) and there should be no need to keep the account
/// around anyways
///
/// # Errors
/// May return `ParsingError` if the server changed it's API, or
/// `ConnectionError`, if the server could not be reached. The characters
/// in the Vec may be `InvalidRequest`, iff the server the server the
/// character would be on could not be determined
pub async fn characters(
self,
) -> Result<Vec<Result<Session, SFError>>, SFError> {
// This could be passed in as an argument in case of multiple SSO
// accounts to safe on requests, but I dont think people have multiple
// and this is way easier
let server_lookup =
ServerLookup::fetch_with_client(&self.client).await?;
let mut res = self
.send_api_request("json/client/characters", APIRequest::Get)
.await?;
#[allow(clippy::indexing_slicing)]
let characters: Vec<SSOCharacter> =
serde_json::from_value(res["characters"].take()).map_err(|_| {
SFError::ParsingError("missing json value ", String::new())
})?;
let account = Arc::new(Mutex::new(self));
let mut chars = vec![];
for char in characters {
chars.push(
Session::from_sso_char(char, account.clone(), &server_lookup)
.await,
);
}
Ok(chars)
}
async fn send_api_request(
&self,
endpoint: &str,
method: APIRequest,
) -> Result<Value, SFError> {
send_api_request(
&self.client,
&self.session.bearer_token,
endpoint,
method,
)
.await
}
}
/// Send a request to the SSO server. The endpoint will be "json/*". We try
/// to check if the response is bad in any way, but S&F responses never obey
/// to HTML status codes, or their own system, so good luck
#[allow(clippy::items_after_statements)]
async fn send_api_request(
client: &Client,
bearer_token: &str,
endpoint: &str,
method: APIRequest,
) -> Result<Value, SFError> {
let mut url = url::Url::parse("https://sso.playa-games.com")
.map_err(|_| SFError::ConnectionError)?;
url.set_path(endpoint);
let mut request = match method {
APIRequest::Get => client.get(url.as_str()),
APIRequest::Post {
parameters,
form_data,
} => {
url.set_query(Some(¶meters.join("&")));
client.post(url.as_str()).form(&form_data)
}
};
// Set all necessary header values to make our request succeed
if !bearer_token.is_empty() {
request = request.bearer_auth(bearer_token);
}
let mut headers = HeaderMap::new();
headers.insert(ACCEPT, HeaderValue::from_static("application/json"));
headers.insert(
REFERER,
HeaderValue::from_str(url.authority())
.map_err(|_| SFError::ConnectionError)?,
);
let res = request
.headers(headers)
.send()
.await
.map_err(|_| SFError::ConnectionError)?;
if !res.status().is_success() {
return Err(SFError::ConnectionError);
}
let text = res.text().await.map_err(|_| SFError::ConnectionError)?;
#[derive(Debug, Serialize, Deserialize)]
struct APIResponse {
success: bool,
status: u8,
data: Option<Value>,
message: Option<Value>,
}
let resp: APIResponse = serde_json::from_str(&text)
.map_err(|_| SFError::ParsingError("API response", text))?;
if !resp.success {
return Err(SFError::ConnectionError);
}
let data = match resp.data {
Some(data) => data,
None => match resp.message {
Some(message) => message,
None => return Err(SFError::ConnectionError),
},
};
Ok(data)
}
#[derive(Debug, Clone)]
pub struct ServerLookup(HashMap<i32, Url>);
impl ServerLookup {
/// Fetches the current mapping of numeric server ids to their URLs.
///
/// # Errors
/// Returns `ConnectionError`, if the server could not be reached, ro
/// `ParsingError`, if the list could not be parsed
pub async fn fetch() -> Result<ServerLookup, SFError> {
Self::fetch_with_client(&reqwest::Client::new()).await
}
/// Fetches the current mapping of server ids to server URLs.
#[allow(clippy::items_after_statements)]
async fn fetch_with_client(
client: &Client,
) -> Result<ServerLookup, SFError> {
let res = client
.get("https://sfgame.net/config.json")
.send()
.await
.map_err(|_| SFError::ConnectionError)?
.text()
.await
.map_err(|_| SFError::ConnectionError)?;
#[derive(Debug, Deserialize, Serialize)]
struct ServerResp {
servers: Vec<ServerInfo>,
}
#[derive(Debug, Deserialize, Serialize)]
struct ServerInfo {
#[serde(rename = "i")]
id: i32,
#[serde(rename = "d")]
url: String,
#[serde(rename = "c")]
country_code: String,
#[serde(rename = "md")]
merged_into: Option<String>,
#[serde(rename = "m")]
merge_date_time: Option<String>,
}
let resp: ServerResp = serde_json::from_str(&res).map_err(|_| {
SFError::ParsingError("server response", res.to_string())
})?;
let servers: HashMap<i32, Url> = resp
.servers
.into_iter()
.filter_map(|s| {
let mut server_url = s.url;
if let Some(merged_url) = s.merged_into {
if let Some(mdt) = s.merge_date_time.and_then(|a| {
NaiveDateTime::parse_from_str(&a, "%Y-%m-%d %H:%M:%S")
.ok()
}) {
if Local::now().naive_utc() > mdt {
server_url = merged_url;
}
} else {
server_url = merged_url;
}
}
Some((s.id, format!("https://{server_url}").parse().ok()?))
})
.collect();
if servers.is_empty() {
return Err(SFError::ParsingError("empty server list", res));
}
Ok(ServerLookup(servers))
}
/// Gets the mapping of a server id to a URL
///
/// # Errors
/// Reutns `InvalidRequest` if there was no server with this id
pub fn get(&self, server_id: i32) -> Result<Url, SFError> {
self.0
.get(&server_id)
.cloned()
.ok_or(SFError::InvalidRequest("There is no server with this id"))
}
/// Returns a set of all the servers, that are currently active, so no
/// merged, or not yet available servers
#[must_use]
pub fn all(&self) -> HashSet<Url> {
self.0.iter().map(|a| a.1.clone()).collect()
}
}
#[derive(Debug)]
pub enum AuthResponse {
Success(SFAccount),
NoAuth(SSOAuth),
}
fn val_to_string(val: &Value) -> Option<String> {
val.as_str().map(std::string::ToString::to_string)
}
#[derive(Debug)]
pub struct SSOAuth {
client: Client,
options: ConnectionOptions,
auth_url: Url,
auth_id: String,
provider: SSOProvider,
}
#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq)]
pub enum SSOProvider {
Google,
Steam,
}
impl SSOProvider {
fn endpoint_ident(self) -> &'static str {
match self {
SSOProvider::Google => "googleauth",
SSOProvider::Steam => "steamauth",
}
}
}
impl SSOAuth {
async fn send_api_request(
&self,
endpoint: &str,
method: APIRequest,
) -> Result<Value, SFError> {
send_api_request(&self.client, "", endpoint, method).await
}
/// Returns the SSO auth URL, that the user has to login through
#[must_use]
pub fn auth_url(&self) -> &Url {
&self.auth_url
}
/// Tries to login. If the user has successfully authenticated via the
/// `auth_url`, this will return the normal `SFAccount`. Otherwise, this
/// will return the existing Auth for you to reattempt the login after a
/// few seconds
///
/// # Errors
/// May return `ConnectionError`, or `ParsingError` depending on what part
/// of the communication failed
#[allow(clippy::indexing_slicing)]
pub async fn try_login(self) -> Result<AuthResponse, SFError> {
let endpoint = format!(
"/json/sso/{}/check/{}",
self.provider.endpoint_ident(),
self.auth_id
);
let resp = self.send_api_request(&endpoint, APIRequest::Get).await?;
if let Some(message) = val_to_string(&resp) {
return match message.as_str() {
"SSO_POPUP_STATE_PROCESSING" => Ok(AuthResponse::NoAuth(self)),
_ => Err(SFError::ConnectionError),
};
}
let id_token =
val_to_string(&resp["id_token"]).ok_or(SFError::ConnectionError)?;
let mut form_data = HashMap::new();
form_data.insert("token".to_string(), id_token.clone());
form_data.insert("language".to_string(), "en".to_string());
let res = self
.send_api_request(
&format!("json/login/sso/{}", self.provider.endpoint_ident()),
APIRequest::Post {
parameters: vec![
"client_id=i43nwwnmfc5tced4jtuk4auuygqghud2yopx",
"auth_type=access_token",
],
form_data,
},
)
.await?;
let access_token = val_to_string(&res["token"]["access_token"])
.ok_or(SFError::ConnectionError)?;
let uuid = val_to_string(&res["account"]["uuid"])
.ok_or(SFError::ConnectionError)?;
let username = val_to_string(&res["account"]["username"])
.ok_or(SFError::ConnectionError)?;
Ok(AuthResponse::Success(SFAccount {
username,
client: self.client,
session: AccountSession {
uuid,
bearer_token: access_token,
},
options: self.options,
auth: match self.provider {
SSOProvider::Google => SSOAuthData::Google,
SSOProvider::Steam => SSOAuthData::Steam,
},
}))
}
/// Instantiates a new attempt to login through a SSO provider. A user then
/// has to interact with the `auth_url` this returns to validate the
/// login. Afterwards you can login and transform this into a normal
/// `SFAccount`
///
/// # Errors
/// May return `ConnectionError`, or `ParsingError` depending on what part
/// of the communication failed
pub async fn new(provider: SSOProvider) -> Result<Self, SFError> {
Self::new_with_options(provider, ConnectionOptions::default()).await
}
/// The same as `new()`, but with optional connection options
///
/// # Errors
/// May return `ConnectionError`, or `ParsingError` depending on what part
/// of the communication failed
#[allow(clippy::indexing_slicing)]
pub async fn new_with_options(
provider: SSOProvider,
options: ConnectionOptions,
) -> Result<Self, SFError> {
let client =
reqwest_client(&options).ok_or(SFError::ConnectionError)?;
let resp = send_api_request(
&client,
"",
&format!("json/sso/{}", provider.endpoint_ident()),
APIRequest::Get,
)
.await?;
let auth_url = val_to_string(&resp["redirect"])
.and_then(|a| Url::parse(&a).ok())
.ok_or(SFError::ConnectionError)?;
let auth_id =
val_to_string(&resp["id"]).ok_or(SFError::ConnectionError)?;
Ok(Self {
client,
options,
auth_url,
auth_id,
provider,
})
}
}