pas-external 4.0.2

Ppoppo Accounts System (PAS) external SDK -- OAuth2 PKCE, PASETO verification, Axum middleware, session liveness
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 axum::Router;
use axum::extract::{Form, Query, State};
use axum::http::{HeaderMap, StatusCode, header::USER_AGENT};
use axum::response::{IntoResponse, Redirect, Response};
use axum::routing::{get, post};
use axum_extra::extract::PrivateCookieJar;
use serde::Deserialize;

use super::cookies;
use super::state::AuthState;
use super::traits::{AccountResolver, SessionStore};
use super::types::NewSession;
use crate::types::PpnumId;

const ROUTE_LOGIN: &str = "/login";
const ROUTE_CALLBACK: &str = "/callback";
const ROUTE_LOGOUT: &str = "/logout";
const ROUTE_DEV_LOGIN: &str = "/dev-login";
const HEADER_X_FORWARDED_FOR: &str = "x-forwarded-for";
const HEADER_X_REAL_IP: &str = "x-real-ip";
const DEFAULT_DEV_PPNUM: &str = "77700000001";

/// Build the PAS authentication router from a prepared [`AuthState`].
///
/// Called by [`super::auth::PasAuth::new`]; not part of the public API.
pub(super) fn build_router<U, S>(state: AuthState<U, S>) -> Router
where
    U: AccountResolver,
    S: SessionStore,
{
    let auth_path = state.settings.auth_path.clone();

    let mut router = Router::new()
        .route(&format!("{auth_path}{ROUTE_LOGIN}"), get(login::<U, S>))
        .route(
            &format!("{auth_path}{ROUTE_CALLBACK}"),
            get(callback_query::<U, S>).post(callback_form::<U, S>),
        )
        .route(&format!("{auth_path}{ROUTE_LOGOUT}"), post(logout::<U, S>));

    if state.settings.dev_login_enabled {
        router = router.route(
            &format!("{auth_path}{ROUTE_DEV_LOGIN}"),
            get(dev_login::<U, S>),
        );
    }

    router.with_state(state)
}

// ── Login ──────────────────────────────────────────────────────────

async fn login<U: AccountResolver, S: SessionStore>(
    State(state): State<AuthState<U, S>>,
    jar: PrivateCookieJar,
) -> Result<(PrivateCookieJar, Redirect), Response> {
    let auth_req = state.client.authorization_url();

    let (pkce_cookie, state_cookie) = cookies::pkce_cookies(
        &auth_req.code_verifier,
        &auth_req.state,
        state.settings.secure_cookies,
        &state.settings.auth_path,
    );

    let jar = jar.add(pkce_cookie).add(state_cookie);

    Ok((jar, Redirect::to(&auth_req.url)))
}

// ── Callback ───────────────────────────────────────────────────────

#[derive(Deserialize)]
struct CallbackParams {
    code: Option<String>,
    state: Option<String>,
    error: Option<String>,
    error_description: Option<String>,
}

async fn callback_query<U: AccountResolver, S: SessionStore>(
    State(state): State<AuthState<U, S>>,
    jar: PrivateCookieJar,
    Query(params): Query<CallbackParams>,
    headers: HeaderMap,
) -> (PrivateCookieJar, Response) {
    let xff_skip = state.settings.xff_trusted_proxies;
    process_callback(state, jar, params, headers, xff_skip).await
}

async fn callback_form<U: AccountResolver, S: SessionStore>(
    State(state): State<AuthState<U, S>>,
    jar: PrivateCookieJar,
    headers: HeaderMap,
    Form(params): Form<CallbackParams>,
) -> (PrivateCookieJar, Response) {
    let xff_skip = state.settings.xff_trusted_proxies;
    process_callback(state, jar, params, headers, xff_skip).await
}

