ดูข้อมูลเกี่ยวกับไวยากรณ์หลักของภาษาของกฎความปลอดภัยของฐานข้อมูลแบบเรียลไทม์

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

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

หัวข้อนี้อธิบายไวยากรณ์และโครงสร้างพื้นฐานของกฎการรักษาความปลอดภัยสำหรับ Realtime Database ที่ใช้สร้างชุดกฎที่สมบูรณ์

การจัดโครงสร้างกฎการรักษาความปลอดภัย

กฎการรักษาความปลอดภัยสำหรับ Realtime Database ประกอบด้วยนิพจน์ที่คล้ายกับ JavaScript ซึ่งอยู่ในเอกสาร JSON โครงสร้างของกฎควรเป็นไปตามโครงสร้างของข้อมูลที่คุณจัดเก็บไว้ในฐานข้อมูล

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

ดังนั้น หากเราพยายามรักษาความปลอดภัย child_node ภายใต้ parent_node ไวยากรณ์ทั่วไปที่ควรปฏิบัติตามคือ

{
  "rules": {
    "parent_node": {
      "child_node": {
        ".read": <condition>,
        ".write": <condition>,
        ".validate": <condition>,
      }
    }
  }
}

ลองใช้รูปแบบนี้กัน สมมติว่าคุณกำลังติดตามรายการข้อความและมีข้อมูลลักษณะดังนี้

{
  "messages": {
    "message0": {
      "content": "Hello",
      "timestamp": 1405704370369
    },
    "message1": {
      "content": "Goodbye",
      "timestamp": 1405704395231
    },
    ...
  }
}

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

{
  "rules": {
    // For requests to access the 'messages' node...
    "messages": {
      // ...and the individual wildcarded 'message' nodes beneath
      // (we'll cover wildcarding variables more a bit later)....
      "$message": {

        // For each message, allow a read operation if <condition>. In this
        // case, we specify our condition as "true", so read access is always granted.
        ".read": "true",

        // For read-only behavior, we specify that for write operations, our
        // condition is false.
        ".write": "false"
      }
    }
  }
}

การดำเนินการกฎพื้นฐาน

กฎสำหรับการบังคับใช้การรักษาความปลอดภัยมี 3 ประเภทตามประเภทการดำเนินการที่ทำกับข้อมูล ได้แก่ .write, .read และ .validate ต่อไปนี้เป็นข้อมูลสรุปคร่าวๆ เกี่ยวกับวัตถุประสงค์ของกฎแต่ละประเภท

ประเภทกฎ
.read อธิบายว่าผู้ใช้ได้รับอนุญาตให้อ่านข้อมูลหรือไม่และเมื่อใด
.write อธิบายว่าได้รับอนุญาตให้เขียนข้อมูลหรือไม่และเมื่อใด
.validate กำหนดลักษณะของค่าที่จัดรูปแบบอย่างถูกต้อง ไม่ว่าจะมีแอตทริบิวต์ย่อยและประเภทข้อมูลหรือไม่

ตัวแปรการจับภาพไวลด์การ์ด

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

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

การทำงานแบบเรียงซ้อนของกฎการอ่านและการเขียน

กฎ .read และ .write จะทำงานจากบนลงล่าง โดยกฎระดับบนจะลบล้างกฎระดับล่าง หากกฎให้สิทธิ์อ่านหรือเขียนในเส้นทางหนึ่ง กฎนั้นจะให้สิทธิ์เข้าถึง โหนดระดับล่างทั้งหมดภายใต้เส้นทางนั้นด้วย ลองดูโครงสร้างต่อไปนี้

{
  "rules": {
     "foo": {
        // allows read to /foo/*
        ".read": "data.child('baz').val() === true",
        "bar": {
          /* ignored, since read was allowed already */
          ".read": false
        }
     }
  }
}

โครงสร้างการรักษาความปลอดภัยนี้อนุญาตให้อ่าน /bar/ ได้ทุกเมื่อที่ /foo/ มีรายการย่อย baz ที่มีค่า true กฎ ".read": false ภายใต้ /foo/bar/ จะไม่มี ผลในที่นี้ เนื่องจากเส้นทางระดับล่างไม่สามารถเพิกถอนการเข้าถึงได้

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

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

กฎไม่ใช่ตัวกรอง

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

{
  "rules": {
    "records": {
      "rec1": {
        ".read": true
      },
      "rec2": {
        ".read": false
      }
    }
  }
}

หากไม่เข้าใจว่าระบบจะประเมินกฎในลักษณะอะตอมมิก คุณอาจคิดว่าการดึงเส้นทาง /records/ จะแสดงผล rec1 แต่ไม่แสดงผล rec2 อย่างไรก็ตาม ผลลัพธ์ที่เกิดขึ้นจริงคือข้อผิดพลาด

