rustango 0.65.0

Batteries-included web framework for Rust: ORM + migrations + auto-admin + multi-tenancy + audit log + auth (sessions, JWT, OAuth2/OIDC, HMAC) + APIs (ViewSet, OpenAPI auto-derive, JSON:API) + jobs (in-mem + Postgres) + email + media (S3 / R2 / B2 / MinIO + presigned uploads + collections + tags) + production middleware (CSRF, CSP, rate-limiting, compression, idempotency, etc.).
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
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
//! Tenant-admin SSO — multi-provider OpenID Connect / social OAuth login
//! (`admin-sso` feature).
//!
//! Reuses the shared handshake core in [`crate::admin::sso`]
//! ([`build_provider`], flow sealing) and mints the tenant session
//! (`rustango_tenant_session`) for the tenant user linked to the IdP
//! subject ([`crate::sso::link`]). Sign-up follows the provider's `signup_mode` (default closed).
//!
//! Providers are rows, managed from the admin UI: each tenant's own
//! [`crate::admin::sso_provider::SsoProvider`] table (per-tenant, granular)
//! merged with the registry-wide [`SharedSsoProvider`] set (operator-defined,
//! offered to all tenants). On a slug clash the tenant's row wins. Each
//! provider's client secret is stored encrypted (`Cast<EncryptedString>`)
//! and decrypted only at login. `{login}/sso/{slug}` starts the handshake
//! for one provider.

use axum::{
    http::{header, request::Parts, HeaderValue},
    response::{IntoResponse, Redirect, Response},
};

use crate::admin::sso::{
    open_flow, seal_flow, FlowPurpose, FlowScope, ProviderButton, SsoError, SSO_FLOW_COOKIE,
};
use crate::admin::sso_provider::SsoProvider;
use crate::query::QuerySet;
use crate::signals::auth::{
    meta_from_parts, send_user_logged_in, AuthFailureReason, UserLoggedInContext,
};
use crate::sql::Pool;
use crate::sso::build_provider_for;
use crate::sso::link::{signal_refused, LinkSource, ProviderKey};
use crate::sso::policy::{
    admit, refuse, AdmitRequest, Denied, EffectivePolicy, Identity, PolicyError, RefusalContext,
    SharedOverride, Surface, TenantSettings,
};
use crate::sso::provider::{load_rows, lookup_row, resolve_row, Lookup, ResolvedProvider};

/// The auth-signal `source` for a tenant console SSO sign-in.
const SIGNAL_SOURCE: &str = "tenant_admin_sso";

/// The `?sso_error=` of every refused sign-in: the rule stays server-side.
pub(crate) const REFUSED: &str = "nouser";

/// IdP callback params (`?code=…&state=…` or `?error=…`).
#[derive(serde::Deserialize, Default)]
struct CallbackParams {
    code: Option<String>,
    state: Option<String>,
    error: Option<String>,
}

/// SSO start params: where to land after sign-in, sealed into the flow.
#[derive(serde::Deserialize, Default)]
struct BeginParams {
    next: Option<String>,
}

use super::member_auth;
use super::org::Org;
use super::routes::RouteConfig;
use super::tenant_console::{self, SessionSecret, TenantSessionPayload};