async fn process_callback<U: AccountResolver, S: SessionStore>(
    state: AuthState<U, S>,
    jar: PrivateCookieJar,
    params: CallbackParams,
    headers: HeaderMap,
    xff_skip: usize,
) -> (PrivateCookieJar, Response) {
    // Any error path must clear PKCE + state cookies alongside the redirect
    // so a stale verifier or stored state can't outlive a failed attempt and
    // get replayed on the next callback.
    let fail = |jar: PrivateCookieJar, code: &str| -> (PrivateCookieJar, Response) {
        let (clear_pkce, clear_state) = cookies::clear_pkce_cookies(&state.settings.auth_path);
        let jar = jar.add(clear_pkce).add(clear_state);
        (jar, error_redirect(&state.settings.error_redirect, code))
    };

    if let Some(error) = &params.error {
        let desc = params
            .error_description
            .as_deref()
            .unwrap_or("Unknown error");
        tracing::warn!(error = %error, description = %desc, "OAuth2 error from PAS");
        return fail(jar, desc);
    }

    let Some(code) = params.code else {
        return fail(jar, "missing_code");
    };
    let Some(received_state) = params.state else {
        return fail(jar, "state_mismatch");
    };
    let Some(stored_state) = cookies::get_state(&jar) else {
        return fail(jar, "state_mismatch");
    };
    if received_state != stored_state {
        tracing::warn!("OAuth state mismatch");
        return fail(jar, "state_mismatch");
    }
    let Some(code_verifier) = cookies::get_pkce_verifier(&jar) else {
        return fail(jar, "missing_verifier");
    };

    let token_response = match state.client.exchange_code(&code, &code_verifier).await {
        Ok(t) => t,
        Err(e) => {
            tracing::error!(error = %e, "Token exchange failed");
            return fail(jar, "token_exchange_failed");
        }
    };

    let user_info = match state
        .client
        .get_user_info(&token_response.access_token)
        .await
    {
        Ok(u) => u,
        Err(e) => {
            tracing::error!(error = %e, "Userinfo request failed");
            return fail(jar, "userinfo_failed");
        }
    };

    let ppnum_id = user_info.sub;

    let user_id = match state
        .account_resolver
        .resolve(&ppnum_id, &user_info.ppnum)
        .await
    {
        Ok(id) => id,
        Err(e) => {
            tracing::error!(error = %e, "Account resolution failed");
            return fail(jar, "account_resolution_failed");
        }
    };

    // M1 — encrypt before crossing the SDK→consumer boundary. Plaintext never
    // reaches `SessionStore::create`. If the cipher is not configured (not
    // recommended outside DEV_AUTH), we drop the token entirely so consumers
    // cannot accidentally persist it as plaintext.
    let encrypted_refresh = match (
        state.settings.refresh_token_cipher.as_ref(),
        token_response.refresh_token.as_deref(),
    ) {
        (Some(cipher), Some(rt)) => match cipher.encrypt_to_token(rt) {
            Ok(ct) => Some(ct),
            Err(e) => {
                // Encryption failure is unrecoverable for THIS session — but
                // the user is otherwise authenticated. Fail loudly so we
                // don't silently break liveness for them later.
                tracing::error!(error = %e, "refresh_token encryption failed");
                return fail(jar, "refresh_token_encryption_failed");
            }
        },
        _ => None,
    };

    // sv claim is exposed by PAS via `UserInfo::session_version` (3.1.0+).
    // Snapshotted here so SvAwareSessionResolver can detect break-glass /
    // lifecycle-driven invalidation per STANDARDS_AUTH_INVALIDATION §5.
    let sv = user_info.session_version;

    let session = NewSession {
        ppnum_id,
        user_id,
        refresh_token: encrypted_refresh,
        user_agent: extract_user_agent(&headers),
        ip_address: extract_client_ip(&headers, xff_skip),
        user_info,
        sv,
    };

    let session_id = match state.session_store.create(session).await {
        Ok(id) => id,
        Err(e) => {
            tracing::error!(error = %e, "Session creation failed");
            return fail(jar, "session_failed");
        }
    };

    let session_cookie = cookies::session_cookie(
        &state.settings.session_cookie_name,
        &session_id.to_string(),
        state.settings.session_ttl_days,
        state.settings.secure_cookies,
    );

    let (clear_pkce, clear_state) = cookies::clear_pkce_cookies(&state.settings.auth_path);

    let jar = jar.add(session_cookie).add(clear_pkce).add(clear_state);

    tracing::info!(session_id = %session_id, "PAS OAuth2 login successful");

    (
        jar,
        Redirect::to(&state.settings.login_redirect).into_response(),
    )
}

