Can debug logging be added to firestore rules functions? - firebase

Given that the firestore rules structure allows for functions, is there some way to add debug logs to those rule-functions ? .. in order to verify that the function you expect, is in fact being called.
I see that with the simulator it shows a red X at the line in the rules sturcture, where access is denied for a given simulation-request. However, am curious for verification in production mode so it can be communicated to parties concerned about the rules integrity.
In the example below, I was thinking it might be implemented with that commented-out line:
console.log('ENTER: isAccessOn()');
However this does not work. Asking here in case there's any option for something like this in the platform.. or if not, if there's a suggestion for how to make such verifications with a production deployment. Thanks
service cloud.firestore {
match /databases/{database}/documents {
// block client access
function isAccessOn() {
// console.log('ENTER: isAccessOn()');
return false;
}
match /{document=**} {
allow read, write: if isAccessOn();
}
}
}

You may want to look into local rules emulation using the Firebase CLI, which is a brand new feature of the CLI. You can do simple logging with the emulator with the debug() function.
However, there is no way to log anything in security rules in production. If you want to verify that your rules work as expected, you should write some integration tests for those and run your tests to make sure access is rejected or allowed according to your specifications.

Firestore rules now have a
debug() function
It's still not brilliant but better than before.

You can use the debug function in rules like this:
match /databases/{database}/documents {
match /{document=**} {
// show paths being requested
allow create, read, update, delete: if debug(request.path);
}
}
Then watch the log file:
tail -f firestore-debug.log

Related

Firebase: Firestore security rule for production

Below is a sample security code I am trying to implement in production but it keeps throwing following error.
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
match /{document=**} {
allow read: if request.time < timestamp.date(2022, 4, 13);
}
}
}
Error:
Missing or insufficient permissions.
I only want a "read only" database for production. What am I missing here?
allow read: if request.time < timestamp.date(2022, 4, 13);
This statement returns true only when time of current time is before 13th April 2022 that was yesterday.
match /{doc=**} {
allow read: if true;
}
You can switch to rules shown above to always allow read operations.
However, these rules allow anyone on the internet to read your database (that should be fine for this specific use case) but you should write secure rules if you also have any other use case.
Checkout more about security rules in the documentation. Also checkout Get to know Cloud Firestore | Security Rules video on Firebase's Youtube channel.
if you want a read-only database then you're probably looking for the ruleset something like this:
allow read;
allow write: if false;
And, just an extra tip, give your users the most minimal permissions. That means, in this case, itself, you probably don't want to give your users read permission to the entire database.
So, it's always a better choice to allow reading or writing only to the specific collections or documents.

Firebase Firestore security rules seem not applied at all

I'm quite new to Firebase, but either I misunderstand something completely or there's something wrong with my Firebase account.
I added a Firestore Database to my Firebase app, and initially I chose it to be created in test mode. As far as I've read in the docs, test mode differs from production mode only by the default security rules.
I wanted to configure my rules properly, so the users can only access their own data.
However, I couldn't make it work, so I tried to configure my Firestore security rules to not allow any read or write operations to anyone. This is what I have currently set in Firestore Database -> Rules:
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
match /{document=**} {
allow read, write: if false;
}
}
}
As I understand, these rules should not allow any read or writes in any collection in my database.
The rules playground tells me exactly that when I try to run any request:
However, from my NextJS app I'm still able to get the data as follows:
import {
getFirebaseAdmin
} from 'next-firebase-auth';
// ...
const categoriesDocument = await getFirebaseAdmin()
.firestore()
.collection('categories')
.doc('D47pV7TxNpDNYNkHgfU0')
.get();
and it all works just fine. I'm also sure the data is fetched from exactly this Firestore db, because when I alter some documents it's reflected in the data fetched.
I also noticed that in Firebase in Firestore Database -> Rules -> Monitor rules I see no results at all (total allows: 0, total denies: 0, total errors: 0).
Any idea what could be wrong here? What am I missing?
On the server, you're using firestore as admin. Rules don't apply there.