/// A registry-wide SSO provider offered to **every** tenant — the shared
/// counterpart of the per-tenant [`crate::admin::sso_provider::SsoProvider`].
///
/// An operator defines a provider once (in the operator console) and it
/// appears on every tenant's login page. Same fields as the per-tenant
/// model; `scope = "registry"` puts the table in the registry database and
/// hides it from tenant admins (only operators manage the shared set). When
/// a tenant configures a provider with the same `slug`, the tenant's row
/// takes precedence on that tenant's login page.
#[derive(crate::Model, Debug, Clone)]
#[rustango(
    table = "rustango_shared_sso_providers",
    access = "admin_only",
    scope = "registry",
    admin(
        list_display = "slug, label, kind, enabled, sort_order",
        ordering = "sort_order",
        readonly_fields = "created_at, updated_at",
        formfield_overrides = "client_secret: password",
    )
)]
#[allow(dead_code)]
pub struct SharedSsoProvider {
    #[rustango(primary_key)]
    pub id: crate::sql::Auto<i64>,
    #[rustango(max_length = 64, unique)]
    #[rustango(
        help_text = "Short id in this provider's URLs, e.g. `google`: the IdP sends users back to `<login>/sso/<slug>/callback`. Unique; a new slug means a new callback URL at the IdP."
    )]
    #[rustango(verbose_name = "Slug")]
    pub slug: String,
    #[rustango(max_length = 150)]
    #[rustango(help_text = "Text on the sign-in button, e.g. `Sign in with Google`.")]
    #[rustango(verbose_name = "Button label")]
    pub label: String,
    #[rustango(max_length = 32)]
    #[rustango(
        help_text = "`google`, `microsoft`, `github`, `gitlab` or `discord` for a built-in provider, or `oidc` for any other OpenID Connect provider (then fill in the issuer URL)."
    )]
    #[rustango(verbose_name = "Provider kind")]
    pub kind: String,
    #[rustango(max_length = 255)]
    #[rustango(
        help_text = "Only for `oidc`: the issuer URL, e.g. `https://<org>.okta.com` or `https://<host>/realms/<realm>`. The endpoints are read from `<issuer>/.well-known/openid-configuration`; for Microsoft Entra ID use the `microsoft` kind."
    )]
    #[rustango(verbose_name = "Issuer URL")]
    pub issuer_url: Option<String>,
    #[rustango(max_length = 255)]
    #[rustango(
        help_text = "Client ID (application ID) from your identity provider's app registration."
    )]
    #[rustango(verbose_name = "Client ID")]
    pub client_id: String,
    /// The OAuth2 client secret, **encrypted at rest** (see
    /// [`crate::admin::sso_provider::SsoProvider::client_secret`]).
    #[rustango(max_length = 1024)]
    #[rustango(
        help_text = "Client secret from the same app registration. Stored encrypted with `RUSTANGO_SECRET_KEY`."
    )]
    #[rustango(verbose_name = "Client secret")]
    pub client_secret: crate::casts::Cast<crate::casts::EncryptedString>,
    #[rustango(default = "true")]
    #[rustango(help_text = "Show this provider's button on the sign-in page.")]
    #[rustango(verbose_name = "Enabled")]
    pub enabled: bool,
    #[rustango(default = "0")]
    #[rustango(help_text = "Button order on the sign-in page; lower numbers come first.")]
    #[rustango(verbose_name = "Sort order")]
    pub sort_order: i32,
    #[rustango(max_length = 255)]
    #[rustango(
        help_text = "OAuth scopes, space separated, e.g. `openid email profile`. Empty: the kind's default scopes."
    )]
    #[rustango(verbose_name = "Scopes")]
    pub scopes: Option<String>,
    /// See [`SsoProvider::allow_email_link`].
    #[rustango(default = "false")]
    #[rustango(
        help_text = "Security: in every tenant, link a first-time sign-in to the existing account with the same verified email; that account's password stops working, its sessions end, its API keys are deleted and its agent keys are turned off. Never a superuser or a user with any role or permission."
    )]
    #[rustango(verbose_name = "Allow email linking")]
    pub allow_email_link: bool,
    // The access policy: see the same fields on `SsoProvider`.
    #[rustango(max_length = 2000)]
    #[rustango(
        help_text = "Security: only users whose verified email is in these domains may sign in. Comma or newline list: `client.org` is that domain only, `*.client.org` its subdomains only. Empty: any domain."
    )]
    #[rustango(verbose_name = "Allowed email domains")]
    pub allowed_email_domains: Option<String>,
    #[rustango(max_length = 2000)]
    #[rustango(
        help_text = "Users with an email in these domains never sign in, even if the allowed list has them. Same format as the allowed list."
    )]
    #[rustango(verbose_name = "Blocked email domains")]
    pub blocked_email_domains: Option<String>,
    #[rustango(max_length = 1000)]
    #[rustango(
        help_text = "Microsoft Entra directory (tenant) IDs allowed to sign in, comma separated, read from a verified id_token. Empty: any Entra directory can sign in through a `microsoft` provider."
    )]
    #[rustango(verbose_name = "Allowed Microsoft directories")]
    pub allowed_idp_tenants: Option<String>,
    #[rustango(max_length = 1000)]
    #[rustango(
        help_text = "Google Workspace domains (the `hd` claim) allowed to sign in, comma separated, e.g. `client.org`."
    )]
    #[rustango(verbose_name = "Allowed Google Workspace domains")]
    pub allowed_hosted_domains: Option<String>,
    #[rustango(default = "'{}'")]
    #[rustango(
        help_text = "JSON object of claims a sign-in must carry, each holding one of its values: `{\"roles\": [\"App.User\"]}`. `{}`: no claim is required."
    )]
    #[rustango(verbose_name = "Required claims")]
    pub required_claims: serde_json::Value,
    #[rustango(
        max_length = 16,
        choices = "closed:Closed, invite_only:Invite only, allowlist:Allowlist, open:Open"
    )]
    #[rustango(
        help_text = "Security: who gets a new account at first sign-in: `closed` (no one), `invite_only` (an invite for the email), `allowlist` (an invite for the email or its domain) or `open` (anyone the sign-in rules let in). Empty: the sign-in page's default."
    )]
    #[rustango(verbose_name = "Sign-up mode")]
    pub signup_mode: Option<String>,
    #[rustango(max_length = 1000)]
    #[rustango(
        help_text = "Tenant roles a new user gets, comma separated, e.g. `Viewer`. An invite with roles replaces them."
    )]
    #[rustango(verbose_name = "Default roles")]
    pub default_roles: Option<String>,
    #[rustango(default = "'{}'")]
    #[rustango(
        help_text = "JSON object from an IdP group or app role to tenant roles: `{\"Admins\": \"Editor\"}` or `{\"Admins\": [\"Editor\", \"Viewer\"]}`."
    )]
    #[rustango(verbose_name = "Role map")]
    pub role_map: serde_json::Value,
    #[rustango(max_length = 255)]
    #[rustango(help_text = "Claims the role map reads, comma separated. Empty: `groups,roles`.")]
    #[rustango(verbose_name = "Role claims")]
    pub role_claims: Option<String>,
    #[rustango(default = "false")]
    #[rustango(
        help_text = "Apply the role map at every sign-in, not only the first. Only roles named in the role map are added or removed."
    )]
    #[rustango(verbose_name = "Sync roles at every sign-in")]
    pub sync_roles_on_login: bool,
    #[rustango(
        max_length = 24,
        default = "'email_local'",
        choices = "email_local:Email local part, email:Email, preferred_username:Preferred username"
    )]
    #[rustango(
        help_text = "Where a new user's username comes from: the email's local part, the whole email, or the IdP's `preferred_username` (falls back to the local part)."
    )]
    #[rustango(verbose_name = "Username from")]
    pub username_from: String,
    #[rustango(
        max_length = 16,
        default = "'suffix'",
        choices = "suffix:Add a suffix, refuse:Refuse"
    )]
    #[rustango(
        help_text = "What happens when that username is taken: add a short suffix, or refuse the sign-up."
    )]
    #[rustango(verbose_name = "When the username is taken")]
    pub username_clash: String,
    #[rustango(default = "false")]
    #[rustango(
        help_text = "Update the user's name and email from the IdP at every sign-in. Never for a superuser."
    )]
    #[rustango(verbose_name = "Sync name and email")]
    pub sync_profile: bool,
    #[rustango(default = "false")]
    #[rustango(
        help_text = "Security: with email linking on, also link users who hold any role or permission. A superuser is never linked by email."
    )]
    #[rustango(verbose_name = "Allow email linking for staff")]
    pub allow_email_link_staff: bool,
    #[rustango(default = "false")]
    #[rustango(
        help_text = "Users linked through this provider may not sign in with a password, even while the provider is off."
    )]
    #[rustango(verbose_name = "Sign-in only through SSO")]
    pub sso_only: bool,
    #[rustango(
        help_text = "After this many days without use, `sso-deactivate-idle` turns off the users this provider signed up who cannot use a password: SSO only here, or password login off for the tenant. Empty: never."
    )]
    #[rustango(verbose_name = "Deactivate after idle days")]
    pub auto_deactivate_after_days: Option<i32>,
    #[rustango(
        help_text = "Longest session, in seconds, after a sign-in through this provider. Empty: the normal session length."
    )]
    #[rustango(verbose_name = "Session length (seconds)")]
    pub session_ttl_secs: Option<i64>,
    #[rustango(
        help_text = "Longest session, in seconds, for a superuser who signs in through this provider. Empty: the normal session length."
    )]
    #[rustango(verbose_name = "Superuser session length (seconds)")]
    pub superuser_session_ttl_secs: Option<i64>,
    #[rustango(auto_now_add)]
    #[rustango(help_text = "When the row was created. Set by the database.")]
    #[rustango(verbose_name = "Created at")]
    pub created_at: crate::sql::Auto<chrono::DateTime<chrono::Utc>>,
    #[rustango(auto_now)]
    #[rustango(help_text = "When the row last changed. Set on every save.")]
    #[rustango(verbose_name = "Updated at")]
    pub updated_at: crate::sql::Auto<chrono::DateTime<chrono::Utc>>,
}

