watchword 0.2.1

Authentication for axum servers and Yew frontends: password, Cloudflare Access and Google sign-in, sessions and user management.
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
use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};

use aws_lc_rs::rand::SystemRandom;
use aws_lc_rs::rsa::{KeyPair, KeySize};
use aws_lc_rs::signature::{KeyPair as _, RSA_PKCS1_SHA256};
use http::HeaderValue;
use serde_json::{Value, json};

use super::*;

const TEAM: &str = "example.cloudflareaccess.com";
const AUD: &str = "aud-tag";

struct Signer {
    kid: String,
    key: KeyPair,
}

impl Signer {
    fn new(kid: &str) -> Self {
        Self {
            kid: kid.to_owned(),
            key: KeyPair::generate(KeySize::Rsa2048).unwrap(),
        }
    }

    fn jwk(&self) -> Jwk {
        let public = PublicKeyComponents::<Vec<u8>>::from(self.key.public_key());

        Jwk {
            kid: self.kid.clone(),
            n: public.n,
            e: public.e,
        }
    }

    fn sign(&self, claims: &Value) -> String {
        let header = json!({ "alg": "RS256", "kid": self.kid, "typ": "JWT" });
        let signed = format!(
            "{}.{}",
            URL_SAFE_NO_PAD.encode(header.to_string()),
            URL_SAFE_NO_PAD.encode(claims.to_string())
        );

        let mut signature = vec![0; self.key.public_modulus_len()];
        self.key
            .sign(
                &RSA_PKCS1_SHA256,
                &SystemRandom::new(),
                signed.as_bytes(),
                &mut signature,
            )
            .unwrap();

        format!("{signed}.{}", URL_SAFE_NO_PAD.encode(signature))
    }
}

#[derive(Default)]
struct FixedKeys {
    keys: Mutex<Vec<Jwk>>,
    fetches: AtomicUsize,
    failing: AtomicBool,
}

impl KeyFetcher for &FixedKeys {
    async fn fetch(&self, team_domain: &str) -> Result<Vec<Jwk>, Box<dyn StdError + Send + Sync>> {
        assert_eq!(team_domain, TEAM);
        self.fetches.fetch_add(1, Ordering::SeqCst);
        // Lets concurrent requests run while this fetch is in flight.
        tokio::task::yield_now().await;

        if self.failing.load(Ordering::SeqCst) {
            return Err("certs endpoint unavailable".into());
        }

        Ok(self.keys.lock().unwrap().clone())
    }
}

fn config(trust_email_header: bool, verify_jwt: bool) -> Config {
    Config {
        team_domain: TEAM.to_owned(),
        audience: AUD.to_owned(),
        trust_email_header,
        verify_jwt,
    }
}

fn now() -> Timestamp {
    "2026-10-01T12:00:00Z".parse().unwrap()
}

fn claims() -> Value {
    let now = now().as_second();

    json!({
        "aud": [AUD],
        "iss": format!("https://{TEAM}"),
        "email": "User@Example.com",
        "iat": now - 10,
        "nbf": now - 10,
        "exp": now + 3600,
        "sub": "user-id",
    })
}

fn headers(email: Option<&str>, jwt: Option<&str>) -> HeaderMap {
    let mut headers = HeaderMap::new();

    if let Some(email) = email {
        headers.insert(EMAIL_HEADER, HeaderValue::from_str(email).unwrap());
    }

    if let Some(jwt) = jwt {
        headers.insert(JWT_HEADER, HeaderValue::from_str(jwt).unwrap());
    }

    headers
}

async fn check(signer: &Signer, claims: Value) -> Result<String, AccessError> {
    let keys = FixedKeys::default();
    keys.keys.lock().unwrap().push(signer.jwk());
    let access = Access::with_fetcher(config(false, true), &keys);
    let jwt = signer.sign(&claims);
    access.email_at(&headers(None, Some(&jwt)), now()).await
}

#[tokio::test]
async fn valid_jwt() {
    let signer = Signer::new("k1");
    assert_eq!(check(&signer, claims()).await.unwrap(), "user@example.com");

    let mut single_aud = claims();
    single_aud["aud"] = json!(AUD);
    assert_eq!(
        check(&signer, single_aud).await.unwrap(),
        "user@example.com"
    );
}

#[tokio::test]
async fn wrong_audience() {
    let signer = Signer::new("k1");
    let mut claims = claims();
    claims["aud"] = json!(["other"]);
    assert!(matches!(
        check(&signer, claims).await,
        Err(AccessError::WrongAudience)
    ));
}

