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
Related
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.
I have a flutter app in development and I use firestore as the storage.
users (collections)-> userId(doc) -> records (collection)
I am using this query:
FirebaseFirestore.instance.collection('users').doc(_userId).collection('records')
I notice when I test my app on simulator and test on my physical iphone, the list of documents I get from firestore are different. And on both env, I notice there are some documents are missing when I fetch from firestore. I can see the documents are in the firestore, but when I check the result of the query, I couldn't get the full list of documents in the collection. I notice I can only get the newly added documents. But the older documents, I couldn't get them anymore.
Anyone know where to start to debug this issue? Thanks.
service cloud.firestore {
match /databases/{database}/documents {
match /{document=**} {
allow read, write: if request.auth != null;
}
}
}
I checked the query exception, no exception detected, the query succeeded.
Found out that the way I read from firebase has some problems.
I was using this to read from the subcollection:
FirebaseFirestore.instance.collection('users').doc(_userId).collection('records').snapshots()
which returns a stream and I didn't listen to it properly.
Changed to
FirebaseFirestore.instance.collection('users').doc(_userId).collection('records').get()
which returns a future, and using await to wait this future. Now it works.
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.
For our app we need to be able to offer groups access to files. Each user can have a large number of groups so it does not make sense to use the "custom token" solution (which is anyways very awkward.
As I discovered, Firebase is very limited with its Storage security rules. The main issue is that we keep Group definitions in Firestore which the Storage security rules do not have access to.
To overcome this we decided to include in the metadata of each uploaded file a "token" which anyone in the group has access to. When they download a file, they need to provide this token in the request params (e.g. /groups/xxx/filename.jpg?token=abc).
So I went ahead and wrote these rules:
match /groups/{groupId}/{filename} {
allow read: if request.auth != null && request.params.token == resource.metadata.token;
allow write: if request.auth.uid == userId
&& request.resource.size < 1 * 1024 * 1024
&& request.resource.contentType.matches('image/.*')
&& (resource == null || request.resource.contentType == resource.contentType)
&& imageId.size() < 32
;
}
But when I run it in the simulator I get the error: "Error: simulator.rules line [23], column [43]. Property params is undefined on object." which points to the rule with "request.params.token"
The documentation specifically states that we have access to the params object from the request object: https://firebase.google.com/docs/storage/security/secure-files?authuser=0#request_evaluation
Due to the severe limitations of Firebase being able to query Firestore data in Storage and the incorrect documentation regarding request.param not being available, we had to use a different approach.
We decided to use the following URL when querying files of a group:
/groups/{groupId}/{token}/{filename}
The only security requirement is for the user to be logged in. Since the above token is a secret and only available to group members, we find it to be pretty secure. We do not allow listing of directories so it is not possible to simply list the /groups/{groupId} to find any tokens.
Note: another optimization could be to not include the {groupId} in the path but we felt it was better to include for debug and management purposes.
If anyone feels this is an insecure way, please let us know on the comments!
Thanks!
It sounds like you're trying to proxy some data from Cloud Firestore into a Cloud Storage request for use in security rules. This is currently not feasible. (On top of that request.params currently refers to APIs that aren't documented, so it can't really be used. I've brought this up with the team, and we feel request.params should likely be removed from security rules docs.)
If you want to assign a Firebase Auth user some group identity that can be verified across products (Firestore, Storage, and Realtime Database), you can use custom claims for this. It will require some work on your backend to assign, directly to the user account, the value(s) you want to check. If you do it correctly, the values you set in that JSON blob will show up in request.auth.token in both Firestore and Storage security rules.
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