Ardışık düzen işlemleri için güvenlik kuralları

Ardışık düzen işlemleri zengin bir özellik seti sunarken kural motoru, kısıtlama karşılanabilirliğini ve güvenliği sağlamak için karşılaştırma (ör. >) ve mantıksal (ör. or) filtreleri tanımakla sınırlıdır.

Desteklenen filtre ifadeleri

Pipeline işlemlerinin kurallarınız tarafından belirlenen sınırlarla kısıtlanması için sabitlere karşı mantıksal ve karşılaştırma operatörleri kullanması gerekir. Kural motoru tarafından tanınan filtre türleri şunlardır:

  • Karşılaştırmalar: eq, neq, gt, gte, lt, lte, in, arrayContains.
  • Mantıksal: and, or.

Aşağıda bazı örnekler verilmiştir:

  • where(eq("foo", 2))
  • where(lt("foo", 2))
  • documents("/user/1", "/user/2").where(...)

İstek Özellikleri

Kimlik doğrulama ve sorgu bağlamını doğrulamak için request nesnesini kullanmaya devam edebilirsiniz ancak standart sorgularda kullanılabilen bazı özellikler ardışık düzen işlemlerinde desteklenmez.

Desteklenen özellikler

Yeni motor, aşağıdaki özellikleri desteklemeye devam eder:

  • request.auth: Kullanıcı UID'sine ve jeton verilerine erişme.
  • request.method: İşlemi tanımlar (ör. get, list).
  • request.path: Erişilen kaynağın yolu.
  • request.time: İsteğin sunucu tarafı zaman damgası.

Desteklenmeyen özellikler

limit, offset ve orderBy gibi request.query özellikleri, çok kademeli sorgularda bu değerleri belirlemenin karmaşıklığı nedeniyle ardışık düzen işlemleri kural kontrolleri için desteklenmez.

Ardışık düzen aşaması yönetimi ve izinleri

Güvenlik kurallarında belirli ayrıntılı işlemlere karşılık gelen farklı ardışık düzen aşamaları vardır:

  • allow list izinleri: collection(), collectionGroup() ve database() aşamaları tarafından tetiklenir.
  • allow get izinleri: Toplu get işlemine benzer şekilde ele alınan documents() aşaması tarafından tetiklenir.
  • allow create izinleri: Yeni dokümanlar oluşturulurken insert() aşamaları ve upsert() aşamaları tarafından tetiklenir.
  • allow update izinleri: update() aşamaları ve mevcut dokümanlar güncellenirken upsert() aşamaları tarafından tetiklenir.
  • allow delete izinleri: delete() aşama tarafından tetiklendi.
  • allow write izinleri: Tüm DML işlemleri (insert(), update(), upsert() ve delete()) için geçerlidir.
  • Literals aşaması: literals() aşaması veritabanından okuma yapmaz ancak maliyetlere neden olabilir. Kötüye kullanımı önlemek için kurallarla doğrulanabilen başka bir aşamayla (ör. collection()) eşleştirilmelidir.

Alan değişikliği aşamaları

Kurallar yalnızca depolanan veriler üzerinde çalışır, türetilmiş değerler üzerinde çalışmaz. Bir ardışık düzen, alanları değiştiren aşamalar içeriyorsa (örneğin, add_fields(...), replace_with(...), select(...), remove_fields(...)) kural motoru, bu aşamayla karşılaşıldıktan sonra filtre kısıtlamalarını uygulamayı durdurur. Kuralların beklendiği gibi çalışması için filtre aşamalarınızı (ör. where) orijinal depolanan dokümanları değiştirebilecek aşamalardan önce konumlandırın.

Örneğin, aşağıdaki güvenlik kuralını ele alalım:

match /databases/{database}/documents {
  match /cities/{city} {
    // Allow the user to read data if the document has the 'visibility'
    // field set to 'public'
    allow read: if resource.data.visibility == 'public';
  }
}

Reddedildi: addFields aşaması, visibility değerinin public olduğu dokümanlar filtrelenmeden önce gerçekleştiği için bu kural aşağıdaki ardışık düzeni reddeder:

const results = await db.pipeline()
  .collection("/cities")
  // Filters after a modification stage are ignored by Rules.
  .addFields(constant(1000).as("population"))
  .where(eq(field("visibility"), constant("public")))
  .execute();

