acebase-server 1.11.0 → 1.13.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (342) hide show
  1. package/.vscode/launch.json +24 -0
  2. package/dist/cjs/index.d.ts +1 -0
  3. package/dist/cjs/logger.js +74 -0
  4. package/dist/cjs/middleware/admin-only.js +29 -0
  5. package/dist/cjs/middleware/user.js +4 -4
  6. package/dist/cjs/routes/auth-change-password.js +7 -4
  7. package/dist/cjs/routes/auth-delete.js +9 -7
  8. package/dist/cjs/routes/auth-forgot-password.js +9 -6
  9. package/dist/cjs/routes/auth-reset-password.js +5 -3
  10. package/dist/cjs/routes/auth-signout.js +6 -4
  11. package/dist/cjs/routes/auth-signup.js +17 -15
  12. package/dist/cjs/routes/auth-update.js +9 -6
  13. package/dist/cjs/routes/auth-verify-email.js +6 -3
  14. package/dist/cjs/routes/data-index-create.js +3 -5
  15. package/dist/cjs/routes/data-index-delete.js +2 -4
  16. package/dist/cjs/routes/data-index-list.js +2 -4
  17. package/dist/cjs/routes/data-reflect.js +2 -4
  18. package/dist/cjs/routes/data-schema-get.js +2 -4
  19. package/dist/cjs/routes/data-schema-set.js +2 -4
  20. package/dist/cjs/routes/data-schema-test.js +2 -4
  21. package/dist/cjs/routes/data-schemas-list.js +2 -4
  22. package/dist/cjs/routes/data-set.js +8 -7
  23. package/dist/cjs/routes/data-transaction.js +15 -8
  24. package/dist/cjs/routes/data-update.js +8 -6
  25. package/dist/cjs/routes/meta-logs.js +50 -0
  26. package/dist/cjs/routes/meta.js +3 -0
  27. package/dist/cjs/routes/oauth2-signin.js +9 -6
  28. package/dist/cjs/server.js +3 -1
  29. package/dist/cjs/shared/rootpath.js +2 -0
  30. package/dist/cjs/shared/signin.js +8 -3
  31. package/dist/cjs/start.js +3 -0
  32. package/dist/cjs/websocket/index.js +42 -23
  33. package/dist/esm/index.d.ts +1 -0
  34. package/dist/esm/logger.js +52 -0
  35. package/dist/esm/middleware/admin-only.js +25 -0
  36. package/dist/esm/middleware/user.js +4 -4
  37. package/dist/esm/routes/auth-change-password.js +6 -3
  38. package/dist/esm/routes/auth-delete.js +7 -5
  39. package/dist/esm/routes/auth-forgot-password.js +8 -6
  40. package/dist/esm/routes/auth-reset-password.js +4 -2
  41. package/dist/esm/routes/auth-signout.js +4 -2
  42. package/dist/esm/routes/auth-signup.js +12 -10
  43. package/dist/esm/routes/auth-update.js +8 -6
  44. package/dist/esm/routes/auth-verify-email.js +6 -2
  45. package/dist/esm/routes/data-index-create.js +4 -6
  46. package/dist/esm/routes/data-index-delete.js +3 -5
  47. package/dist/esm/routes/data-index-list.js +3 -5
  48. package/dist/esm/routes/data-reflect.js +1 -4
  49. package/dist/esm/routes/data-schema-get.js +3 -5
  50. package/dist/esm/routes/data-schema-set.js +3 -5
  51. package/dist/esm/routes/data-schema-test.js +3 -5
  52. package/dist/esm/routes/data-schemas-list.js +3 -5
  53. package/dist/esm/routes/data-set.js +6 -5
  54. package/dist/esm/routes/data-transaction.js +12 -5
  55. package/dist/esm/routes/data-update.js +6 -4
  56. package/dist/esm/routes/meta-logs.js +36 -0
  57. package/dist/esm/routes/meta.js +3 -0
  58. package/dist/esm/routes/oauth2-signin.js +8 -5
  59. package/dist/esm/server.js +3 -1
  60. package/dist/esm/shared/rootpath.js +2 -0
  61. package/dist/esm/shared/signin.js +7 -3
  62. package/dist/esm/start.js +3 -0
  63. package/dist/esm/websocket/index.js +37 -22
  64. package/dist/types/logger.d.ts +35 -0
  65. package/dist/types/middleware/admin-only.d.ts +19 -0
  66. package/dist/types/routes/meta-logs.d.ts +20 -0
  67. package/dist/types/rules.d.ts +2 -2
  68. package/dist/types/shared/env.d.ts +3 -1
  69. package/dist/types/shared/signin.d.ts +1 -1
  70. package/dist/types/websocket/index.d.ts +4 -0
  71. package/package.json +5 -5
  72. package/webmanager/acebase-client-browser.min.js +16 -16
  73. package/create-package-files +0 -12
  74. package/dist/cjs/auth.js.map +0 -1
  75. package/dist/cjs/cluster.js.map +0 -1
  76. package/dist/cjs/index.js.map +0 -1
  77. package/dist/cjs/middleware/404.js.map +0 -1
  78. package/dist/cjs/middleware/cache.js.map +0 -1
  79. package/dist/cjs/middleware/connection.js.map +0 -1
  80. package/dist/cjs/middleware/context.js.map +0 -1
  81. package/dist/cjs/middleware/cors.js.map +0 -1
  82. package/dist/cjs/middleware/swagger.js.map +0 -1
  83. package/dist/cjs/middleware/user.js.map +0 -1
  84. package/dist/cjs/oauth-providers/dropbox.js.map +0 -1
  85. package/dist/cjs/oauth-providers/facebook.js.map +0 -1
  86. package/dist/cjs/oauth-providers/google.js.map +0 -1
  87. package/dist/cjs/oauth-providers/index.js.map +0 -1
  88. package/dist/cjs/oauth-providers/instagram.js.map +0 -1
  89. package/dist/cjs/oauth-providers/oauth-provider.js.map +0 -1
  90. package/dist/cjs/oauth-providers/spotify.js.map +0 -1
  91. package/dist/cjs/routes/auth-change-password.js.map +0 -1
  92. package/dist/cjs/routes/auth-delete.js.map +0 -1
  93. package/dist/cjs/routes/auth-forgot-password.js.map +0 -1
  94. package/dist/cjs/routes/auth-reset-password.js.map +0 -1
  95. package/dist/cjs/routes/auth-signin.js.map +0 -1
  96. package/dist/cjs/routes/auth-signout.js.map +0 -1
  97. package/dist/cjs/routes/auth-signup.js.map +0 -1
  98. package/dist/cjs/routes/auth-state.js.map +0 -1
  99. package/dist/cjs/routes/auth-update.js.map +0 -1
  100. package/dist/cjs/routes/auth-verify-email.js.map +0 -1
  101. package/dist/cjs/routes/auth.js.map +0 -1
  102. package/dist/cjs/routes/data-exists.js.map +0 -1
  103. package/dist/cjs/routes/data-export.js.map +0 -1
  104. package/dist/cjs/routes/data-get.js.map +0 -1
  105. package/dist/cjs/routes/data-import.js.map +0 -1
  106. package/dist/cjs/routes/data-index-create.js.map +0 -1
  107. package/dist/cjs/routes/data-index-delete.js.map +0 -1
  108. package/dist/cjs/routes/data-index-list.js.map +0 -1
  109. package/dist/cjs/routes/data-query.js.map +0 -1
  110. package/dist/cjs/routes/data-reflect.js.map +0 -1
  111. package/dist/cjs/routes/data-schema-get.js.map +0 -1
  112. package/dist/cjs/routes/data-schema-set.js.map +0 -1
  113. package/dist/cjs/routes/data-schema-test.js.map +0 -1
  114. package/dist/cjs/routes/data-schemas-list.js.map +0 -1
  115. package/dist/cjs/routes/data-set.js.map +0 -1
  116. package/dist/cjs/routes/data-sync-changes.js.map +0 -1
  117. package/dist/cjs/routes/data-sync-mutations.js.map +0 -1
  118. package/dist/cjs/routes/data-transaction.js.map +0 -1
  119. package/dist/cjs/routes/data-update.js.map +0 -1
  120. package/dist/cjs/routes/data.js.map +0 -1
  121. package/dist/cjs/routes/docs.js.map +0 -1
  122. package/dist/cjs/routes/meta-info.js.map +0 -1
  123. package/dist/cjs/routes/meta-ping.js.map +0 -1
  124. package/dist/cjs/routes/meta-stats.js.map +0 -1
  125. package/dist/cjs/routes/meta.js.map +0 -1
  126. package/dist/cjs/routes/oauth2-init.js.map +0 -1
  127. package/dist/cjs/routes/oauth2-refresh.js.map +0 -1
  128. package/dist/cjs/routes/oauth2-signin.js.map +0 -1
  129. package/dist/cjs/routes/webmanager.js.map +0 -1
  130. package/dist/cjs/rules.js.map +0 -1
  131. package/dist/cjs/schema/user.js.map +0 -1
  132. package/dist/cjs/server.js.map +0 -1
  133. package/dist/cjs/settings/email.js.map +0 -1
  134. package/dist/cjs/settings/index.js.map +0 -1
  135. package/dist/cjs/shared/clients.js.map +0 -1
  136. package/dist/cjs/shared/email.js.map +0 -1
  137. package/dist/cjs/shared/env.js.map +0 -1
  138. package/dist/cjs/shared/error.js.map +0 -1
  139. package/dist/cjs/shared/http.js.map +0 -1
  140. package/dist/cjs/shared/password.js.map +0 -1
  141. package/dist/cjs/shared/rootpath.js.map +0 -1
  142. package/dist/cjs/shared/signin.js.map +0 -1
  143. package/dist/cjs/shared/simple-fetch.js.map +0 -1
  144. package/dist/cjs/shared/tokens.js.map +0 -1
  145. package/dist/cjs/shared/validate.js.map +0 -1
  146. package/dist/cjs/start.js.map +0 -1
  147. package/dist/cjs/test.js.map +0 -1
  148. package/dist/cjs/websocket/index.js.map +0 -1
  149. package/dist/cjs/websocket/manager.js.map +0 -1
  150. package/dist/cjs/websocket/socket.io.js.map +0 -1
  151. package/dist/esm/auth.js.map +0 -1
  152. package/dist/esm/cluster.js.map +0 -1
  153. package/dist/esm/index.js.map +0 -1
  154. package/dist/esm/middleware/404.js.map +0 -1
  155. package/dist/esm/middleware/cache.js.map +0 -1
  156. package/dist/esm/middleware/connection.js.map +0 -1
  157. package/dist/esm/middleware/context.js.map +0 -1
  158. package/dist/esm/middleware/cors.js.map +0 -1
  159. package/dist/esm/middleware/swagger.js.map +0 -1
  160. package/dist/esm/middleware/user.js.map +0 -1
  161. package/dist/esm/oauth-providers/dropbox.js.map +0 -1
  162. package/dist/esm/oauth-providers/facebook.js.map +0 -1
  163. package/dist/esm/oauth-providers/google.js.map +0 -1
  164. package/dist/esm/oauth-providers/index.js.map +0 -1
  165. package/dist/esm/oauth-providers/instagram.js.map +0 -1
  166. package/dist/esm/oauth-providers/oauth-provider.js.map +0 -1
  167. package/dist/esm/oauth-providers/spotify.js.map +0 -1
  168. package/dist/esm/routes/auth-change-password.js.map +0 -1
  169. package/dist/esm/routes/auth-delete.js.map +0 -1
  170. package/dist/esm/routes/auth-forgot-password.js.map +0 -1
  171. package/dist/esm/routes/auth-reset-password.js.map +0 -1
  172. package/dist/esm/routes/auth-signin.js.map +0 -1
  173. package/dist/esm/routes/auth-signout.js.map +0 -1
  174. package/dist/esm/routes/auth-signup.js.map +0 -1
  175. package/dist/esm/routes/auth-state.js.map +0 -1
  176. package/dist/esm/routes/auth-update.js.map +0 -1
  177. package/dist/esm/routes/auth-verify-email.js.map +0 -1
  178. package/dist/esm/routes/auth.js.map +0 -1
  179. package/dist/esm/routes/data-exists.js.map +0 -1
  180. package/dist/esm/routes/data-export.js.map +0 -1
  181. package/dist/esm/routes/data-get.js.map +0 -1
  182. package/dist/esm/routes/data-import.js.map +0 -1
  183. package/dist/esm/routes/data-index-create.js.map +0 -1
  184. package/dist/esm/routes/data-index-delete.js.map +0 -1
  185. package/dist/esm/routes/data-index-list.js.map +0 -1
  186. package/dist/esm/routes/data-query.js.map +0 -1
  187. package/dist/esm/routes/data-reflect.js.map +0 -1
  188. package/dist/esm/routes/data-schema-get.js.map +0 -1
  189. package/dist/esm/routes/data-schema-set.js.map +0 -1
  190. package/dist/esm/routes/data-schema-test.js.map +0 -1
  191. package/dist/esm/routes/data-schemas-list.js.map +0 -1
  192. package/dist/esm/routes/data-set.js.map +0 -1
  193. package/dist/esm/routes/data-sync-changes.js.map +0 -1
  194. package/dist/esm/routes/data-sync-mutations.js.map +0 -1
  195. package/dist/esm/routes/data-transaction.js.map +0 -1
  196. package/dist/esm/routes/data-update.js.map +0 -1
  197. package/dist/esm/routes/data.js.map +0 -1
  198. package/dist/esm/routes/docs.js.map +0 -1
  199. package/dist/esm/routes/meta-info.js.map +0 -1
  200. package/dist/esm/routes/meta-ping.js.map +0 -1
  201. package/dist/esm/routes/meta-stats.js.map +0 -1
  202. package/dist/esm/routes/meta.js.map +0 -1
  203. package/dist/esm/routes/oauth2-init.js.map +0 -1
  204. package/dist/esm/routes/oauth2-refresh.js.map +0 -1
  205. package/dist/esm/routes/oauth2-signin.js.map +0 -1
  206. package/dist/esm/routes/webmanager.js.map +0 -1
  207. package/dist/esm/rules.js.map +0 -1
  208. package/dist/esm/schema/user.js.map +0 -1
  209. package/dist/esm/server.js.map +0 -1
  210. package/dist/esm/settings/email.js.map +0 -1
  211. package/dist/esm/settings/index.js.map +0 -1
  212. package/dist/esm/shared/clients.js.map +0 -1
  213. package/dist/esm/shared/email.js.map +0 -1
  214. package/dist/esm/shared/env.js.map +0 -1
  215. package/dist/esm/shared/error.js.map +0 -1
  216. package/dist/esm/shared/http.js.map +0 -1
  217. package/dist/esm/shared/password.js.map +0 -1
  218. package/dist/esm/shared/rootpath.js.map +0 -1
  219. package/dist/esm/shared/signin.js.map +0 -1
  220. package/dist/esm/shared/simple-fetch.js.map +0 -1
  221. package/dist/esm/shared/tokens.js.map +0 -1
  222. package/dist/esm/shared/validate.js.map +0 -1
  223. package/dist/esm/start.js.map +0 -1
  224. package/dist/esm/test.js.map +0 -1
  225. package/dist/esm/websocket/index.js.map +0 -1
  226. package/dist/esm/websocket/manager.js.map +0 -1
  227. package/dist/esm/websocket/socket.io.js.map +0 -1
  228. package/src/auth.ts +0 -87
  229. package/src/cluster.ts +0 -62
  230. package/src/index.ts +0 -4
  231. package/src/middleware/404.ts +0 -13
  232. package/src/middleware/cache.ts +0 -15
  233. package/src/middleware/connection.ts +0 -48
  234. package/src/middleware/context.ts +0 -23
  235. package/src/middleware/cors.ts +0 -49
  236. package/src/middleware/swagger.ts +0 -19
  237. package/src/middleware/user.ts +0 -51
  238. package/src/oauth-providers/dropbox.ts +0 -144
  239. package/src/oauth-providers/facebook.ts +0 -103
  240. package/src/oauth-providers/google.ts +0 -147
  241. package/src/oauth-providers/index.ts +0 -21
  242. package/src/oauth-providers/instagram.ts +0 -98
  243. package/src/oauth-providers/oauth-provider.ts +0 -65
  244. package/src/oauth-providers/spotify.ts +0 -127
  245. package/src/placeholder.d.ts +0 -12
  246. package/src/routes/auth-change-password.ts +0 -89
  247. package/src/routes/auth-change-password.yaml +0 -74
  248. package/src/routes/auth-delete.ts +0 -47
  249. package/src/routes/auth-delete.yaml +0 -78
  250. package/src/routes/auth-forgot-password.ts +0 -73
  251. package/src/routes/auth-forgot-password.yaml +0 -50
  252. package/src/routes/auth-reset-password.ts +0 -93
  253. package/src/routes/auth-reset-password.yaml +0 -54
  254. package/src/routes/auth-signin.ts +0 -55
  255. package/src/routes/auth-signin.yaml +0 -130
  256. package/src/routes/auth-signout.ts +0 -61
  257. package/src/routes/auth-signout.yaml +0 -46
  258. package/src/routes/auth-signup.ts +0 -161
  259. package/src/routes/auth-signup.yaml +0 -136
  260. package/src/routes/auth-state.ts +0 -20
  261. package/src/routes/auth-state.yaml +0 -29
  262. package/src/routes/auth-update.ts +0 -147
  263. package/src/routes/auth-update.yaml +0 -152
  264. package/src/routes/auth-verify-email.ts +0 -67
  265. package/src/routes/auth-verify-email.yaml +0 -53
  266. package/src/routes/auth.ts +0 -67
  267. package/src/routes/data-exists.ts +0 -31
  268. package/src/routes/data-exists.yaml +0 -44
  269. package/src/routes/data-export.ts +0 -51
  270. package/src/routes/data-export.yaml +0 -64
  271. package/src/routes/data-get.ts +0 -68
  272. package/src/routes/data-get.yaml +0 -54
  273. package/src/routes/data-import.ts +0 -56
  274. package/src/routes/data-import.yaml +0 -75
  275. package/src/routes/data-index-create.ts +0 -85
  276. package/src/routes/data-index-create.yaml +0 -105
  277. package/src/routes/data-index-delete.ts +0 -39
  278. package/src/routes/data-index-delete.yaml +0 -51
  279. package/src/routes/data-index-list.ts +0 -42
  280. package/src/routes/data-index-list.yaml +0 -80
  281. package/src/routes/data-query.ts +0 -97
  282. package/src/routes/data-query.yaml +0 -166
  283. package/src/routes/data-reflect.ts +0 -94
  284. package/src/routes/data-reflect.yaml +0 -124
  285. package/src/routes/data-schema-get.ts +0 -38
  286. package/src/routes/data-schema-get.yaml +0 -53
  287. package/src/routes/data-schema-set.ts +0 -38
  288. package/src/routes/data-schema-set.yaml +0 -60
  289. package/src/routes/data-schema-test.ts +0 -53
  290. package/src/routes/data-schema-test.yaml +0 -66
  291. package/src/routes/data-schemas-list.ts +0 -33
  292. package/src/routes/data-schemas-list.yaml +0 -41
  293. package/src/routes/data-set.ts +0 -80
  294. package/src/routes/data-set.yaml +0 -77
  295. package/src/routes/data-sync-changes.ts +0 -78
  296. package/src/routes/data-sync-changes.yaml +0 -67
  297. package/src/routes/data-sync-mutations.ts +0 -78
  298. package/src/routes/data-sync-mutations.yaml +0 -67
  299. package/src/routes/data-transaction-finish.yaml +0 -82
  300. package/src/routes/data-transaction-start.yaml +0 -58
  301. package/src/routes/data-transaction.ts +0 -159
  302. package/src/routes/data-update.ts +0 -81
  303. package/src/routes/data-update.yaml +0 -77
  304. package/src/routes/data.ts +0 -79
  305. package/src/routes/docs.ts +0 -249
  306. package/src/routes/meta-info.ts +0 -80
  307. package/src/routes/meta-info.yaml +0 -41
  308. package/src/routes/meta-ping.ts +0 -15
  309. package/src/routes/meta-ping.yaml +0 -23
  310. package/src/routes/meta-stats.ts +0 -31
  311. package/src/routes/meta-stats.yaml +0 -41
  312. package/src/routes/meta.ts +0 -18
  313. package/src/routes/oauth2-init.ts +0 -44
  314. package/src/routes/oauth2-init.yaml +0 -63
  315. package/src/routes/oauth2-refresh.ts +0 -39
  316. package/src/routes/oauth2-refresh.yaml +0 -65
  317. package/src/routes/oauth2-signin.ts +0 -282
  318. package/src/routes/oauth2-signin.yaml +0 -66
  319. package/src/routes/webmanager.ts +0 -29
  320. package/src/rules.ts +0 -196
  321. package/src/schema/user.ts +0 -99
  322. package/src/server.ts +0 -418
  323. package/src/settings/email.ts +0 -18
  324. package/src/settings/index.ts +0 -241
  325. package/src/shared/clients.ts +0 -31
  326. package/src/shared/email.ts +0 -33
  327. package/src/shared/env.ts +0 -38
  328. package/src/shared/error.ts +0 -37
  329. package/src/shared/http.ts +0 -26
  330. package/src/shared/password.ts +0 -41
  331. package/src/shared/rootpath.ts +0 -15
  332. package/src/shared/signin.ts +0 -143
  333. package/src/shared/simple-fetch.ts +0 -65
  334. package/src/shared/tokens.ts +0 -77
  335. package/src/shared/validate.ts +0 -53
  336. package/src/start.ts +0 -45
  337. package/src/test.ts +0 -10
  338. package/src/websocket/index.ts +0 -320
  339. package/src/websocket/manager.ts +0 -46
  340. package/src/websocket/socket.io.ts +0 -90
  341. package/tsconfig-cjs.json +0 -10
  342. package/tsconfig.json +0 -21