// ── Logout ─────────────────────────────────────────────────────────

async fn logout<U: AccountResolver, S: SessionStore>(
    State(state): State<AuthState<U, S>>,
    jar: PrivateCookieJar,
) -> (PrivateCookieJar, Redirect) {
    if let Some(cookie) = jar.get(&state.settings.session_cookie_name) {
        let session_id = crate::types::SessionId(cookie.value().to_string());
        if let Err(e) = state.session_store.delete(&session_id).await {
            tracing::error!(
                error = %e,
                session_id = %session_id,
                "Session deletion failed during logout — session may persist in store"
            );
        }
    }

    let clear_cookie = cookies::clear_session_cookie(&state.settings.session_cookie_name);
    (
        jar.remove(clear_cookie),
        Redirect::to(&state.settings.logout_redirect),
    )
}

// ── Dev Login ──────────────────────────────────────────────────────

#[derive(Deserialize)]
struct DevLoginParams {
    ppnum: Option<String>,
}

async fn dev_login<U: AccountResolver, S: SessionStore>(
    State(state): State<AuthState<U, S>>,
    jar: PrivateCookieJar,
    Query(params): Query<DevLoginParams>,
    headers: HeaderMap,
) -> Result<(PrivateCookieJar, Redirect), Response> {
    let ppnum_raw = params.ppnum.as_deref().unwrap_or(DEFAULT_DEV_PPNUM);

    let ppnum: crate::types::Ppnum = ppnum_raw
        .parse()
        .map_err(|_| (StatusCode::BAD_REQUEST, "Invalid ppnum for dev login").into_response())?;

    let ppnum_id: PpnumId = format!("{ppnum_raw:0>26}")
        .parse()
        .map_err(|_| (StatusCode::BAD_REQUEST, "Invalid ppnum for dev login").into_response())?;

    let user_info = crate::oauth::UserInfo::new(ppnum_id, ppnum)
        .with_email(format!("{ppnum_raw}@dev.local"))
        .with_email_verified(true);

    let user_id = state
        .account_resolver
        .resolve(&ppnum_id, &user_info.ppnum)
        .await
        .map_err(|e| {
            tracing::error!(error = %e, "Dev account resolution failed");
            (StatusCode::INTERNAL_SERVER_ERROR, "Dev login failed").into_response()
        })?;

    let xff_skip = state.settings.xff_trusted_proxies;
    let session = NewSession {
        ppnum_id,
        user_id,
        refresh_token: None,
        user_agent: extract_user_agent(&headers),
        ip_address: extract_client_ip(&headers, xff_skip),
        user_info,
        // DEV_AUTH bypasses the OAuth /token round-trip, so no real
        // `sv` claim exists. SvAwareSessionResolver admits sessions
        // with `sv = None` unconditionally per spec §4.2.1.
        sv: None,
    };

    let session_id = state.session_store.create(session).await.map_err(|e| {
        tracing::error!(error = %e, "Dev session creation failed");
        (StatusCode::INTERNAL_SERVER_ERROR, "Dev login failed").into_response()
    })?;

    let session_cookie = cookies::session_cookie(
        &state.settings.session_cookie_name,
        &session_id.to_string(),
        state.settings.session_ttl_days,
        state.settings.secure_cookies,
    );

    tracing::info!(session_id = %session_id, "Dev login successful");

    Ok((
        jar.add(session_cookie),
        Redirect::to(&state.settings.login_redirect),
    ))
}

// ── Helpers ────────────────────────────────────────────────────────

