Cloud Firestore Güvenlik Kuralları, veritabanınızdaki belgelere ve koleksiyonlara erişimi kontrol etmenize olanak tanır. Esnek kural sözdizimi, tüm yazma işlemlerinden tüm veritabanına ve belirli bir belge üzerindeki işlemlere kadar her şeyle eşleşen kurallar oluşturmanıza olanak tanır.
Bu kılavuz, güvenlik kurallarının temel sözdizimini ve yapısını açıklamaktadır. Eksiksiz kural kümeleri oluşturmak için bu sözdizimini güvenlik kuralları koşullarıyla birleştirin.
Hizmet ve veritabanı bildirimi
Cloud Firestore Güvenlik Kuralları her zaman aşağıdaki bildirimle başlar:
service cloud.firestore {
match /databases/{database}/documents {
// ...
}
}
service cloud.firestore bildirimi, kuralları Cloud Firestore kapsamına alarak Cloud Firestore Güvenlik Kuralları ile Cloud Storage gibi diğer ürünlerin kuralları arasındaki çakışmaları önler.
match /databases/{database}/documents bildirimi, kuralların projedeki herhangi bir Cloud Firestore veritabanıyla eşleşmesi gerektiğini belirtir. Şu anda her projenin (default) adlı yalnızca tek bir veritabanı vardır.
Temel okuma/yazma kuralları
Temel kurallar, bir belge yolu belirten bir match ifadesinden ve belirtilen verileri okurken izin verilen bir allow ifadesinden oluşur:
service cloud.firestore {
match /databases/{database}/documents {
// Match any document in the 'cities' collection
match /cities/{city} {
allow read: if <condition>;
allow write: if <condition>;
}
}
}
Tüm eşleşme ifadeleri koleksiyonlara değil belgelere işaret etmelidir. Match deyimi, match /cities/SF olduğu gibi belirli bir belgeye işaret edebilir veya match /cities/{city} 'de olduğu gibi, belirtilen yoldaki herhangi bir belgeye işaret etmek için joker karakterler kullanabilir.
Yukarıdaki örnekte, eşleşme ifadesi {city} joker karakter sözdizimini kullanır. Bu, kuralın /cities/SF veya /cities/NYC gibi cities koleksiyonundaki tüm belgeler için geçerli olduğu anlamına gelir. Match deyimindeki allow ifadeleri değerlendirildiğinde, city değişkeni, SF veya NYC gibi şehir belgesi adına çözümlenir.
Ayrıntılı işlemler
Bazı durumlarda, read ve write işlemlerini daha ayrıntılı işlemlere ayırmak yararlıdır. Örneğin, uygulamanız belge oluşturmada belge silmeden farklı koşullar uygulamak isteyebilir. Veya tek belge okumalarına izin verip büyük sorguları reddetmek isteyebilirsiniz.
Bir read kuralı get ve list olarak bölünebilirken, bir write kuralı create , update ve delete olarak bölünebilir:
service cloud.firestore {
match /databases/{database}/documents {
// A read rule can be divided into get and list rules
match /cities/{city} {
// Applies to single document read requests
allow get: if <condition>;
// Applies to queries and collection read requests
allow list: if <condition>;
}
// A write rule can be divided into create, update, and delete rules
match /cities/{city} {
// Applies to writes to nonexistent documents
allow create: if <condition>;
// Applies to writes to existing documents
allow update: if <condition>;
// Applies to delete operations
allow delete: if <condition>;
}
}
}
hiyerarşik veri
Cloud Firestore'daki veriler, belge koleksiyonları halinde düzenlenir ve her belge, alt koleksiyonlar yoluyla hiyerarşiyi genişletebilir. Güvenlik kurallarının hiyerarşik verilerle nasıl etkileşime girdiğini anlamak önemlidir.
cities koleksiyonundaki her belgenin bir landmarks alt koleksiyonu içerdiği durumu düşünün. Güvenlik kuralları yalnızca eşleşen yolda geçerlidir, bu nedenle cities koleksiyonunda tanımlanan erişim kontrolleri, landmarks alt koleksiyonu için geçerli değildir. Bunun yerine, alt koleksiyonlara erişimi kontrol etmek için açık kurallar yazın:
service cloud.firestore {
match /databases/{database}/documents {
match /cities/{city} {
allow read, write: if <condition>;
// Explicitly define rules for the 'landmarks' subcollection
match /landmarks/{landmark} {
allow read, write: if <condition>;
}
}
}
}
match match yolu her zaman dış match deyiminin yoluna görelidir. Aşağıdaki kural kümeleri bu nedenle eşdeğerdir:
service cloud.firestore {
match /databases/{database}/documents {
match /cities/{city} {
match /landmarks/{landmark} {
allow read, write: if <condition>;
}
}
}
}
service cloud.firestore {
match /databases/{database}/documents {
match /cities/{city}/landmarks/{landmark} {
allow read, write: if <condition>;
}
}
}
Özyinelemeli joker karakterler
Kuralların keyfi olarak derin bir hiyerarşiye uygulanmasını istiyorsanız, yinelemeli joker karakter sözdizimini kullanın {name=**} . Örneğin:
service cloud.firestore {
match /databases/{database}/documents {
// Matches any document in the cities collection as well as any document
// in a subcollection.
match /cities/{document=**} {
allow read, write: if <condition>;
}
}
}
Özyinelemeli joker karakter sözdizimini kullanırken, belge derinlemesine iç içe geçmiş bir alt koleksiyonda bulunsa bile joker karakter değişkeni eşleşen yol bölümünün tamamını içerecektir. Örneğin, yukarıda listelenen kurallar /cities/SF/landmarks/coit_tower bulunan bir belgeyle eşleşir ve document değişkeninin değeri SF/landmarks/coit_tower .
Ancak yinelemeli joker karakterlerin davranışının kuralların sürümüne bağlı olduğunu unutmayın.
Versiyon 1
Güvenlik kuralları, varsayılan olarak sürüm 1'i kullanır. 1. sürümde, yinelemeli joker karakterler bir veya daha fazla yol öğesiyle eşleşir. Boş bir yolla match /cities/{city}/{document=**} ile eşleşen alt koleksiyonlardaki belgelerle eşleşir, ancak cities koleksiyonundaki belgelerle eşleşmezken, /cities/{document=**} ile match /cities/{document=**} her iki belgeyle de eşleşir cities koleksiyonu ve alt koleksiyonlar.
Yinelemeli joker karakterler, bir eşleşme bildiriminin sonunda gelmelidir.
Versiyon 2
Güvenlik kurallarının 2. sürümünde, yinelenen joker karakterler sıfır veya daha fazla yol öğesiyle eşleşir. match/cities/{city}/{document=**} , herhangi bir alt koleksiyondaki belgelerle ve cities koleksiyonundaki belgelerle eşleşir.
rules_version = '2'; ekleyerek sürüm 2'ye kaydolmalısınız. güvenlik kurallarınızın en üstünde:
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
// Matches any document in the cities collection as well as any document
// in a subcollection.
match /cities/{city}/{document=**} {
allow read, write: if <condition>;
}
}
}
Eşleşme bildirimi başına en fazla bir yinelenen joker karakteriniz olabilir, ancak sürüm 2'de bu joker karakteri eşleşme ifadesinde herhangi bir yere yerleştirebilirsiniz. Örneğin:
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
// Matches any document in the songs collection group
match /{path=**}/songs/{song} {
allow read, write: if <condition>;
}
}
}
Koleksiyon grubu sorguları kullanıyorsanız, sürüm 2'yi kullanmalısınız, bkz. toplama grubu sorgularının güvenliğini sağlama .
Çakışan eşleşme ifadeleri
Bir belgenin birden fazla match deyimiyle eşleşmesi mümkündür. Birden fazla allow ifadesinin bir istekle eşleşmesi durumunda, koşullardan herhangi biri true erişime izin verilir:
service cloud.firestore {
match /databases/{database}/documents {
// Matches any document in the 'cities' collection.
match /cities/{city} {
allow read, write: if false;
}
// Matches any document in the 'cities' collection or subcollections.
match /cities/{document=**} {
allow read, write: if true;
}
}
}
Yukarıdaki örnekte, ilk kural her zaman false olsa da ikinci kural her zaman true olduğundan, cities koleksiyonuna yapılan tüm okuma ve yazma işlemlerine izin verilecektir.
Güvenlik kuralı sınırları
Güvenlik kurallarıyla çalışırken aşağıdaki sınırlara dikkat edin:
| sınır | Detaylar |
|---|---|
İstek başına en fazla escape( exists() , get() ve getAfter() çağrısı sayısı |
Her iki sınırın aşılması, izin reddedildi hatasıyla sonuçlanır. Bazı belge erişim çağrıları önbelleğe alınabilir ve önbelleğe alınan çağrılar limitlere dahil edilmez. |
Maksimum iç içe match bildirimi derinliği | 10 |
Bir dizi iç içe geçmiş match ifadesi içinde izin verilen, yol segmentlerinde maksimum yol uzunluğu | 100 |
Bir dizi iç içe geçmiş match ifadesi içinde izin verilen maksimum yol yakalama değişkeni sayısı | 20 |
| Maksimum işlev çağrısı derinliği | 20 |
| Maksimum işlev bağımsız değişkeni sayısı | 7 |
İşlev başına maksimum let değişken bağlama sayısı | 10 |
| Maksimum özyinelemeli veya döngüsel işlev çağrısı sayısı | 0 (izin verilmez) |
| İstek başına değerlendirilen maksimum ifade sayısı | 1.000 |
| Bir kural kümesinin maksimum boyutu | Kural kümeleri iki boyut sınırına uymalıdır:
|
Sonraki adımlar
- Özel güvenlik kuralları koşulları yazın.
- Güvenlik kuralları referansını okuyun.