Realtime Database Güvenlik Kurallarında koşulları kullanma

Bu kılavuz, Firebase Realtime Database Güvenlik Kurallarınıza nasıl koşul ekleyeceğinizi göstermek için temel Firebase Güvenlik Kuralları dilini öğrenme kılavuzunu temel alır.

Realtime Database Güvenlik Kuralları'nın temel yapı taşı koşuldur. Koşul, belirli bir işleme izin verilip verilmeyeceğini belirleyen bir Boole ifadesidir. Temel kurallar için koşul olarak true ve false değişmezlerini kullanmak son derece iyi sonuç verir. Ancak Realtime Database Security Rules dili, aşağıdakileri yapabilen daha karmaşık koşullar yazmanıza olanak tanır:

• Kullanıcı kimlik doğrulamasını kontrol etme
• Mevcut verileri yeni gönderilen verilerle karşılaştırma
• Veritabanınızın farklı bölümlerine erişme ve bunları karşılaştırma
• Gelen verileri doğrulama
• Güvenlik mantığı için gelen sorguların yapısını kullanma

Yol Segmentlerini Yakalamak İçin $ Değişkenlerini Kullanma

$ ön ekiyle yakalama değişkenleri tanımlayarak okuma veya yazma yolunun bölümlerini yakalayabilirsiniz. Bu, joker karakter görevi görür ve bu anahtarın değerini kural koşullarında kullanılmak üzere saklar:

{
  "rules": {
    "rooms": {
      // this rule applies to any child of /rooms/, the key for each room id
      // is stored inside $room_id variable for reference
      "$room_id": {
        "topic": {
          // the room's topic can be changed if the room id has "public" in it
          ".write": "$room_id.contains('public')"
        }
      }
    }
  }
}

Dinamik $ değişkenleri, sabit yol adlarıyla paralel olarak da kullanılabilir. Bu örnekte, widget öğesinin title ve color dışında alt öğesi olmamasını sağlayan bir .validate kuralı bildirmek için $other değişkenini kullanıyoruz. Ek alt öğelerin oluşturulmasına neden olacak tüm yazma işlemleri başarısız olur.

{
  "rules": {
    "widget": {
      // a widget can have a title or color attribute
      "title": { ".validate": true },
      "color": { ".validate": true },

      // but no other child paths are allowed
      // in this case, $other means any key excluding "title" and "color"
      "$other": { ".validate": false }
    }
  }
}

Not: Yol anahtarları her zaman dizedir. Bu nedenle, $ değişkenini bir sayıyla karşılaştırmaya çalıştığımızda bunun her zaman başarısız olacağını unutmamak önemlidir. Bu sorun, sayı dizeye dönüştürülerek düzeltilebilir (ör. $key === newData.val()+'').

Doğrulama

En yaygın güvenlik kuralı kalıplarından biri, erişimi kullanıcının kimlik doğrulama durumuna göre kontrol etmektir. Örneğin, uygulamanız yalnızca oturum açmış kullanıcıların veri yazmasına izin vermek isteyebilir.

Uygulamanız Firebase Authentication kullanıyorsa request.auth değişkeni, veri isteyen istemcinin kimlik doğrulama bilgilerini içerir. request.auth hakkında daha fazla bilgi için referans dokümanlarını inceleyin.

Firebase Authentication, koşulları kullanarak veri erişimini kullanıcı bazında kontrol etmenize olanak tanımak için Firebase Realtime Database ile entegre olur. Kullanıcı kimlik doğrulamasını tamamladığında Realtime Database Güvenlik Kuralları'ndaki auth değişkeni, kullanıcının bilgileriyle doldurulur. Bu bilgiler arasında kullanıcının benzersiz tanımlayıcısı (uid), bağlı hesap verileri (ör. Facebook kimliği veya e-posta adresi) ve diğer bilgiler yer alır. Özel bir kimlik doğrulama sağlayıcısı kullanıyorsanız kullanıcınızın kimlik doğrulama yüküne kendi alanlarınızı ekleyebilirsiniz.

Bu bölümde, Firebase Realtime Database Güvenlik Kuralları dilinin kullanıcılarınızla ilgili kimlik doğrulama bilgileriyle nasıl birleştirileceği açıklanmaktadır. Bu iki kavramı birleştirerek verilere erişimi kullanıcı kimliğine göre kontrol edebilirsiniz.

auth Değişkeni

Kurallardaki önceden tanımlanmış auth değişkeni, kimlik doğrulama gerçekleşmeden önce boştur.

Kullanıcının kimliği Firebase Authentication ile doğrulandıktan sonra aşağıdaki özellikler eklenir:

