ใช้เงื่อนไขในกฎความปลอดภัยของฐานข้อมูลเรียลไทม์

คู่มือนี้สร้างขึ้นจากคู่มือเรียนรู้ภาษาหลักของกฎการรักษาความปลอดภัยของ Firebase เพื่อแสดงวิธีเพิ่มเงื่อนไขลงในกฎการรักษาความปลอดภัยของ Firebase Realtime Database

เงื่อนไขเป็นองค์ประกอบหลักของกฎความปลอดภัยของ Realtime Database เงื่อนไขคือนิพจน์บูลีนที่กำหนดว่าควรอนุญาตหรือปฏิเสธการดำเนินการหนึ่งๆ สำหรับกฎพื้นฐาน การใช้ลิเทอรัล true และ false เป็น เงื่อนไขจะทำงานได้อย่างสมบูรณ์ แต่ภาษาของกฎความปลอดภัยของ Realtime Database จะช่วยให้คุณเขียนเงื่อนไขที่ซับซ้อนยิ่งขึ้นได้ ซึ่งจะทำสิ่งต่อไปนี้ได้

• ตรวจสอบการตรวจสอบสิทธิ์ของผู้ใช้
• ประเมินข้อมูลที่มีอยู่กับข้อมูลที่ส่งใหม่
• เข้าถึงและเปรียบเทียบส่วนต่างๆ ของฐานข้อมูล
• ตรวจสอบข้อมูลขาเข้า
• ใช้โครงสร้างของคำค้นหาขาเข้าสำหรับตรรกะความปลอดภัย

การใช้ตัวแปร $ เพื่อบันทึกกลุ่มเส้นทาง

คุณสามารถบันทึกส่วนของเส้นทางสำหรับการอ่านหรือเขียนได้โดยการประกาศตัวแปรการบันทึกที่มีคำนำหน้า $ ซึ่งทำหน้าที่เป็นอักขระแทน และจัดเก็บค่าของคีย์นั้นเพื่อใช้ภายใน เงื่อนไขของกฎ

{
  "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')"
        }
      }
    }
  }
}

นอกจากนี้ยังใช้ตัวแปร $ แบบไดนามิกร่วมกับชื่อเส้นทางแบบค่าคงที่ได้ด้วย ในตัวอย่างนี้ เราใช้ตัวแปร $other เพื่อประกาศ .validate กฎที่รับประกันว่า widget จะไม่มีองค์ประกอบย่อยอื่นนอกเหนือจาก title และ color การเขียนใดๆ ที่จะส่งผลให้มีการสร้างรายการย่อยเพิ่มเติมจะล้มเหลว

{
  "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 }
    }
  }
}

การตรวจสอบสิทธิ์

รูปแบบกฎความปลอดภัยที่พบบ่อยที่สุดอย่างหนึ่งคือการควบคุมการเข้าถึงตาม สถานะการตรวจสอบสิทธิ์ของผู้ใช้ เช่น แอปอาจต้องการอนุญาตให้เฉพาะผู้ใช้ที่ลงชื่อเข้าใช้เขียนข้อมูลได้

หากแอปใช้การตรวจสอบสิทธิ์ Firebase ตัวแปร request.auth จะมี ข้อมูลการตรวจสอบสิทธิ์สำหรับไคลเอ็นต์ที่ขอข้อมูล ดูข้อมูลเพิ่มเติมเกี่ยวกับ request.auth ได้ที่เอกสารอ้างอิง

Firebase Authentication ทำงานร่วมกับ Firebase Realtime Database เพื่อให้คุณควบคุมการเข้าถึงข้อมูล ของผู้ใช้แต่ละรายได้โดยใช้เงื่อนไข เมื่อผู้ใช้ตรวจสอบสิทธิ์แล้ว ระบบจะป้อนข้อมูลผู้ใช้ลงในตัวแปร auth ในกฎความปลอดภัยของ Realtime Database ข้อมูลนี้รวมถึงตัวระบุที่ไม่ซ้ำกัน (uid) รวมถึงข้อมูลบัญชีที่ลิงก์ เช่น รหัส Facebook หรืออีเมล และ ข้อมูลอื่นๆ หากคุณใช้ผู้ให้บริการการตรวจสอบสิทธิ์ที่กำหนดเอง คุณจะเพิ่มช่องของคุณเอง ลงในเพย์โหลดการตรวจสอบสิทธิ์ของผู้ใช้ได้

ส่วนนี้จะอธิบายวิธีรวมภาษาของกฎความปลอดภัยของฐานข้อมูลเรียลไทม์ของ Firebase กับ ข้อมูลการตรวจสอบสิทธิ์เกี่ยวกับผู้ใช้ การรวมแนวคิดทั้ง 2 อย่างนี้เข้าด้วยกัน จะช่วยให้คุณควบคุมการเข้าถึงข้อมูลตามข้อมูลประจำตัวของผู้ใช้ได้

auth ตัวแปร