inventory::submit! {
    crate::admin::derived_fields::AdminDerivedField {
        table: "rustango_shared_sso_providers",
        derive: crate::sso::provider::admin_encrypt_secret,
    }
}

inventory::submit! {
    crate::admin::derived_fields::AdminDerivedField {
        table: "rustango_shared_sso_providers",
        derive: crate::sso::policy::admin_normalise,
    }
}

// A shared row decides sign-in for every tenant.
crate::object_permissions::register_framework_object_permission!(
    "rustango_shared_sso_providers",
    "add",
    crate::object_permissions::superuser_only
);
crate::object_permissions::register_framework_object_permission!(
    "rustango_shared_sso_providers",
    "change",
    crate::object_permissions::superuser_only
);
crate::object_permissions::register_framework_object_permission!(
    "rustango_shared_sso_providers",
    "delete",
    crate::object_permissions::superuser_only
);
crate::object_permissions::register_framework_object_permission!(
    "rustango_shared_sso_providers",
    "view",
    crate::object_permissions::superuser_only
);

/// Enabled providers for this tenant's login page: the tenant's own
/// [`SsoProvider`] rows merged with the registry-wide [`SharedSsoProvider`]
/// set, **tenant-wins** on a slug clash, sorted by `sort_order`. Each button
/// links to `{login_url}/sso/{slug}`. DB errors degrade to an empty list.
pub(crate) async fn list_enabled(
    tenant_pool: &Pool,
    registry_pool: &Pool,
    routes: &RouteConfig,
) -> Vec<ProviderButton> {
    let tenant_rows = load_rows(QuerySet::<SsoProvider>::new(), tenant_pool)
        .await
        .unwrap_or_default();
    let shared_rows = load_rows(QuerySet::<SharedSsoProvider>::new(), registry_pool)
        .await
        .unwrap_or_default();
    merge_provider_buttons(
        &routes.login_url,
        tenant_rows
            .into_iter()
            .map(|r| (r.slug, r.label, r.sort_order, r.enabled)),
        shared_rows
            .into_iter()
            .map(|r| (r.slug, r.label, r.sort_order, r.enabled)),
    )
}

