tracker

8.2 KB

1. // lib/users.hl — WHO IS SIGNED IN (tracker.worldapi.org#1; copied from calendar.worldapi.org's users.hl unchanged in
2. // shape, per the architect: "Copy calendar.worldapi.org's login unchanged"). Login is ident's LOGIN BUTTON flow
3. // (ident README "How apps use ident", way 2): <ident>/login?key=&return=<public url>/login/callback → ?ident_code=
4. // → the server exchanges it (key + secret) for the per-app identity id. Way 3, the IDENTITY SELECTOR, sits beside the
5. // button (login.js hands its code to the shell).
6. //
7. // usersTable pk @id index !identity { identity, created } storage/mpackdb/users.db
8. // identity = what ident's exchange answers: the identity's public SHORT id (ident#23, `a68sz`) — stays SERVER
9. // SIDE, never sent to a page.
10. // The session (hl:web) carries `user = { id = <users @id> }` only. No display name: nothing else is stored.
11. //
12. // Config (environment, or `.env` beside project.hl — never read or printed by workers):
13. // IDENT_URL, IDENT_EXCHANGE_URL, TRACKER_KEY, TRACKER_SECRET as calendar's IDENT_API_KEY/IDENT_API_SECRET
14. // TRACKER_URL the app's own address, default https://tracker.worldapi.org
15. // TRACKER_STORAGE table directory, default ./storage/mpackdb
16. import { MPackDB } from 'hl:mpackdb'
17. import { Response } from 'hl:http1'
18. import { randomBytes } from 'hl:crypto'
19. import { now } from 'hl:time'
20. import { fetch } from 'hl:fetch'
21. import { envOr, storageDir, firstOf } from './util.hl'
23. static identUrl = envOr('IDENT_URL', 'https://ident.worldapi.org')
24. static identExchangeUrl = envOr('IDENT_EXCHANGE_URL', identUrl)
25. static identKey = envOr('TRACKER_KEY', '')
26. static identSecret = envOr('TRACKER_SECRET', '')
27. static publicUrl = envOr('TRACKER_URL', 'https://tracker.worldapi.org')
29. static usersTable = new MPackDB(file = storageDir + '/users.db', primaryKey = '@id', indexes = ['!identity'])
31. static selectorScript = identUrl + '/selector.js'
32. static callbackUrl = publicUrl.replaceAll('/', '') == '' ? '' : publicUrl + '/login/callback'
33. static loginHref = identUrl + '/login?key=' + identKey + '&return=' + encodeURIComponent(callbackUrl)
35. // only lowercase hex (ident's one-time codes are 48 hex)
36. static isHex = (&s, &max) => {
37. if (s == null || hlTypeName(s) != 'String' || s.length == 0 || s.length > max) { return false }
38. let i = 0
39. while (i < s.length) {
40. let c = s.charCodeAt(i)
41. if (!((c >= 48 && c <= 57) || (c >= 97 && c <= 102))) { return false }
42. i = i + 1
43. }
44. return true
45. }
47. // an identity id as ident answers it: its public SHORT ID since ident#23 (5 characters like `a68sz`: 2-9 and a-z),
48. // before that the old per-app id (32 hex) — lower case letters and digits, at most 64
49. static isIdentId = (&s) => {
50. if (s == null || hlTypeName(s) != 'String' || s.length == 0 || s.length > 64) { return false }
51. let i = 0
52. while (i < s.length) {
53. let c = s.charCodeAt(i)
54. if (!((c >= 48 && c <= 57) || (c >= 97 && c <= 122))) { return false }
55. i = i + 1
56. }
57. return true
58. }
60. // THE EXCHANGE: POST <ident>/api/exchange { key, secret, code } → { identity } | { error }
61. // (a failed fetch is an `Error` event, absorbed by project.hl's `on Error`; the fetch then yields null)
62. static exchangeCode = (code) => {
63. if (identKey == '' || identSecret == '') { return { error = 'login is not set up on this server (TRACKER_KEY / TRACKER_SECRET missing)' } }
64. if (!isHex(code, 200)) { return { error = 'that is not an ident login code' } }
65. r = fetch(identExchangeUrl + '/api/exchange', { method = 'POST' json = { key = identKey secret = identSecret code = code } headers = { 'user-agent' = 'tracker.worldapi.org (ident exchange)' } timeoutMs = 10000 })
66. if (r == null || r.status == null || r.status == 0) { return { error = 'ident did not answer' } }
67. j = r.status == 200 ? r.json() : null
68. if (j == null || j.identity == null || !isIdentId(j.identity)) {
69. let why = ''
70. if (r.status != 200) {
71. e = r.json()
72. why = e != null && e.error != null ? ': ' + e.error : ''
73. }
74. return { error = 'ident refused the login (' + r.status + why + ')' }
75. }
76. return { identity = j.identity }
77. }
79. // ---- users --------------------------------------------------------------------------------
80. // a face's trailing `session` is always the server's since hybriel #16 (a peer's extra argument is refused)
82. static userRecord = (&userId) => {
83. if (userId == null || hlTypeName(userId) != 'String' || userId == '') { return null }
84. return usersTable.fetch(userId)
85. }
87. // the user of an identity id, made at its first login
88. static ensureUser = (identity) => {
89. u = firstOf(usersTable.find('identity', identity))
90. if (u != null) { return u }
91. id = usersTable.put({ identity = identity created = now() })
92. if (id == null) { return null }
93. return usersTable.fetch(id)
94. }
96. // an ident login code → this app's user (made at its first login): { user } or { error } — both ways in (the header's
97. // selector, components/main.hl face trackerLogin; the button's return, loginCallbackOf below)
98. static userOfCode = (code) => {
99. x = exchangeCode(code)
100. if (x.error != null) { return { error = x.error } }
101. u = ensureUser(x.identity)
102. if (u == null) { return { error = 'could not store the user' } }
103. return { user = u }
104. }
106. static userOfSession = (&session) => {
107. if (session == null || session.user == null) { return null }
108. return userRecord(session.user.id)
109. }
111. // the users @id of a session, or null (a page may know it: it is not the identity id)
112. static userIdOfSession = (&session) => {
113. u = userOfSession(session)
114. return u == null ? null : u.id
115. }
117. // ---- THE LOGIN BUTTON'S RETURN (ident README "How apps use ident"), copied from calendar.worldapi.org's project.hl ---------
118. // (mission 028: out of project.hl, whose route `/login/callback` calls `loginCallbackOf` with the server's sessions)
119. // /login/callback?ident_code=<code> the app's server exchanges the code for the identity's short id
120. // (POST <ident>/api/exchange) and signs this app's OWN session in
121. // (session.user = { id = <users @id> }); the header's "Log out" signs it out again
122. // (components/main.hl face trackerLogOut) — ident's own session is untouched
123. // BACK TO THE PAGE: /login.js puts `?next=` into the button's return URL at the click. Only a same-origin PATH
124. // goes (one `/`, URL-safe characters, ≤ 500). Anything else → `/`.
125. static nextChars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-._~/?&=%+,;@!$()*:'
126. static safePath = (&want) => {
127. if (want == null || hlTypeName(want) != 'String' || want == '' || want.length > 500) { return '/' }
128. if (want.slice(0, 1) != '/' || want.slice(0, 2) == '//' || want.slice(0, 7) == '/login/') { return '/' }
129. let i = 0
130. while (i < want.length) {
131. if (!nextChars.includes(want[i])) { return '/' }
132. i = i + 1
133. }
134. return want
135. }
137. // A FAILED LOGIN is a page (components/loginfailed.hl): the reason is parked in the session, then → /login/failed
138. static loginFailedOf = (&sessions, &req, why) => {
139. let s = req.session
140. fresh = s == null
141. if (fresh) { s = sessions.mint() }
142. s.data.loginError = why
143. sessions.save(s)
144. let res = new Response('login failed: ' + why, { status = 302 headers = { 'Location' = '/login/failed' 'Cache-Control' = 'no-store' 'Content-Type' = 'text/plain; charset=utf-8' } })
145. if (fresh) { res.headers['Set-Cookie'] = sessions.cookieHeader(s.id) }
146. return res
147. }
149. // the function route gets the cookie's session as req.session (hybriel #11); none yet → minted here. `sessions` = the
150. // server's (hl:web `server.sessions`)
151. static loginCallbackOf = (&sessions, &req) => {
152. if (req.method != 'GET') { return loginFailedOf(sessions, req, 'GET only') }
153. q = req.query != null ? req.query : {}
154. code = q.ident_code
155. if (code == null || code == '') { return loginFailedOf(sessions, req, 'ident sent no login code') }
156. x = userOfCode(code)
157. if (x.error != null) { return loginFailedOf(sessions, req, x.error) }
158. u = x.user
159. let s = req.session
160. fresh = s == null
161. if (fresh) { s = sessions.mint() }
162. s.user = { id = u.id }
163. s.data.tag = randomBytes(16)
164. s.data.loginError = null
165. sessions.save(s)
166. let res = new Response('logged in', { status = 302 headers = { 'Location' = safePath(q.next) 'Cache-Control' = 'no-store' 'Content-Type' = 'text/plain; charset=utf-8' } })
167. if (fresh) { res.headers['Set-Cookie'] = sessions.cookieHeader(s.id) }
168. return res
169. }