rustauth-plugins 0.2.0

Official RustAuth plugin modules.
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
use std::sync::{Arc, Mutex};
use std::time::{Duration, Instant};

use http::{header, Method, Request, StatusCode};
use rustauth_core::api::{core_auth_async_endpoints, AuthRouter};
use rustauth_core::context::create_auth_context_with_adapter;
use rustauth_core::db::{DbAdapter, DbRecord, DbValue, FindOne, MemoryAdapter, Where};
use rustauth_core::error::RustAuthError;
use rustauth_core::options::{AdvancedOptions, RustAuthOptions, TrustedOriginOptions};
use rustauth_plugins::magic_link::{
    default_key_hasher, magic_link, MagicLinkEmail, MagicLinkOptions, TokenStorage,
};

mod failure_redirects;
mod rate_limit;
mod support;
mod token_generation;
mod upstream_parity;

use support::{
    build_router, get, json_body, options, post_json, seed_user, sender, sent_messages,
    set_cookie_values, SECRET,
};

#[tokio::test]
async fn exposes_magic_link_plugin_metadata() -> Result<(), Box<dyn std::error::Error>> {
    let sent = sent_messages();
    let plugin = magic_link(options(sent.clone()));

    assert_eq!(
        rustauth_plugins::magic_link::UPSTREAM_PLUGIN_ID,
        "magic-link"
    );
    assert_eq!(plugin.id, "magic-link");
    assert_eq!(plugin.version.as_deref(), Some(rustauth_plugins::VERSION));
    assert_eq!(plugin.endpoints.len(), 2);
    assert_eq!(plugin.rate_limit.len(), 2);
    Ok(())
}

#[tokio::test]
async fn sends_magic_link_with_url_and_metadata() -> Result<(), Box<dyn std::error::Error>> {
    let sent = sent_messages();
    let (router, _adapter) =
        build_router(sent.clone(), MagicLinkOptions::new(sender(sent.clone())))?;

    let response = post_json(
        &router,
        "/api/auth/sign-in/magic-link",
        r#"{"email":"Ada@Example.COM","metadata":{"inviteId":"123"}}"#,
    )
    .await?;

    assert_eq!(response.status(), StatusCode::OK);
    assert_eq!(json_body(&response)?["status"], true);
    let message = last_message(&sent).await?;
    assert_eq!(message.email, "Ada@Example.COM");
    assert!(message
        .url
        .starts_with("http://localhost:3000/api/auth/magic-link/verify?"));
    let metadata = message.metadata.as_ref().ok_or("missing metadata")?;
    assert_eq!(metadata["inviteId"], "123");
    Ok(())
}

#[tokio::test]
async fn sign_in_returns_before_slow_magic_link_sender_completes(
) -> Result<(), Box<dyn std::error::Error>> {
    let sent = sent_messages();
    let captured = Arc::clone(&sent);
    let options = MagicLinkOptions::new(move |email| {
        let captured = Arc::clone(&captured);
        Box::pin(async move {
            tokio::time::sleep(Duration::from_millis(250)).await;
            captured
                .lock()
                .map_err(|_| RustAuthError::Api("sent messages lock poisoned".to_owned()))?
                .push(email);
            Ok(())
        })
    });
    let (router, _adapter) = build_router(sent.clone(), options)?;

    let started = Instant::now();
    let response = post_json(
        &router,
        "/api/auth/sign-in/magic-link",
        r#"{"email":"slow-magic@example.com"}"#,
    )
    .await?;

    assert_eq!(response.status(), StatusCode::OK);
    assert!(
        started.elapsed() < Duration::from_millis(150),
        "magic-link response waited for slow sender"
    );
    let message = support::last_sent_token(&sent).await?;
    assert!(!message.is_empty());
    Ok(())
}