ตัวแปร auth ที่กำหนดไว้ล่วงหน้าในกฎจะเป็นค่าว่างก่อน การตรวจสอบสิทธิ์

เมื่อตรวจสอบสิทธิ์ผู้ใช้ด้วยการตรวจสอบสิทธิ์ Firebase แล้ว ระบบจะกำหนดแอตทริบิวต์ต่อไปนี้

ต่อไปนี้คือตัวอย่างกฎที่ใช้ตัวแปร auth เพื่อให้มั่นใจว่า ผู้ใช้แต่ละรายจะเขียนได้เฉพาะเส้นทางของผู้ใช้รายนั้นๆ

{
  "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"
      }
    }
  }
}

การจัดโครงสร้างฐานข้อมูลเพื่อรองรับเงื่อนไขการตรวจสอบสิทธิ์

โดยปกติแล้ว การจัดโครงสร้างฐานข้อมูลในลักษณะที่ช่วยให้เขียนRulesได้ง่ายขึ้นจะเป็นประโยชน์ รูปแบบทั่วไปอย่างหนึ่งสำหรับการจัดเก็บข้อมูลผู้ใช้ใน Realtime Database คือ การจัดเก็บผู้ใช้ทั้งหมดไว้ในโหนด users เดียวที่มีโหนดย่อยเป็น ค่า uid สำหรับผู้ใช้ทุกคน หากต้องการจำกัดการเข้าถึงข้อมูลนี้เพื่อให้เฉพาะผู้ใช้ที่เข้าสู่ระบบเท่านั้นที่เห็นข้อมูลของตนเอง กฎของคุณจะมีลักษณะดังนี้

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

การทำงานกับเคลมที่กำหนดเองสำหรับการตรวจสอบสิทธิ์

สำหรับแอปที่ต้องมีการควบคุมการเข้าถึงที่กำหนดเองสำหรับผู้ใช้ที่แตกต่างกัน Firebase Authentication ช่วยให้นักพัฒนาแอปตั้งค่าการอ้างสิทธิ์ในผู้ใช้ Firebase ได้ คุณเข้าถึงการอ้างสิทธิ์เหล่านี้ได้ในตัวแปรauth.tokenในกฎ ตัวอย่างกฎที่ใช้hasEmergencyTowel การอ้างสิทธิ์ที่กำหนดเองมีดังนี้

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

นักพัฒนาแอปที่สร้าง โทเค็นการตรวจสอบสิทธิ์ที่กำหนดเองสามารถเพิ่มการอ้างสิทธิ์ลงในโทเค็นเหล่านี้ได้ โดยคุณจะดูการอ้างสิทธิ์เหล่านี้ได้ในตัวแปร auth.token ในกฎ

ข้อมูลที่มีอยู่เทียบกับข้อมูลใหม่

ใช้ตัวแปร data ที่กำหนดไว้ล่วงหน้าเพื่ออ้างอิงถึงข้อมูลก่อน การดำเนินการเขียน ในทางกลับกัน ตัวแปร newData จะมีข้อมูลใหม่ที่จะมีอยู่หากการดำเนินการเขียนสำเร็จ newData แสดงผลลัพธ์ที่ผสานรวมของข้อมูลใหม่ที่เขียน และข้อมูลที่มีอยู่

ตัวอย่างเช่น กฎนี้จะช่วยให้เราสร้างระเบียนใหม่หรือลบระเบียนที่มีอยู่ได้ แต่จะเปลี่ยนแปลงข้อมูลที่มีอยู่ซึ่งไม่ใช่ค่าว่างไม่ได้

// 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()"

การอ้างอิงข้อมูลในเส้นทางอื่นๆ

คุณใช้ข้อมูลใดก็ได้เป็นเกณฑ์สำหรับกฎ การใช้ตัวแปรที่กำหนดไว้ล่วงหน้า root, data และ newData เรา สามารถเข้าถึงเส้นทางใดก็ได้เหมือนกับที่เส้นทางนั้นมีอยู่ก่อนหรือหลังเหตุการณ์การเขียน

พิจารณาตัวอย่างนี้ ซึ่งอนุญาตการดำเนินการเขียนตราบใดที่ค่าของโหนด /allow_writes/ เป็น true โหนดระดับบนไม่มีการตั้งค่าแฟล็ก readOnly และมีโหนดลูกชื่อ foo ใน ข้อมูลที่เขียนใหม่

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

การตรวจสอบข้อมูล

การบังคับใช้โครงสร้างข้อมูลและการตรวจสอบรูปแบบและเนื้อหาของข้อมูลควรทำโดยใช้.validateกฎ ซึ่งจะทำงานหลังจากที่กฎ.writeทำงานสำเร็จเพื่อให้สิทธิ์เข้าถึงเท่านั้น ด้านล่างนี้คือตัวอย่าง .validate คำจำกัดความของกฎที่อนุญาตเฉพาะวันที่ในรูปแบบ ปปปป-ดด-วว ระหว่างปี 1900-2099 ซึ่งตรวจสอบโดยใช้นิพจน์ทั่วไป

".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])$/)"