/// Pure merge: tenant providers first (they **win** on a slug clash, a
/// disabled one too), then the registry-wide shared set; disabled rows
/// dropped; result sorted by `sort_order`. Each `(slug, label, sort_order, enabled)`.
fn merge_provider_buttons(
    login_base: &str,
    tenant: impl IntoIterator<Item = (String, String, i32, bool)>,
    shared: impl IntoIterator<Item = (String, String, i32, bool)>,
) -> Vec<ProviderButton> {
    let mut seen = std::collections::HashSet::new();
    let mut out: Vec<(i32, ProviderButton)> = Vec::new();
    for (slug, label, sort_order, enabled) in tenant.into_iter().chain(shared) {
        if seen.insert(slug.clone()) && enabled {
            out.push((
                sort_order,
                ProviderButton {
                    login_url: format!("{login_base}/sso/{slug}"),
                    slug,
                    label,
                },
            ));
        }
    }
    out.sort_by_key(|(o, _)| *o);
    out.into_iter().map(|(_, b)| b).collect()
}

/// Resolve one provider by `slug` — the tenant's own table first, then the
/// registry-wide shared set — with its link key. `Ok(None)` when no enabled
/// row matches, or the tenant's own row for the slug is disabled.
async fn resolve_by_slug(
    tenant_pool: &Pool,
    registry_pool: &Pool,
    slug: &str,
    redirect_uri: String,
) -> Result<Option<(ResolvedProvider, ProviderKey)>, SsoError> {
    match lookup_row::<SsoProvider>(tenant_pool, slug, redirect_uri.clone()).await? {
        Lookup::Enabled(p) => {
            let key = p.key(LinkSource::Tenant);
            return Ok(Some((*p, key)));
        }
        // The tenant's row wins even when disabled: never the shared one.
        Lookup::Disabled => return Ok(None),
        Lookup::Missing => {}
    }
    Ok(
        resolve_row::<SharedSsoProvider>(registry_pool, slug, redirect_uri)
            .await?
            .map(|p| {
                let key = p.key(LinkSource::Shared);
                (p, key)
            }),
    )
}

/// The policy a tenant sign-in through `cfg` runs under: the provider, a
/// tenant override of a shared provider, then the tenant's settings. An
/// unreadable override or settings row refuses.
pub(crate) async fn tenant_policy(
    tenant_pool: &Pool,
    cfg: &ResolvedProvider,
    key: &ProviderKey,
    slug: &str,
    settings: &Result<TenantSettings, PolicyError>,
) -> EffectivePolicy {
    let mut policy = cfg.effective_policy();
    if key.source() == LinkSource::Shared {
        policy = policy.shared_override(SharedOverride::load(tenant_pool, key, slug).await);
    }
    match settings {
        Ok(s) => policy.tenant(s),
        Err(e) => policy.tighten(Err(e.clone())),
    }
}