JavaScript
var db = firebase.database();
db.ref("records").once("value", function(snap) {
  // success method is not called
}, function(err) {
  // error callback triggered with PERMISSION_DENIED
});
Objective-C
หมายเหตุ: ผลิตภัณฑ์ Firebase นี้ไม่พร้อมใช้งานในเป้าหมาย App Clip 
FIRDatabaseReference *ref = [[FIRDatabase database] reference];
[[_ref child:@"records"] observeSingleEventOfType:FIRDataEventTypeValue withBlock:^(FIRDataSnapshot *snapshot) {
  // success block is not called
} withCancelBlock:^(NSError * _Nonnull error) {
  // cancel block triggered with PERMISSION_DENIED
}];
Swift
หมายเหตุ: ผลิตภัณฑ์ Firebase นี้ไม่พร้อมใช้งานในเป้าหมาย App Clip 
var ref = FIRDatabase.database().reference()
ref.child("records").observeSingleEventOfType(.Value, withBlock: { snapshot in
    // success block is not called
}, withCancelBlock: { error in
    // cancel block triggered with PERMISSION_DENIED
})
Java
FirebaseDatabase database = FirebaseDatabase.getInstance();
DatabaseReference ref = database.getReference("records");
ref.addListenerForSingleValueEvent(new ValueEventListener() {
  @Override
  public void onDataChange(DataSnapshot snapshot) {
    // success method is not called
  }

  @Override
  public void onCancelled(FirebaseError firebaseError) {
    // error callback triggered with PERMISSION_DENIED
  });
});
REST
curl https://docs-examples.firebaseio.com/rest/records/
# response returns a PERMISSION_DENIED error

เนื่องจากการดำเนินการอ่านที่ /records/ เป็นแบบอะตอมมิก และไม่มีกฎการอ่านที่ให้สิทธิ์เข้าถึงข้อมูลทั้งหมดภายใต้ /records/ การดำเนินการนี้จึงจะแสดงข้อผิดพลาด PERMISSION_DENIED หากเราประเมิน กฎนี้ในเครื่องมือจำลองการรักษาความปลอดภัยในคอนโซลFirebaseFirebase เราจะเห็นว่า ระบบปฏิเสธการดำเนินการอ่านเนื่องจากไม่มีกฎการอ่านที่อนุญาตให้เข้าถึงเส้นทาง /records/ อย่างไรก็ตาม โปรดทราบว่าระบบไม่เคยประเมินกฎสำหรับ rec1 เนื่องจากกฎดังกล่าวไม่ได้อยู่ในเส้นทางที่เราขอ หากต้องการดึง rec1 เราจะต้องเข้าถึงโดยตรงดังนี้

JavaScript
var db = firebase.database();
db.ref("records/rec1").once("value", function(snap) {
  // SUCCESS!
}, function(err) {
  // error callback is not called
});
Objective-C
หมายเหตุ: ผลิตภัณฑ์ Firebase นี้ไม่พร้อมใช้งานในเป้าหมาย App Clip 
FIRDatabaseReference *ref = [[FIRDatabase database] reference];
[[ref child:@"records/rec1"] observeSingleEventOfType:FEventTypeValue withBlock:^(FIRDataSnapshot *snapshot) {
    // SUCCESS!
}];
Swift
หมายเหตุ: ผลิตภัณฑ์ Firebase นี้ไม่พร้อมใช้งานในเป้าหมาย App Clip 
var ref = FIRDatabase.database().reference()
ref.child("records/rec1").observeSingleEventOfType(.Value, withBlock: { snapshot in
    // SUCCESS!
})
Java
FirebaseDatabase database = FirebaseDatabase.getInstance();
DatabaseReference ref = database.getReference("records/rec1");
ref.addListenerForSingleValueEvent(new ValueEventListener() {
  @Override
  public void onDataChange(DataSnapshot snapshot) {
    // SUCCESS!
  }

  @Override
  public void onCancelled(FirebaseError firebaseError) {
    // error callback is not called
  }
});
REST
curl https://docs-examples.firebaseio.com/rest/records/rec1
# SUCCESS!

คำสั่งที่ทับซ้อนกัน

กฎมากกว่า 1 ข้ออาจใช้กับโหนดได้ ในกรณีที่นิพจน์กฎหลายรายการระบุโหนด ระบบจะปฏิเสธวิธีการเข้าถึงหากเงื่อนไข ใดๆ เป็น false

{
  "rules": {
    "messages": {
      // A rule expression that applies to all nodes in the 'messages' node
      "$message": {
        ".read": "true",
        ".write": "true"
      },
      // A second rule expression applying specifically to the 'message1` node
      "message1": {
        ".read": "false",
        ".write": "false"
      }
    }
  }
}

ในตัวอย่างด้านบน ระบบจะปฏิเสธการอ่านโหนด message1 เนื่องจากกฎที่ 2 เป็น false เสมอ แม้ว่ากฎแรกจะเป็น true เสมอ

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

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