shardline-server 1.0.1

HTTP server boundary, runtime, and operator workflows for Shardline.
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
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
use std::fmt;
use std::sync::Arc;

use axum::http::{HeaderMap, header::AUTHORIZATION};
use shardline_protocol::{TokenClaims, TokenCodecError, TokenScope};
use shardline_server_core::{AuthError, AuthProvider};
use subtle::ConstantTimeEq;

use crate::ServerError;

const MAX_BEARER_TOKEN_BYTES: usize = 8192;

/// Verified request authorization context.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct AuthContext {
    claims: TokenClaims,
}

impl AuthContext {
    /// Creates an authorization context from verified token claims.
    #[must_use]
    pub const fn new(claims: TokenClaims) -> Self {
        Self { claims }
    }

    /// Returns the verified claims.
    #[must_use]
    pub const fn claims(&self) -> &TokenClaims {
        &self.claims
    }
}

/// Bearer-token verifier backed by a pluggable [`AuthProvider`].
#[derive(Clone)]
pub struct ServerAuth {
    provider: Arc<dyn AuthProvider>,
}

impl ServerAuth {
    /// Creates a bearer-token verifier from a signing key using the local
    /// HMAC-SHA256 provider.
    ///
    /// # Errors
    ///
    /// Returns [`ServerError`] when the signing key is invalid.
    pub fn new(signing_key: &[u8]) -> Result<Self, ServerError> {
        let provider = shardline_server_core::auth::LocalHmacProvider::new(signing_key)?;
        Ok(Self {
            provider: Arc::new(provider),
        })
    }

    /// Creates a bearer-token verifier from a boxed [`AuthProvider`].
    #[must_use]
    pub fn from_provider(provider: Box<dyn AuthProvider>) -> Self {
        Self {
            provider: Arc::from(provider),
        }
    }

    /// Returns a reference to the underlying [`AuthProvider`].
    #[must_use]
    pub fn provider(&self) -> &dyn AuthProvider {
        self.provider.as_ref()
    }

    /// Returns a clone of the underlying [`AuthProvider`] as an [`Arc`].
    #[must_use]
    pub fn provider_arc(&self) -> Arc<dyn AuthProvider> {
        self.provider.clone()
    }

    /// Validates the request token and required scope.
    ///
    /// # Errors
    ///
    /// Returns [`ServerError`] when the authorization header is missing, malformed, or
    /// insufficient for the requested scope.
    pub fn authorize(
        &self,
        headers: &HeaderMap,
        required_scope: TokenScope,
    ) -> Result<AuthContext, ServerError> {
        let header = headers
            .get(AUTHORIZATION)
            .ok_or(ServerError::MissingAuthorization)?;
        let header = header
            .to_str()
            .map_err(|_error| ServerError::InvalidAuthorizationHeader)?;
        let token = parse_bearer_token(header)?;
        let claims = self.provider.verify_token(token)?;
        if !scope_allows(claims.scope(), required_scope) {
            return Err(ServerError::InsufficientScope);
        }

        Ok(AuthContext::new(claims))
    }
}

impl fmt::Debug for ServerAuth {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("ServerAuth")
            .field("provider", &"<dyn AuthProvider>")
            .finish()
    }
}

fn parse_bearer_token(header: &str) -> Result<&str, ServerError> {
    let Some(token) = header.strip_prefix("Bearer ") else {
        return Err(ServerError::InvalidAuthorizationHeader);
    };
    if token.trim().is_empty() {
        return Err(ServerError::InvalidAuthorizationHeader);
    }
    if token.len() > MAX_BEARER_TOKEN_BYTES {
        return Err(ServerError::InvalidAuthorizationHeader);
    }
    if token.bytes().any(|byte| byte.is_ascii_whitespace()) {
        return Err(ServerError::InvalidAuthorizationHeader);
    }

    Ok(token)
}

pub(crate) fn authorize_static_bearer_token(
    headers: &HeaderMap,
    expected_token: &[u8],
) -> Result<(), ServerError> {
    let header = headers
        .get(AUTHORIZATION)
        .ok_or(ServerError::MissingAuthorization)?;
    let header = header
        .to_str()
        .map_err(|_error| ServerError::InvalidAuthorizationHeader)?;
    let token = parse_bearer_token(header)?;
    let actual = token.as_bytes();

    use sha2::{Digest, Sha256};
    let actual_hash = Sha256::digest(actual);
    let expected_hash = Sha256::digest(expected_token);
    if bool::from(actual_hash.ct_eq(&expected_hash)) {
        return Ok(());
    }

    Err(ServerError::InvalidAuthorizationHeader)
}