/// Derive the absolute per-provider callback URL for this tenant from the
/// request — tenants are host-based, so the redirect_uri is per-host +
/// per-slug: `{scheme}://{host}{login_url}/sso/{slug}/callback`. Scheme
/// honors `X-Forwarded-Proto` from a trusted proxy, else `https`.
fn derive_redirect(parts: &Parts, routes: &RouteConfig, slug: &str) -> Option<String> {
    let host = crate::urls::HostAuthority::parse(parts.headers.get(header::HOST)?.to_str().ok()?)?;
    let scheme =
        crate::real_ip::trusted_forwarded(&parts.headers, &parts.extensions, "x-forwarded-proto")
            .unwrap_or("https");
    Some(format!(
        "{scheme}://{host}{}",
        callback_path(&routes.login_url, slug)
    ))
}

/// The IdP callback path for `slug` under the tenant login path.
pub(crate) fn callback_path(login_url: &str, slug: &str) -> String {
    format!("{login_url}/sso/{slug}/callback")
}

/// The login page's text for `?sso_error=`: a fixed message for a known
/// code only, and after a refusal the tenant's own access-denied note.
pub(crate) async fn login_notice(
    tenant_pool: &Pool,
    query: Option<&str>,
) -> Option<(&'static str, Option<String>)> {
    let code = query?
        .split('&')
        .find_map(|p| p.strip_prefix("sso_error="))?;
    let notice = match code {
        REFUSED => "You can't sign in with this account. Ask your administrator for access.",
        "denied" => "The sign-in was cancelled.",
        "expired" | "callback" | "handshake" => "The sign-in did not finish. Please try again.",
        "config" | "disabled" => "This sign-in option is not available right now.",
        _ => return None,
    };
    let note = if code == REFUSED {
        denied_note(tenant_pool).await
    } else {
        None
    };
    Some((notice, note))
}

/// The tenant's `access_denied_message`, if set and readable.
async fn denied_note(pool: &Pool) -> Option<String> {
    TenantSettings::load(pool).await.ok()?.access_denied_message
}

/// Set on the login page's automatic redirect; while it lives the page
/// shows instead, so a session that does not stick cannot loop.
pub(crate) const AUTO_COOKIE: &str = "rustango_sso_auto";

/// The [`AUTO_COOKIE`] header value under `cookie_path`, for 60 seconds.
pub(crate) fn auto_cookie(cookie_path: &str) -> String {
    format!(
        "{AUTO_COOKIE}=1; Path={cookie_path}; HttpOnly; SameSite=Lax; Max-Age=60{}",
        secure_suffix()
    )
}

/// Where the login page sends a visitor straight away: the tenant's
/// default provider, or the only one when the password form is hidden.
/// Never with `?local=1`, after an SSO error or with a flash message, so a
/// refused sign-in does not loop. `shown`: a flash message or a recent
/// automatic redirect.
pub(crate) fn auto_redirect(
    settings: &TenantSettings,
    providers: &[ProviderButton],
    query: Option<&str>,
    shown: bool,
) -> Option<String> {
    let pairs: Vec<&str> = query.unwrap_or("").split('&').collect();
    if shown
        || pairs
            .iter()
            .any(|p| *p == "local=1" || p.starts_with("sso_error="))
    {
        return None;
    }
    let pick = match &settings.default_provider {
        Some(slug) => providers.iter().find(|b| &b.slug == slug),
        None if !settings.shows_password_form(false) && providers.len() == 1 => providers.first(),
        None => None,
    };
    pick.map(|b| b.login_url.clone())
}

fn login_error(routes: &RouteConfig, code: &str) -> Response {
    Redirect::to(&format!("{}?sso_error={code}", routes.login_url)).into_response()
}

/// `"; Secure"` on the prod tier (HTTPS), empty in dev so local-HTTP SSO
/// works — the framework's session-cookie posture (audit H2), same as
/// the tenant login cookie.
fn secure_suffix() -> &'static str {
    if crate::session::secure_cookies() {
        "; Secure"
    } else {
        ""
    }
}

/// The tenant console's flow cookie under `cookie_path`: `__Host-` on the
/// tenant's own host over HTTPS, the plain name under a path prefix.
fn flow_cookie(cookie_path: &str) -> crate::sso::FlowCookie<'_> {
    crate::sso::FlowCookie::new(
        SSO_FLOW_COOKIE,
        cookie_path,
        crate::session::secure_cookies(),
    )
}