İzin verildi: where(eq(field("visibility"), constant("public"))) aşaması herhangi bir değişiklik aşamasından önce gerçekleştiği için bu kural aşağıdaki ardışık düzene izin verir:

const results = await db.pipeline()
  .collection("/cities")
  .where(eq(field("visibility"), constant("public")))
  .addFields(constant(1000).as("population"))
  .execute();

Veri manipülasyon dili aşamaları ve güvenlik kuralları

Veri manipülasyon dili (DML) aşamaları (insert(), update(), upsert() ve delete()) yürütülürken güvenlik kuralları, izinleri okuma sorgularından farklı şekilde değerlendirir:

  • Belge başına kural değerlendirmesi: Planlama aşamasında sorguyu kısıtlamak için önceden filtre ifadeleri gerektiren okuma ardışık düzenlerinin aksine, DML işlemleri güvenlik kurallarını her bir belge mutasyonuna göre değerlendirir.
  • Kural değişkenleri:
    • request.resource: insert(), update() ve upsert() işlemleri için önerilen belge verilerini içerir.
    • resource: Değişiklikten önce veritabanında depolanan mevcut belge verilerini içerir (mevcut belgelerin update(), delete() ve upsert() işlemleri için kullanılabilir).

DML ile sistem sınırları ve yürütme davranışı

Güvenlik Kuralları ile DML işlemleri çalıştırırken aşağıdaki sistem sınırlarını ve yürütme davranışlarını göz önünde bulundurun:

get() ve exists() için 20 arama sınırı

Firebase Güvenlik Kuralları, bir isteğin tamamında en fazla 20 doküman aramasına (get() veya exists()) izin verir.

DML ardışık düzeni açık bir işlem dışında çalıştığında Cloud Firestore, belge yazma işlemlerini toplu olarak işler. Her toplu işlem kendi işleminde yürütüldüğünden ve dokümanlar toplu işlemler arasında eşzamanlı olarak değiştirilebileceğinden güvenlik kuralları ve doküman aramaları her yazma toplu işlemi için yeniden değerlendirilir.

Güvenlik kurallarınız tek bir statik belgeye göre değerlendirme yapsa bile (örneğin, bir kullanıcının yönetici olup olmadığını kontrol etme):

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    match /posts/{postId} {
      allow write: if get(/databases/$(database)/documents/users/$(request.auth.uid)).data.isAdmin == true;
    }
  }
}

10 dokümandan oluşan her yazma grubu bir arama gerçekleştirir. Sonuç olarak, tüm olası belgeler yazıldıktan sonra istek için 20 arama sınırına ulaşılır ve ardışık düzen PERMISSION_DENIED hatasıyla başarısız olur. Ayrıca, yazma grubu başına gerçekleştirilen her arama için kendi okuma faturalandırması uygulanır.

Kısmen başarılı ve PERMISSION_DENIED

İşlem dışında yürütüldüğünde DML işlemleri, yazma işlemlerini sıralı gruplar halinde kaydeder. Bir toplu işlem başarısız olursa (bir doküman kural koşulunu karşılamadığı veya 20 arama sınırı aşıldığı için) ardışık düzen durur ve PERMISSION_DENIED hatası döndürür.

Ancak önceden kaydedilmiş gruplar geri alınmaz. Veritabanı kısmen güncellenmiş durumda kalır. Müşteri, değiştirilen belgelerin listesini içermeyen bir hata aldığından, hangi yazma işlemlerinin başarılı olduğunu incelemek için verilerinizi sorgulamanız gerekir.

Cloud Denetleme Günlükleri ile kural hatalarını teşhis etme

Güvenlik nedeniyle, istemciye yönelik PERMISSION_DENIED hataları, hangi güvenlik kuralı koşulunun başarısız olduğunu veya 20 arama sınırına ulaşılıp ulaşılmadığını açıklamaz.

Proje yöneticileri, kural değerlendirme hatalarını teşhis etmek için Google Cloud Console'daki Cloud Denetleme Günlükleri'ni (Firestore > İzleme bölümünde veya Günlük Gezgini'nde) inceleyerek ayrıntılı EvaluationError girişlerini görüntüleyebilir.