manabrew-server 0.35.0

Matchmaking and lobby relay server for manabrew multiplayer
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
use std::collections::HashMap;
use std::time::{Duration, Instant};

use aws_lc_rs::signature::{UnparsedPublicKey, ED25519};
use base64::engine::general_purpose::URL_SAFE_NO_PAD;
use base64::Engine;
use serde::Deserialize;
use sha2::{Digest, Sha256};
use tokio::sync::Mutex;
use tracing::warn;

use crate::protocol::identity_token::{
    self, DecodedIdentityToken, IdentityTokenClaims, HUB_ISSUER, RELAY_AUDIENCE, SELF_ISSUER,
    SIGNED_ALG,
};
use crate::protocol::IdentityProof;

const CLOCK_SKEW_SECS: i64 = 60;
const JWKS_REFRESH_COOLDOWN: Duration = Duration::from_secs(60);
const JWKS_TIMEOUT: Duration = Duration::from_secs(5);
const DEVICE_SECRET_MIN_LEN: usize = 16;
const DEVICE_SECRET_MAX_LEN: usize = 512;

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum SessionIdentity {
    Account(String),
    Device(String),
}

impl SessionIdentity {
    pub fn kind(&self) -> &'static str {
        match self {
            Self::Account(_) => "account",
            Self::Device(_) => "device",
        }
    }
}

#[derive(Default)]
pub struct ResolvedIdentity {
    pub identities: Vec<SessionIdentity>,
    pub name: Option<String>,
    pub name_verified: bool,
    pub qualification: Option<String>,
    pub avatar_url: Option<String>,
    pub stale_token: bool,
}

#[derive(Deserialize)]
struct Jwks {
    keys: Vec<Jwk>,
}

#[derive(Deserialize)]
struct Jwk {
    kid: String,
    kty: String,
    crv: String,
    x: String,
}

#[derive(Default)]
struct KeyCache {
    keys: HashMap<String, Vec<u8>>,
    last_fetch: Option<Instant>,
}

pub struct IdentityVerifier {
    jwks_url: Option<String>,
    http: reqwest::Client,
    cache: Mutex<KeyCache>,
}

impl IdentityVerifier {
    pub fn new(jwks_url: Option<String>) -> Self {
        IdentityVerifier {
            jwks_url,
            http: reqwest::Client::builder()
                .timeout(JWKS_TIMEOUT)
                .build()
                .unwrap_or_default(),
            cache: Mutex::new(KeyCache::default()),
        }
    }

    pub fn hub_configured(&self) -> bool {
        self.jwks_url.is_some()
    }

    pub async fn resolve(&self, proof: &IdentityProof) -> ResolvedIdentity {
        let mut resolved = ResolvedIdentity::default();
        if let Some(decoded) = proof.token.as_deref().and_then(identity_token::decode) {
            if decoded.is_unsigned() {
                if let Some(name) = unverified_name(&decoded) {
                    resolved.name = Some(name);
                }
            } else if let Some((identity, name, qualification, avatar_url)) =
                self.account_identity(&decoded).await
            {
                if !claims_current(&decoded.claims) {
                    resolved.stale_token = true;
                } else {
                    resolved.identities.push(identity);
                    if !name.trim().is_empty() {
                        resolved.name = Some(name);
                        resolved.name_verified = true;
                        resolved.qualification = qualification;
                        resolved.avatar_url = avatar_url;
                    }
                }
            }
        }
        if let Some(identity) = proof.device.as_deref().and_then(device_identity) {
            resolved.identities.push(identity);
        }
        resolved
    }

    async fn account_identity(
        &self,
        decoded: &DecodedIdentityToken,
    ) -> Option<(SessionIdentity, String, Option<String>, Option<String>)> {
        if decoded.header.alg != SIGNED_ALG {
            return None;
        }

        let key = self.public_key(decoded.header.kid.as_deref()?).await?;
        UnparsedPublicKey::new(&ED25519, &key)
            .verify(decoded.signing_input.as_bytes(), &decoded.signature)
            .ok()?;

        let claims = &decoded.claims;
        if claims.iss != HUB_ISSUER || claims.aud != RELAY_AUDIENCE || claims.sub.is_empty() {
            return None;
        }

        Some((
            SessionIdentity::Account(claims.sub.clone()),
            claims.handle.clone(),
            claims.qualification.clone(),
            claims.avatar_url.clone(),
        ))
    }