fn set_cookie(resp: &mut Response, value: &str) {
    if let Ok(v) = HeaderValue::from_str(value) {
        resp.headers_mut().append(header::SET_COOKIE, v);
    }
}

/// `GET {login_url}/sso/{slug}` — start the tenant handshake for one
/// provider (tenant-owned or shared).
pub(super) async fn tenant_sso_begin(
    org: &Org,
    slug: &str,
    secret: &SessionSecret,
    tenant_pool: &Pool,
    registry_pool: &Pool,
    routes: &RouteConfig,
    cookie_path: &str,
    parts: &Parts,
) -> Response {
    let scope = crate::sso::policy::org_throttle_scope(org);
    if let Err(refused) =
        crate::sso::policy::throttle_check(&scope, &parts.extensions, &parts.headers).await
    {
        return refused;
    }
    let Some(redirect_uri) = derive_redirect(parts, routes, slug) else {
        return login_error(routes, "config");
    };
    let (cfg, key) = match resolve_by_slug(tenant_pool, registry_pool, slug, redirect_uri).await {
        Ok(Some(c)) => c,
        Ok(None) => return login_error(routes, "disabled"),
        Err(e) => {
            tracing::error!(target: "rustango::tenancy::sso", "begin resolve: {e}");
            return login_error(routes, "config");
        }
    };
    let provider = match build_provider_for(&cfg.sso, key.source()).await {
        Ok(p) => p,
        Err(e) => {
            tracing::error!(target: "rustango::tenancy::sso", "begin build: {e}");
            return login_error(routes, "config");
        }
    };
    let Some(tenant) = super::TenantSlug::of(org) else {
        return login_error(routes, "config");
    };
    let (url, mut flow) = provider.begin();
    let params: BeginParams =
        serde_urlencoded::from_str(parts.uri.query().unwrap_or("")).unwrap_or_default();
    flow.next = super::admin::tenant_next(params.next.as_deref(), routes, cookie_path);
    let sealed = seal_flow(
        &flow,
        FlowScope::for_tenant(FlowPurpose::TenantAdmin, &tenant, slug),
        secret.key(),
    );
    let mut resp = Redirect::to(&url).into_response();
    set_cookie(&mut resp, &flow_cookie(cookie_path).set(&sealed, 600));
    resp
}

