Backend Notları 7: EF Core ve RLS ile Multi-Tenant PostgreSQL

Backend Notları 7: EF Core ve RLS ile Multi-Tenant PostgreSQL

Çoğu hata için özür dilenebilir. Bir müşterinin verisini başka bir müşteriye göstermek bunlardan biri değildir. Multi-tenant (çok kiracılı) bir sistemde tenant izolasyonu, en kötü günde, en yeni geliştiricinin yazdığı ve kimsenin incelemediği kod yolunda bile geçerli kalması gereken özelliktir.

Geliştirmekte olduğum multi-tenant bir platformda her servisin kendi PostgreSQL veritabanı var ve tenant'lar, bir tenant_id kolonuyla ayrılarak tabloları paylaşıyor. İzolasyon iki kez uygulanıyor: bir kez EF Core'da global sorgu filtreleriyle, bir kez de PostgreSQL'de row-level security ile. Bu not, tek bir korumanın neden yetmediğini, ikincisinin nasıl bağlandığını ve onun gerçekten çalışıp çalışmadığını belirleyen connection pooling ayrıntılarını anlatıyor.

Bilerek paylaşılan tablolar

Yaygın üç yerleşim var. Tenant başına bir veritabanı en güçlü ayrımı ve tenant başına yedekleri sağlar, ama her şema değişikliği yüzlerce veritabanı üzerinde dönen bir döngüye dönüşür ve bağlantı havuzları çoğalır. Tenant başına bir şema, aynı operasyonel maliyetin çoğunu taşıyan bir orta yoldur. Tenant kolonu olan paylaşılan tablolar işletmesi ve migrate etmesi en ucuz, ama en riskli seçenektir, çünkü her sorgunun filtreyi hatırlaması gerekir.

Çok sayıda küçük tenant'ı olan bir platformda, risk disiplinle değil tasarımla ele alındığı sürece, operasyon açısından paylaşılan tablolar kazanır. İki koruma tam da bunun için var.

Tenant'ı bir kez çözümleyin, şüphe hâlinde reddedin

Aşağıdaki her şey mevcut tenant'ı bilmeye dayanır; bu yüzden tenant çözümlemesi bilerek katı tutulur. Tenant, kimliği doğrulanmış çağıranın token'ından gelir; asla bir varsayılan değerden, asla yalnızca bir header'dan gelmez:

  • Kimliği doğrulanmamış bir isteğin tenant'ı yoktur ve reddedilir.
  • Token tam olarak bir tenant claim'i taşımalıdır. Hiç olmaması ya da iki tane olması (aynı değerde olsalar bile) ret sebebidir.
  • İstemci ayrıca bir tenant seçici header'ı gönderiyorsa, bu header claim ile birebir eşleşmelidir.
  • Tenant dizini tenant'ı aktif olarak göstermelidir. Askıya alınmış bir tenant boş bir sayfa değil, açık bir hata alır.

Her ret, hata kodu sabit bir ProblemDetails yanıtıdır. Kabul edilen tenant, scoped bir ICurrentTenant servisi aracılığıyla isteğin geri kalanı için mevcut tenant olur. Health check'ler gibi gerçekten tenant gerektirmeyen endpoint'ler bir attribute ile açıkça bu kuralın dışına çıkar; böylece unutmak güvenlidir ve kuralın dışına çıkmak code review'da görünür.

Birinci koruma: EF Core global sorgu filtreleri

Global sorgu filtresi, EF Core'un bir entity tipi için her LINQ sorgusuna eklediği bir koşuldur (predicate). Önemli ayrıntı şu: DbContext'in bir property'sini okuyan bir filtre, her context instance'ı için ayrı değerlendirilir. Model bir kez oluşturulup önbelleğe alınır, ama tenant değeri, sorguyu çalıştıran context'ten okunan bir parametredir.

public interface ITenantScoped { string? TenantId { get; } }    // also read by the interceptor below

public sealed class AppDbContext(DbContextOptions<AppDbContext> options, ICurrentTenant tenant)
    : DbContext(options), ITenantScoped
{
    public string? TenantId => tenant.Id;          // read for every query, per context

    public DbSet<Employee> Employees => Set<Employee>();

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        // EF Core 10: a named filter, so other filters (soft delete) can sit beside it
        modelBuilder.Entity<Employee>()
            .HasQueryFilter("Tenant", e => e.TenantId == TenantId);

        // EF Core 8 and 9 allow one unnamed filter per entity type:
        // modelBuilder.Entity<Employee>().HasQueryFilter(e => e.TenantId == TenantId);
    }
}