#[tokio::test]
async fn wrong_issuer() {
    let signer = Signer::new("k1");
    let mut claims = claims();
    claims["iss"] = json!("https://other.cloudflareaccess.com");
    assert!(matches!(
        check(&signer, claims).await,
        Err(AccessError::WrongIssuer)
    ));
}

#[tokio::test]
async fn expired() {
    let signer = Signer::new("k1");
    let mut claims = claims();
    claims["exp"] = json!(now().as_second() - LEEWAY_SECONDS - 1);
    assert!(matches!(
        check(&signer, claims).await,
        Err(AccessError::Expired)
    ));

    let mut claims = self::claims();
    claims["nbf"] = json!(now().as_second() + LEEWAY_SECONDS + 1);
    assert!(matches!(
        check(&signer, claims).await,
        Err(AccessError::NotYetValid)
    ));
}

#[tokio::test]
async fn bad_signature() {
    let signer = Signer::new("k1");
    let keys = FixedKeys::default();
    keys.keys.lock().unwrap().push(signer.jwk());
    let access = Access::with_fetcher(config(false, true), &keys);

    // Signed by a different key under the same kid.
    let forger = Signer::new("k1");
    let jwt = forger.sign(&claims());
    assert!(matches!(
        access.email_at(&headers(None, Some(&jwt)), now()).await,
        Err(AccessError::BadSignature)
    ));

    // Claims swapped after signing.
    let jwt = signer.sign(&claims());
    let mut other = claims();
    other["email"] = json!("admin@example.com");
    let (header, rest) = jwt.split_once('.').unwrap();
    let (_, signature) = rest.split_once('.').unwrap();
    let tampered = format!(
        "{header}.{}.{signature}",
        URL_SAFE_NO_PAD.encode(other.to_string())
    );
    assert!(matches!(
        access
            .email_at(&headers(None, Some(&tampered)), now())
            .await,
        Err(AccessError::BadSignature)
    ));
}

#[tokio::test]
async fn unsupported_algorithm() {
    let signer = Signer::new("k1");
    let jwt = signer.sign(&claims());
    let (_, rest) = jwt.split_once('.').unwrap();
    let header = URL_SAFE_NO_PAD.encode(json!({ "alg": "none", "kid": "k1" }).to_string());

    let keys = FixedKeys::default();
    let access = Access::with_fetcher(config(false, true), &keys);
    assert!(matches!(
        access
            .email_at(&headers(None, Some(&format!("{header}.{rest}"))), now())
            .await,
        Err(AccessError::UnsupportedAlgorithm)
    ));
}

#[tokio::test]
async fn header_and_jwt_emails() {
    let signer = Signer::new("k1");
    let keys = FixedKeys::default();
    keys.keys.lock().unwrap().push(signer.jwk());
    let access = Access::with_fetcher(config(true, true), &keys);
    let jwt = signer.sign(&claims());

    assert_eq!(
        access
            .email_at(&headers(Some(" USER@example.com"), Some(&jwt)), now())
            .await
            .unwrap(),
        "user@example.com"
    );

    assert!(matches!(
        access
            .email_at(&headers(Some("other@example.com"), Some(&jwt)), now())
            .await,
        Err(AccessError::EmailMismatch)
    ));

    assert!(matches!(
        access.email_at(&headers(None, Some(&jwt)), now()).await,
        Err(AccessError::MissingEmail)
    ));

    assert!(matches!(
        access
            .email_at(&headers(Some("user@example.com"), None), now())
            .await,
        Err(AccessError::MissingJwt)
    ));
}

#[tokio::test]
async fn header_only() {
    let keys = FixedKeys::default();
    let access = Access::with_fetcher(config(true, false), &keys);

    assert_eq!(
        access
            .email_at(&headers(Some("User@Example.com"), None), now())
            .await
            .unwrap(),
        "user@example.com"
    );
    assert_eq!(keys.fetches.load(Ordering::SeqCst), 0);

    let access = Access::with_fetcher(config(false, false), &keys);
    assert!(matches!(
        access
            .email_at(&headers(Some("user@example.com"), None), now())
            .await,
        Err(AccessError::Disabled)
    ));
}

#[tokio::test]
async fn jwt_from_cookie() {
    let signer = Signer::new("k1");
    let keys = FixedKeys::default();
    keys.keys.lock().unwrap().push(signer.jwk());
    let access = Access::with_fetcher(config(false, true), &keys);

    let mut headers = HeaderMap::new();
    let cookie = format!("other=1; {JWT_COOKIE}={}", signer.sign(&claims()));
    headers.insert(COOKIE, HeaderValue::from_str(&cookie).unwrap());

    assert_eq!(
        access.email_at(&headers, now()).await.unwrap(),
        "user@example.com"
    );
}