sağlayıcı	Kullanılan kimlik doğrulama yöntemi ("password", "anonymous", "facebook", "github", "google" veya "twitter").
uid	Tüm sağlayıcılarda benzersiz olması garanti edilen benzersiz bir kullanıcı kimliği.
token	Firebase Auth kimlik jetonunun içeriği. Daha fazla bilgi için auth.token ile ilgili referans belgelerini inceleyin.

Her kullanıcının yalnızca kullanıcıya özel bir yola yazabilmesini sağlamak için auth değişkenini kullanan örnek bir kuralı aşağıda bulabilirsiniz:

{
  "rules": {
    "users": {
      "$user_id": {
        // grants write access to the owner of this user account
        // whose uid must exactly match the key ($user_id)
        ".write": "$user_id === auth.uid"
      }
    }
  }
}

Veritabanınızı Kimlik Doğrulama Koşullarını Destekleyecek Şekilde Yapılandırma

Veritabanınızı yazmayı kolaylaştıracak şekilde yapılandırmak genellikle faydalıdır. Security Rules Kullanıcı verilerini Realtime Database içinde depolamak için yaygın olarak kullanılan bir yöntem, tüm kullanıcılarınızı alt öğeleri her kullanıcının uid değerleri olan tek bir users düğümünde depolamaktır. Bu verilere erişimi yalnızca giriş yapmış kullanıcıların kendi verilerini görebileceği şekilde kısıtlamak istiyorsanız kurallarınız şuna benzer:

{
  "rules": {
    "users": {
      "$uid": {
        ".read": "auth !== null && auth.uid === $uid"
      }
    }
  }
}

Authentication Custom Claims ile çalışma

Farklı kullanıcılar için özel erişim denetimi gerektiren uygulamalarda Firebase Authentication, geliştiricilerin Firebase kullanıcıları için talepler belirlemesine olanak tanır. Bu hak taleplerine kurallarınızdaki auth.token değişkeninden erişilebilir. hasEmergencyTowel özel hak talebini kullanan kurallara bir örnek:

{
  "rules": {
    "frood": {
      // A towel is about the most massively useful thing an interstellar
      // hitchhiker can have
      ".read": "auth.token.hasEmergencyTowel === true"
    }
  }
}

Kendi özel kimlik doğrulama jetonlarını oluşturan geliştiriciler, isteğe bağlı olarak bu jetonlara hak talepleri ekleyebilir. Bu talepler, kurallarınızdaki auth.token değişkeninde kullanılabilir.

Mevcut Veriler ile Yeni Verilerin Karşılaştırması

Önceden tanımlanmış data değişkeni, yazma işlemi gerçekleşmeden önceki verilere başvurmak için kullanılır. Buna karşılık, newData değişkeni, yazma işlemi başarılı olursa mevcut olacak yeni verileri içerir. newData, yazılan yeni veriler ile mevcut verilerin birleştirilmiş sonucunu temsil eder.

Örneğin, bu kural yeni kayıtlar oluşturmamıza veya mevcut kayıtları silmemize izin verir ancak mevcut boş olmayan verilerde değişiklik yapmamıza izin vermez:

// we can write as long as old data or new data does not exist
// in other words, if this is a delete or a create, but not an update
".write": "!data.exists() || !newData.exists()"

Boş veya geçersiz veri olup olmadığını kontrol edin. Kurallardaki hatalar, işlemlerin reddedilmesine neden olur.

Diğer yollardaki verilere referans verme

Herhangi bir veri, kurallar için ölçüt olarak kullanılabilir. Önceden tanımlanmış root, data ve newData değişkenlerini kullanarak yazma etkinliğinden önce veya sonra mevcut olan tüm yollara erişebiliriz.

/allow_writes/ düğümünün değeri true olduğu, üst düğümde readOnly işareti ayarlanmadığı ve yeni yazılan verilerde foo adında bir alt öğe bulunduğu sürece yazma işlemlerine izin veren şu örneği inceleyin:

".write": "root.child('allow_writes').val() === true &&
          !data.parent().child('readOnly').exists() &&
          newData.child('foo').exists()"

Veriler doğrulanıyor

Veri yapılarını zorunlu kılma ve verilerin biçimini ve içeriğini doğrulama işlemleri, yalnızca bir .write kuralı erişim izni verdikten sonra çalıştırılan .validate kuralları kullanılarak yapılmalıdır. Aşağıda, yalnızca 1900-2099 yılları arasında YYYY-AA-GG biçimindeki tarihlere izin veren ve normal ifade kullanılarak kontrol edilen örnek bir .validate kural tanımı verilmiştir.

