notes

4.7 KB

1. // lib/users.hl — WHO OWNS NOTES (ticket notes#1; CONCEPT.md "login via ident"). Login is ident's LOGIN BUTTON flow
2. // (ident README "How apps use ident", way 2): <ident>/login?key=&return=<public url>/login/callback → ?ident_code=
3. // → the server exchanges it (key + secret) for the per-app identity id. Way 3, the IDENTITY SELECTOR, sits beside the
4. // button (login.js hands its code to the shell).
5. //
6. // usersTable pk @id index !identity { identity, created } storage/mpackdb/users.db
7. // identity = what ident's exchange answers: the identity's public SHORT id since ident#23 (`a68sz`; old 32-hex per-app
8. // ids are rewritten once by tools/migrate-short-ids.hl) — stays SERVER SIDE, never sent to a page.
9. // The session (hl:web) carries `user = { id = <users @id> }` and `data.tag` (the login's random tag, tagOf) only.
10. // No display name: notes are private. Both logins (lib/api.hl loginCallback, the face notesLogin in components/main.hl)
11. // go through userOfLoginCode; they write the session themselves.
12. //
13. // Config (environment, or `.env` beside project.hl — never read or printed by workers):
14. // IDENT_URL, IDENT_EXCHANGE_URL, IDENT_API_KEY, IDENT_API_SECRET as in gitoria
15. // NOTES_PUBLIC_URL the app's address, default https://notes.worldapi.org
16. // NOTES_STORAGE table directory, default ./storage/mpackdb (lib/util.hl storageDir)
17. import { MPackDB } from 'hl:mpackdb'
18. import { now } from 'hl:time'
19. import { fetch } from 'hl:fetch'
20. import { envOr, storageDir, firstOf, isHex, isIdentId } from './util.hl'
22. static identUrl = envOr('IDENT_URL', 'https://ident.worldapi.org')
23. static identExchangeUrl = envOr('IDENT_EXCHANGE_URL', identUrl)
24. static identKey = envOr('IDENT_API_KEY', '')
25. static identSecret = envOr('IDENT_API_SECRET', '')
26. static publicUrl = envOr('NOTES_PUBLIC_URL', 'https://notes.worldapi.org')
28. static usersTable = new MPackDB(file = storageDir + '/users.db', primaryKey = '@id', indexes = ['!identity'])
30. static selectorScript = identUrl + '/selector.js'
31. static callbackUrl = publicUrl.replaceAll('/', '') == '' ? '' : publicUrl + '/login/callback'
32. static loginHref = identUrl + '/login?key=' + identKey + '&return=' + encodeURIComponent(callbackUrl)
34. // THE EXCHANGE: POST <ident>/api/exchange { key, secret, code } → { identity } | { error }
35. // (a failed fetch is an `Error` event, absorbed by project.hl's `on Error`; the fetch then yields null)
36. static exchangeCode = (code) => {
37. if (identKey == '' || identSecret == '') { return { error = 'login is not set up on this server (IDENT_API_KEY / IDENT_API_SECRET missing)' } }
38. if (!isHex(code, 200)) { return { error = 'that is not an ident login code' } }
39. r = fetch(identExchangeUrl + '/api/exchange', { method = 'POST' json = { key = identKey secret = identSecret code = code } headers = { 'user-agent' = 'notes.worldapi.org (ident exchange)' } timeoutMs = 10000 })
40. if (r == null || r.status == null || r.status == 0) { return { error = 'ident did not answer' } }
41. j = r.status == 200 ? r.json() : null
42. if (j == null || j.identity == null || !isIdentId(j.identity)) {
43. let why = ''
44. if (r.status != 200) {
45. e = r.json()
46. why = e != null && e.error != null ? ': ' + e.error : ''
47. }
48. return { error = 'ident refused the login (' + r.status + why + ')' }
49. }
50. return { identity = j.identity }
51. }
53. // ---- users --------------------------------------------------------------------------------
54. // a face's trailing `session` is always the server's since hybriel #16 (a peer's extra argument is refused)
56. static userRecord = (userId) => {
57. if (userId == null || hlTypeName(userId) != 'String' || userId == '') { return null }
58. return usersTable.fetch(userId)
59. }
61. // the user of an identity id, made at its first login
62. static ensureUser = (identity) => {
63. u = firstOf(usersTable.find('identity', identity))
64. if (u != null) { return u }
65. id = usersTable.put({ identity = identity created = now() })
66. if (id == null) { return null }
67. return usersTable.fetch(id)
68. }
70. // A LOGIN CODE (the button's ?ident_code= or the selector's) → { user } (made at the first login) | { error }
71. static userOfLoginCode = (code) => {
72. x = exchangeCode(code)
73. if (x.error != null) { return { error = x.error } }
74. u = ensureUser(x.identity)
75. if (u == null) { return { error = 'could not store the user' } }
76. return { user = u }
77. }
79. static userOfSession = (session) => {
80. if (session == null || session.user == null) { return null }
81. return userRecord(session.user.id)
82. }
84. // the users @id of a session, or null (a page may know it: it is not the identity id)
85. static userIdOfSession = (session) => {
86. u = userOfSession(session)
87. return u == null ? null : u.id
88. }
90. // the random tag of a session's login (project.hl audience: the login state reaches the tabs of that one session)
91. static tagOf = (session) => { return session != null && session.data != null ? session.data.tag : null }