rust-template-foundation 0.3.0

Shared infrastructure for projects spawned from rust-template.
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

//! Integration tests for JWT bearer-token auth (the
//! `auth::jwt` module).
//!
//! Uses a `LocalDecoder` with HS256 instead of a `RemoteJwksDecoder`
//! pointing at an in-test JWKS server: the JWKS HTTP fetch is
//! `axum-jwt-auth`'s responsibility to test.  We're testing
//! foundation's wiring — that the `ServiceClaims` shape, the
//! `JwtConfig::validation()` rules, and the `Claims<ServiceClaims>`
//! extractor all compose correctly through an axum router.

#![cfg(feature = "auth")]
// Helpers (sign_token, build_app, etc.) live outside `#[test]`
// functions; opt the whole file into the test-unwrap exemption.
#![allow(clippy::unwrap_used, clippy::expect_used)]

use axum::{
  body::Body,
  extract::FromRef,
  http::{header, Request, StatusCode},
  routing::get,
  Json, Router,
};
use jsonwebtoken::{
  encode, Algorithm, DecodingKey, EncodingKey, Header, Validation,
};
use rust_template_foundation::auth::jwt::{
  Claims, Decoder, JwtConfig, LocalDecoder, ServiceClaims,
};
use serde_json::json;
use std::sync::Arc;
use std::time::{SystemTime, UNIX_EPOCH};
use tower::ServiceExt;

// ── test helpers ────────────────────────────────────────────────────────────

const SECRET: &[u8] = b"test-shared-secret-do-not-use-in-prod";
const ISSUER: &str = "https://issuer.test/";
const AUDIENCE: &str = "test-api";

#[derive(Clone)]
struct TestState {
  decoder: Decoder<ServiceClaims>,
}

impl FromRef<TestState> for Decoder<ServiceClaims> {
  fn from_ref(state: &TestState) -> Self {
    state.decoder.clone()
  }
}

fn now_secs() -> i64 {
  SystemTime::now()
    .duration_since(UNIX_EPOCH)
    .map(|d| d.as_secs() as i64)
    .unwrap_or(0)
}

/// HS256 LocalDecoder configured to mirror what `JwtConfig::validation`
/// produces, so we exercise the same validation surface.
fn build_local_decoder(audience: &str, issuer: &str) -> Decoder<ServiceClaims> {
  // Construct via JwtConfig so the validation rules (issuer, audience,
  // algorithm list) are the ones foundation actually generates.
  let config = JwtConfig {
    jwks_url: "https://unused.invalid/jwks.json".to_string(),
    issuer: issuer.to_string(),
    audiences: vec![audience.to_string()],
    algorithms: vec![Algorithm::HS256],
  };
  let validation = config.validation();
  let key = DecodingKey::from_secret(SECRET);
  let decoder = LocalDecoder::builder()
    .keys(vec![key])
    .validation(validation)
    .build()
    .unwrap();
  Arc::new(decoder)
}

fn sign_token(claims: &serde_json::Value, secret: &[u8]) -> String {
  encode(
    &Header::new(Algorithm::HS256),
    claims,
    &EncodingKey::from_secret(secret),
  )
  .unwrap()
}

fn valid_claims() -> serde_json::Value {
  json!({
    "sub": "service-account-1",
    "iss": ISSUER,
    "aud": AUDIENCE,
    "exp": now_secs() + 3600,
  })
}

async fn protected_handler(
  claims: Claims<ServiceClaims>,
) -> Json<serde_json::Value> {
  Json(json!({
    "sub": claims.claims.sub,
    "iss": claims.claims.iss,
  }))
}

fn build_app() -> Router {
  let state = TestState {
    decoder: build_local_decoder(AUDIENCE, ISSUER),
  };
  Router::new()
    .route("/protected", get(protected_handler))
    .with_state(state)
}

async fn body_string(body: Body) -> String {
  let bytes = axum::body::to_bytes(body, usize::MAX).await.unwrap();
  String::from_utf8(bytes.to_vec()).unwrap()
}

