ident

4.9 KB

1. // lib/apps-helpers.hl — what lib/apps.hl (and lib/invites.hl) look up: the app form's strict input, an origin,
2. // a return URL against the app's origins, new keys and secrets, the row a page shows. No table access. Statics only.
3. import { randomBytes } from 'hl:crypto'
4. import { hasControl, isList, isObject, urlChars } from './util.hl'
6. static maxOrigins = 10
7. static maxName = 60
9. // ---- validation -----------------------------------------------------------------------
10. static checkName = (name) => {
11. if (name == null || hlTypeName(name) != 'String') { return { error = 'field name must be a string' field = 'name' } }
12. t = name.trim()
13. if (t == '') { return { error = 'the app needs a name' field = 'name' } }
14. if (t.length > maxName) { return { error = 'field name is longer than ' + maxName + ' characters' field = 'name' } }
15. if (hasControl(t)) { return { error = 'field name contains a control character' field = 'name' } }
16. return { name = t }
17. }
19. // AN ORIGIN is `http(s)://host[:port]`: lowercase, no path, no user, no query. One
20. // trailing slash is forgiven. Answers { origin } or { error }.
21. static hostChars = 'abcdefghijklmnopqrstuvwxyz0123456789.-[]:'
22. static checkOrigin = (o) => {
23. if (o == null || hlTypeName(o) != 'String') { return { error = 'an origin must be a string' } }
24. let t = o.trim().toLowerCase()
25. if (t.length > 0 && t[t.length - 1] == '/') { t = t.slice(0, t.length - 1) }
26. if (t.length > 200) { return { error = 'the origin ' + t + ' is too long' } }
27. scheme = t.slice(0, 7) == 'http://' ? 'http://' : (t.slice(0, 8) == 'https://' ? 'https://' : null)
28. if (scheme == null) { return { error = 'an origin starts with http:// or https:// (' + t + ')' } }
29. host = t.slice(scheme.length, t.length)
30. if (host == '' || host[0] == '.' || host[0] == ':') { return { error = 'the origin ' + t + ' has no host' } }
31. let i = 0
32. while (i < host.length) {
33. if (!hostChars.includes(host[i])) { return { error = 'an origin is only scheme://host[:port], no path (' + t + ')' } }
34. i = i + 1
35. }
36. return { origin = t }
37. }
39. // the app form's input, STRICT: exactly { name, origins } — origins a list of 1-10
40. // strings. Answers { error, field } or { name, origins (list, deduplicated) }.
41. static appFields = ['name' 'origins']
42. static checkAppInput = (input) => {
43. if (!isObject(input)) { return { error = 'the app must be an object' field = '' } }
44. for (k of input.keys()) {
45. if (!appFields.includes(k)) { return { error = 'unknown field: ' + k field = k } }
46. }
47. for (k of appFields) {
48. if (input[k] == null) { return { error = 'missing field: ' + k field = k } }
49. }
50. n = checkName(input.name)
51. if (n.error != null) { return n }
52. if (!isList(input.origins)) { return { error = 'field origins must be a list of strings' field = 'origins' } }
53. out = []
54. for (o of input.origins) {
55. let c = checkOrigin(o)
56. if (c.error != null) { return { error = c.error field = 'origins' } }
57. if (!out.includes(c.origin)) { out.push(c.origin) }
58. }
59. if (out.length == 0) { return { error = 'give at least one origin the app runs on' field = 'origins' } }
60. if (out.length > maxOrigins) { return { error = 'at most ' + maxOrigins + ' origins' field = 'origins' } }
61. return { name = n.name origins = out }
62. }
64. // ---- apps -----------------------------------------------------------------------------
65. static newKey = () => { return 'pk_' + randomBytes(16) } // 32 hex
66. static newSecret = () => { return 'sk_' + randomBytes(24) } // 48 hex
67. static originsOf = (rec) => { return rec.origins == '' ? [] : rec.origins.split(' ') }
69. static appRowOf = (rec) => {
70. if (rec == null) { return null }
71. let origins = originsOf(rec)
72. return { id = rec.id name = rec.name origins = origins originsText = origins.join(' ') apiKey = rec.apiKey }
73. }
75. // ---- the login button ---------------------------------------------------------------
76. // A RETURN URL is absolute http(s), printable, no fragment, at most 2000 chars, and its
77. // origin is one of the app's. Answers { error } or { origin }.
78. static checkReturn = (url, appRec) => {
79. if (url == null || url == '') { return { error = 'the return parameter is missing' } }
80. if (url.length > 2000) { return { error = 'the return URL is too long' } }
81. let i = 0
82. while (i < url.length) {
83. if (!urlChars.includes(url[i])) { return { error = 'the return URL contains a character that is not allowed' } }
84. i = i + 1
85. }
86. lower = url.toLowerCase()
87. scheme = lower.slice(0, 7) == 'http://' ? 'http://' : (lower.slice(0, 8) == 'https://' ? 'https://' : null)
88. if (scheme == null) { return { error = 'the return URL must start with http:// or https://' } }
89. rest = lower.slice(scheme.length, lower.length)
90. let end = rest.length
91. for (ch of ['/' '?']) {
92. let at = rest.indexOf(ch)
93. if (at >= 0 && at < end) { end = at }
94. }
95. host = rest.slice(0, end)
96. if (host == '') { return { error = 'the return URL has no host' } }
97. let origin = scheme + host
98. if (!originsOf(appRec).includes(origin)) { return { error = 'the return URL is on ' + origin + ', which is not one of the origins registered for ' + appRec.name } }
99. return { origin = origin }
100. }