#[tokio::test]
async fn verifies_magic_link_creates_session_and_sets_cookie(
) -> Result<(), Box<dyn std::error::Error>> {
    let sent = sent_messages();
    let (router, adapter) = build_router(sent.clone(), options(sent.clone()))?;
    seed_user(&adapter, "user_1", "Ada", "ada@example.com", true).await?;

    post_json(
        &router,
        "/api/auth/sign-in/magic-link",
        r#"{"email":"ada@example.com"}"#,
    )
    .await?;
    let token = token_from_last_message(&sent).await?;
    let response = get(
        &router,
        &format!("/api/auth/magic-link/verify?token={token}"),
    )
    .await?;

    assert_eq!(response.status(), StatusCode::OK);
    let body = json_body(&response)?;
    assert!(body["token"]
        .as_str()
        .is_some_and(|value| !value.is_empty()));
    assert_eq!(body["user"]["email"], "ada@example.com");
    assert!(set_cookie_values(&response)
        .iter()
        .any(|cookie| cookie.starts_with("rustauth.session_token=")));
    assert_eq!(adapter.len("session").await, 1);
    Ok(())
}

#[tokio::test]
async fn rejects_reused_expired_and_invalid_tokens() -> Result<(), Box<dyn std::error::Error>> {
    let sent = sent_messages();
    let (router, adapter) = build_router(sent.clone(), options(sent.clone()))?;
    seed_user(&adapter, "user_1", "Ada", "ada@example.com", true).await?;

    post_json(
        &router,
        "/api/auth/sign-in/magic-link",
        r#"{"email":"ada@example.com"}"#,
    )
    .await?;
    let token = token_from_last_message(&sent).await?;
    let first = get(
        &router,
        &format!("/api/auth/magic-link/verify?token={token}"),
    )
    .await?;
    assert_eq!(first.status(), StatusCode::OK);

    let reused = get(
        &router,
        &format!("/api/auth/magic-link/verify?token={token}"),
    )
    .await?;
    assert_redirect_error(&reused, "ATTEMPTS_EXCEEDED")?;

    let invalid = get(&router, "/api/auth/magic-link/verify?token=missing").await?;
    assert_redirect_error(&invalid, "INVALID_TOKEN")?;

    let short_lived =
        MagicLinkOptions::new(sender(sent.clone())).expires_in(time::Duration::seconds(1));
    let (router, _adapter) = build_router(sent.clone(), short_lived)?;
    post_json(
        &router,
        "/api/auth/sign-in/magic-link",
        r#"{"email":"ada@example.com"}"#,
    )
    .await?;
    let expired_token = token_from_last_message(&sent).await?;
    // Token TTL is 1s (`expires_in(1)`). Brief buffer is enough for expiry checks.
    tokio::time::sleep(std::time::Duration::from_millis(1_100)).await;
    let expired = get(
        &router,
        &format!("/api/auth/magic-link/verify?token={expired_token}"),
    )
    .await?;
    assert_redirect_error(&expired, "EXPIRED_TOKEN")?;
    Ok(())
}

#[tokio::test]
async fn missing_or_empty_verify_token_redirects_with_invalid_token(
) -> Result<(), Box<dyn std::error::Error>> {
    let sent = sent_messages();
    let (router, _adapter) = build_router(sent.clone(), options(sent))?;

    let missing = get(&router, "/api/auth/magic-link/verify").await?;
    assert_redirect_error(&missing, "INVALID_TOKEN")?;

    let empty = get(&router, "/api/auth/magic-link/verify?token=").await?;
    assert_redirect_error(&empty, "INVALID_TOKEN")?;
    Ok(())
}

