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

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

องค์ประกอบหลักของกฎความปลอดภัยของ 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, โหนดหลักไม่ได้ตั้งค่า Flag 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 ที่มีประสิทธิภาพ โปรดพิจารณากฎต่อไปนี้

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