Pratikte her entity için elle bir filtre yazmazsınız. Platform filtreyi, ITenantOwned işaretleyici arayüzünü (marker interface) uygulayan her entity'ye konvansiyonla uygular; böylece filtresiz yeni bir tablo eklenemez. Bir save interceptor da eksik parçayı tamamlar: tenant'a ait olması gereken ama tenant'ı atanmamış yeni bir satır mevcut tenant'ı alır; başka bir tenant'a ait bir satır ya da hiç mevcut tenant olmadan yapılan bir yazma ise daha hiçbir SQL gönderilmeden reddedilir. Tenant bilinmediğinde filtre null ile karşılaştırma yapar ve hiçbir şeyle eşleşmez; dolayısıyla varsayılan sonuç her şey değil, boş bir sonuçtur.

Bu koruma normal yolu çok iyi kapsar. Ama her şeyi kapsamaz:

  • IgnoreQueryFilters() onu kapatır; bazen iyi bir nedenle, bazen kopyala-yapıştır yüzünden. EF Core 10'daki isimli filtreler burada işe yarar, çünkü yalnızca soft delete filtresini yok sayıp tenant filtresini koruyabilirsiniz.
  • Database.SqlQuery<T> ya da ExecuteSql gibi bir entity set'ten geçmeyen ham SQL hiçbir filtre almaz.
  • EF Core olmayan hiçbir şey filtre almaz: bir Dapper sorgusu, bir raporlama aracı, psql'de elle çalıştırılan bir veri düzeltmesi.

İkinci koruma: row-level security

PostgreSQL'in row-level security (RLS, satır düzeyinde güvenlik) özelliği bir tabloya politikalar bağlar ve veritabanı bu politikaları, sorguyu kim yazmış olursa olsun, o tablodaki her sorguya ekler. Politikanın mevcut tenant'ı bilmesi gerekir; bu yüzden uygulama onu özel bir oturum ayarına, app.tenant_id'ye koyar ve politika onu oradan okur:

ALTER TABLE employees ENABLE ROW LEVEL SECURITY;
ALTER TABLE employees FORCE ROW LEVEL SECURITY;      -- the service connects as the owner

CREATE POLICY tenant_isolation ON employees
    USING      (tenant_id = NULLIF(current_setting('app.tenant_id', true), ''))
    WITH CHECK (tenant_id = NULLIF(current_setting('app.tenant_id', true), ''));

Her satırın bir nedeni var:

  • FORCE. Bir tablonun sahibi normalde o tablonun politikalarından muaftır. Servisler genellikle tablolarının sahibi olan rolle bağlanır, çünkü migration'ları o rol çalıştırır; dolayısıyla FORCE ROW LEVEL SECURITY olmadan politika, uygulama dışında herkese uygulanırdı.
  • Superuser yok. Superuser'lar ve BYPASSRLS özelliğine sahip roller, FORCE uygulanmış olsun ya da olmasın her politikayı atlar. Servis rolü bu iki özellikten hiçbirine sahip olmamalıdır ve bir başlangıç kontrolü bunu doğrular.
  • USING ve WITH CHECK. USING, bir SQL ifadesinin görebileceği, güncelleyebileceği ya da silebileceği satırları filtreler. WITH CHECK, başka bir tenant için satır üretecek insert ve update'leri reddeder; PostgreSQL bunlara sessizce atlayarak değil, bir hatayla yanıt verir.
  • current_setting(..., true) ve NULLIF. İkinci argüman sayesinde, ayar mevcut değilse hata yerine null döner. Oturumda daha önce atanmış ve sonra sıfırlanmış bir ayar boş string olarak dönebilir; NULLIF bunu null'a çevirir. Null hiçbir şeye eşit değildir; bu yüzden tenant'ı olmayan bir bağlantı hiçbir satır görmez ve hiçbir satır yazamaz.

Başınıza gelmeden önce bilmeniz gereken bir sınır var. Unique ve foreign key kontrolleri RLS'i atlar; bu yüzden yalnızca email üzerindeki bir unique indeks, A tenant'ına B tenant'ının o adrese zaten sahip olduğunu söyler. Tenant'a ait tablolardaki unique kısıtlar tenant_id'yi de içermelidir.

Tenant'ı bağlantıya yerleştirmek