@@ -1,65 +0,0 @@
1
- /oauth2/{dbname}/refresh:
2
- get:
3
- tags:
4
- - auth
5
- - oauth2
6
- summary: Refreshes an OAuth2 access token
7
- description: Refreshes an OAuth2 provider's access token using the refresh token given by the auth provider at signin.
8
- parameters:
9
- - name: dbname
10
- in: path
11
- description: name of the database
12
- required: true
13
- schema:
14
- type: string
15
- example: mydb
16
- - name: provider
17
- in: query
18
- description: External OAuth2 provider name
19
- required: true
20
- schema:
21
- type: string
22
- example: facebook
23
- - name: refresh_token
24
- in: query
25
- description: A refresh token from the OAuth2 signin result
26
- required: true
27
- schema:
28
- type: string
29
- example: erfiyh3rfig3fuyb3rjfg3u7refc...
30
- responses:
31
- 200:
32
- description: Returns a JSON object containing new access and refresh tokens and expiry information
33
- content:
34
- 'application/json':
35
- schema:
36
- type: object
37
- properties:
38
- name:
39
- type: string
40
- description: Provider name
41
- example: facebook
42
- access_token:
43
- type: string
44
- description: New access token
45
- example: fkw3ygfi74g25foli2n4vo7h2vto72g4...
46
- refresh_token:
47
- type: string
48
- description: New refresh token
49
- example: 32lo548jnl34tv73h4l5nbb35ithn3jt...
50
- expires_in:
51
- type: integer
52
- description: Amount of seconds these tokens remain valid. A new refresh will have to be done before they expire.
53
- example: 3600
54
- example:
55
- name: facebook
56
- access_token: fkw3ygfi74g25foli2n4vo7h2vto72g4...
57
- refresh_token: 32lo548jnl34tv73h4l5nbb35ithn3jt...
58
- expires_in: 3600
59
- 500:
60
- description: If anything goes wrong on the server, it returns the actual error text in plain text
61
- content:
62
- 'text/plain':
63
- schema:
64
- type: string
65
- example: Some error text
@@ -1,282 +0,0 @@
1
- import { DataSnapshot, ID } from 'acebase-core';
2
- import { DbUserAccountDetails } from '../schema/user';
3
- import { AceBaseUserSignInEmailRequest, AceBaseUserSignupEmailRequest } from '../shared/email';
4
- import { RouteInitEnvironment, RouteRequest } from '../shared/env';
5
- import { createPasswordHash, generatePassword } from '../shared/password';
6
- import { createPublicAccessToken, createSignedPublicToken, parseSignedPublicToken } from '../shared/tokens';
7
- import { fetch } from '../shared/simple-fetch';
8
-
9
- const socketSignInSuccess = `<html><script>window.close()</script><body>Signed in succesfully. You can <a href="javascript:window.close()">close</a> this page</body></html>`;
10
- const socketSignInFailed = `<html><script>window.close()</script><body>Failed to sign in. You can <a href="javascript:window.close()">close</a> this page</body></html>`;
11
-
12
- export type RequestQuery = { state: string; code?: string; error?: string; error_reason?: string; error_description?: string };
13
- export type RequestBody = null;
14
- export type ResponseBody = string | { code: 'admin_only', message: string };
15
- export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
16
-
17
- export const addRoute = (env: RouteInitEnvironment) => {
18
-
19
- env.app.get(`/oauth2/${env.db.name}/signin`, async (req: Request, res) => {
20
-
21
- // This is where the user is redirected to by the provider after signin or error
22
- try {
23
- const state = parseSignedPublicToken(req.query.state, env.tokenSalt);
24
- if (req.query.error) {
25
- if (state.flow === 'socket') {
26
- const client = env.clients.get(state.client_id);
27
- client.socket.emit('oauth2-signin', { error: req.query.error, reason: req.query.error_reason, description: req.query.error_description, provider: state.provider });
28
- }
29
- else {
30
- const callbackUrl = `${state.callbackUrl}?provider=${state.provider}&error=${req.query.error}&reason=${req.query.error_reason}&description=${req.query.error_description}`;
31
- res.redirect(callbackUrl);
32
- }
33
- return;
34
- }
35
-
36
- // Got authorization code
37
- const authCode = req.query.code;
38
- const provider = env.authProviders[state.provider];
39
-
40
- // Get access & refresh tokens
41
- const tokens = await provider.getAccessToken({ type: 'auth', auth_code: authCode, redirect_url: `${req.protocol}://${req.headers.host}/oauth2/${env.db.name}/signin` });
42
-
43
- let user_details;
44
- // TODO: Have we got an id_token?
45
- // if (tokens.id_token) {
46
- // // decode, extract user information
47
- // }
48
- // else {
49
- user_details = await provider.getUserInfo(tokens.access_token);
50
- // }
51
-
52
- if (user_details.picture && user_details.picture.length > 0) {
53
- // Download it, convert to base64
54
- const best = user_details.picture.sort((a,b) => a.width * a.height > b.width * b.height ? -1 : 1)[0]
55
- try {
56
- const response = await fetch(best.url);
57
- const contentType = response.headers.get('Content-Type');
58
- if (contentType === 'image/png') { //state.provider === 'google' &&
59
- // Don't accept image/png, because it's probably a placeholder image. Google does this by creating a png with people's initials
60
- user_details.picture = [];
61
- }
62
- else {
63
- const image = await response.arrayBuffer();
64
- let buff = Buffer.from(image);
65
- best.url = `data:${contentType};base64,${buff.toString('base64')}`;
66
- user_details.picture = [best]; // Only keep the best one
67
- }
68
- }
69
- catch(err) {
70
- env.debug.warn(`Could not fetch profile picture from "${best.url}": `, err);
71
- user_details.picture = null;
72
- }
73
- }
74
-
75
- const getProviderSettings = () => {
76
- // Returns an object with all info (except picture) the provider has about the user
77
- const settings = {
78
- [`${state.provider}_id`]: user_details.id,
79
- [`${state.provider}_email`]: user_details.email,
80
- [`${state.provider}_email_verified`]: user_details.email_verified,
81
- [`${state.provider}_name`]: user_details.name,
82
- [`${state.provider}_display_name`]: user_details.display_name,
83
- };
84
- Object.keys(user_details.other).forEach(key => {
85
- settings[`${state.provider}_${key}`] = user_details.other[key];
86
- });
87
- return settings;
88
- };
89
- const providerUsername = `${state.provider}:${user_details.id}`;
90
-
91
- // Check if this user exists in the database
92
- let snaps: DataSnapshot[];
93
- let addToExistingAccount = true;
94
- if (typeof state.uid === 'string') {
95
- // Use the signed in uid to link this account to. This allows multiple auth provider
96
- // accounts (with different email addresses) to be linked to the account the user
97
- // is signed into, and also allows multiple AceBase users to link to the same provider
98
- // accounts, eg if a client app allows users to link their own account to a shared
99
- // family Spotify / Dropbox account.
100
- let snap = await env.authRef.child(state.uid).get();
101
- if (!snap.exists()) {
102
- // This is wrong!
103
- throw new Error(`Invalid uid`);
104
- }
105
- snaps = [snap];
106
- let user = snap.val();
107
- addToExistingAccount = user.email === user_details.email;
108
- }
109
- else {
110
- const query = env.authRef.query();
111
- if (user_details.email) {
112
- query.filter('email', '==', user_details.email);
113
- }
114
- else {
115
- // User did not allow reading e-mail address, or provider does not have one (eg whatsapp?)
116
- // Switch to using a generated username such as "facebook-3292389234" instead
117
- query.filter('username', '==', providerUsername);
118
- }
119
- snaps = await query.get();
120
- }
121
- if (snaps.length === 0 && user_details.email) {
122
- // Try again with providerUsername, use might previously have denied access to email,
123
- // and now has granted access. In that case, we'll already have an account with the
124
- // generated providerUsername
125
- snaps = await env.authRef.query().filter('username', '==', providerUsername).get();
126
- }
127
- let user: DbUserAccountDetails;
128
- if (snaps.length === 1) {
129
- const uid = snaps[0].key as string;
130
- user = snaps[0].val();
131
- user.uid = uid;
132
-
133
- if (addToExistingAccount) {
134
- // Update user details
135
- user.email_verified = user.email_verified || user_details.email_verified;
136
- user.email = user.email || user_details.email;
137
- if (user_details.picture && user_details.picture.length > 0) {
138
- user.picture = user_details.picture[0];
139
- }
140
- await env.authRef.child(uid).update({
141
- email: user.email || null,
142
- email_verified: user.email_verified,
143
- last_signin: new Date(),
144
- last_signin_ip: req.ip,
145
- picture: user.picture
146
- });
147
- }
148
- // Add provider details
149
- await env.authRef.child(uid).child('settings').update(getProviderSettings());
150
-
151
- // Log success
152
- env.logRef.push({ action: 'oauth2_signin', success: true, ip: req.ip, date: new Date(), uid });
153
-
154
- // Cache the user
155
- env.authCache.set(user.uid, user);
156
-
157
- // Request signin e-mail to be sent
158
- const request: AceBaseUserSignInEmailRequest = {
159
- type: 'user_signin',
160
- user: {
161
- uid: user.uid,
162
- username: user.username,
163
- email: user.email,
164
- displayName: user.display_name,
165
- settings: user.settings
166
- },
167
- date: user.created,
168
- ip: req.ip,
169
- activationCode: user.email_verified ? null : createSignedPublicToken({ uid: user.uid }, env.tokenSalt),
170
- emailVerified: user.email_verified,
171
- provider: state.provider
172
- };
173
-
174
- env.config.email?.send(request).catch(err => {
175
- env.logRef.push({ action: 'oauth2_login_email', success: false, code: 'unexpected', ip: req.ip, date: new Date(), error: err.message, request });
176
- });
177
- }
178
- else if (snaps.length === 0) {
179
- // User does not exist, create
180
-
181
- if (!env.config.auth.allowUserSignup) {
182
- env.logRef.push({ action: 'oauth2_signup', success: false, code: 'user_signup_disabled', provider: state.provider, email: user_details.email, date: new Date() });
183
- res.statusCode = 403; // Forbidden
184
- return res.send({ code: 'admin_only', message: 'Only admin is allowed to create users' });
185
- }
186
-
187
- // Create user with Generated password
188
- let pwd = createPasswordHash(generatePassword());
189
- user = {
190
- uid: null,
191
- username: typeof user_details.email === 'undefined' ? providerUsername : null, // provider-accountid usernames for external accounts without email address
192
- email: user_details.email || null,
193
- email_verified: user_details.email_verified, // trust provider's verification
194
- display_name: user_details.display_name,
195
- password: pwd.hash,
196
- password_salt: pwd.salt,
197
- created: new Date(),
198
- created_ip: req.ip,
199
- access_token: ID.generate(),
200
- access_token_created: new Date(),
201
- last_signin: new Date(),
202
- last_signin_ip: req.ip,
203
- picture: user_details.picture && user_details.picture[0],
204
- settings: getProviderSettings()
205
- };
206
-
207
- const userRef = await env.authRef.push(user);
208
- const uid = userRef.key;
209
- user.uid = uid;
210
-
211
- // Log success
212
- env.logRef.push({ action: 'oauth2_signup', success: true, ip: req.ip, date: new Date(), uid });
213
-
214
- // Cache the user
215
- env.authCache.set(user.uid, user);
216
-
217
- // Request welcome e-mail to be sent
218
- const request: AceBaseUserSignupEmailRequest = {
219
- type: 'user_signup',
220
- user: {
221
- uid: user.uid,
222
- username: user.username,
223
- email: user.email,
224
- displayName: user.display_name,
225
- settings: user.settings
226
- },
227
- date: user.created,
228
- ip: user.created_ip,
229
- activationCode: user.email_verified ? null : createSignedPublicToken({ uid: user.uid }, env.tokenSalt),
230
- emailVerified: user.email_verified,
231
- provider: state.provider
232
- };
233
-
234
- env.config.email?.send(request).catch(err => {
235
- env.logRef.push({ action: 'oauth2_signup_email', success: false, code: 'unexpected', ip: req.ip, date: new Date(), error: err.message, request });
236
- });
237
- }
238
- else {
239
- // More than 1?!!
240
- if (state.flow === 'socket') {
241
- const client = env.clients.get(state.client_id);
242
- client.socket.emit('oauth2-signin', { action: 'error', error: 'account_duplicates' });
243
- return res.send(socketSignInFailed);
244
- }
245
- else {
246
- const callbackUrl = `${state.callbackUrl}?provider=${state.provider}&error=account_duplicates`;
247
- return res.redirect(callbackUrl);
248
- }
249
- }
250
-
251
- let result = {
252
- provider: {
253
- name: state.provider,
254
- access_token: tokens.access_token,
255
- refresh_token: tokens.refresh_token,
256
- expires_in: tokens.expires_in
257
- },
258
- access_token: createPublicAccessToken(user.uid, req.ip, user.access_token, env.tokenSalt),
259
-
260
- // Disabled sending user details because:
261
- // 1) they might be too big to send as redirect header,
262
- // 2) client should verify the sent access token and get user details from the server
263
- // user: getPublicAccountDetails(user)
264
- };
265
-
266
- if (state.flow === 'socket') {
267
- const client = env.clients.get(state.client_id);
268
- client.socket.emit('oauth2-signin', { action: 'success', result });
269
- res.send(socketSignInSuccess);
270
- }
271
- else {
272
- const base64Result = Buffer.from(JSON.stringify(result)).toString('base64');
273
- const callbackUrl = `${state.callbackUrl}?result=${base64Result}`;
274
- res.redirect(callbackUrl);
275
- }
276
- }
277
- catch(err) {
278
- res.status(500).send(err.message);
279
- }
280
-
281
- });
282
- };
@@ -1,66 +0,0 @@
1
- /oauth2/{dbname}/signin:
2
- get:
3
- tags:
4
- - auth
5
- - oauth2
6
- summary: Finishes an OAuth2 flow
7
- description: Finishes a 3rd party OAuth2 authentication flow. This is the url you have to add to your oAuth2 provider's allowed callback urls; the auth provider will redirect the login result to this address so AceBase auth can handle the signin and then redirect the user to the callbackUrl you provided in the oauth2 init endpoint.
8
- parameters:
9
- - name: dbname
10
- in: path
11
- description: name of the database
12
- required: true
13
- schema:
14
- type: string
15
- example: mydb
16
- - name: state
17
- in: query
18
- description: info about the initial oauth2 request (generated by AceBase)
19
- required: true
20
- schema:
21
- type: string
22
- example: sefwerg44tgwefvq3g4rbqewrgbqebwdfbwsergq34t...
23
- - name: code
24
- in: query
25
- required: false
26
- description: If signin is successful, contains the authorization code AceBase will use to request access and refresh tokens from the OAuth2 provider.
27
- schema:
28
- type: string
29
- example: erfuihqrf7g3rfgh3rifhwre8f73efuh3eifh...
30
- - name: error
31
- in: query
32
- description: If an error occurred, the error code
33
- required: false
34
- schema:
35
- type: string
36
- example: canceled
37
- - name: error_reason
38
- in: query
39
- description: If an error occurred, the error reason
40
- required: false
41
- schema:
42
- type: string
43
- example: user_canceled
44
- - name: error_description
45
- in: query
46
- description: If an error occurred, the error description
47
- required: false
48
- schema:
49
- type: string
50
- example: The user canceled the auth request
51
- responses:
52
- 200:
53
- description: Redirects the user to the callbackUrl you provided in the init endpoint
54
- headers:
55
- Location:
56
- schema:
57
- type: string
58
- format: url
59
- example: https://my.website.com/oauth2/callback?result=er32f32g2erv2erv23g315g..
60
- 500:
61
- description: If anything goes wrong on the server, it returns the actual error text in plain text
62
- content:
63
- 'text/plain':
64
- schema:
65
- type: string
66
- example: Some error text
@@ -1,29 +0,0 @@
1
- import { RouteInitEnvironment } from "../shared/env";
2
- import { packageRootPath } from "../shared/rootpath";
3
- import { join as joinPaths } from 'path'
4
-
5
- export const addRoutes = (env: RouteInitEnvironment) => {
6
-
7
- const webManagerDir = `/webmanager/`;
8
-
9
- // Add redirect from root to webmanager
10
- env.app.get('/', (req, res) => {
11
- res.redirect(webManagerDir);
12
- });
13
-
14
- // Serve static files from webmanager directory
15
- env.app.get(`${webManagerDir}*`, (req, res) => {
16
- const filePath = req.path.slice(webManagerDir.length);
17
- const assetsPath = joinPaths(packageRootPath, '/webmanager');
18
- if (filePath.length === 0) {
19
- // Send default file
20
- res.sendFile(joinPaths(assetsPath, '/index.html'));
21
- }
22
- else {
23
- res.sendFile(joinPaths(assetsPath, '/', filePath));
24
- }
25
- });
26
-
27
- };
28
-
29
- export default addRoutes;
package/src/rules.ts DELETED
@@ -1,196 +0,0 @@
1
- import { AceBase } from 'acebase';
2
- import { DebugLogger, PathInfo } from 'acebase-core';
3
- import * as fs from 'fs';
4
- import { DbUserAccountDetails } from './schema/user';
5
- import { AUTH_ACCESS_DEFAULT, AuthAccessDefault } from './settings';
6
-
7
- type PathRuleFunction = ((env: any) => boolean) & { getText(): string };
8
- type PathRules = {} & {
9
- '.schema'?: string|Object;
10
- '.read'?: boolean|string|PathRuleFunction;
11
- '.write'?: boolean|string|PathRuleFunction;
12
- '.validate'?: string|PathRuleFunction;
13
- }
14
- type RulesData = {
15
- rules: PathRules;
16
- }
17
- export type RuleValidationFailCode = 'rule'|'no_rule'|'private'|'exception';
18
- // type HasAccessResult = { allow: true } | { allow: false; code: RuleValidationFailCode; message: string; rule?: string|boolean; rulePath?: string; details?: any };
19
- type HasAccessResult = { allow: boolean; code?: RuleValidationFailCode; message?: string; rule?: string|boolean; rulePath?: string; details?: any } & ({ allow: true } | { allow: false; code: RuleValidationFailCode; message: string; rule?: string|boolean; rulePath?: string; details?: any });
20
-
21
- export class PathBasedRules {
22
-
23
- private authEnabled: boolean;
24
- private accessRules: RulesData;
25
- stop(): void { throw new Error('not started yet'); }
26
-
27
- constructor(rulesFilePath: string, defaultAccess: AuthAccessDefault, env: { debug: DebugLogger, db: AceBase, authEnabled: boolean } ) {
28
- // Reads rules from a file and monitors it
29
- // Check if there is a rules file, load it or generate default
30
-
31
- const readRules = () => {
32
- try {
33
- const json = fs.readFileSync(rulesFilePath, 'utf-8');
34
- const obj = JSON.parse(json);
35
- if (typeof obj !== 'object' || typeof obj.rules !== 'object') {
36
- throw new Error(`malformed rules object`);
37
- }
38
- return obj;
39
- }
40
- catch (err) {
41
- env.debug.error(`Failed to read rules from "${rulesFilePath}": ${err.message}`);
42
- return defaultRules;
43
- }
44
- };
45
- const defaultAccessRule = (def => {
46
- switch (def) {
47
- case AUTH_ACCESS_DEFAULT.ALLOW_AUTHENTICATED: {
48
- return 'auth !== null';
49
- }
50
- case AUTH_ACCESS_DEFAULT.ALLOW_ALL: {
51
- return true;
52
- }
53
- case AUTH_ACCESS_DEFAULT.DENY_ALL: {
54
- return false;
55
- }
56
- default: {
57
- env.debug.error(`Unknown defaultAccessRule "${def}"`);
58
- return false;
59
- }
60
- }
61
- })(defaultAccess);
62
- const defaultRules:RulesData = {
63
- rules: {
64
- ".read": defaultAccessRule,
65
- ".write": defaultAccessRule
66
- }
67
- };
68
- let accessRules = defaultRules;
69
- if (!fs.existsSync(rulesFilePath)) {
70
- // Write defaults
71
- fs.writeFileSync(rulesFilePath, JSON.stringify(defaultRules, null, 4));
72
- }
73
- else {
74
- accessRules = readRules();
75
- }
76
-
77
- // Convert string rules to functions that can be executed
78
- const processRules = (path: string, parent: any, variables: string[]) => {
79
- Object.keys(parent).forEach(key => {
80
- let rule = parent[key];
81
- if (['.read', '.write', '.validate'].includes(key) && typeof rule === 'string') {
82
- // Convert to function
83
- const text = rule;
84
- rule = eval(`(env => { const { now, root, newData, data, auth, ${variables.join(', ')} } = env; return ${text}; })`);
85
- rule.getText = () => {
86
- return text;
87
- }
88
- return parent[key] = rule;
89
- }
90
- else if (key === '.schema') {
91
- // Add schema
92
- return env.db.schema.set(path, rule)
93
- .catch(err => {
94
- env.debug.error(`Error parsing ${path}/.schema: ${err.message}`)
95
- });
96
- }
97
- else if (key.startsWith('$')) {
98
- variables.push(key);
99
- }
100
- if (typeof rule === 'object') {
101
- processRules(`${path}/${key}`, rule, variables.slice());
102
- }
103
- });
104
- };
105
- processRules('', accessRules.rules, []);
106
-
107
- // Watch file for changes
108
- const watchFileListener = () => {
109
- // Reload access rules
110
- const accessRules = readRules();
111
- processRules('', accessRules, []);
112
- this.accessRules = accessRules;
113
- };
114
- fs.watchFile(rulesFilePath, watchFileListener);
115
- this.stop = () => {
116
- fs.unwatchFile(rulesFilePath, watchFileListener);
117
- }
118
- process.on('SIGINT', this.stop);
119
-
120
- this.authEnabled = env.authEnabled;
121
- this.accessRules = accessRules;
122
- }
123
-
124
- /**
125
- *
126
- * @param {DbUserAccountDetails} user
127
- * @param {string} path
128
- * @param {boolean} [write]
129
- * @param {(details: { code: string, message: string, [key:string]: any }) => void} denyDetailsCallback
130
- */
131
- userHasAccess (user: Pick<DbUserAccountDetails, 'uid'>, path: string, write: boolean = false): HasAccessResult {
132
- // Process rules, find out if signed in user is allowed to read/write
133
- // Defaults to false unless a rule is found that tells us otherwise
134
-
135
- const allow: HasAccessResult = { allow: true };
136
- if (!this.authEnabled) {
137
- // Authentication is disabled, anyone can do anything. Not really a smart thing to do!
138
- return allow;
139
- }
140
- else if (user && user.uid === 'admin') {
141
- // Always allow admin access
142
- // TODO: implement user.is_admin, so the default admin account can be disabled
143
- return allow;
144
- }
145
- else if (path.startsWith('__')) {
146
- // NEW: with the auth database now integrated into the main database,
147
- // deny access to private resources starting with '__' for non-admins
148
- return { allow: false, code: 'private', message: `Access to private resource "${path}" not allowed` };
149
- }
150
-
151
- const env = { now: Date.now(), auth: user || null }; // IDEA: Add functions like "exists" and "value". These will be async (so that requires refactoring) and can be used like "await exists('./shared/' + auth.uid)" and "await value('./writable') === true"
152
- const pathKeys = PathInfo.getPathKeys(path);
153
- let rule = this.accessRules.rules;
154
- let rulePath = [];
155
- while(true) {
156
- if (!rule) {
157
- // TODO: check if this one is redundant with the pathKeys.length === 0 near the end
158
- return { allow: false, code: 'no_rule', message: `No rules set for requested path "${path}", defaulting to false` };
159
- }
160
- let checkRule = write ? rule['.write'] : rule['.read'];
161
- if (typeof checkRule === 'boolean') {
162
- if (!checkRule) {
163
- return { allow: false, code: 'rule', message: `Access denied to path "${path}" by set rule`, rule: checkRule, rulePath: rulePath.join('/') };
164
- }
165
- return allow;
166
- }
167
- if (typeof checkRule === 'function') {
168
- try {
169
- // Execute rule function
170
- if (!checkRule(env)) {
171
- return { allow: false, code: 'rule', message: `Access denied to path "${path}" by set rule`, rule: checkRule.getText(), rulePath: rulePath.join('/') };
172
- }
173
- return allow;
174
- }
175
- catch (err) {
176
- // If rule execution throws an exception, don't allow. Can happen when rule is "auth.uid === '...'", and auth is null because the user is not signed in
177
- return { allow: false, code: 'exception', message: `Access denied to path "${path}" by set rule`, rule: checkRule.getText(), rulePath: rulePath.join('/'), details: err };
178
- }
179
- }
180
- if (pathKeys.length === 0) {
181
- return { allow: false, code: 'no_rule', message: `No rule found for path ${path}` };
182
- }
183
- let nextKey = pathKeys.shift();
184
- // if nextKey is '*' or '$something', rule[nextKey] will be undefined (or match a variable) so there is no
185
- // need to change things here for usage of wildcard paths in subscriptions
186
- if (typeof rule[nextKey] === 'undefined') {
187
- // Check if current rule has a wildcard child
188
- const wildcardKey = Object.keys(rule).find(key => key ==='*' || key[0] === '$');
189
- if (wildcardKey) { env[wildcardKey] = nextKey; }
190
- nextKey = wildcardKey;
191
- }
192
- nextKey && rulePath.push(nextKey);
193
- rule = rule[nextKey];
194
- }
195
- }
196
- }