const fn scope_allows(actual_scope: TokenScope, required_scope: TokenScope) -> bool {
    match required_scope {
        TokenScope::Read => actual_scope.allows_read(),
        TokenScope::Write => actual_scope.allows_write(),
    }
}

impl From<TokenCodecError> for ServerError {
    fn from(error: TokenCodecError) -> Self {
        Self::InvalidToken(error)
    }
}

impl From<AuthError> for ServerError {
    fn from(error: AuthError) -> Self {
        match error {
            AuthError::InvalidToken => Self::InvalidToken(TokenCodecError::InvalidFormat),
            AuthError::ExpiredToken => Self::InvalidToken(TokenCodecError::Expired),
            AuthError::InsufficientScope => Self::InsufficientScope,
            AuthError::ProviderError(msg) => Self::SigningKeyError(msg),
        }
    }
}

#[cfg(test)]
mod tests {
    use axum::http::{
        HeaderMap,
        header::{AUTHORIZATION, HeaderValue},
    };
    use shardline_protocol::{
        RepositoryProvider, RepositoryScope, TokenClaims, TokenScope, TokenSigner,
    };

    use super::{MAX_BEARER_TOKEN_BYTES, ServerAuth, authorize_static_bearer_token};
    use crate::ServerError;

    #[test]
    fn server_auth_rejects_missing_header() {
        let auth = ServerAuth::new(b"test-signing-key-32-bytes-long!!");
        assert!(auth.is_ok());
        let Ok(auth) = auth else {
            return;
        };

        assert!(matches!(
            auth.authorize(&HeaderMap::new(), TokenScope::Read),
            Err(ServerError::MissingAuthorization)
        ));
    }

    #[test]
    fn server_auth_rejects_insufficient_scope() {
        let auth = ServerAuth::new(b"test-signing-key-32-bytes-long!!");
        assert!(auth.is_ok());
        let Ok(auth) = auth else {
            return;
        };
        let signer = TokenSigner::new(b"test-signing-key-32-bytes-long!!");
        assert!(signer.is_ok());
        let Ok(signer) = signer else {
            return;
        };
        let repository =
            RepositoryScope::new(RepositoryProvider::GitHub, "team", "assets", Some("main"));
        assert!(repository.is_ok());
        let Ok(repository) = repository else {
            return;
        };
        let claims = TokenClaims::new(
            "local",
            "provider-user-1",
            TokenScope::Read,
            repository,
            u64::MAX,
        );
        assert!(claims.is_ok());
        let Ok(claims) = claims else {
            return;
        };
        let token = signer.sign(&claims);
        assert!(token.is_ok());
        let Ok(token) = token else {
            return;
        };
        let mut headers = HeaderMap::new();
        let header_value = HeaderValue::from_str(&format!("Bearer {token}"));
        assert!(header_value.is_ok());
        let Ok(header_value) = header_value else {
            return;
        };
        headers.insert(AUTHORIZATION, header_value);

        assert!(matches!(
            auth.authorize(&headers, TokenScope::Write),
            Err(ServerError::InsufficientScope)
        ));
    }

    #[test]
    fn server_auth_rejects_oversized_bearer_token_before_decoding() {
        let auth = ServerAuth::new(b"test-signing-key-32-bytes-long!!");
        assert!(auth.is_ok());
        let Ok(auth) = auth else {
            return;
        };
        let token = "a".repeat(MAX_BEARER_TOKEN_BYTES + 1);
        let mut headers = HeaderMap::new();
        let header_value = HeaderValue::from_str(&format!("Bearer {token}"));
        assert!(header_value.is_ok());
        let Ok(header_value) = header_value else {
            return;
        };
        headers.insert(AUTHORIZATION, header_value);

        assert!(matches!(
            auth.authorize(&headers, TokenScope::Read),
            Err(ServerError::InvalidAuthorizationHeader)
        ));
    }