/// `GET {login_url}/sso/{slug}/callback` — finish the handshake, sign in
/// the linked tenant user, mint the tenant session.
pub(super) async fn tenant_sso_callback(
    org: &Org,
    slug: &str,
    secret: &SessionSecret,
    tenant_pool: &Pool,
    registry_pool: &Pool,
    routes: &RouteConfig,
    cookie_path: &str,
    parts: &Parts,
) -> Response {
    let params: CallbackParams =
        serde_urlencoded::from_str(parts.uri.query().unwrap_or("")).unwrap_or_default();
    if params.error.is_some() {
        return login_error(routes, "denied");
    }
    let (Some(code), Some(cb_state)) = (params.code, params.state) else {
        return login_error(routes, "callback");
    };
    let Some(sealed) = flow_cookie(cookie_path).read(&parts.headers) else {
        return login_error(routes, "expired");
    };
    let Some(tenant) = super::TenantSlug::of(org) else {
        return login_error(routes, "config");
    };
    let flow = match open_flow(
        sealed,
        FlowScope::for_tenant(FlowPurpose::TenantAdmin, &tenant, slug),
        secret.key(),
    ) {
        Ok(f) => f,
        Err(_) => return login_error(routes, "expired"),
    };
    let scope = crate::sso::policy::org_throttle_scope(org);
    let attempt =
        match crate::sso::policy::throttle_begin(&scope, &parts.extensions, &parts.headers).await {
            Ok(a) => a,
            Err(refused) => return refused,
        };
    // Claimed only past the throttle, so a throttled callback can be retried.
    if !crate::sso::claim_flow(&flow) {
        return login_error(routes, "expired");
    }
    let Some(redirect_uri) = derive_redirect(parts, routes, slug) else {
        return login_error(routes, "config");
    };
    let (cfg, key) = match resolve_by_slug(tenant_pool, registry_pool, slug, redirect_uri).await {
        Ok(Some(c)) => c,
        Ok(None) => return login_error(routes, "disabled"),
        Err(e) => {
            tracing::error!(target: "rustango::tenancy::sso", "callback resolve: {e}");
            return login_error(routes, "config");
        }
    };
    let provider = match build_provider_for(&cfg.sso, key.source()).await {
        Ok(p) => p,
        Err(e) => {
            tracing::error!(target: "rustango::tenancy::sso", "callback build: {e}");
            return login_error(routes, "config");
        }
    };
    let identity = match provider.complete(&flow, &code, &cb_state).await {
        Ok((u, tokens)) => Identity::from_handshake(&provider, u, &tokens, &flow).await,
        Err(e) => {
            tracing::warn!(target: "rustango::tenancy::sso", "handshake: {e}");
            attempt.failed().await;
            return login_error(routes, "handshake");
        }
    };
    let normalized = &identity.profile;
    let meta = || meta_from_parts(&parts.extensions, &parts.headers, Some(parts.uri.path()));
    let settings = TenantSettings::load(tenant_pool).await;
    let policy = tenant_policy(tenant_pool, &cfg, &key, slug, &settings).await;
    let request = AdmitRequest::new(tenant_pool, Surface::TenantAdmin, &key, &policy, &identity)
        .provider(slug);
    let uid = match admit(request, &member_auth::TenantAccounts(tenant_pool)).await {
        Ok(a) => a.user_id,
        Err(Denied::Refused(r)) => {
            let ctx = RefusalContext {
                pool: tenant_pool,
                surface: Surface::TenantAdmin,
                signal_source: SIGNAL_SOURCE,
                provider: slug,
                key: &key,
                identity: &identity,
                tenant: Some(org.slug.clone()),
                extensions: &parts.extensions,
                headers: &parts.headers,
                path: parts.uri.path(),
            };
            refuse(&ctx, &r).await;
            attempt.failed().await;
            return login_error(routes, REFUSED);
        }
        Err(e) => {
            tracing::error!(target: "rustango::tenancy::sso", tenant = %org.slug, slug, "sso sign-in failed: {e}");
            return login_error(routes, REFUSED);
        }
    };
    let Some(user) = member_auth::tenant_user(tenant_pool, uid).await else {
        return login_error(routes, REFUSED);
    };
    if !user.active {
        signal_refused(
            SIGNAL_SOURCE,
            normalized,
            AuthFailureReason::Inactive,
            meta(),
            Some(org.slug.clone()),
        )
        .await;
        return login_error(routes, REFUSED);
    }

    // Mint the tenant session — same shape as a password login.
    attempt.succeeded().await;
    let route_ttl = i64::try_from(routes.tenant_session_ttl.as_secs())
        .unwrap_or(tenant_console::SESSION_TTL_SECS);
    let ttl = policy.session_ttl(route_ttl, user.is_superuser);
    let mut payload = TenantSessionPayload::new(
        uid,
        &tenant,
        ttl,
        super::session::PasswordFingerprint::of(secret, &user.password_hash),
    );
    payload.iat = crate::session::issued_at(user.sessions_revoked_at);
    let cookie_value = tenant_console::encode(secret, &payload);
    let session_cookie = format!(
        "{}={cookie_value}; Path={cookie_path}; HttpOnly; SameSite=Lax; Max-Age={ttl}{}",
        tenant_console::COOKIE_NAME,
        secure_suffix()
    );
    // An explicit `next` wins; then the landing rules, on the scoped identity.
    let landing = match super::admin::tenant_next(flow.next.as_deref(), routes, cookie_path) {
        Some(next) => next,
        None => {
            let scoped = policy.scope(&identity);
            super::admin::rule_landing(tenant_pool, org, uid, Some(&scoped), routes, cookie_path)
                .await
                .unwrap_or_else(|| routes.admin_url.clone())
        }
    };
    let mut resp = Redirect::to(&landing).into_response();
    set_cookie(&mut resp, &session_cookie);
    for c in flow_cookie(cookie_path).clear() {
        set_cookie(&mut resp, &c);
    }
    send_user_logged_in(UserLoggedInContext {
        source: SIGNAL_SOURCE,
        user_id: uid,
        username: user.username.clone(),
        is_superuser: user.is_superuser,
        request: meta(),
        tenant: Some(org.slug.clone()),
    })
    .await;
    resp
}

#[cfg(test)]
mod tests {
    use super::merge_provider_buttons;

    fn row(slug: &str, label: &str, sort: i32, enabled: bool) -> (String, String, i32, bool) {
        (slug.into(), label.into(), sort, enabled)
    }