#[tokio::test]
async fn signs_up_new_users_and_can_disable_sign_up() -> Result<(), Box<dyn std::error::Error>> {
    let sent = sent_messages();
    let (router, adapter) = build_router(sent.clone(), options(sent.clone()))?;

    post_json(
        &router,
        "/api/auth/sign-in/magic-link",
        r#"{"email":"new@example.com","name":"New User"}"#,
    )
    .await?;
    let token = token_from_last_message(&sent).await?;
    let response = get(
        &router,
        &format!("/api/auth/magic-link/verify?token={token}"),
    )
    .await?;
    assert_eq!(response.status(), StatusCode::OK);

    let user = find_user(&adapter, "new@example.com")
        .await?
        .ok_or("missing new user")?;
    assert_eq!(
        user.get("name"),
        Some(&DbValue::String("New User".to_owned()))
    );
    assert_eq!(user.get("email_verified"), Some(&DbValue::Boolean(true)));

    let disabled = MagicLinkOptions::new(sender(sent.clone())).disable_sign_up(true);
    let (router, _adapter) = build_router(sent.clone(), disabled)?;
    post_json(
        &router,
        "/api/auth/sign-in/magic-link",
        r#"{"email":"blocked@example.com"}"#,
    )
    .await?;
    let token = token_from_last_message(&sent).await?;
    let response = get(
        &router,
        &format!("/api/auth/magic-link/verify?token={token}"),
    )
    .await?;
    assert_redirect_error(&response, "new_user_signup_disabled")?;
    Ok(())
}

#[tokio::test]
async fn verified_unverified_user_session_persists_through_get_session(
) -> Result<(), Box<dyn std::error::Error>> {
    let sent = sent_messages();
    let (router, adapter) = build_router(sent.clone(), options(sent.clone()))?;
    seed_user(&adapter, "user_1", "Ada", "ada@example.com", false).await?;

    post_json(
        &router,
        "/api/auth/sign-in/magic-link",
        r#"{"email":"ada@example.com"}"#,
    )
    .await?;
    let token = token_from_last_message(&sent).await?;
    let verify = get(
        &router,
        &format!("/api/auth/magic-link/verify?token={token}"),
    )
    .await?;
    assert_eq!(verify.status(), StatusCode::OK);
    let cookies = set_cookie_values(&verify);
    let cookie = cookies
        .iter()
        .find_map(|value| value.split(';').next())
        .ok_or("missing session cookie")?;

    let session = router
        .handle_async(
            Request::builder()
                .method(Method::GET)
                .uri("http://localhost:3000/api/auth/get-session")
                .header(header::COOKIE, cookie)
                .body(Vec::new())?,
        )
        .await?;
    let body = json_body(&session)?;

    assert_eq!(session.status(), StatusCode::OK);
    assert_eq!(body["user"]["emailVerified"], true);
    assert_eq!(body["user"]["email"], "ada@example.com");
    Ok(())
}

#[tokio::test]
async fn verifies_existing_unverified_user() -> Result<(), Box<dyn std::error::Error>> {
    let sent = sent_messages();
    let (router, adapter) = build_router(sent.clone(), options(sent.clone()))?;
    seed_user(&adapter, "user_1", "Ada", "ada@example.com", false).await?;

    post_json(
        &router,
        "/api/auth/sign-in/magic-link",
        r#"{"email":"ada@example.com"}"#,
    )
    .await?;
    let token = token_from_last_message(&sent).await?;
    let response = get(
        &router,
        &format!("/api/auth/magic-link/verify?token={token}"),
    )
    .await?;

    assert_eq!(response.status(), StatusCode::OK);
    assert_eq!(json_body(&response)?["user"]["emailVerified"], true);
    let user = find_user(&adapter, "ada@example.com")
        .await?
        .ok_or("missing verified user")?;
    assert_eq!(user.get("email_verified"), Some(&DbValue::Boolean(true)));
    Ok(())
}

