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

use std::sync::Arc;

use http::{Method, StatusCode};
use rustauth_core::db::MemoryAdapter;
use rustauth_plugins::api_key::{
    api_key, ApiKeyConfiguration, ApiKeyOptions, ApiKeyRateLimitOptions,
};
use serde_json::json;
use time::Duration;

use super::helpers::{request_json, server_request_json, sign_up, test_router};

#[tokio::test]
async fn create_applies_explicit_rate_limit_enabled_false() -> Result<(), Box<dyn std::error::Error>>
{
    let router = test_router(
        Arc::new(MemoryAdapter::new()),
        api_key(
            ApiKeyOptions::builder()
                .configuration(ApiKeyConfiguration::default())
                .build()?,
        )?,
    )?;
    let user = sign_up(&router, "Rae", "rae-rate-limit@example.com").await?;

    let created = server_request_json(
        &router,
        Method::POST,
        "/api/auth/api-key/create",
        json!({"userId": user.user_id, "rateLimitEnabled": false}),
        None,
        None,
    )
    .await?;
    assert_eq!(created.status, StatusCode::OK);
    assert_eq!(created.body["rateLimitEnabled"], false);
    Ok(())
}

#[tokio::test]
async fn create_defaults_rate_limit_enabled_true_when_omitted(
) -> Result<(), Box<dyn std::error::Error>> {
    let router = test_router(
        Arc::new(MemoryAdapter::new()),
        api_key(
            ApiKeyOptions::builder()
                .configuration(ApiKeyConfiguration::default())
                .build()?,
        )?,
    )?;
    let user = sign_up(&router, "Rem", "rem-rate-limit@example.com").await?;

    let created = server_request_json(
        &router,
        Method::POST,
        "/api/auth/api-key/create",
        json!({"userId": user.user_id}),
        None,
        None,
    )
    .await?;
    assert_eq!(created.status, StatusCode::OK);
    assert_eq!(created.body["rateLimitEnabled"], true);
    Ok(())
}

#[tokio::test]
async fn create_respects_disabled_rate_limit_from_plugin_options(
) -> Result<(), Box<dyn std::error::Error>> {
    let router = test_router(
        Arc::new(MemoryAdapter::new()),
        api_key(
            ApiKeyOptions::builder()
                .configuration(ApiKeyConfiguration {
                    enable_metadata: true,
                    rate_limit: ApiKeyRateLimitOptions {
                        enabled: false,
                        time_window: Duration::seconds(1),
                        max_requests: 10,
                    },
                    ..ApiKeyConfiguration::default()
                })
                .build()?,
        )?,
    )?;
    let user = sign_up(&router, "Rio", "rio-rate-limit@example.com").await?;

    let created = server_request_json(
        &router,
        Method::POST,
        "/api/auth/api-key/create",
        json!({"userId": user.user_id}),
        None,
        None,
    )
    .await?;
    assert_eq!(created.status, StatusCode::OK);
    assert_eq!(created.body["rateLimitEnabled"], false);
    assert_eq!(created.body["rateLimitTimeWindow"], 1_000);
    assert_eq!(created.body["rateLimitMax"], 10);
    Ok(())
}

#[tokio::test]
async fn verify_skips_rate_limit_when_rate_limit_enabled_is_false(
) -> Result<(), Box<dyn std::error::Error>> {
    let router = test_router(
        Arc::new(MemoryAdapter::new()),
        api_key(
            ApiKeyOptions::builder()
                .configuration(ApiKeyConfiguration::default())
                .build()?,
        )?,
    )?;
    let user = sign_up(&router, "Ryn", "ryn-rate-limit@example.com").await?;

    let created = server_request_json(
        &router,
        Method::POST,
        "/api/auth/api-key/create",
        json!({
            "userId": user.user_id,
            "rateLimitEnabled": false,
            "rateLimitMax": 1,
            "rateLimitTimeWindow": 60_000
        }),
        None,
        None,
    )
    .await?;
    assert_eq!(created.status, StatusCode::OK);
    let key = created.body["key"].as_str().ok_or("missing api key")?;

    for _ in 0..3 {
        let verified = request_json(
            &router,
            Method::POST,
            "/api/auth/api-key/verify",
            json!({"key": key}),
            None,
            None,
        )
        .await?;
        assert_eq!(verified.status, StatusCode::OK);
        assert_eq!(verified.body["valid"], true);
    }
    Ok(())
}