    #[test]
    fn server_auth_rejects_bearer_token_with_whitespace() {
        let auth = ServerAuth::new(b"test-signing-key-32-bytes-long!!");
        assert!(auth.is_ok());
        let Ok(auth) = auth else {
            return;
        };
        let mut headers = HeaderMap::new();
        headers.insert(
            AUTHORIZATION,
            HeaderValue::from_static("Bearer abc.def ghi"),
        );

        assert!(matches!(
            auth.authorize(&headers, TokenScope::Read),
            Err(ServerError::InvalidAuthorizationHeader)
        ));
    }

    #[test]
    fn server_auth_accepts_valid_write_token() {
        let auth = ServerAuth::new(b"test-signing-key-32-bytes-long!!");
        assert!(auth.is_ok());
        let Ok(auth) = auth else {
            return;
        };
        let signer = TokenSigner::new(b"test-signing-key-32-bytes-long!!");
        assert!(signer.is_ok());
        let Ok(signer) = signer else {
            return;
        };
        let repository =
            RepositoryScope::new(RepositoryProvider::GitHub, "team", "assets", Some("main"));
        assert!(repository.is_ok());
        let Ok(repository) = repository else {
            return;
        };
        let claims = TokenClaims::new(
            "local",
            "provider-user-1",
            TokenScope::Write,
            repository,
            u64::MAX,
        );
        assert!(claims.is_ok());
        let Ok(claims) = claims else {
            return;
        };
        let token = signer.sign(&claims);
        assert!(token.is_ok());
        let Ok(token) = token else {
            return;
        };
        let mut headers = HeaderMap::new();
        let header_value = HeaderValue::from_str(&format!("Bearer {token}"));
        assert!(header_value.is_ok());
        let Ok(header_value) = header_value else {
            return;
        };
        headers.insert(AUTHORIZATION, header_value);

        let context = auth.authorize(&headers, TokenScope::Read);

        assert!(context.is_ok());
        let Ok(context) = context else {
            return;
        };
        assert_eq!(context.claims().subject(), "provider-user-1");
        assert_eq!(context.claims().scope(), TokenScope::Write);
    }

    #[test]
    fn static_bearer_token_rejects_missing_header() {
        let result = authorize_static_bearer_token(&HeaderMap::new(), b"metrics-token");

        assert!(matches!(result, Err(ServerError::MissingAuthorization)));
    }

    #[test]
    fn static_bearer_token_rejects_wrong_value() {
        let mut headers = HeaderMap::new();
        headers.insert(
            AUTHORIZATION,
            HeaderValue::from_static("Bearer wrong-token"),
        );

        let result = authorize_static_bearer_token(&headers, b"metrics-token");

        assert!(matches!(
            result,
            Err(ServerError::InvalidAuthorizationHeader)
        ));
    }

    #[test]
    fn static_bearer_token_accepts_matching_value() {
        let mut headers = HeaderMap::new();
        headers.insert(
            AUTHORIZATION,
            HeaderValue::from_static("Bearer metrics-token"),
        );

        let result = authorize_static_bearer_token(&headers, b"metrics-token");

        assert!(result.is_ok());
    }

    // ── parse_bearer_token edge cases ──────────────────────────────────────

    #[test]
    fn parse_bearer_token_rejects_missing_bearer_prefix() {
        use super::parse_bearer_token;
        let result = parse_bearer_token("Basic token");
        assert!(matches!(
            result,
            Err(ServerError::InvalidAuthorizationHeader)
        ));
    }

    #[test]
    fn parse_bearer_token_rejects_empty_token_after_prefix() {
        use super::parse_bearer_token;
        let result = parse_bearer_token("Bearer ");
        assert!(matches!(
            result,
            Err(ServerError::InvalidAuthorizationHeader)
        ));
    }

    #[test]
    fn parse_bearer_token_rejects_whitespace_only_token() {
        use super::parse_bearer_token;
        let result = parse_bearer_token("Bearer   ");
        assert!(matches!(
            result,
            Err(ServerError::InvalidAuthorizationHeader)
        ));
    }

    #[test]
    fn parse_bearer_token_rejects_token_with_whitespace() {
        use super::parse_bearer_token;
        let result = parse_bearer_token("Bearer abc def");
        assert!(matches!(
            result,
            Err(ServerError::InvalidAuthorizationHeader)
        ));
    }