    async fn public_key(&self, kid: &str) -> Option<Vec<u8>> {
        let url = self.jwks_url.as_ref()?;
        let mut cache = self.cache.lock().await;
        if let Some(key) = cache.keys.get(kid) {
            return Some(key.clone());
        }
        if cache
            .last_fetch
            .is_some_and(|at| at.elapsed() < JWKS_REFRESH_COOLDOWN)
        {
            return None;
        }

        cache.last_fetch = Some(Instant::now());
        match self.fetch_jwks(url).await {
            Ok(keys) => cache.keys = keys,
            Err(error) => {
                warn!(%error, "identity jwks fetch failed");
                return None;
            }
        }
        cache.keys.get(kid).cloned()
    }

    async fn fetch_jwks(&self, url: &str) -> Result<HashMap<String, Vec<u8>>, reqwest::Error> {
        let jwks: Jwks = self
            .http
            .get(url)
            .send()
            .await?
            .error_for_status()?
            .json()
            .await?;
        Ok(jwks
            .keys
            .into_iter()
            .filter(|jwk| jwk.kty == "OKP" && jwk.crv == "Ed25519")
            .filter_map(|jwk| Some((jwk.kid, decode(&jwk.x)?)))
            .collect())
    }
}

pub fn same_owner(session: &[SessionIdentity], presented: &[SessionIdentity]) -> bool {
    !session.is_empty() && presented.iter().any(|identity| session.contains(identity))
}

pub fn label(identities: &[SessionIdentity]) -> &'static str {
    identities
        .first()
        .map_or("anonymous", SessionIdentity::kind)
}

fn unverified_name(decoded: &DecodedIdentityToken) -> Option<String> {
    let claims = &decoded.claims;
    if claims.iss != SELF_ISSUER || claims.aud != RELAY_AUDIENCE {
        return None;
    }
    if !claims_current(claims) {
        return None;
    }
    let handle = claims.handle.trim();
    if handle.is_empty() {
        return None;
    }
    Some(handle.to_string())
}

fn claims_current(claims: &IdentityTokenClaims) -> bool {
    let now = chrono::Utc::now().timestamp();
    claims.exp + CLOCK_SKEW_SECS >= now && claims.iat - CLOCK_SKEW_SECS <= now
}

fn device_identity(secret: &str) -> Option<SessionIdentity> {
    if !(DEVICE_SECRET_MIN_LEN..=DEVICE_SECRET_MAX_LEN).contains(&secret.len()) {
        return None;
    }
    let digest = Sha256::digest(secret.as_bytes());
    Some(SessionIdentity::Device(
        digest.iter().map(|byte| format!("{byte:02x}")).collect(),
    ))
}

fn decode(value: &str) -> Option<Vec<u8>> {
    URL_SAFE_NO_PAD.decode(value).ok()
}

#[cfg(test)]
mod tests {
    use aws_lc_rs::signature::{Ed25519KeyPair, KeyPair};

    use super::*;

    struct Signer {
        key_pair: Ed25519KeyPair,
    }

    impl Signer {
        fn new() -> Self {
            let document =
                Ed25519KeyPair::generate_pkcs8(&aws_lc_rs::rand::SystemRandom::new()).unwrap();
            Signer {
                key_pair: Ed25519KeyPair::from_pkcs8(document.as_ref()).unwrap(),
            }
        }

        fn mint(&self, claims: serde_json::Value) -> String {
            let header = serde_json::json!({ "alg": "EdDSA", "typ": "JWT", "kid": "test" });
            let signing_input = format!(
                "{}.{}",
                URL_SAFE_NO_PAD.encode(header.to_string()),
                URL_SAFE_NO_PAD.encode(claims.to_string()),
            );
            let signature = self.key_pair.sign(signing_input.as_bytes());
            format!(
                "{signing_input}.{}",
                URL_SAFE_NO_PAD.encode(signature.as_ref())
            )
        }
    }

    async fn verifier_for(signer: &Signer) -> IdentityVerifier {
        let verifier = IdentityVerifier::new(Some("http://unused".into()));
        verifier.cache.lock().await.keys.insert(
            "test".into(),
            signer.key_pair.public_key().as_ref().to_vec(),
        );
        verifier
    }

    fn token_proof(token: String) -> IdentityProof {
        IdentityProof {
            token: Some(token),
            device: None,
        }
    }

    fn claims(now: i64) -> serde_json::Value {
        serde_json::json!({
            "sub": "account-1",
            "handle": "brewer",
            "iss": HUB_ISSUER,
            "aud": RELAY_AUDIENCE,
            "iat": now,
            "exp": now + 600,
        })
    }