#[tokio::test]
async fn caches_and_refetches_on_unknown_kid() {
    let old = Signer::new("old");
    let new = Signer::new("new");
    let keys = FixedKeys::default();
    keys.keys.lock().unwrap().push(old.jwk());
    let access = Access::with_fetcher(config(false, true), &keys);

    let jwt = old.sign(&claims());
    for _ in 0..2 {
        access
            .email_at(&headers(None, Some(&jwt)), now())
            .await
            .unwrap();
    }
    assert_eq!(keys.fetches.load(Ordering::SeqCst), 1);

    // Rotation: an unknown kid is refetched, but not more than once per interval.
    keys.keys.lock().unwrap().push(new.jwk());
    access.cache.lock().unwrap().attempted_at = None;
    let jwt = new.sign(&claims());
    access
        .email_at(&headers(None, Some(&jwt)), now())
        .await
        .unwrap();
    assert_eq!(keys.fetches.load(Ordering::SeqCst), 2);

    let unknown = Signer::new("unknown").sign(&claims());
    assert!(matches!(
        access.email_at(&headers(None, Some(&unknown)), now()).await,
        Err(AccessError::UnknownKey)
    ));
    assert_eq!(keys.fetches.load(Ordering::SeqCst), 2);
}

#[tokio::test]
async fn not_yet_valid_within_leeway() {
    let signer = Signer::new("k1");
    let mut claims = claims();
    claims["nbf"] = json!(now().as_second() + LEEWAY_SECONDS - 1);
    assert_eq!(check(&signer, claims).await.unwrap(), "user@example.com");

    let mut claims = self::claims();
    claims.as_object_mut().unwrap().remove("nbf");
    assert_eq!(check(&signer, claims).await.unwrap(), "user@example.com");
}

#[tokio::test]
async fn failed_fetch_is_not_retried_at_once() {
    let signer = Signer::new("k1");
    let keys = FixedKeys::default();
    keys.keys.lock().unwrap().push(signer.jwk());
    keys.failing.store(true, Ordering::SeqCst);
    let access = Access::with_fetcher(config(false, true), &keys);

    let jwt = signer.sign(&claims());
    assert!(matches!(
        access.email_at(&headers(None, Some(&jwt)), now()).await,
        Err(AccessError::Fetch(_))
    ));

    // Any kid, even a forged one, waits out the interval.
    let forged = Signer::new("forged").sign(&claims());
    for jwt in [&jwt, &forged] {
        assert!(matches!(
            access.email_at(&headers(None, Some(jwt)), now()).await,
            Err(AccessError::FetchFailedRecently)
        ));
    }
    assert_eq!(keys.fetches.load(Ordering::SeqCst), 1);

    keys.failing.store(false, Ordering::SeqCst);
    access.cache.lock().unwrap().attempted_at = None;
    access
        .email_at(&headers(None, Some(&jwt)), now())
        .await
        .unwrap();
    assert_eq!(keys.fetches.load(Ordering::SeqCst), 2);
}

#[tokio::test]
async fn concurrent_requests_share_a_fetch() {
    let signer = Signer::new("k1");
    let keys = FixedKeys::default();
    keys.keys.lock().unwrap().push(signer.jwk());
    let access = Access::with_fetcher(config(false, true), &keys);

    let headers = headers(None, Some(&signer.sign(&claims())));
    let (a, b, c) = tokio::join!(
        access.email_at(&headers, now()),
        access.email_at(&headers, now()),
        access.email_at(&headers, now()),
    );

    for email in [a, b, c] {
        assert_eq!(email.unwrap(), "user@example.com");
    }
    assert_eq!(keys.fetches.load(Ordering::SeqCst), 1);
}

#[test]
fn parses_key_set() {
    let body = br#"{
        "keys": [
            { "kid": "a", "kty": "RSA", "alg": "RS256", "use": "sig", "e": "AQAB", "n": "AKs" },
            { "kid": "b", "kty": "EC", "crv": "P-256", "x": "AA", "y": "AA" }
        ],
        "public_cert": { "kid": "a", "cert": "" }
    }"#;

    let keys = parse_jwks(body).unwrap();
    assert_eq!(keys.len(), 1);
    assert_eq!(keys[0].kid, "a");
    assert_eq!(keys[0].e, [1, 0, 1]);
    assert_eq!(keys[0].n, [0, 0xab]);
}