#[tokio::test]
async fn concurrent_verify_mints_only_one_session() -> Result<(), Box<dyn std::error::Error>> {
    let sent = sent_messages();
    let (router, adapter) = build_router(sent.clone(), options(sent.clone()))?;
    seed_user(&adapter, "user_1", "Ada", "ada@example.com", true).await?;

    post_json(
        &router,
        "/api/auth/sign-in/magic-link",
        r#"{"email":"ada@example.com"}"#,
    )
    .await?;
    let token = token_from_last_message(&sent).await?;
    let path = format!("/api/auth/magic-link/verify?token={token}");
    let sessions_before = adapter.len("session").await;

    let (first, second) = tokio::join!(get(&router, &path), get(&router, &path));
    let responses = [first?, second?];
    let ok = responses
        .iter()
        .filter(|response| response.status() == StatusCode::OK)
        .count();
    let rejected = responses
        .iter()
        .filter(|response| response.status() == StatusCode::FOUND)
        .count();

    assert_eq!(
        ok, 1,
        "only one concurrent verify should mint a session for the default single attempt"
    );
    assert_eq!(
        rejected, 1,
        "the losing concurrent verify should redirect with an error"
    );
    let rejected_location = responses
        .iter()
        .find(|response| response.status() == StatusCode::FOUND)
        .and_then(|response| response.headers().get(header::LOCATION))
        .and_then(|value| value.to_str().ok())
        .ok_or("missing rejected redirect location")?;
    assert!(
        rejected_location.contains("error=ATTEMPTS_EXCEEDED")
            || rejected_location.contains("error=INVALID_TOKEN"),
        "{rejected_location}"
    );
    assert_eq!(
        adapter.len("session").await,
        sessions_before + 1,
        "only one new session row should be created by concurrent verification"
    );
    Ok(())
}

#[tokio::test]
async fn respects_allowed_attempts_and_unlimited_attempts() -> Result<(), Box<dyn std::error::Error>>
{
    let sent = sent_messages();
    let opts = MagicLinkOptions::new(sender(sent.clone())).allowed_attempts(3);
    let (router, adapter) = build_router(sent.clone(), opts)?;
    seed_user(&adapter, "user_1", "Ada", "ada@example.com", true).await?;

    post_json(
        &router,
        "/api/auth/sign-in/magic-link",
        r#"{"email":"ada@example.com"}"#,
    )
    .await?;
    let token = token_from_last_message(&sent).await?;
    for _ in 0..3 {
        let response = get(
            &router,
            &format!("/api/auth/magic-link/verify?token={token}"),
        )
        .await?;
        assert_eq!(response.status(), StatusCode::OK);
    }
    let fourth = get(
        &router,
        &format!("/api/auth/magic-link/verify?token={token}"),
    )
    .await?;
    assert_redirect_error(&fourth, "ATTEMPTS_EXCEEDED")?;

    let opts = MagicLinkOptions::new(sender(sent.clone())).unlimited_attempts();
    let (router, adapter) = build_router(sent.clone(), opts)?;
    seed_user(&adapter, "user_2", "Grace", "grace@example.com", true).await?;
    post_json(
        &router,
        "/api/auth/sign-in/magic-link",
        r#"{"email":"grace@example.com"}"#,
    )
    .await?;
    let token = token_from_last_message(&sent).await?;
    for _ in 0..5 {
        let response = get(
            &router,
            &format!("/api/auth/magic-link/verify?token={token}"),
        )
        .await?;
        assert_eq!(response.status(), StatusCode::OK);
    }
    Ok(())
}

#[tokio::test]
async fn supports_token_storage_modes() -> Result<(), Box<dyn std::error::Error>> {
    let sent = sent_messages();
    let hashed_opts = MagicLinkOptions::new(sender(sent.clone())).store_token(TokenStorage::Hashed);
    let (router, adapter) = build_router(sent.clone(), hashed_opts)?;
    post_json(
        &router,
        "/api/auth/sign-in/magic-link",
        r#"{"email":"ada@example.com"}"#,
    )
    .await?;
    let token = token_from_last_message(&sent).await?;
    let hashed = default_key_hasher(&token);
    assert!(find_verification(&adapter, &hashed).await?.is_some());

    let custom_opts =
        MagicLinkOptions::new(sender(sent.clone())).store_token(TokenStorage::custom(|token| {
            Box::pin(async move { Ok(format!("{token}:hashed")) })
        }));
    let (router, adapter) = build_router(sent.clone(), custom_opts)?;
    post_json(
        &router,
        "/api/auth/sign-in/magic-link",
        r#"{"email":"ada@example.com"}"#,
    )
    .await?;
    let token = token_from_last_message(&sent).await?;
    assert!(find_verification(&adapter, &format!("{token}:hashed"))
        .await?
        .is_some());
    Ok(())
}