".validate": "newData.isString() &&
              newData.val().matches(/^(19|20)[0-9][0-9][-\\/. ](0[1-9]|1[012])[-\\/. ](0[1-9]|[12][0-9]|3[01])$/)"

JSFiddle'da deneyin: Uygulamalı olarak görmek için burayı tıklayın. Giriş alanına farklı değerler yazmayı deneyin.

.validate kuralları, basamaklı olmayan tek güvenlik kuralı türüdür. Herhangi bir alt kayıtta doğrulama kuralı başarısız olursa yazma işleminin tamamı reddedilir. Ayrıca, veriler silindiğinde (yani yazılan yeni değer null olduğunda) doğrulama tanımları yoksayılır.

Not: .validate kuralları yalnızca boş olmayan değerler için değerlendirilir ve basamaklı değildir.

Bunlar önemsiz noktalar gibi görünebilir ancak aslında güçlü Firebase Realtime Database Security Rules yazmak için önemli özelliklerdir. Aşağıdaki kuralları göz önünde bulundurun:

{
  "rules": {
    // write is allowed for all paths
    ".write": true,
    "widget": {
      // a valid widget must have attributes "color" and "size"
      // allows deleting widgets (since .validate is not applied to delete rules)
      ".validate": "newData.hasChildren(['color', 'size'])",
      "size": {
        // the value of "size" must be a number between 0 and 99
        ".validate": "newData.isNumber() &&
                      newData.val() >= 0 &&
                      newData.val() <= 99"
      },
      "color": {
        // the value of "color" must exist as a key in our mythical
        // /valid_colors/ index
        ".validate": "root.child('valid_colors/' + newData.val()).exists()"
      }
    }
  }
}

Bu varyantı göz önünde bulundurarak aşağıdaki yazma işlemlerinin sonuçlarına bakın:

JavaScript

var ref = db.ref("/widget");

// PERMISSION_DENIED: does not have children color and size
ref.set('foo');

// PERMISSION DENIED: does not have child color
ref.set({size: 22});

// PERMISSION_DENIED: size is not a number
ref.set({ size: 'foo', color: 'red' });

// SUCCESS (assuming 'blue' appears in our colors list)
ref.set({ size: 21, color: 'blue'});

// If the record already exists and has a color, this will
// succeed, otherwise it will fail since newData.hasChildren(['color', 'size'])
// will fail to validate
ref.child('size').set(99);

Objective-C

Not: Bu Firebase ürünü, Uygulama Klibi hedefinde kullanılamaz.

FIRDatabaseReference *ref = [[[FIRDatabase database] reference] child: @"widget"];

// PERMISSION_DENIED: does not have children color and size
[ref setValue: @"foo"];

// PERMISSION DENIED: does not have child color
[ref setValue: @{ @"size": @"foo" }];

// PERMISSION_DENIED: size is not a number
[ref setValue: @{ @"size": @"foo", @"color": @"red" }];

// SUCCESS (assuming 'blue' appears in our colors list)
[ref setValue: @{ @"size": @21, @"color": @"blue" }];

// If the record already exists and has a color, this will
// succeed, otherwise it will fail since newData.hasChildren(['color', 'size'])
// will fail to validate
[[ref child:@"size"] setValue: @99];

Swift

Not: Bu Firebase ürünü, Uygulama Klibi hedefinde kullanılamaz.

var ref = FIRDatabase.database().reference().child("widget")

// PERMISSION_DENIED: does not have children color and size
ref.setValue("foo")

// PERMISSION DENIED: does not have child color
ref.setValue(["size": "foo"])

// PERMISSION_DENIED: size is not a number
ref.setValue(["size": "foo", "color": "red"])

// SUCCESS (assuming 'blue' appears in our colors list)
ref.setValue(["size": 21, "color": "blue"])

// If the record already exists and has a color, this will
// succeed, otherwise it will fail since newData.hasChildren(['color', 'size'])
// will fail to validate
ref.child("size").setValue(99);

Java

FirebaseDatabase database = FirebaseDatabase.getInstance();
DatabaseReference ref = database.getReference("widget");

// PERMISSION_DENIED: does not have children color and size
ref.setValue("foo");

// PERMISSION DENIED: does not have child color
ref.child("size").setValue(22);

// PERMISSION_DENIED: size is not a number
Map<String,Object> map = new HashMap<String, Object>();
map.put("size","foo");
map.put("color","red");
ref.setValue(map);

// SUCCESS (assuming 'blue' appears in our colors list)
map = new HashMap<String, Object>();
map.put("size", 21);
map.put("color","blue");
ref.setValue(map);