.validateเป็นกฎความปลอดภัยประเภทเดียวที่ไม่เรียงซ้อน หากกฎการตรวจสอบใดๆ ล้มเหลวในระเบียนย่อย ระบบจะปฏิเสธการดำเนินการเขียนทั้งหมด นอกจากนี้ ระบบจะไม่สนใจคำจำกัดความการตรวจสอบเมื่อมีการลบข้อมูล (นั่นคือเมื่อค่าใหม่ ที่เขียนเป็น null)

แม้ว่าสิ่งเหล่านี้อาจดูเหมือนเป็นจุดเล็กๆ แต่จริงๆ แล้วเป็นฟีเจอร์สำคัญสำหรับการเขียน กฎความปลอดภัยของ Firebase Realtime Database ที่มีประสิทธิภาพ โปรดพิจารณากฎต่อไปนี้

{
  "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()"
      }
    }
  }
}

เมื่อพิจารณาถึงตัวแปรนี้แล้ว ให้ดูผลลัพธ์ของการดำเนินการเขียนต่อไปนี้

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);

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];

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);

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);

# 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

ตอนนี้มาดูโครงสร้างเดียวกัน แต่ใช้กฎ .write แทน .validate กัน

{
  "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()"
      }
    }
  }
}

ในตัวแปรนี้ การดำเนินการต่อไปนี้จะสำเร็จ

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);

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];

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)

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);

# 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

ซึ่งแสดงให้เห็นความแตกต่างระหว่างกฎ .write กับ .validate ดังที่แสดงให้เห็น กฎทั้งหมดเหล่านี้ควรเขียนโดยใช้ .validate โดยมีข้อยกเว้นที่เป็นไปได้สำหรับกฎ newData.hasChildren() ซึ่งจะขึ้นอยู่กับว่าควรอนุญาตให้ลบหรือไม่

กฎที่อิงตามคำค้นหา

แม้ว่าจะใช้กฎเป็นตัวกรองไม่ได้ แต่คุณก็จำกัดการเข้าถึงข้อมูลชุดย่อยได้โดยใช้พารามิเตอร์การค้นหาในกฎ ใช้query.นิพจน์ในกฎเพื่อให้สิทธิ์อ่านหรือเขียนตามพารามิเตอร์การค้นหา

ตัวอย่างเช่น กฎที่อิงตามการค้นหาต่อไปนี้ใช้กฎความปลอดภัยตามผู้ใช้ และกฎที่อิงตามการค้นหาเพื่อจำกัดการเข้าถึงข้อมูลในคอลเล็กชัน baskets เฉพาะตะกร้าสินค้าที่ผู้ใช้ที่ใช้งานอยู่เป็นเจ้าของ

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

การค้นหาต่อไปนี้ซึ่งมีพารามิเตอร์การค้นหาในกฎจะ สําเร็จ

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

อย่างไรก็ตาม การค้นหาที่ไม่มีพารามิเตอร์ในกฎจะล้มเหลวโดยมีข้อผิดพลาด PermissionDenied

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

นอกจากนี้ คุณยังใช้กฎที่อิงตามการค้นหาเพื่อจำกัดปริมาณข้อมูลที่ไคลเอ็นต์ดาวน์โหลด ผ่านการดำเนินการอ่านได้ด้วย

ตัวอย่างเช่น กฎต่อไปนี้จำกัดสิทธิ์การอ่านเฉพาะผลลัพธ์ 1,000 รายการแรก ของการค้นหาตามลำดับความสำคัญ

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)

นิพจน์ query. ต่อไปนี้พร้อมใช้งานในกฎความปลอดภัยของ Realtime Database

ขั้นตอนถัดไป

หลังจากพูดคุยเรื่องเงื่อนไขนี้แล้ว คุณจะมีความเข้าใจที่ซับซ้อนมากขึ้นเกี่ยวกับ Rules และพร้อมที่จะทำสิ่งต่อไปนี้

ดูวิธีจัดการกรณีการใช้งานหลัก และดูเวิร์กโฟลว์สำหรับการพัฒนา การทดสอบ และการติดตั้งใช้งาน Rules:

• ดูชุดRules ตัวแปรที่กำหนดไว้ล่วงหน้าทั้งหมดที่คุณใช้ได้ เพื่อสร้างเงื่อนไข
• เขียนกฎที่ใช้กับสถานการณ์ทั่วไป
• เสริมความรู้ด้วยการทบทวนสถานการณ์ที่คุณต้องระบุและหลีกเลี่ยงกฎที่ไม่ปลอดภัย
• ดูข้อมูลเกี่ยวกับ Firebase Local Emulator Suite และวิธีใช้เพื่อทดสอบRules
• ตรวจสอบวิธีการที่ใช้ได้สำหรับการติดตั้งใช้งานRules

ดูฟีเจอร์ของ Rules ที่มีเฉพาะใน Realtime Database

• ดูวิธีจัดทำดัชนี Realtime Database
• ดู REST API สำหรับการติดตั้งใช้งาน Rules