How to use Firestore Security Rules perfectly

I read the documentation and watched the video about this
but still not understanding perfectly
I mean I know how to write those security rules
but when should I use this?
do I have to write out all Security Rules for all the collections and documents? (if do so, it`s gonna be huge)
for instance, I`m making random dating app right now.
in my situation, I think I would not be so concerned about security unless I'm concerned with the payment system.
If I do not set up security rules for all documents, are all those documents in danger? (unsecured ones)
Unless you want anyone on the internet to be able to read and write any document in your database, you will need to use security rules to protect them. Whether or not this is going to be a problem for you, it's impossible to tell. But the possibility exists.
Go through this step by step then you will know how to use rules this
Basic Rules
Our Firestore security rules for Fogo, our image-sharing app, are as follows:
service cloud.firestore {
match /databases/{database}/documents {
match /uploads/{document=**} {
allow write: if request.auth.token.admin == true ;
allow read;
}
​
match /users/{document=**} {
allow read, write: if request.auth.token.admin == true ;
}
}
}
Let's break these rules down line-by-line.
service cloud.firestore — defines the service, in this case it's cloud.firestore
match /databases/{database}/documents — defines the database; the {database} clause indicates that these rules apply to all Firestore databases on the project
match /uploads/{document=**} — creates a new rules block to apply to the uploads collection and all documents contained therein
allow write: if requests.auth.token.admin == true ; — allows write access for authenticated sessions with an admin attribute equal to true on the auth token, which is also known as the user's JWT
allow read; — allows public read access
match /users/{document=**} - creates a new rules block for the users collection and all documents contained therein
allow read, write: if request.auth.token.admin == true ; - allows both read and write access for authenticated sessions with an admin attribute equal to true on the auth token, which is also known as the user's JWT

firestore security rules request.auth.uid == userId kept returning 'Simulated read denied'

I'm trying to get request.auth.uid == userId to be tested but I'm getting 'Simulated read denied'.
I checked all of the basic questions before inputting this issue -
Did you deploy security rules?
I deployed the rules via the fireconsole (clicking the publish button and waiting for a min).
Did you have loggedin using Firebase Authentication?
I haven't implemented this work, I'm trying to test the security rules via using simulator in console.
I tried basic rule below and it works fine.
if request.auth.uid != null;
Here are the screenshots of my testing -
When using the security rules simulator, you need to enter the exact, full path of the document to read. You can't use wildcards. Right now, you're trying to using a wildcard in the document path: "/users/{userId}" This isn't going to work. This makes the userId variable in your rules become literally the string "{userId}". What you need to do instead is paste the actual ID of the document you want to test for reading into the form. This is going to be the UID starting with "JoF".
BTW: You are not required to deploy rules in order to test them in the simulator. You can choose to deploy them only after you've tested them.

Error storage/unknown uploading picture to Firebase Storage

Faced this error while working on a new React-Native project and using React-Native-Firebase library. Followed all tutorial setup steps and got this error. It's likely that this error can be faced in not react-native projects as well.
I've spent so many hours trying to fix it and didn't find a solution to my problem on stackoverflow.
Turns out, the solution was as simple as going to Firebase Console => Storage => click Getting started which creates default Storage rules.
It was a new project and no storage rules existed.
Solution was found by running
adb logcat command, output showed something like
check security rules for firebase storage and
no permission for storage
Hope this will save you hours debugging I wasted!
In my case the problem was that I had a wrong storage bucket URL set up (something.firebaseapp.com) when it should have been something.appspot.com
Just make the rules of your firebase storage to be true i.e. allow read and write to be true. That will do the trick. Like this
rules version = '2';
service firebase.storage {
match /b/{bucket}/o {
match /{allPaths=**} {
allow read, write: if true;
}
}
}

Resources