// If the record already exists and has a color, this will
// succeed, otherwise it will fail since newData.hasChildren(['color', 'size'])
// will fail to validate
ref.child("size").setValue(99);

REST

# PERMISSION_DENIED: does not have children color and size
curl -X PUT -d 'foo' \
https://docs-examples.firebaseio.com/rest/securing-data/example.json

# PERMISSION DENIED: does not have child color
curl -X PUT -d '{"size": 22}' \
https://docs-examples.firebaseio.com/rest/securing-data/example.json

# PERMISSION_DENIED: size is not a number
curl -X PUT -d '{"size": "foo", "color": "red"}' \
https://docs-examples.firebaseio.com/rest/securing-data/example.json

# SUCCESS (assuming 'blue' appears in our colors list)
curl -X PUT -d '{"size": 21, "color": "blue"}' \
https://docs-examples.firebaseio.com/rest/securing-data/example.json

# If the record already exists and has a color, this will
# succeed, otherwise it will fail since newData.hasChildren(['color', 'size'])
# will fail to validate
curl -X PUT -d '99' \
https://docs-examples.firebaseio.com/rest/securing-data/example/size.json

Şimdi aynı yapıya .validate yerine .write kuralları kullanarak bakalım:

{
  "rules": {
    // this variant will NOT allow deleting records (since .write would be disallowed)
    "widget": {
      // a widget must have 'color' and 'size' in order to be written to this path
      ".write": "newData.hasChildren(['color', 'size'])",
      "size": {
        // the value of "size" must be a number between 0 and 99, ONLY IF WE WRITE DIRECTLY TO SIZE
        ".write": "newData.isNumber() && newData.val() >= 0 && newData.val() <= 99"
      },
      "color": {
        // the value of "color" must exist as a key in our mythical valid_colors/ index
        // BUT ONLY IF WE WRITE DIRECTLY TO COLOR
        ".write": "root.child('valid_colors/'+newData.val()).exists()"
      }
    }
  }
}

Bu varyantta, aşağıdaki işlemlerden herhangi biri başarılı olur:

JavaScript

var ref = new Firebase(URL + "/widget");

// ALLOWED? Even though size is invalid, widget has children color and size,
// so write is allowed and the .write rule under color is ignored
ref.set({size: 99999, color: 'red'});

// ALLOWED? Works even if widget does not exist, allowing us to create a widget
// which is invalid and does not have a valid color.
// (allowed by the write rule under "color")
ref.child('size').set(99);

Objective-C

Not: Bu Firebase ürünü, Uygulama Klibi hedefinde kullanılamaz.

Firebase *ref = [[Firebase alloc] initWithUrl:URL];

// ALLOWED? Even though size is invalid, widget has children color and size,
// so write is allowed and the .write rule under color is ignored
[ref setValue: @{ @"size": @9999, @"color": @"red" }];

// ALLOWED? Works even if widget does not exist, allowing us to create a widget
// which is invalid and does not have a valid color.
// (allowed by the write rule under "color")
[[ref childByAppendingPath:@"size"] setValue: @99];

Swift

Not: Bu Firebase ürünü, Uygulama Klibi hedefinde kullanılamaz.

var ref = Firebase(url:URL)

// ALLOWED? Even though size is invalid, widget has children color and size,
// so write is allowed and the .write rule under color is ignored
ref.setValue(["size": 9999, "color": "red"])

// ALLOWED? Works even if widget does not exist, allowing us to create a widget
// which is invalid and does not have a valid color.
// (allowed by the write rule under "color")
ref.childByAppendingPath("size").setValue(99)

Java

Firebase ref = new Firebase(URL + "/widget");

// ALLOWED? Even though size is invalid, widget has children color and size,
// so write is allowed and the .write rule under color is ignored
Map<String,Object> map = new HashMap<String, Object>();
map.put("size", 99999);
map.put("color", "red");
ref.setValue(map);

// ALLOWED? Works even if widget does not exist, allowing us to create a widget
// which is invalid and does not have a valid color.
// (allowed by the write rule under "color")
ref.child("size").setValue(99);

REST

# ALLOWED? Even though size is invalid, widget has children color and size,
# so write is allowed and the .write rule under color is ignored
curl -X PUT -d '{size: 99999, color: "red"}' \
https://docs-examples.firebaseio.com/rest/securing-data/example.json

# ALLOWED? Works even if widget does not exist, allowing us to create a widget
# which is invalid and does not have a valid color.
# (allowed by the write rule under "color")
curl -X PUT -d '99' \
https://docs-examples.firebaseio.com/rest/securing-data/example/size.json