    #[test]
    fn tenant_wins_on_slug_clash_and_result_is_sorted() {
        let buttons = merge_provider_buttons(
            "/login",
            // tenant: a clashing "corp" (wins), a disabled one (dropped)
            vec![
                row("corp", "Tenant Corp", 1, true),
                row("off", "Off", 0, false),
            ],
            // shared: same "corp" (loses), a shared-only "global"
            vec![
                row("corp", "Shared Corp", 0, true),
                row("global", "Global", 5, true),
            ],
        );
        let view: Vec<_> = buttons
            .iter()
            .map(|b| (b.slug.as_str(), b.label.as_str(), b.login_url.as_str()))
            .collect();
        assert_eq!(
            view,
            vec![
                ("corp", "Tenant Corp", "/login/sso/corp"), // tenant label wins, sort=1
                ("global", "Global", "/login/sso/global"),  // shared-only, sort=5
            ]
        );
    }

    /// A disabled tenant row still hides the shared provider with its slug.
    #[test]
    fn a_disabled_tenant_row_hides_the_shared_one() {
        let buttons = merge_provider_buttons(
            "/login",
            vec![row("corp", "Tenant Corp", 0, false)],
            vec![row("corp", "Shared Corp", 0, true)],
        );
        assert!(buttons.is_empty(), "{:?}", buttons.len());
    }

    /// The default provider, or the only one with the password form
    /// hidden; never with `?local=1`, an SSO error or a flash.
    #[test]
    fn auto_redirect_picks_and_never_loops() {
        use crate::sso::policy::{PasswordLogin, TenantSettings};
        let one = merge_provider_buttons("/login", vec![row("corp", "C", 0, true)], vec![]);
        let two = merge_provider_buttons(
            "/login",
            vec![row("corp", "C", 0, true), row("b", "B", 1, true)],
            vec![],
        );
        let on = TenantSettings::default();
        let off = TenantSettings {
            password_login: PasswordLogin::SuperusersOnly,
            ..TenantSettings::default()
        };
        let default = TenantSettings {
            default_provider: Some("corp".into()),
            ..TenantSettings::default()
        };
        let go = |s: &TenantSettings, p: &[super::ProviderButton], q: Option<&str>, f| {
            super::auto_redirect(s, p, q, f)
        };
        assert_eq!(go(&on, &one, None, false), None);
        assert_eq!(
            go(&off, &one, None, false).as_deref(),
            Some("/login/sso/corp")
        );
        assert_eq!(go(&off, &two, None, false), None);
        assert_eq!(
            go(&default, &two, None, false).as_deref(),
            Some("/login/sso/corp")
        );
        for q in ["local=1", "sso_error=nouser", "next=/x&local=1"] {
            assert_eq!(go(&default, &two, Some(q), false), None, "{q}");
        }
        assert_eq!(go(&default, &two, None, true), None);
    }

    /// Only a superuser adds, changes, deletes or views a shared provider in the admin.
    #[test]
    fn shared_providers_are_superuser_only_in_the_admin() {
        use crate::admin::object_permissions::is_allowed;
        let parts = |scoped: bool| {
            let mut p = axum::http::Request::builder()
                .body(())
                .unwrap()
                .into_parts()
                .0;
            p.extensions
                .insert(crate::admin::session::PermsScoped(scoped));
            p
        };
        for action in ["add", "change", "delete", "view"] {
            let t = "rustango_shared_sso_providers";
            assert!(!is_allowed(t, action, &parts(true), None), "{action}");
            assert!(is_allowed(t, action, &parts(false), None), "{action}");
        }
    }

    #[test]
    fn shared_only_when_no_tenant_providers() {
        let buttons = merge_provider_buttons(
            "/admin/login",
            std::iter::empty(),
            vec![row("okta", "Okta", 0, true)],
        );
        assert_eq!(buttons.len(), 1);
        assert_eq!(buttons[0].login_url, "/admin/login/sso/okta");
    }

    /// The `redirect_uri` never takes userinfo from the Host (#2173).
    #[test]
    fn derive_redirect_refuses_a_host_with_userinfo() {
        let routes = super::RouteConfig::default();
        let parts = |host: &str| {
            axum::http::Request::builder()
                .header("host", host)
                .body(())
                .unwrap()
                .into_parts()
                .0
        };
        assert!(super::derive_redirect(&parts("good.com:1@evil.com:2"), &routes, "g").is_none());
        assert!(super::derive_redirect(&parts("good.com@evil.com"), &routes, "g").is_none());
        let ok = super::derive_redirect(&parts("good.com:8443"), &routes, "g").unwrap();
        assert!(ok.starts_with("https://good.com:8443/"), "{ok}");
    }
}