Repository navigation
Expand file tree
/
Copy pathfirestore.rules
More file actions
285 lines (254 loc) · 11.6 KB
/
Copy pathfirestore.rules
File metadata and controls
285 lines (254 loc) · 11.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
// ===============================================================
// Data Model
// ===============================================================
//
// users/{userId}/transactions/{txId}
// type: string, "income" | "expense"
// amount: number, > 0
// category: string, 1..40 chars
// note: string, <= 500 chars
// date: string, YYYY-MM-DD
// createdAt: number, epoch ms
// createdByUid / createdByName / createdByPhotoURL
//
// books/{bookId}
// name: string, 1..80 chars
// ownerUid: string, immutable owner uid
// ownerName: string, 1..100 chars
// memberIds: list<string>, max 50 (always == keys of `members`)
// members: map<uid, BookMember>, max 50
// createdAt: number, epoch ms (immutable)
// updatedAt: number, epoch ms
// deleted: bool, optional (soft delete by the owner)
//
// Only MEMBERS can read a book. There is no join password: a person who
// knows the book id sends a join request and the OWNER approves it.
//
// books/{bookId}/transactions/{txId}
// same fields as a personal transaction; members read, owner/editor write.
//
// books/{bookId}/joinRequests/{requesterUid}
// requesterUid, requesterName, requesterPhotoURL, requestedAt,
// role ("viewer"), status ("pending" | "rejected")
// Approving = the owner adds the member to the book and deletes the request.
//
// ===============================================================
function isAuthenticated() {
return request.auth != null;
}
function isOwner(userId) {
return isAuthenticated() && request.auth.uid == userId;
}
function validString(data, field, minLen, maxLen) {
return data[field] is string &&
data[field].size() >= minLen &&
data[field].size() <= maxLen;
}
function validOptionalUrl(data, field) {
return data[field] is string &&
data[field].size() <= 500 &&
(data[field] == "" || data[field].matches("^https?://.*"));
}
function validEpochMs(data, field) {
return data[field] is number &&
data[field] > 0 &&
data[field] < 4102444800000;
}
function isValidTransaction(data) {
return data.keys().hasOnly([
"type", "amount", "category", "note", "date", "createdAt",
"createdByUid", "createdByName", "createdByPhotoURL"
]) &&
data.keys().hasAll([
"type", "amount", "category", "note", "date", "createdAt",
"createdByUid", "createdByName", "createdByPhotoURL"
]) &&
data.type in ["income", "expense"] &&
data.amount is number &&
data.amount > 0 &&
data.amount < 1000000000 &&
validString(data, "category", 1, 40) &&
validString(data, "note", 0, 500) &&
data.date is string &&
data.date.matches("^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$") &&
validEpochMs(data, "createdAt") &&
data.createdByUid == request.auth.uid &&
validString(data, "createdByName", 1, 100) &&
validOptionalUrl(data, "createdByPhotoURL");
}
function txImmutableFieldsUnchanged() {
return request.resource.data.createdAt == resource.data.createdAt &&
request.resource.data.createdByUid == resource.data.createdByUid;
}
// Account deletion: any member — whatever their current role — may strip their own
// identity from the entries they wrote. Nothing else about the entry may change.
function isOwnTxAnonymization(bookId) {
return isBookMemberById(bookId) &&
resource.data.createdByUid == request.auth.uid &&
request.resource.data.diff(resource.data).affectedKeys().hasOnly(["createdByName", "createdByPhotoURL"]) &&
request.resource.data.createdByName == "ผู้ใช้ที่ลบบัญชี" &&
request.resource.data.createdByPhotoURL == "";
}
function isValidMember(member, role) {
return member is map &&
member.keys().hasOnly(["name", "photoURL", "role", "joinedAt"]) &&
member.keys().hasAll(["name", "photoURL", "role", "joinedAt"]) &&
member.name is string &&
member.name.size() >= 1 &&
member.name.size() <= 100 &&
member.photoURL is string &&
member.photoURL.size() <= 500 &&
(member.photoURL == "" || member.photoURL.matches("^https?://.*")) &&
member.role in ["owner", "editor", "viewer"] &&
member.role == role &&
member.joinedAt is number &&
member.joinedAt > 0 &&
member.joinedAt < 4102444800000;
}
function bookPath(bookId) {
return /databases/$(database)/documents/books/$(bookId);
}
function bookData(bookId) {
return get(bookPath(bookId)).data;
}
function isBookOwner(bookId) {
return isAuthenticated() &&
exists(bookPath(bookId)) &&
bookData(bookId).ownerUid == request.auth.uid;
}
function isBookMemberById(bookId) {
return isAuthenticated() &&
exists(bookPath(bookId)) &&
request.auth.uid in bookData(bookId).memberIds;
}
function canWriteBook(bookId) {
return isBookMemberById(bookId) &&
bookData(bookId).get("deleted", false) == false &&
bookData(bookId).members[request.auth.uid].role in ["owner", "editor"];
}
function isValidCreatedBook(data) {
return data.keys().hasOnly([
"name", "ownerUid", "ownerName", "memberIds", "members",
"createdAt", "updatedAt"
]) &&
data.keys().hasAll([
"name", "ownerUid", "ownerName", "memberIds", "members",
"createdAt", "updatedAt"
]) &&
validString(data, "name", 1, 80) &&
data.ownerUid == request.auth.uid &&
validString(data, "ownerName", 1, 100) &&
data.memberIds is list &&
data.memberIds.size() == 1 &&
data.memberIds[0] == request.auth.uid &&
data.members is map &&
data.members.keys().hasOnly([request.auth.uid]) &&
isValidMember(data.members[request.auth.uid], "owner") &&
validEpochMs(data, "createdAt") &&
validEpochMs(data, "updatedAt");
}
// The owner may rename the book, soft-delete it and manage members.
// `joinPassword` (legacy field from the old password flow) may only be
// REMOVED, never written — it is not in the allowed key list.
function isValidOwnerUpdate() {
return isAuthenticated() &&
resource.data.ownerUid == request.auth.uid &&
request.resource.data.keys().hasOnly([
"name", "ownerUid", "ownerName", "memberIds", "members",
"createdAt", "updatedAt", "deleted"
]) &&
request.resource.data.ownerUid == resource.data.ownerUid &&
request.resource.data.createdAt == resource.data.createdAt &&
validString(request.resource.data, "name", 1, 80) &&
validString(request.resource.data, "ownerName", 1, 100) &&
request.resource.data.memberIds is list &&
request.resource.data.memberIds.size() <= 50 &&
request.resource.data.members is map &&
request.resource.data.members.size() <= 50 &&
request.resource.data.memberIds.toSet() == request.resource.data.members.keys().toSet() &&
request.auth.uid in request.resource.data.memberIds &&
request.resource.data.members[request.auth.uid].role == "owner";
}
// A non-owner member may remove ONLY themself from the book.
function isValidMemberLeave() {
return isAuthenticated() &&
request.auth.uid in resource.data.memberIds &&
resource.data.ownerUid != request.auth.uid &&
request.resource.data.diff(resource.data).affectedKeys().hasOnly([
"memberIds", "members", "updatedAt"
]) &&
!(request.auth.uid in request.resource.data.memberIds) &&
request.resource.data.memberIds.size() == resource.data.memberIds.size() - 1 &&
request.resource.data.members.diff(resource.data.members).affectedKeys().hasOnly([request.auth.uid]) &&
validEpochMs(request.resource.data, "updatedAt");
}
match /users/{userId}/transactions/{txId} {
allow read: if isOwner(userId);
allow create: if isOwner(userId) && isValidTransaction(request.resource.data);
allow update: if isOwner(userId) && isValidTransaction(request.resource.data) && txImmutableFieldsUnchanged();
allow delete: if isOwner(userId);
}
// "Which books did I ask to join?" — kept server-side so it works on every device and
// so account deletion can withdraw every pending request. Private to the user.
match /users/{userId}/joinRequestRefs/{bookId} {
allow read, delete: if isOwner(userId);
allow create, update: if isOwner(userId) &&
request.resource.data.keys().hasOnly(["requestedAt"]) &&
validEpochMs(request.resource.data, "requestedAt");
}
match /books/{bookId} {
allow create: if isAuthenticated() && isValidCreatedBook(request.resource.data);
// get + list: members only. Clients must query with
// where("memberIds", "array-contains", uid).
allow read: if isAuthenticated() && request.auth.uid in resource.data.memberIds;
allow update: if isValidOwnerUpdate() || isValidMemberLeave();
// Only the owner may hard-delete a book. Used by "delete my account", which
// first purges the book's transactions and join requests.
allow delete: if isAuthenticated() && resource.data.ownerUid == request.auth.uid;
match /transactions/{txId} {
allow read: if isBookMemberById(bookId);
allow create: if canWriteBook(bookId) && isValidTransaction(request.resource.data);
allow update: if (canWriteBook(bookId) && isValidTransaction(request.resource.data) && txImmutableFieldsUnchanged()) ||
isOwnTxAnonymization(bookId);
// The owner can always purge (even a soft-deleted book) — needed for account deletion.
allow delete: if canWriteBook(bookId) || isBookOwner(bookId);
}
// Doc id == requester uid, so each person has at most one request per book.
match /joinRequests/{requesterUid} {
function isValidJoinRequest(data) {
return data.keys().hasOnly([
"requesterUid", "requesterName", "requesterPhotoURL", "requestedAt", "role", "status"
]) &&
data.keys().hasAll([
"requesterUid", "requesterName", "requesterPhotoURL", "requestedAt", "role", "status"
]) &&
data.requesterUid == request.auth.uid &&
validString(data, "requesterName", 1, 100) &&
validOptionalUrl(data, "requesterPhotoURL") &&
validEpochMs(data, "requestedAt") &&
data.role == "viewer" &&
data.status == "pending";
}
// Path-based on purpose: lets a requester read their own request
// before it exists (needed for onSnapshot on a not-yet-created doc).
allow read: if isAuthenticated() &&
(request.auth.uid == requesterUid || isBookOwner(bookId));
allow create: if isAuthenticated() &&
request.auth.uid == requesterUid &&
exists(bookPath(bookId)) &&
!(request.auth.uid in bookData(bookId).memberIds) &&
isValidJoinRequest(request.resource.data);
// Owner can only flip the status to "rejected".
allow update: if isBookOwner(bookId) &&
request.resource.data.diff(resource.data).affectedKeys().hasOnly(["status"]) &&
request.resource.data.status == "rejected";
// Requester withdraws / dismisses; owner clears after approve/reject.
allow delete: if isAuthenticated() &&
(request.auth.uid == requesterUid || isBookOwner(bookId));
}
}
}
}