Bu örnekte, .write ve .validate kuralları arasındaki farklar gösterilmektedir. Gösterildiği gibi, bu kuralların tümü .validate kullanılarak yazılmalıdır. Silme işlemlerine izin verilip verilmeyeceğine bağlı olarak newData.hasChildren() kuralı istisna olabilir.

Not: Doğrulama kuralları, uygulamanızdaki veri doğrulama kodunun yerini tamamen alacak şekilde tasarlanmamıştır. Uygulamanız çevrimdışıyken en iyi performans ve en iyi kullanıcı deneyimi için istemci tarafında giriş doğrulaması da yapmanızı öneririz.

Sorguya Dayalı Kurallar

Kuralları filtre olarak kullanamasanız da kurallarınızda sorgu parametreleri kullanarak veri alt kümelerine erişimi sınırlayabilirsiniz. Sorgu parametrelerine göre okuma veya yazma erişimi vermek için kurallarınızda query. ifadelerini kullanın.

Örneğin, aşağıdaki sorgu tabanlı kural, baskets koleksiyonundaki verilere erişimi yalnızca etkin kullanıcının sahip olduğu alışveriş sepetleriyle kısıtlamak için kullanıcı tabanlı güvenlik kurallarını ve sorgu tabanlı kuralları kullanır:

"baskets": {
  ".read": "auth.uid !== null &&
            query.orderByChild === 'owner' &&
            query.equalTo === auth.uid" // restrict basket access to owner of basket
}

Kuraldaki sorgu parametrelerini içeren aşağıdaki sorgu başarılı olur:

db.ref("baskets").orderByChild("owner")
                 .equalTo(auth.currentUser.uid)
                 .on("value", cb)                 // Would succeed

Ancak kuraldaki parametreleri içermeyen sorgular PermissionDenied hatasıyla başarısız olur:

db.ref("baskets").on("value", cb)                 // Would fail with PermissionDenied

Okuma işlemleri aracılığıyla bir istemcinin ne kadar veri indireceğini sınırlamak için sorguya dayalı kuralları da kullanabilirsiniz.

Örneğin, aşağıdaki kural, okuma erişimini önceliğe göre sıralanmış bir sorgunun yalnızca ilk 1.000 sonucuyla sınırlandırır:

messages: {
  ".read": "query.orderByKey &&
            query.limitToFirst <= 1000"
}

// Example queries:

db.ref("messages").on("value", cb)                // Would fail with PermissionDenied

db.ref("messages").limitToFirst(1000)
                  .on("value", cb)                // Would succeed (default order by key)

Realtime Database Güvenlik Kuralları'nda aşağıdaki query. ifadeleri kullanılabilir.

Sorguya dayalı kural ifadeleri
İfade	Tür	Açıklama
query.orderByKey query.orderByPriority query.orderByValue	boole	Anahtara, önceliğe veya değere göre sıralanan sorgular için True değerini döndürür. Aksi takdirde False (yanlış) değerini alır.
query.orderByChild	string null	Bir alt düğümün göreli yolunu temsil etmek için dize kullanın. Örneğin, query.orderByChild === "address/zip". Sorgu bir alt düğüme göre sıralanmamışsa bu değer null olur.
query.startAt query.endAt query.equalTo	string number boolean null	Yürütülen sorgunun sınırlarını alır veya sınır ayarlanmamışsa null değerini döndürür.
query.limitToFirst query.limitToLast	sayı null	Yürütülen sorgudaki sınırı alır veya sınır ayarlanmamışsa null değerini döndürür.

Sonraki adımlar

Koşullarla ilgili bu tartışmadan sonra Security Rules hakkında daha ayrıntılı bilgi edindiniz ve şunları yapmaya hazırsınız:

Temel kullanım alanlarını nasıl ele alacağınızı ve Security Rules geliştirme, test etme ve dağıtma iş akışını öğrenin:

• Koşul oluşturmak için kullanabileceğiniz önceden tanımlanmış Security Rules değişkenlerin tamamı hakkında bilgi edinin.
• Sık karşılaşılan senaryoları ele alan kurallar yazın.
• Güvenli olmayan kuralları tespit edip bunlardan kaçınmanız gereken durumları inceleyerek bilgilerinizi pekiştirin.
• Firebase Local Emulator Suite ve bu aracı Security Rules test etmek için nasıl kullanabileceğiniz hakkında bilgi edinin.
• Security Rules dağıtımı için kullanılabilen yöntemleri inceleyin.

Realtime Database'e özgü Security Rules özelliklerini öğrenin:

• Realtime Database içeriğinizi nasıl dizine ekleyeceğinizi öğrenin.
• Security Rules dağıtımı için REST API'yi inceleyin.