Rule syntax and structure in Firebase - Mini Project: Build & Apply

Firebase Rule Syntax and Structure

📖 Scenario: You are setting up security rules for a Firebase Realtime Database to control access to user data in a simple app.

🎯 Goal: Build a basic Firebase Realtime Database security rule that allows read and write access only to authenticated users under their own user ID.

📋 What You'll Learn

Create a rules dictionary with a rules key

Add a users node under rules to represent user data

Set read and write permissions to allow only authenticated users to access their own data using auth.uid

Use the correct Firebase rule syntax for matching user IDs

💡 Why This Matters

🌍 Real World

Firebase security rules protect user data in mobile and web apps by controlling who can read or write data.

💼 Career

Understanding Firebase rules is essential for developers working with Firebase backend services to ensure app security and data privacy.

1

Create the base rules structure

Create a variable called rules that is a dictionary with a key rules set to an empty dictionary {}.

Firebase

# Your code here

Hint

Start by creating a dictionary named rules with a key rules set to an empty dictionary.

2

Add the users node under rules

Add a key users inside rules["rules"] and set it to an empty dictionary {}.

Firebase

rules = {
    "rules": {
        # Add users node here
    }
}

Hint

Inside the rules dictionary, add a users key with an empty dictionary as its value.

3

Add a wildcard to match user IDs

Inside rules["rules"]["users"], add a wildcard key "$user_id" set to an empty dictionary {}.

Firebase

rules = {
    "rules": {
        "users": {
            # Add $user_id wildcard here
        }
    }
}

Hint

Use a wildcard "$user_id" inside users to represent any user ID.

4

Set read and write rules for authenticated users

Inside rules["rules"]["users"]["$user_id"], add ".read" and ".write" keys. Set both to the condition "auth != null && auth.uid == $user_id".

Firebase

rules = {
    "rules": {
        "users": {
            "$user_id": {
                # Add .read and .write rules here
            }
        }
    }
}

Hint

Set both .read and .write to allow only authenticated users matching the user ID.

Practice

1. What is the main purpose of a match block in Firebase security rules?

easy

A. To create new collections automatically

B. To define user roles and permissions

C. To write data to the database

D. To specify which data paths the rules apply to

Solution

1. Step 1: Understand the role of match blocks

   The match block is used to specify the path in the database where the rules apply.

2. Step 2: Differentiate from other rule parts

   Other parts like allow control access, but match targets the data location.

3. Final Answer:

   To specify which data paths the rules apply to -> Option D

4. Quick Check:

   match = data path selector [OK]

Hint: Remember: match points to data location [OK]

Common Mistakes:

• Confusing match with allow
• Thinking match defines user roles
• Assuming match writes data

2. Which of the following is the correct syntax to allow read access to all users in a Firebase rule?

easy

A. allow read { true }

B. allow read: if true;

C. allow read = true;

D. allow read if (true)

Solution

1. Step 1: Recall correct allow syntax

   The correct syntax uses a colon and condition: allow read: if true;

2. Step 2: Check other options for syntax errors

   Options A, B, and D use incorrect symbols or missing keywords.

3. Final Answer:

   allow read: if true; -> Option B

4. Quick Check:

   Correct allow syntax uses colon and if [OK]

Hint: Use colon and 'if' for conditions in allow [OK]

Common Mistakes:

• Using '=' instead of ':'
• Omitting 'if' keyword
• Using braces instead of semicolon

3. Given the rule snippet:

match /posts/{postId} {
  allow read: if request.auth != null;
  allow write: if request.auth.uid == resource.data.authorId;
}

What happens if a logged-in user tries to write to a post they did NOT create?

medium

A. Write is denied because user is not the author

B. Write is allowed because user is logged in

C. Write is allowed only if postId matches user ID

D. Write is denied because read access is restricted

Solution

1. Step 1: Analyze write condition

   Write is allowed only if request.auth.uid == resource.data.authorId, meaning user must be the author.

2. Step 2: Apply condition to user not author

   If user is logged in but not the author, condition fails, so write is denied.

3. Final Answer:

   Write is denied because user is not the author -> Option A

4. Quick Check:

   Write allowed only for author = A [OK]

Hint: Check if user ID matches author ID for write [OK]

Common Mistakes:

• Assuming any logged-in user can write
• Confusing read and write conditions
• Ignoring resource data in condition

4. Identify the error in this Firebase rule snippet:

match /users/{userId} {
  allow read if request.auth.uid == userId;
  allow write: if request.auth.uid == userId;
}

medium

A. Missing colon after 'allow read'

B. Incorrect variable name 'userId'

C. Missing semicolon after 'allow write' condition

D. Using '==' instead of '=' in conditions

Solution

1. Step 1: Check syntax for 'allow' statements

   Each allow must have a colon before the condition, e.g., allow read: if ...;

2. Step 2: Identify missing colon

   The first line misses colon after allow read, causing syntax error.

3. Final Answer:

   Missing colon after 'allow read' -> Option A

4. Quick Check:

   Colon required after allow keyword [OK]

Hint: Always put colon after allow before condition [OK]

Common Mistakes:

• Omitting colon after allow
• Confusing '=' and '=='
• Forgetting semicolon at line end

5. You want to write a rule that allows users to read their own profile data but only write if their profile contains a non-empty 'name' field. Which rule snippet correctly enforces this?

hard

A. match /profiles/{userId} {
allow read: if request.auth.uid == userId;
allow write: if request.resource.data.name != "";
}

B. match /profiles/{userId} {
allow read: if request.auth.uid == userId;
allow write: if request.auth.uid == userId || request.resource.data.name != "";
}

C. match /profiles/{userId} {
allow read: if request.auth.uid == userId;
allow write: if request.auth.uid == userId && request.resource.data.name != "";
}

D. match /profiles/{userId} {
allow read: if true;
allow write: if request.auth.uid == userId && request.resource.data.name == "";
}

Solution

1. Step 1: Understand read condition

   Users can read only their own profile: request.auth.uid == userId.

2. Step 2: Understand write condition

   Write allowed only if user owns profile AND 'name' field is not empty: request.auth.uid == userId && request.resource.data.name != "".

3. Step 3: Check options for correct logic

   match /profiles/{userId} { allow read: if request.auth.uid == userId; allow write: if request.auth.uid == userId && request.resource.data.name != ""; } matches both conditions correctly; others use wrong logic or allow too much.

4. Final Answer:

   match /profiles/{userId} { allow read: if request.auth.uid == userId; allow write: if request.auth.uid == userId && request.resource.data.name != ""; } -> Option C

5. Quick Check:

   Use AND for ownership and non-empty name [OK]

Hint: Use AND (&&) to combine ownership and data checks [OK]

Common Mistakes:

• Using OR (||) instead of AND (&&)
• Allowing write without ownership check
• Checking for empty string incorrectly