fn request_with_token(token: Option<&str>) -> Request<Body> {
  let mut builder = Request::builder().uri("/protected");
  if let Some(t) = token {
    builder = builder.header(header::AUTHORIZATION, format!("Bearer {t}"));
  }
  builder.body(Body::empty()).unwrap()
}

// ── happy path ──────────────────────────────────────────────────────────────

#[tokio::test]
async fn valid_token_reaches_handler_with_claims() {
  let token = sign_token(&valid_claims(), SECRET);
  let resp = build_app()
    .oneshot(request_with_token(Some(&token)))
    .await
    .unwrap();

  assert_eq!(resp.status(), StatusCode::OK);
  let body = body_string(resp.into_body()).await;
  let json: serde_json::Value = serde_json::from_str(&body).unwrap();
  assert_eq!(json["sub"], "service-account-1");
  assert_eq!(json["iss"], ISSUER);
}

#[tokio::test]
async fn custom_claims_struct_works_via_generic_decoder() {
  // Apps with their own claims shape parameterize Decoder/Claims over
  // it.  The decoder construction is identical — only the type
  // parameter changes.
  use serde::Deserialize;

  #[derive(Clone, Deserialize)]
  struct MyClaims {
    sub: String,
    #[serde(default)]
    scope: String,
    tenant_id: String,
  }

  #[derive(Clone)]
  struct AppState {
    decoder: Decoder<MyClaims>,
  }

  impl FromRef<AppState> for Decoder<MyClaims> {
    fn from_ref(state: &AppState) -> Self {
      state.decoder.clone()
    }
  }

  async fn handler(claims: Claims<MyClaims>) -> Json<serde_json::Value> {
    Json(json!({
      "sub": claims.claims.sub,
      "scope": claims.claims.scope,
      "tenant_id": claims.claims.tenant_id,
    }))
  }

  // Build a Decoder<MyClaims> using the same LocalDecoder shape the
  // helper uses, just with a different T.
  let config = JwtConfig {
    jwks_url: "https://unused.invalid/jwks.json".to_string(),
    issuer: ISSUER.to_string(),
    audiences: vec![AUDIENCE.to_string()],
    algorithms: vec![Algorithm::HS256],
  };
  let local = LocalDecoder::builder()
    .keys(vec![DecodingKey::from_secret(SECRET)])
    .validation(config.validation())
    .build()
    .unwrap();
  let decoder: Decoder<MyClaims> = Arc::new(local);

  let app = Router::new()
    .route("/protected", get(handler))
    .with_state(AppState { decoder });

  let token = sign_token(
    &json!({
      "sub": "robot",
      "iss": ISSUER,
      "aud": AUDIENCE,
      "exp": now_secs() + 3600,
      "scope": "read:widgets",
      "tenant_id": "acme",
    }),
    SECRET,
  );

  let resp = app.oneshot(request_with_token(Some(&token))).await.unwrap();
  assert_eq!(resp.status(), StatusCode::OK);
  let body = body_string(resp.into_body()).await;
  let json: serde_json::Value = serde_json::from_str(&body).unwrap();
  assert_eq!(json["sub"], "robot");
  assert_eq!(json["scope"], "read:widgets");
  assert_eq!(json["tenant_id"], "acme");
}

#[tokio::test]
async fn extra_claims_round_trip_through_flatten() {
  // Verifies ServiceClaims.extra captures non-registered claims.
  let claims = json!({
    "sub": "svc",
    "iss": ISSUER,
    "aud": AUDIENCE,
    "exp": now_secs() + 3600,
    "scope": "read:widgets write:widgets",
    "tenant_id": "acme",
  });
  let token = sign_token(&claims, SECRET);

  // Decode it directly via the decoder to inspect the parsed shape.
  let decoder = build_local_decoder(AUDIENCE, ISSUER);
  let token_data = decoder.decode(&token).await.unwrap();
  assert_eq!(token_data.claims.sub, "svc");
  assert_eq!(
    token_data
      .claims
      .extra
      .get("scope")
      .and_then(|v| v.as_str()),
    Some("read:widgets write:widgets")
  );
  assert_eq!(
    token_data
      .claims
      .extra
      .get("tenant_id")
      .and_then(|v| v.as_str()),
    Some("acme")
  );
}

