modo-rs 0.8.0

Rust web framework for small monolithic apps
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

use serde::Deserialize;

/// Top-level OAuth configuration, typically loaded from the application YAML config.
///
/// Each field corresponds to a provider. Set the field to `None` to disable that provider.
///
/// # Example (YAML)
///
/// ```yaml
/// oauth:
///   google:
///     client_id: "${GOOGLE_CLIENT_ID}"
///     client_secret: "${GOOGLE_CLIENT_SECRET}"
///     redirect_uri: "https://example.com/auth/google/callback"
///   github:
///     client_id: "${GITHUB_CLIENT_ID}"
///     client_secret: "${GITHUB_CLIENT_SECRET}"
///     redirect_uri: "https://example.com/auth/github/callback"
/// ```
#[non_exhaustive]
#[derive(Debug, Clone, Deserialize, Default)]
#[serde(default)]
pub struct OAuthConfig {
    /// Google OAuth 2.0 provider configuration. `None` disables Google login.
    pub google: Option<OAuthProviderConfig>,
    /// GitHub OAuth 2.0 provider configuration. `None` disables GitHub login.
    pub github: Option<OAuthProviderConfig>,
}

/// Per-provider OAuth 2.0 credentials and settings.
#[non_exhaustive]
#[derive(Debug, Clone, Deserialize)]
pub struct OAuthProviderConfig {
    /// OAuth application client ID.
    pub client_id: String,
    /// OAuth application client secret.
    pub client_secret: String,
    /// Redirect URI registered with the OAuth provider.
    pub redirect_uri: String,
    /// Optional list of scopes to request. Falls back to sensible provider defaults when empty.
    #[serde(default)]
    pub scopes: Vec<String>,
}

impl OAuthProviderConfig {
    /// Create a provider configuration with the given credentials.
    pub fn new(
        client_id: impl Into<String>,
        client_secret: impl Into<String>,
        redirect_uri: impl Into<String>,
    ) -> Self {
        Self {
            client_id: client_id.into(),
            client_secret: client_secret.into(),
            redirect_uri: redirect_uri.into(),
            scopes: Vec::new(),
        }
    }
}

/// Query parameters delivered by the OAuth provider to the callback route.
///
/// Deserialize this from the request query string with axum's `Query<CallbackParams>`.
#[non_exhaustive]
#[derive(Debug, Clone, Deserialize)]
pub struct CallbackParams {
    /// Authorization code returned by the provider.
    pub code: String,
    /// Opaque state value — must match the nonce stored in the OAuth cookie.
    pub state: String,
}