    #[tokio::test]
    async fn accepts_a_token_signed_by_the_hub_key() {
        let signer = Signer::new();
        let verifier = verifier_for(&signer).await;
        let token = signer.mint(claims(chrono::Utc::now().timestamp()));

        let resolved = verifier.resolve(&token_proof(token)).await;

        assert_eq!(
            resolved.identities,
            vec![SessionIdentity::Account("account-1".into())]
        );
        assert_eq!(resolved.name.as_deref(), Some("brewer"));
    }

    #[tokio::test]
    async fn accepts_a_self_minted_unsigned_token_as_an_unverified_name() {
        let verifier = IdentityVerifier::new(None);
        let now = chrono::Utc::now().timestamp();
        let token = identity_token::mint_unsigned("node:test", "Free room host", now, 600);

        let resolved = verifier.resolve(&token_proof(token)).await;

        assert_eq!(resolved.name.as_deref(), Some("Free room host"));
        assert!(!resolved.name_verified);
        assert!(resolved.identities.is_empty());

        let expired = identity_token::mint_unsigned("node:test", "stale", now - 3600, 600);
        assert!(verifier.resolve(&token_proof(expired)).await.name.is_none());
    }

    #[tokio::test]
    async fn an_unsigned_token_cannot_claim_the_hub_issuer() {
        let verifier = IdentityVerifier::new(None);
        let now = chrono::Utc::now().timestamp();
        let header = URL_SAFE_NO_PAD.encode(r#"{"alg":"none"}"#);
        let claims = URL_SAFE_NO_PAD.encode(
            serde_json::json!({
                "sub": "account-1", "handle": "impostor",
                "iss": HUB_ISSUER, "aud": RELAY_AUDIENCE,
                "iat": now, "exp": now + 600,
            })
            .to_string(),
        );

        let resolved = verifier
            .resolve(&token_proof(format!("{header}.{claims}.")))
            .await;

        assert!(resolved.name.is_none());
        assert!(resolved.identities.is_empty());
    }

    #[tokio::test]
    async fn rejects_tampered_expired_and_foreign_tokens() {
        let signer = Signer::new();
        let verifier = verifier_for(&signer).await;
        let now = chrono::Utc::now().timestamp();

        let mut tampered = signer.mint(claims(now));
        tampered.replace_range(..1, "x");
        assert!(verifier
            .resolve(&token_proof(tampered))
            .await
            .identities
            .is_empty());

        let expired = signer.mint(serde_json::json!({
            "sub": "account-1", "iss": HUB_ISSUER, "aud": RELAY_AUDIENCE,
            "iat": now - 3600, "exp": now - 1800,
        }));
        assert!(verifier
            .resolve(&token_proof(expired))
            .await
            .identities
            .is_empty());

        let wrong_audience = signer.mint(serde_json::json!({
            "sub": "account-1", "iss": HUB_ISSUER, "aud": "someone-else",
            "iat": now, "exp": now + 600,
        }));
        assert!(verifier
            .resolve(&token_proof(wrong_audience))
            .await
            .identities
            .is_empty());

        let other = Signer::new();
        let forged = other.mint(claims(now));
        assert!(verifier
            .resolve(&token_proof(forged))
            .await
            .identities
            .is_empty());
    }

    #[tokio::test]
    async fn falls_back_to_the_device_secret_without_a_configured_hub() {
        let signer = Signer::new();
        let verifier = IdentityVerifier::new(None);
        let secret = "self-hosted-device-secret";
        let proof = IdentityProof {
            token: Some(signer.mint(claims(chrono::Utc::now().timestamp()))),
            device: Some(secret.into()),
        };

        assert_eq!(
            verifier.resolve(&proof).await.identities,
            device_identity(secret).into_iter().collect::<Vec<_>>()
        );
        assert!(verifier
            .resolve(&token_proof("a.b.c".into()))
            .await
            .identities
            .is_empty());
    }

    #[test]
    fn device_secrets_hash_stably_and_bound_length() {
        let secret = "a".repeat(DEVICE_SECRET_MIN_LEN);
        assert_eq!(device_identity(&secret), device_identity(&secret));
        assert_ne!(device_identity(&secret), device_identity(&"b".repeat(32)));
        assert_eq!(device_identity("short"), None);
        assert_eq!(
            device_identity(&"a".repeat(DEVICE_SECRET_MAX_LEN + 1)),
            None
        );
    }
}