// ── rejection cases ─────────────────────────────────────────────────────────

#[tokio::test]
async fn missing_authorization_header_is_unauthorized() {
  let resp = build_app().oneshot(request_with_token(None)).await.unwrap();
  assert_eq!(resp.status(), StatusCode::UNAUTHORIZED);
}

#[tokio::test]
async fn malformed_token_is_unauthorized() {
  let resp = build_app()
    .oneshot(request_with_token(Some("not-a-jwt")))
    .await
    .unwrap();
  assert_eq!(resp.status(), StatusCode::UNAUTHORIZED);
}

#[tokio::test]
async fn wrong_signature_is_unauthorized() {
  let token = sign_token(&valid_claims(), b"different-secret");
  let resp = build_app()
    .oneshot(request_with_token(Some(&token)))
    .await
    .unwrap();
  assert_eq!(resp.status(), StatusCode::UNAUTHORIZED);
}

#[tokio::test]
async fn expired_token_is_unauthorized() {
  // jsonwebtoken's default Validation has a 60-second leeway, so put
  // exp comfortably outside that window.
  let claims = json!({
    "sub": "svc",
    "iss": ISSUER,
    "aud": AUDIENCE,
    "exp": now_secs() - 600,
  });
  let token = sign_token(&claims, SECRET);
  let resp = build_app()
    .oneshot(request_with_token(Some(&token)))
    .await
    .unwrap();
  assert_eq!(resp.status(), StatusCode::UNAUTHORIZED);
}

#[tokio::test]
async fn wrong_audience_is_unauthorized() {
  let claims = json!({
    "sub": "svc",
    "iss": ISSUER,
    "aud": "some-other-api",
    "exp": now_secs() + 3600,
  });
  let token = sign_token(&claims, SECRET);
  let resp = build_app()
    .oneshot(request_with_token(Some(&token)))
    .await
    .unwrap();
  assert_eq!(resp.status(), StatusCode::UNAUTHORIZED);
}

#[tokio::test]
async fn wrong_issuer_is_unauthorized() {
  let claims = json!({
    "sub": "svc",
    "iss": "https://attacker.example/",
    "aud": AUDIENCE,
    "exp": now_secs() + 3600,
  });
  let token = sign_token(&claims, SECRET);
  let resp = build_app()
    .oneshot(request_with_token(Some(&token)))
    .await
    .unwrap();
  assert_eq!(resp.status(), StatusCode::UNAUTHORIZED);
}

#[tokio::test]
async fn algorithm_mismatch_is_unauthorized() {
  // Decoder accepts only HS256; sign with HS384 to confirm rejection.
  let token = encode(
    &Header::new(Algorithm::HS384),
    &valid_claims(),
    &EncodingKey::from_secret(SECRET),
  )
  .unwrap();
  let resp = build_app()
    .oneshot(request_with_token(Some(&token)))
    .await
    .unwrap();
  assert_eq!(resp.status(), StatusCode::UNAUTHORIZED);
}

// ── JwtConfig::validation shape ─────────────────────────────────────────────

#[test]
fn jwt_config_validation_sets_issuer_audience_and_algorithms() {
  let config = JwtConfig {
    jwks_url: "https://x/jwks".into(),
    issuer: "https://issuer.example/".into(),
    audiences: vec!["a".into(), "b".into()],
    algorithms: vec![Algorithm::RS256, Algorithm::ES256],
  };
  let validation = config.validation();
  assert!(validation.algorithms.contains(&Algorithm::RS256));
  assert!(validation.algorithms.contains(&Algorithm::ES256));
  // jsonwebtoken stores these as Option<HashSet<String>> internally;
  // round-tripping via Validation is the documented surface.
  let _: Validation = validation;
}

#[test]
fn jwt_config_validation_defaults_to_rs256_when_algorithms_empty() {
  let config = JwtConfig {
    jwks_url: "https://x/jwks".into(),
    issuer: "https://issuer.example/".into(),
    audiences: vec!["a".into()],
    algorithms: vec![],
  };
  let validation = config.validation();
  assert!(validation.algorithms.contains(&Algorithm::RS256));
}