Politika, ancak sorguyu çalıştıran bağlantıdaki app.tenant_id değeri kadar doğrudur ve bağlantılar havuzlanır. Bir bağlantı havuza, oturum durumu neyse onunla döner; Npgsql bu durumu varsayılan olarak yeniden kullanımda sıfırlar, ama bazen performans için açılan No Reset On Close seçeneği bu sıfırlamayı kapatır. Doğruluk bu iki ayardan hiçbirine bağlı olmamalıdır; bu yüzden platform, EF Core her bağlantı açtığında değerin üzerine yazar ve tenant yoksa boş bir değer kullanır:

public sealed class TenantSessionInterceptor : DbConnectionInterceptor
{
    public override async Task ConnectionOpenedAsync(DbConnection connection,
        ConnectionEndEventData eventData, CancellationToken cancellationToken = default)
    {
        await using var command = SetTenant(connection, eventData.Context);
        await command.ExecuteNonQueryAsync(cancellationToken);
    }

    public override void ConnectionOpened(DbConnection connection, ConnectionEndEventData eventData)
    {
        using var command = SetTenant(connection, eventData.Context);
        command.ExecuteNonQuery();
    }

    private static DbCommand SetTenant(DbConnection connection, DbContext? context)
    {
        var command = connection.CreateCommand();
        command.CommandText = "SELECT set_config('app.tenant_id', @tenant, false)";
        var tenant = command.CreateParameter();
        tenant.ParameterName = "tenant";
        tenant.Value = (context as ITenantScoped)?.TenantId ?? "";   // empty matches no row
        command.Parameters.Add(tenant);
        return command;
    }
}

// registration: options.UseNpgsql(dataSource).AddInterceptors(new TenantSessionInterceptor());

Interceptor kendine ait hiçbir durum tutmaz; tenant'ı bağlantıyı açan context'ten okur, bu yüzden tek bir instance tüm context'lere hizmet edebilir. SET yerine set_config kullanılır, çünkü SET bind parametresi alamaz ve onu string birleştirmeyle oluşturmak bir injection riskidir.

set_config'in üçüncü argümanı işin ince kısmıdır. true ile ayar, SET LOCAL'daki gibi yalnızca mevcut transaction'ın sonuna kadar geçerlidir. Bu en güvenli kapsamdır, ama EF Core çoğu sorguyu açık bir transaction olmadan çalıştırır; bu durumda her sorgunun yalnızca tenant'ı atamak için bir transaction açması gerekirdi. false ile ayar oturum boyunca geçerlidir; bu da EF Core'un bir bağlantıyı bir sorgu ya da bir unit of work süresince tutma biçimiyle örtüşür. Bunun iki sonucu var. Değer bir transaction başlamadan önce atanmalıdır, çünkü bir transaction içinde değiştirilen ayar, o transaction rollback olursa geri alınır. Ve "her açılışta üzerine yaz" kuralı isteğe bağlı değildir, çünkü oturum istekten daha uzun yaşar.

İki pooling kurulumu oturum kapsamlı durumu tamamen bozar. Npgsql'in multiplexing modu farklı çağıranların komutlarını paylaşılan bağlantılar üzerinden gönderir; dolayısıyla yapılandırılacak sabit bir oturum yoktur. Platform bu tür bağlantıları doğrudan reddeder. Transaction pooling modundaki PgBouncer ise her transaction'dan sonra bir sunucu bağlantısını farklı bir istemciye verir; bu yüzden oturum düzeyindeki bir ayar başka bir istemciye sızabilir. Böyle bir pooler'ın arkasında, her unit of work için açık bir transaction içinde set_config(..., true) kullanın.

Migration'lar ve owner rolü

Politikaların yeri migration'lardır, korudukları tabloların hemen yanı. EF Core'da bu, tenant'a ait her tablonun birebir aynı ifadeleri alması için küçük bir extension method'a sarılmış migrationBuilder.Sql(...) çağrıları ve Down için buna karşılık gelen bir metot demektir.

FORCE'un veri migration'ları üzerinde bir yan etkisi vardır. Kolon eklemek gibi DDL işlemleri etkilenmez, ama değerleri backfill eden bir UPDATE politikanın altında çalışır, tenant atanmamışsa hiçbir satır görmez ve hiçbir şeyi değiştirmeden başarı bildirir. Backfill'ler ya her biri için app.tenant_id'yi atayarak tenant'lar üzerinde döngüyle ilerlemeli ya da uygulamanın asla kullanmadığı, BYPASSRLS özelliğine sahip ayrı bir bakım rolüyle çalışmalıdır.