#[tokio::test]
async fn rejects_untrusted_verify_callback_urls() -> Result<(), Box<dyn std::error::Error>> {
    let sent = sent_messages();
    let adapter = Arc::new(MemoryAdapter::new());
    let plugin = magic_link(options(sent.clone()));
    let context = create_auth_context_with_adapter(
        RustAuthOptions {
            base_url: Some("http://localhost:3000".to_owned()),
            trusted_origins: TrustedOriginOptions::Static(vec!["http://localhost:3000".to_owned()]),
            secret: Some(SECRET.to_owned()),
            advanced: AdvancedOptions {
                disable_csrf_check: true,
                disable_origin_check: false,
                ..AdvancedOptions::default()
            },
            plugins: vec![plugin],
            ..RustAuthOptions::default()
        },
        adapter.clone(),
    )?;
    let router =
        AuthRouter::with_async_endpoints(context, Vec::new(), core_auth_async_endpoints())?;

    post_json(
        &router,
        "/api/auth/sign-in/magic-link",
        r#"{"email":"ada@example.com"}"#,
    )
    .await?;
    let token = token_from_last_message(&sent).await?;
    let response = get(
        &router,
        &format!("/api/auth/magic-link/verify?token={token}&callbackURL=http://evil.example"),
    )
    .await?;

    assert_eq!(response.status(), StatusCode::FORBIDDEN);
    assert_eq!(json_body(&response)?["code"], "INVALID_CALLBACK_URL");
    Ok(())
}

async fn last_message(
    sent: &Arc<Mutex<Vec<MagicLinkEmail>>>,
) -> Result<MagicLinkEmail, Box<dyn std::error::Error>> {
    for _ in 0..200 {
        if let Some(message) = sent
            .lock()
            .map_err(|_| "sent messages lock poisoned")?
            .last()
            .cloned()
        {
            return Ok(message);
        }
        tokio::time::sleep(Duration::from_millis(2)).await;
    }
    Err("missing sent magic link".into())
}

async fn token_from_last_message(
    sent: &Arc<Mutex<Vec<MagicLinkEmail>>>,
) -> Result<String, Box<dyn std::error::Error>> {
    Ok(last_message(sent).await?.token)
}

fn assert_redirect_error(
    response: &http::Response<Vec<u8>>,
    error: &str,
) -> Result<(), Box<dyn std::error::Error>> {
    assert_eq!(response.status(), StatusCode::FOUND);
    let location = response
        .headers()
        .get(header::LOCATION)
        .and_then(|value| value.to_str().ok())
        .ok_or("missing location header")?;
    assert!(location.contains(&format!("error={error}")), "{location}");
    Ok(())
}

async fn find_user(
    adapter: &MemoryAdapter,
    email: &str,
) -> Result<Option<DbRecord>, RustAuthError> {
    adapter
        .find_one(
            FindOne::new("user")
                .where_clause(Where::new("email", DbValue::String(email.to_owned()))),
        )
        .await
}

async fn find_verification(
    adapter: &MemoryAdapter,
    identifier: &str,
) -> Result<Option<DbRecord>, RustAuthError> {
    adapter
        .find_one(FindOne::new("verification").where_clause(Where::new(
            "identifier",
            DbValue::String(identifier.to_owned()),
        )))
        .await
}