config.ts 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240
  1. import { isIP } from 'node:net'
  2. import { homedir } from 'node:os'
  3. import { basename, resolve } from 'node:path'
  4. import { createPrivateKey } from 'node:crypto'
  5. import { accessSync, constants as fsConstants, existsSync, readFileSync, statSync } from 'node:fs'
  6. export interface APNsProviderConfig {
  7. keyFile: string
  8. keyId: string
  9. teamId: string
  10. topic: string
  11. }
  12. export interface ServerConfig {
  13. host: string
  14. port: number
  15. upstream: URL
  16. allowedHosts: ReadonlySet<string>
  17. home: string
  18. mediaRoot: string
  19. attachmentsRoot: string
  20. imagesRoot: string
  21. mediaOwner: string
  22. tlsCert?: string
  23. tlsKey?: string
  24. allowInsecureLan: boolean
  25. insecureLan: boolean
  26. production: boolean
  27. superviseDashboard?: boolean
  28. yaoyaoPluginSource?: string
  29. releaseSource?: string
  30. releaseRoot?: string
  31. allowRemoteUpdate?: boolean
  32. upstreamUsername?: string
  33. upstreamPassword?: string
  34. apns?: APNsProviderConfig
  35. apnsConfigurationError?: string
  36. }
  37. export const DEFAULT_YAOYAO_PLUGIN_SOURCE = 'https://git.samien.cn/samien/hermes-yaoyao.git#hermes-plugins/yaoyao'
  38. export const DEFAULT_YAOYAO_RELEASE_SOURCE = 'https://git.samien.cn/samien/hermes-yaoyao.git'
  39. export const DEFAULT_APNS_TOPIC = 'cn.samien.yaoyao.hermes'
  40. function flag(value: string | undefined): boolean {
  41. return value === '1' || value?.toLowerCase() === 'true'
  42. }
  43. function parsePort(value: string | undefined): number {
  44. const port = Number(value ?? '8800')
  45. if (!Number.isInteger(port) || port < 1 || port > 65_535) {
  46. throw new Error('HERMES_YAOYAO_PORT must be an integer between 1 and 65535')
  47. }
  48. return port
  49. }
  50. function parseUpstream(value: string | undefined): URL {
  51. const upstream = new URL(value ?? 'http://127.0.0.1:9119')
  52. if (!['http:', 'https:'].includes(upstream.protocol)) {
  53. throw new Error('HERMES_YAOYAO_UPSTREAM must use http or https')
  54. }
  55. if (upstream.username || upstream.password || upstream.search || upstream.hash) {
  56. throw new Error('HERMES_YAOYAO_UPSTREAM must not contain credentials, query, or fragment')
  57. }
  58. upstream.pathname = upstream.pathname.replace(/\/+$/, '') || '/'
  59. return upstream
  60. }
  61. function parsePluginSource(value: string | undefined): string {
  62. const source = value?.trim() || DEFAULT_YAOYAO_PLUGIN_SOURCE
  63. if (source.length > 2_048 || /[\u0000-\u001f\u007f]/.test(source)) {
  64. throw new Error('HERMES_YAOYAO_PLUGIN_SOURCE is invalid')
  65. }
  66. if (source.startsWith('https://') || source.startsWith('http://')) {
  67. const url = new URL(source)
  68. if (url.username || url.password) {
  69. throw new Error('HERMES_YAOYAO_PLUGIN_SOURCE must not contain credentials')
  70. }
  71. } else if (!source.startsWith('git@') && !source.startsWith('ssh://')) {
  72. throw new Error('HERMES_YAOYAO_PLUGIN_SOURCE must be an HTTPS or SSH Git source')
  73. }
  74. return source
  75. }
  76. function parseReleaseSource(value: string | undefined): string {
  77. const source = value?.trim() || DEFAULT_YAOYAO_RELEASE_SOURCE
  78. if (source.length > 2_048 || /[\u0000-\u001f\u007f]/.test(source)) {
  79. throw new Error('HERMES_YAOYAO_RELEASE_SOURCE is invalid')
  80. }
  81. if (source.startsWith('https://')) {
  82. const url = new URL(source)
  83. if (url.username || url.password || url.search || url.hash) {
  84. throw new Error('HERMES_YAOYAO_RELEASE_SOURCE must not contain credentials, query, or fragment')
  85. }
  86. } else if (!source.startsWith('git@') && !source.startsWith('ssh://')) {
  87. throw new Error('HERMES_YAOYAO_RELEASE_SOURCE must be an HTTPS or SSH Git source')
  88. }
  89. return source
  90. }
  91. function parseAPNsConfiguration(env: NodeJS.ProcessEnv): {
  92. apns?: APNsProviderConfig
  93. apnsConfigurationError?: string
  94. } {
  95. const rawKeyFile = env.HERMES_YAOYAO_APNS_KEY_FILE?.trim()
  96. const keyId = env.HERMES_YAOYAO_APNS_KEY_ID?.trim()
  97. const teamId = env.HERMES_YAOYAO_APNS_TEAM_ID?.trim()
  98. const topic = env.HERMES_YAOYAO_APNS_TOPIC?.trim() || DEFAULT_APNS_TOPIC
  99. if (!rawKeyFile && !keyId && !teamId && !env.HERMES_YAOYAO_APNS_TOPIC?.trim()) return {}
  100. if (!rawKeyFile || !keyId || !teamId) {
  101. return { apnsConfigurationError: 'HERMES_YAOYAO_APNS_KEY_FILE, HERMES_YAOYAO_APNS_KEY_ID, and HERMES_YAOYAO_APNS_TEAM_ID must be set together' }
  102. }
  103. if (!/^[A-Za-z0-9]{1,128}$/.test(keyId)) {
  104. return { apnsConfigurationError: 'HERMES_YAOYAO_APNS_KEY_ID is invalid' }
  105. }
  106. if (!/^[A-Za-z0-9]{1,128}$/.test(teamId)) {
  107. return { apnsConfigurationError: 'HERMES_YAOYAO_APNS_TEAM_ID is invalid' }
  108. }
  109. if (topic.length > 255 || !/^[A-Za-z0-9](?:[A-Za-z0-9.-]*[A-Za-z0-9])?$/.test(topic)) {
  110. return { apnsConfigurationError: 'HERMES_YAOYAO_APNS_TOPIC is invalid' }
  111. }
  112. const keyFile = resolve(rawKeyFile)
  113. try {
  114. if (!existsSync(keyFile) || !statSync(keyFile).isFile()) {
  115. return { apnsConfigurationError: 'HERMES_YAOYAO_APNS_KEY_FILE must point to a readable file' }
  116. }
  117. accessSync(keyFile, fsConstants.R_OK)
  118. const key = createPrivateKey(readFileSync(keyFile))
  119. if (key.asymmetricKeyType !== 'ec' || key.asymmetricKeyDetails?.namedCurve !== 'prime256v1') {
  120. return { apnsConfigurationError: 'HERMES_YAOYAO_APNS_KEY_FILE must contain an ES256 private key' }
  121. }
  122. } catch {
  123. return { apnsConfigurationError: 'HERMES_YAOYAO_APNS_KEY_FILE must contain a readable ES256 private key' }
  124. }
  125. return { apns: { keyFile, keyId, teamId, topic } }
  126. }
  127. function normalizeConfiguredHost(raw: string): string {
  128. const value = raw.trim().toLowerCase()
  129. if (!value) return ''
  130. if (value.startsWith('[') && value.endsWith(']')) return value.slice(1, -1)
  131. return value.replace(/\.$/, '')
  132. }
  133. export function isLoopbackHost(host: string): boolean {
  134. const normalized = normalizeConfiguredHost(host)
  135. if (normalized === 'localhost' || normalized === '::1') return true
  136. if (isIP(normalized) === 4) return normalized.split('.')[0] === '127'
  137. return false
  138. }
  139. export function isPrivateHost(host: string): boolean {
  140. const normalized = normalizeConfiguredHost(host)
  141. if (isLoopbackHost(normalized)) return true
  142. if (isIP(normalized) === 4) {
  143. const parts = normalized.split('.').map(Number)
  144. return parts[0] === 10
  145. || (parts[0] === 100 && parts[1]! >= 64 && parts[1]! <= 127)
  146. || (parts[0] === 169 && parts[1] === 254)
  147. || (parts[0] === 172 && parts[1]! >= 16 && parts[1]! <= 31)
  148. || (parts[0] === 192 && parts[1] === 168)
  149. }
  150. if (isIP(normalized) === 6) {
  151. return normalized.startsWith('fc')
  152. || normalized.startsWith('fd')
  153. || /^fe[89ab]/.test(normalized)
  154. }
  155. return false
  156. }
  157. export function isLoopbackUpstream(upstream: URL): boolean {
  158. return isLoopbackHost(upstream.hostname)
  159. }
  160. export function loadServerConfig(
  161. env: NodeJS.ProcessEnv = process.env,
  162. ): ServerConfig {
  163. const host = env.HERMES_YAOYAO_HOST?.trim() || '127.0.0.1'
  164. const port = parsePort(env.HERMES_YAOYAO_PORT)
  165. const upstream = parseUpstream(env.HERMES_YAOYAO_UPSTREAM)
  166. const home = resolve(env.HERMES_YAOYAO_HOME?.trim() || `${homedir()}/.hermes-yaoyao`)
  167. const mediaRoot = resolve(env.HERMES_YAOYAO_MEDIA_ROOT?.trim() || `${homedir()}/Agents`)
  168. const attachmentsRoot = resolve(`${homedir()}/.hermes/attachments`)
  169. const imagesRoot = resolve(`${homedir()}/.hermes/images`)
  170. const tlsCert = env.HERMES_YAOYAO_TLS_CERT?.trim() || undefined
  171. const tlsKey = env.HERMES_YAOYAO_TLS_KEY?.trim() || undefined
  172. if (Boolean(tlsCert) !== Boolean(tlsKey)) {
  173. throw new Error('HERMES_YAOYAO_TLS_CERT and HERMES_YAOYAO_TLS_KEY must be set together')
  174. }
  175. const allowInsecureLan = flag(env.HERMES_YAOYAO_ALLOW_INSECURE_LAN)
  176. const production = env.NODE_ENV === 'production'
  177. const superviseDashboard = flag(env.HERMES_YAOYAO_SUPERVISE_DASHBOARD)
  178. const yaoyaoPluginSource = parsePluginSource(env.HERMES_YAOYAO_PLUGIN_SOURCE)
  179. const releaseSource = parseReleaseSource(env.HERMES_YAOYAO_RELEASE_SOURCE)
  180. const releaseRoot = resolve(env.HERMES_YAOYAO_RELEASE_ROOT?.trim() || `${homedir()}/.local/share/hermes-yaoyao`)
  181. const allowRemoteUpdate = flag(env.HERMES_YAOYAO_ALLOW_REMOTE_UPDATE)
  182. const upstreamUsername = env.HERMES_YAOYAO_UPSTREAM_USERNAME?.trim() || undefined
  183. const upstreamPasswordFile = env.HERMES_YAOYAO_UPSTREAM_PASSWORD_FILE?.trim()
  184. if (env.HERMES_YAOYAO_UPSTREAM_PASSWORD && upstreamPasswordFile) {
  185. throw new Error('Set only one of HERMES_YAOYAO_UPSTREAM_PASSWORD or HERMES_YAOYAO_UPSTREAM_PASSWORD_FILE')
  186. }
  187. const upstreamPassword = env.HERMES_YAOYAO_UPSTREAM_PASSWORD
  188. || (upstreamPasswordFile ? readFileSync(resolve(upstreamPasswordFile), 'utf8').replace(/[\r\n]+$/, '') : undefined)
  189. const apnsConfiguration = parseAPNsConfiguration(env)
  190. const insecureLan = !tlsCert && !isLoopbackHost(host)
  191. if (production && insecureLan && !allowInsecureLan) {
  192. throw new Error(
  193. 'Plain HTTP on a non-loopback host requires HERMES_YAOYAO_ALLOW_INSECURE_LAN=1',
  194. )
  195. }
  196. const allowedHosts = new Set(
  197. (env.HERMES_YAOYAO_ALLOWED_HOSTS ?? '')
  198. .split(',')
  199. .map(normalizeConfiguredHost)
  200. .filter(Boolean),
  201. )
  202. return {
  203. host,
  204. port,
  205. upstream,
  206. allowedHosts,
  207. home,
  208. mediaRoot,
  209. attachmentsRoot,
  210. imagesRoot,
  211. mediaOwner: basename(homedir()),
  212. tlsCert,
  213. tlsKey,
  214. allowInsecureLan,
  215. insecureLan,
  216. production,
  217. superviseDashboard,
  218. yaoyaoPluginSource,
  219. releaseSource,
  220. releaseRoot,
  221. allowRemoteUpdate,
  222. upstreamUsername,
  223. upstreamPassword,
  224. ...apnsConfiguration,
  225. }
  226. }