notes

5.2 KB

1. // 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> }` only. No display name: notes are private.
10. //
11. // Config (environment, or `.env` beside project.hl — never read or printed by workers):
12. // IDENT_URL, IDENT_EXCHANGE_URL, IDENT_API_KEY, IDENT_API_SECRET as in gitoria
13. // NOTES_PUBLIC_URL the app's address, default https://notes.worldapi.org
14. // NOTES_STORAGE table directory, default ./storage/mpackdb
15. import { MPackDB } from 'hl:mpackdb'
16. import { env } from 'hl:proc'
17. import { now } from 'hl:time'
18. import { fetch } from 'hl:fetch'
20. static envOr = (name, fallback) => {
21. let v = env(name)
22. return v != null && v.trim() != '' ? v.trim() : fallback
23. }
25. static identUrl = envOr('IDENT_URL', 'https://ident.worldapi.org')
26. static identExchangeUrl = envOr('IDENT_EXCHANGE_URL', identUrl)
27. static identKey = envOr('IDENT_API_KEY', '')
28. static identSecret = envOr('IDENT_API_SECRET', '')
29. static publicUrl = envOr('NOTES_PUBLIC_URL', 'https://notes.worldapi.org')
31. static storageDir = envOr('NOTES_STORAGE', './storage/mpackdb')
32. static usersTable = new MPackDB(file = storageDir + '/users.db', primaryKey = '@id', indexes = ['!identity'])
34. static countOfList = (list) => {
35. if (list == null) { return 0 }
36. let n = list.length
37. return n == null ? 0 : n
38. }
39. static firstOf = (list) => { return countOfList(list) > 0 ? list[0] : null }
41. static selectorScript = identUrl + '/selector.js'
42. static callbackUrl = publicUrl.replaceAll('/', '') == '' ? '' : publicUrl + '/login/callback'
43. static loginHref = identUrl + '/login?key=' + identKey + '&return=' + encodeURIComponent(callbackUrl)
45. // only lowercase hex (ident's one-time codes are 48 hex)
46. static isHex = (s, max) => {
47. if (s == null || hlTypeName(s) != 'String' || s.length == 0 || s.length > max) { return false }
48. let i = 0
49. while (i < s.length) {
50. let c = s.charCodeAt(i)
51. if (!((c >= 48 && c <= 57) || (c >= 97 && c <= 102))) { return false }
52. i = i + 1
53. }
54. return true
55. }
57. // an identity id as ident answers it: its public SHORT ID since ident#23 (5 characters like `a68sz`: 2-9 and a-z),
58. // before that the old per-app id (32 hex) — lower case letters and digits, at most 64 (mission 039; isHex refused `a68sz`)
59. static isIdentId = (s) => {
60. if (s == null || hlTypeName(s) != 'String' || s.length == 0 || s.length > 64) { return false }
61. let i = 0
62. while (i < s.length) {
63. let c = s.charCodeAt(i)
64. if (!((c >= 48 && c <= 57) || (c >= 97 && c <= 122))) { return false }
65. i = i + 1
66. }
67. return true
68. }
70. // THE EXCHANGE: POST <ident>/api/exchange { key, secret, code } → { identity } | { error }
71. // (a failed fetch is an `Error` event, absorbed by project.hl's `on Error`; the fetch then yields null)
72. static exchangeCode = (code) => {
73. if (identKey == '' || identSecret == '') { return { error = 'login is not set up on this server (IDENT_API_KEY / IDENT_API_SECRET missing)' } }
74. if (!isHex(code, 200)) { return { error = 'that is not an ident login code' } }
75. let r = fetch(identExchangeUrl + '/api/exchange', { method = 'POST' json = { key = identKey secret = identSecret code = code } headers = { 'user-agent' = 'notes.worldapi.org (ident exchange)' } timeoutMs = 10000 })
76. if (r == null || r.status == null || r.status == 0) { return { error = 'ident did not answer' } }
77. let j = r.status == 200 ? r.json() : null
78. if (j == null || j.identity == null || !isIdentId(j.identity)) {
79. let why = ''
80. if (r.status != 200) {
81. let e = r.json()
82. why = e != null && e.error != null ? ': ' + e.error : ''
83. }
84. return { error = 'ident refused the login (' + r.status + why + ')' }
85. }
86. return { identity = j.identity }
87. }
89. // ---- users --------------------------------------------------------------------------------
90. // a face's trailing `session` is always the server's since hybriel #16 (a peer's extra argument is refused)
92. static userRecord = (userId) => {
93. if (userId == null || hlTypeName(userId) != 'String' || userId == '') { return null }
94. return usersTable.fetch(userId)
95. }
97. // the user of an identity id, made at its first login
98. static ensureUser = (identity) => {
99. let u = firstOf(usersTable.find('identity', identity))
100. if (u != null) { return u }
101. let id = usersTable.put({ identity = identity created = now() })
102. if (id == null) { return null }
103. return usersTable.fetch(id)
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. let u = userOfSession(session)
114. return u == null ? null : u.id
115. }