Unutulmuş bir politika sessizce başarısız olduğu için platformda, başlangıçta ve testlerde çalışan, katalogu okuyup tabloların gerçekten korunduğunu doğrulayan bir kontrol var:

SELECT c.relname
FROM pg_class c
JOIN pg_namespace n ON n.oid = c.relnamespace
WHERE n.nspname = current_schema()
  AND c.relkind IN ('r', 'p')
  AND EXISTS (SELECT 1 FROM pg_attribute a
              WHERE a.attrelid = c.oid AND a.attname = 'tenant_id' AND NOT a.attisdropped)
  AND NOT (c.relrowsecurity AND c.relforcerowsecurity);

Dönen her satır, tenant kolonu olduğu hâlde korunmayan bir tablodur ve kontrol başarısız olur. pg_roles üzerinde çalışan benzer bir sorgu da bağlanan rolün ne superuser ne de RLS'ten muaf olduğunu doğrular.

Testcontainers ile izolasyonu test etmek

İzolasyon, veritabanı ile driver'ın birlikte sağladığı bir özelliktir; bu yüzden gerçek bir PostgreSQL'e karşı test edilmesi gerekir. Testcontainers ile test paketi tek bir PostgreSQL 16 container'ı başlatır ve her test kendi veritabanını alır. Bir ayrıntı diğer hepsinden önemlidir: container'ın varsayılan postgres kullanıcısı bir superuser'dır ve superuser her politikayı atlar. Bu kullanıcıyla bağlanan testler RLS hakkında hiçbir şey kanıtlamaz. Fixture ayrı bir login rolü oluşturur, onu her test veritabanının sahibi yapar ve tıpkı servis gibi bu rolle bağlanır.

Testler ardından ikinci korumaya doğrudan saldırır: IgnoreQueryFilters() yine yalnızca mevcut tenant'ın satırlarını görür; ham SQL yalnızca mevcut tenant'ın satırlarını görür; tenant'ı olmayan bir context hiçbir şey görmez ve insert yapamaz; başka bir tenant için yapılan bir insert yetersiz yetki (insufficient privilege) hatasıyla başarısız olur; başka bir tenant'ın satırlarını hedefleyen bir update sıfır satır değiştirir. En çok değer verdiğim test, bağlantının yeniden kullanılmasını zorlar:

[Fact]
public async Task Pooled_connection_does_not_leak_the_previous_tenant()
{
    var pooled = new NpgsqlConnectionStringBuilder(_db.OwnerConnectionString)
    {
        NoResetOnClose = true,     // keep session state between uses
        MaxPoolSize = 1,           // so the next context gets the same physical connection
    }.ConnectionString;

    const string rawTenants = "SELECT tenant_id AS \"Value\" FROM employees";

    await using (var acme = _db.NewContext(pooled, tenant: "acme"))
        Assert.Equal(new[] { "acme" }, await acme.Database.SqlQueryRaw<string>(rawTenants).ToListAsync());

    await using (var none = _db.NewContext(pooled, tenant: null))
        Assert.Empty(await none.Database.SqlQueryRaw<string>(rawTenants).ToListAsync());
}

Interceptor, tenant yokken boş bir değer yazmak yerine çağrıyı atlasaydı, ikinci context havuzdaki oturumdan acme'yi devralır ve test başarısız olurdu. Bu test tam da bu hatayı yakalamak için var.

RLS'in korumadıkları

İki koruma tek bir hata sınıfını zorlaştırır: tenant'ı unutan bir sorgu. Tenant en baştan yanlış çözümlenmişse işe yaramazlar; çözümlemenin şüphe hâlinde reddetmesinin (fail closed) nedeni de budur. Önbellekleri kapsamazlar: içinde tenant olmayan bir Redis anahtarı (bu serinin ilk notundaki önbellekleri düşünün) en az bir sorgu kadar veri sızdırır. Logları ve dışa aktarımları da kapsamazlar. İzolasyon tüm sistemin bir özelliğidir; veritabanı yalnızca onun hâlâ uygulanabildiği son yerdir.

Multi-tenant bir servis tasarlıyorsanız ya da müşteriler gelmeden önce mevcut bir servisi gözden geçirmek istiyorsanız, bu tam da üstlendiğim türden bir backend işi. Bir sonraki not isteklerin dışında gerçekleşen işlere bakıyor: hosted service'lerden Hangfire'a ve PostgreSQL'deki bir lease kuyruğuna kadar arka plan işleri.

Bu not İngilizce ve Farsça olarak da yayımlandı: İngilizce · Farsça.

Tüm notlara dön