    #[test]
    fn parse_bearer_token_rejects_oversized_token() {
        use super::{MAX_BEARER_TOKEN_BYTES, parse_bearer_token};
        let large = "a".repeat(MAX_BEARER_TOKEN_BYTES + 1);
        let header = format!("Bearer {large}");
        let result = parse_bearer_token(&header);
        assert!(matches!(
            result,
            Err(ServerError::InvalidAuthorizationHeader)
        ));
    }

    #[test]
    fn parse_bearer_token_accepts_valid_token() {
        use super::parse_bearer_token;
        let result = parse_bearer_token("Bearer valid-token-here");
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), "valid-token-here");
    }

    // ── scope_allows ───────────────────────────────────────────────────────

    #[test]
    fn scope_allows_read_when_scope_is_read() {
        assert!(super::scope_allows(TokenScope::Read, TokenScope::Read));
    }

    #[test]
    fn scope_allows_write_when_scope_is_write() {
        assert!(super::scope_allows(TokenScope::Write, TokenScope::Write));
    }

    #[test]
    fn scope_allows_read_when_scope_is_write() {
        // Write scope implicitly allows Read
        assert!(super::scope_allows(TokenScope::Write, TokenScope::Read));
    }

    #[test]
    fn scope_allows_rejects_write_when_scope_is_read() {
        assert!(!super::scope_allows(TokenScope::Read, TokenScope::Write));
    }

    // ── AuthError conversion ───────────────────────────────────────────────

    #[test]
    fn from_auth_error_invalid_token() {
        use shardline_server_core::AuthError;
        let err: ServerError = AuthError::InvalidToken.into();
        assert!(matches!(err, ServerError::InvalidToken(_)));
    }

    #[test]
    fn from_auth_error_expired_token() {
        use shardline_server_core::AuthError;
        let err: ServerError = AuthError::ExpiredToken.into();
        assert!(matches!(err, ServerError::InvalidToken(_)));
    }

    #[test]
    fn from_auth_error_insufficient_scope() {
        use shardline_server_core::AuthError;
        let err: ServerError = AuthError::InsufficientScope.into();
        assert!(matches!(err, ServerError::InsufficientScope));
    }

    #[test]
    fn from_auth_error_provider_error() {
        use shardline_server_core::AuthError;
        let err: ServerError = AuthError::ProviderError("msg".to_owned()).into();
        assert!(matches!(err, ServerError::SigningKeyError(_)));
    }

    // ── ServerAuth from_provider ───────────────────────────────────────────

    #[test]
    fn server_auth_from_provider_delegates() {
        use shardline_server_core::auth::PassthroughProvider;
        let provider = Box::new(PassthroughProvider);
        let auth = ServerAuth::from_provider(provider);
        // Verify it can authorize a request with a Bearer token
        let mut headers = HeaderMap::new();
        headers.insert(AUTHORIZATION, HeaderValue::from_static("Bearer any-token"));
        let result = auth.authorize(&headers, TokenScope::Write);
        assert!(result.is_ok());
        let ctx = result.unwrap();
        // PassthroughProvider uses "anonymous" as the default subject
        assert!(ctx.claims().subject() == "anonymous" || ctx.claims().subject() == "passthrough");
    }

    #[test]
    fn server_auth_debug_redacts_provider() {
        use shardline_server_core::auth::PassthroughProvider;
        let provider = Box::new(PassthroughProvider);
        let auth = ServerAuth::from_provider(provider);
        let debug = format!("{auth:?}");
        assert!(!debug.contains("PassthroughProvider"));
        assert!(debug.contains("<dyn AuthProvider>"));
    }

    #[test]
    fn server_auth_provider_arc_returns_cloneable_arc() {
        use shardline_server_core::auth::PassthroughProvider;
        let provider = Box::new(PassthroughProvider);
        let auth = ServerAuth::from_provider(provider);
        let arc = auth.provider_arc();
        // Verify the arc points to the same provider
        assert!(std::sync::Arc::ptr_eq(&auth.provider, &arc));
    }

    // ── Repeated Authorization header tests ────────────────────────────────

    #[test]
    fn authorize_picks_first_of_two_separate_authorization_headers() {
        // When a client sends two separate Authorization headers, `HeaderMap::get()`
        // returns the first one.  This test validates that behavior.
        let auth = ServerAuth::new(b"test-signing-key-32-bytes-long!!").unwrap();

        // Create two Authorization headers via `append`.
        let mut headers = HeaderMap::new();
        // A valid token is appended first.
        let signer = TokenSigner::new(b"test-signing-key-32-bytes-long!!").unwrap();
        let repository =
            RepositoryScope::new(RepositoryProvider::GitHub, "team", "assets", Some("main"))
                .unwrap();
        let claims = TokenClaims::new(
            "local",
            "provider-user-1",
            TokenScope::Write,
            repository,
            u64::MAX,
        )
        .unwrap();
        let valid_token = signer.sign(&claims).unwrap();

        headers.append(
            AUTHORIZATION,
            HeaderValue::from_str(&format!("Bearer {valid_token}")).unwrap(),
        );
        // Append a second (invalid) header — should be ignored.
        headers.append(
            AUTHORIZATION,
            HeaderValue::from_static("Bearer invalid-token-here"),
        );

        // Headers.get() returns the first entry — the valid token.
        let result = auth.authorize(&headers, TokenScope::Read);
        assert!(
            result.is_ok(),
            "first Authorization header should be used, got: {result:?}"
        );
    }

    #[test]
    fn authorize_rejects_comma_separated_bearer_in_one_header() {
        // RFC 7230 §3.2.2 allows combining multiple header values into a single
        // comma-separated value.  If a client sends
        // `Authorization: Bearer token1, Bearer token2`, the token after
        // comma + space contains whitespace and MUST be rejected.
        let auth = ServerAuth::new(b"test-signing-key-32-bytes-long!!").unwrap();
        let mut headers = HeaderMap::new();
        headers.insert(
            AUTHORIZATION,
            HeaderValue::from_static("Bearer valid-token, Bearer invalid-token"),
        );

        let result = auth.authorize(&headers, TokenScope::Read);
        assert!(
            matches!(result, Err(ServerError::InvalidAuthorizationHeader)),
            "comma-separated Bearer tokens should be rejected, got: {result:?}"
        );
    }

    #[test]
    fn parse_bearer_token_rejects_comma_space_in_token() {
        // Even without the second "Bearer" prefix, a comma + space triggers the
        // whitespace rejection in parse_bearer_token.
        use super::parse_bearer_token;
        let result = parse_bearer_token("Bearer token1, token2");
        assert!(matches!(
            result,
            Err(ServerError::InvalidAuthorizationHeader)
        ));
    }

    // ── ServerAuth authorize_token method ──────────────────────────────────

    #[test]
    fn server_auth_authorize_token_with_no_matching_token_provider() {
        // When auth is built with Local provider and no token is in the header,
        // it should go through the provider_path.
        use shardline_server_core::auth::PassthroughProvider;
        let provider = Box::new(PassthroughProvider);
        let auth = super::ServerAuth::from_provider(provider);

        // Empty headers → MissingAuthorization
        let result = auth.authorize(&HeaderMap::new(), TokenScope::Read);
        assert!(matches!(result, Err(ServerError::MissingAuthorization)));
    }

    #[test]
    fn server_auth_authorize_token_with_invalid_scheme() {
        use shardline_server_core::auth::PassthroughProvider;
        let provider = Box::new(PassthroughProvider);
        let auth = super::ServerAuth::from_provider(provider);

        let mut headers = HeaderMap::new();
        headers.insert(AUTHORIZATION, HeaderValue::from_static("Basic token"));
        let result = auth.authorize(&headers, TokenScope::Read);
        assert!(matches!(
            result,
            Err(ServerError::InvalidAuthorizationHeader)
        ));
    }

    // ── scope_allows edge cases ────────────────────────────────────────────

    #[test]
    fn scope_allows_with_same_scope_read_read() {
        assert!(super::scope_allows(TokenScope::Read, TokenScope::Read));
    }

    #[test]
    fn scope_allows_with_same_scope_write_write() {
        assert!(super::scope_allows(TokenScope::Write, TokenScope::Write));
    }

    #[test]
    fn scope_allows_write_grants_read() {
        assert!(super::scope_allows(TokenScope::Write, TokenScope::Read));
    }

    #[test]
    fn scope_allows_read_denies_write() {
        assert!(!super::scope_allows(TokenScope::Read, TokenScope::Write));
    }
}