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

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

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

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

การวางโครงสร้างกฎความปลอดภัยของคุณ

กฎความปลอดภัยของฐานข้อมูลแบบเรียลไทม์ประกอบด้วยนิพจน์ที่เหมือน 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"
      }
    }
  }
}

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

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

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

ตัวแปรการจับสัญลักษณ์แทน

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

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

อ่านและเขียนกฎ Cascade

.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
});
วัตถุประสงค์-C
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
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 ข้อผิดพลาด ถ้าเราประเมินกฎนี้ในการจำลองการรักษาความปลอดภัยของเรา Firebase คอนโซล เราจะเห็นว่าการดำเนินการอ่านถูกปฏิเสธเพราะกฎการอ่านไม่ได้รับอนุญาตให้เข้าถึง /records/ เส้นทาง อย่างไรก็ตามทราบว่ากฎสำหรับ rec1 ก็ไม่เคยได้รับการประเมินเพราะมันไม่ได้อยู่ในเส้นทางที่เราร้องขอ สามารถดึงข้อมูล rec1 เราจะต้องเข้าถึงได้โดยตรง

JavaScript
var db = firebase.database();
db.ref("records/rec1").once("value", function(snap) {
  // SUCCESS!
}, function(err) {
  // error callback is not called
});
วัตถุประสงค์-C
FIRDatabaseReference *ref = [[FIRDatabase database] reference];
[[ref child:@"records/rec1"] observeSingleEventOfType:FEventTypeValue withBlock:^(FIRDataSnapshot *snapshot) {
    // SUCCESS!
}];
Swift
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!

คำชี้แจงที่ทับซ้อนกัน

เป็นไปได้มากกว่าหนึ่งกฎที่จะนำไปใช้กับโหนด ในกรณีที่กฎหลายสำนวนที่ระบุโหนดวิธีการเข้าถึงถูกปฏิเสธหากเงื่อนไขใด ๆ เป็น 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 โหนดจะถูกปฏิเสธเพราะกฎที่สองอยู่เสมอ false แม้ว่ากฎข้อแรกอยู่เสมอ true

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

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