fn error_redirect(error_redirect: &str, code: &str) -> Response {
    let encoded = urlencoding::encode(code);
    Redirect::to(&format!("{error_redirect}?error={encoded}")).into_response()
}

fn extract_user_agent(headers: &HeaderMap) -> Option<String> {
    headers
        .get(USER_AGENT)
        .and_then(|v| v.to_str().ok())
        .map(|s| s.to_string())
}

/// Extract the client IP, walking `X-Forwarded-For` from the right and skipping
/// `xff_skip` trusted-proxy entries first. Falls back to `X-Real-IP` if XFF is
/// absent. See [`PasAuthConfig::with_xff_trusted_proxies`] for how to choose
/// the skip count for your deployment.
fn extract_client_ip(headers: &HeaderMap, xff_skip: usize) -> Option<String> {
    if let Some(xff) = headers.get(HEADER_X_FORWARDED_FOR).and_then(|v| v.to_str().ok()) {
        // Collect entries left-to-right, then take the (xff_skip + 1)-th from the
        // right. With xff_skip = 0 this is the rightmost (single trusted proxy);
        // with xff_skip = 2 this skips two proxy hops (e.g., GFE + GKE LB).
        let entries: Vec<&str> = xff.split(',').map(str::trim).filter(|s| !s.is_empty()).collect();
        if !entries.is_empty() {
            let idx = entries.len().saturating_sub(xff_skip + 1);
            return Some(entries[idx].to_string());
        }
    }
    headers
        .get(HEADER_X_REAL_IP)
        .and_then(|v| v.to_str().ok())
        .map(|s| s.trim().to_string())
}

#[cfg(test)]
#[allow(clippy::unwrap_used)]
mod tests {
    use super::*;
    use axum::http::HeaderValue;

    fn xff(value: &str) -> HeaderMap {
        let mut h = HeaderMap::new();
        h.insert(HEADER_X_FORWARDED_FOR, HeaderValue::from_str(value).unwrap());
        h
    }

    #[test]
    fn xff_skip_0_returns_rightmost() {
        let h = xff("203.0.113.1, 198.51.100.2, 10.0.0.1");
        assert_eq!(extract_client_ip(&h, 0).as_deref(), Some("10.0.0.1"));
    }

    #[test]
    fn xff_skip_1_returns_second_from_right() {
        let h = xff("203.0.113.1, 198.51.100.2, 10.0.0.1");
        assert_eq!(extract_client_ip(&h, 1).as_deref(), Some("198.51.100.2"));
    }

    #[test]
    fn xff_skip_2_returns_third_from_right() {
        let h = xff("203.0.113.1, 198.51.100.2, 10.0.0.1");
        assert_eq!(extract_client_ip(&h, 2).as_deref(), Some("203.0.113.1"));
    }

    #[test]
    fn xff_skip_clamped_to_leftmost() {
        // Skip more than we have → clamp to leftmost (the original client).
        let h = xff("203.0.113.1, 198.51.100.2, 10.0.0.1");
        assert_eq!(extract_client_ip(&h, 99).as_deref(), Some("203.0.113.1"));
    }

    #[test]
    fn x_real_ip_fallback_when_no_xff() {
        let mut h = HeaderMap::new();
        h.insert(HEADER_X_REAL_IP, HeaderValue::from_static("203.0.113.7"));
        assert_eq!(extract_client_ip(&h, 0).as_deref(), Some("203.0.113.7"));
    }

    #[test]
    fn empty_headers_yield_none() {
        assert_eq!(extract_client_ip(&HeaderMap::new(), 0), None);
    }

    #[test]
    fn whitespace_around_entries_is_trimmed() {
        let h = xff("  203.0.113.1  ,  10.0.0.1  ");
        assert_eq!(extract_client_ip(&h, 0).as_deref(), Some("10.0.0.1"));
        assert_eq!(extract_client_ip(&h, 1).as_deref(), Some("203.0.113.1"));
    }
}