@coffeerunhobby/mcp-ha-connect 2.2.1 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (293) hide show
  1. package/.env.example +1 -1
  2. package/README.md +24 -2
  3. package/dist/omadaClient/accessControl.d.ts +290 -0
  4. package/dist/omadaClient/accessControl.js +509 -0
  5. package/dist/omadaClient/accessControl.js.map +1 -0
  6. package/dist/omadaClient/client.d.ts +6 -1
  7. package/dist/omadaClient/client.js +12 -1
  8. package/dist/omadaClient/client.js.map +1 -1
  9. package/dist/omadaClient/diagnose.d.ts +68 -0
  10. package/dist/omadaClient/diagnose.js +164 -0
  11. package/dist/omadaClient/diagnose.js.map +1 -0
  12. package/dist/omadaClient/index.d.ts +9 -0
  13. package/dist/omadaClient/index.js +19 -0
  14. package/dist/omadaClient/index.js.map +1 -1
  15. package/dist/omadaClient/macGroups.d.ts +58 -0
  16. package/dist/omadaClient/macGroups.js +110 -0
  17. package/dist/omadaClient/macGroups.js.map +1 -0
  18. package/dist/omadaClient/serialize.d.ts +13 -0
  19. package/dist/omadaClient/serialize.js +29 -0
  20. package/dist/omadaClient/serialize.js.map +1 -0
  21. package/dist/omadaClient/timeRange.d.ts +41 -0
  22. package/dist/omadaClient/timeRange.js +109 -0
  23. package/dist/omadaClient/timeRange.js.map +1 -0
  24. package/dist/tools/infra/actions.d.ts +1 -1
  25. package/dist/tools/infra/actions.js +1 -1
  26. package/dist/tools/omada/accessControl.d.ts +151 -0
  27. package/dist/tools/omada/accessControl.js +158 -0
  28. package/dist/tools/omada/accessControl.js.map +1 -0
  29. package/dist/tools/omada/index.js +9 -0
  30. package/dist/tools/omada/index.js.map +1 -1
  31. package/dist/tools/omada/macGroups.d.ts +19 -0
  32. package/dist/tools/omada/macGroups.js +77 -0
  33. package/dist/tools/omada/macGroups.js.map +1 -0
  34. package/dist/tools/omada/namespace.js +16 -0
  35. package/dist/tools/omada/namespace.js.map +1 -1
  36. package/dist/version.d.ts +1 -1
  37. package/dist/version.js +1 -1
  38. package/package.json +5 -1
  39. package/.codex/review-rules.md +0 -16
  40. package/.dockerignore +0 -8
  41. package/.gitattributes +0 -30
  42. package/.github/workflows/ci.yml +0 -193
  43. package/AGENTS.md +0 -389
  44. package/Dockerfile +0 -50
  45. package/docker-compose.yml +0 -23
  46. package/docs/CHANGELOG.md +0 -341
  47. package/docs/COVERAGE.md +0 -219
  48. package/docs/QUICK_START.md +0 -240
  49. package/eslint.config.js +0 -33
  50. package/n8n/ai-agent-safety-monitor.json +0 -355
  51. package/openapi.json +0 -1259
  52. package/scripts/check-version-sync.mjs +0 -69
  53. package/scripts/generate-jwt.ts +0 -121
  54. package/src/config.ts +0 -440
  55. package/src/haClient/automations.ts +0 -261
  56. package/src/haClient/calendars.ts +0 -94
  57. package/src/haClient/config.ts +0 -52
  58. package/src/haClient/devices.ts +0 -653
  59. package/src/haClient/entities.ts +0 -128
  60. package/src/haClient/events.ts +0 -689
  61. package/src/haClient/history.ts +0 -73
  62. package/src/haClient/index.ts +0 -336
  63. package/src/haClient/request.ts +0 -142
  64. package/src/haClient/services.ts +0 -45
  65. package/src/haClient/states.ts +0 -60
  66. package/src/haClient/updates.ts +0 -58
  67. package/src/haClient/wsCommand.ts +0 -44
  68. package/src/index.ts +0 -164
  69. package/src/localAI/index.ts +0 -88
  70. package/src/localAI/prompts.ts +0 -50
  71. package/src/localAI/providers/base.ts +0 -120
  72. package/src/localAI/providers/ollama.ts +0 -78
  73. package/src/localAI/providers/openai.ts +0 -86
  74. package/src/localAI/types.ts +0 -67
  75. package/src/omadaClient/auth.ts +0 -178
  76. package/src/omadaClient/client.ts +0 -337
  77. package/src/omadaClient/device.ts +0 -118
  78. package/src/omadaClient/index.ts +0 -310
  79. package/src/omadaClient/network.ts +0 -284
  80. package/src/omadaClient/request.ts +0 -365
  81. package/src/omadaClient/security.ts +0 -51
  82. package/src/omadaClient/site.ts +0 -344
  83. package/src/ownerQuestions/service.ts +0 -536
  84. package/src/permissions/index.ts +0 -143
  85. package/src/resources/index.ts +0 -213
  86. package/src/server/auth.ts +0 -175
  87. package/src/server/chatFace.ts +0 -789
  88. package/src/server/chatSlice.ts +0 -57
  89. package/src/server/common.ts +0 -170
  90. package/src/server/eventSubscription.ts +0 -343
  91. package/src/server/http.ts +0 -626
  92. package/src/server/instructions.ts +0 -97
  93. package/src/server/rateLimiter.ts +0 -227
  94. package/src/server/stdio.ts +0 -41
  95. package/src/server/stream.ts +0 -205
  96. package/src/tools/ai/analyzeSensors.ts +0 -33
  97. package/src/tools/ai/index.ts +0 -20
  98. package/src/tools/common.ts +0 -442
  99. package/src/tools/homeassistant/askOwner.ts +0 -133
  100. package/src/tools/homeassistant/automationControls.ts +0 -66
  101. package/src/tools/homeassistant/calendar.ts +0 -97
  102. package/src/tools/homeassistant/callService.ts +0 -25
  103. package/src/tools/homeassistant/controlClimate.ts +0 -68
  104. package/src/tools/homeassistant/controlCover.ts +0 -48
  105. package/src/tools/homeassistant/controlFan.ts +0 -44
  106. package/src/tools/homeassistant/controlLight.ts +0 -38
  107. package/src/tools/homeassistant/controlMediaPlayer.ts +0 -50
  108. package/src/tools/homeassistant/createAutomation.ts +0 -35
  109. package/src/tools/homeassistant/deleteAutomation.ts +0 -24
  110. package/src/tools/homeassistant/entityAction.ts +0 -35
  111. package/src/tools/homeassistant/entityGuard.ts +0 -28
  112. package/src/tools/homeassistant/getAllSensors.ts +0 -46
  113. package/src/tools/homeassistant/getAutomationTrace.ts +0 -30
  114. package/src/tools/homeassistant/getDomainSummary.ts +0 -29
  115. package/src/tools/homeassistant/getEntitiesByDomain.ts +0 -56
  116. package/src/tools/homeassistant/getHistory.ts +0 -24
  117. package/src/tools/homeassistant/getState.ts +0 -24
  118. package/src/tools/homeassistant/getStates.ts +0 -46
  119. package/src/tools/homeassistant/getVersion.ts +0 -21
  120. package/src/tools/homeassistant/index.ts +0 -121
  121. package/src/tools/homeassistant/listAutomations.ts +0 -35
  122. package/src/tools/homeassistant/listEntities.ts +0 -44
  123. package/src/tools/homeassistant/listPersons.ts +0 -46
  124. package/src/tools/homeassistant/sceneAndScript.ts +0 -53
  125. package/src/tools/homeassistant/searchEntities.ts +0 -58
  126. package/src/tools/homeassistant/sendNotification.ts +0 -179
  127. package/src/tools/homeassistant/systemTools.ts +0 -52
  128. package/src/tools/homeassistant/triggerAutomation.ts +0 -24
  129. package/src/tools/index.ts +0 -78
  130. package/src/tools/infra/actions.ts +0 -95
  131. package/src/tools/infra/index.ts +0 -138
  132. package/src/tools/omada/blockClient.ts +0 -28
  133. package/src/tools/omada/cyclePoePort.ts +0 -32
  134. package/src/tools/omada/deleteClient.ts +0 -27
  135. package/src/tools/omada/disableClientRateLimit.ts +0 -23
  136. package/src/tools/omada/getClient.ts +0 -14
  137. package/src/tools/omada/getDevice.ts +0 -14
  138. package/src/tools/omada/getFirewallSetting.ts +0 -14
  139. package/src/tools/omada/getInternetInfo.ts +0 -14
  140. package/src/tools/omada/getLanNetworkList.ts +0 -14
  141. package/src/tools/omada/getLanProfileList.ts +0 -14
  142. package/src/tools/omada/getPortForwardingStatus.ts +0 -26
  143. package/src/tools/omada/getRateLimitProfiles.ts +0 -14
  144. package/src/tools/omada/getSiteNtpStatus.ts +0 -14
  145. package/src/tools/omada/getSsidDetail.ts +0 -22
  146. package/src/tools/omada/getSsidList.ts +0 -21
  147. package/src/tools/omada/getSwitchStackDetail.ts +0 -14
  148. package/src/tools/omada/getThreatList.ts +0 -42
  149. package/src/tools/omada/getWlanGroupList.ts +0 -14
  150. package/src/tools/omada/graph.ts +0 -187
  151. package/src/tools/omada/index.ts +0 -153
  152. package/src/tools/omada/listBlockedClients.ts +0 -17
  153. package/src/tools/omada/listClients.ts +0 -14
  154. package/src/tools/omada/listClientsActivity.ts +0 -25
  155. package/src/tools/omada/listClientsPastConnections.ts +0 -44
  156. package/src/tools/omada/listDevices.ts +0 -14
  157. package/src/tools/omada/listDevicesStats.ts +0 -41
  158. package/src/tools/omada/listMostActiveClients.ts +0 -14
  159. package/src/tools/omada/listSites.ts +0 -18
  160. package/src/tools/omada/namespace.ts +0 -1164
  161. package/src/tools/omada/searchDevices.ts +0 -20
  162. package/src/tools/omada/setClientRateLimit.ts +0 -26
  163. package/src/tools/omada/setClientRateLimitProfile.ts +0 -25
  164. package/src/tools/omada/setSiteNtpServers.ts +0 -36
  165. package/src/tools/omada/setSsidEnabled.ts +0 -38
  166. package/src/tools/omada/unblockClient.ts +0 -26
  167. package/src/tools/types.ts +0 -11
  168. package/src/tools/utils/pagination-schema.ts +0 -27
  169. package/src/types/ai/index.ts +0 -11
  170. package/src/types/ai/types.ts +0 -67
  171. package/src/types/homeassistant/automations.ts +0 -43
  172. package/src/types/homeassistant/calendars.ts +0 -26
  173. package/src/types/homeassistant/config.ts +0 -14
  174. package/src/types/homeassistant/entities.ts +0 -14
  175. package/src/types/homeassistant/errors.ts +0 -33
  176. package/src/types/homeassistant/haConfig.ts +0 -7
  177. package/src/types/homeassistant/history.ts +0 -13
  178. package/src/types/homeassistant/index.ts +0 -46
  179. package/src/types/homeassistant/request.ts +0 -6
  180. package/src/types/homeassistant/serviceCall.ts +0 -18
  181. package/src/types/homeassistant/states.ts +0 -58
  182. package/src/types/homeassistant/updates.ts +0 -28
  183. package/src/types/index.ts +0 -12
  184. package/src/types/omada/activeClientInfo.ts +0 -17
  185. package/src/types/omada/clientActivity.ts +0 -32
  186. package/src/types/omada/clientBlockStatus.ts +0 -11
  187. package/src/types/omada/clientPastConnection.ts +0 -82
  188. package/src/types/omada/index.ts +0 -14
  189. package/src/types/omada/omadaApiResponse.ts +0 -5
  190. package/src/types/omada/omadaClientInfo.ts +0 -11
  191. package/src/types/omada/omadaDeviceInfo.ts +0 -11
  192. package/src/types/omada/omadaDeviceStats.ts +0 -31
  193. package/src/types/omada/omadaSiteSummary.ts +0 -5
  194. package/src/types/omada/oswStackDetail.ts +0 -11
  195. package/src/types/omada/paginatedResult.ts +0 -6
  196. package/src/types/omada/rateLimitProfile.ts +0 -58
  197. package/src/types/omada/threatInfo.ts +0 -38
  198. package/src/types/omada/tokenResult.ts +0 -6
  199. package/src/types.ts +0 -2
  200. package/src/utils/config-validations.ts +0 -68
  201. package/src/utils/jwt.ts +0 -112
  202. package/src/utils/logger.ts +0 -121
  203. package/src/utils/plainText.ts +0 -48
  204. package/src/utils/redact.ts +0 -59
  205. package/src/utils/sanitizeError.ts +0 -18
  206. package/src/utils/tlsDispatcher.ts +0 -69
  207. package/src/version.ts +0 -5
  208. package/tests/bdd/automation-creation.spec.ts +0 -214
  209. package/tests/bdd/automation-management.spec.ts +0 -267
  210. package/tests/bdd/calendar.spec.ts +0 -190
  211. package/tests/bdd/configuration.spec.ts +0 -283
  212. package/tests/bdd/device-control.spec.ts +0 -344
  213. package/tests/bdd/entity-listing.spec.ts +0 -208
  214. package/tests/bdd/entity-search.spec.ts +0 -183
  215. package/tests/bdd/history-retrieval.spec.ts +0 -195
  216. package/tests/bdd/notifications.spec.ts +0 -238
  217. package/tests/bdd/service-calls.spec.ts +0 -144
  218. package/tests/bdd/state-retrieval.spec.ts +0 -204
  219. package/tests/bench/hotpaths.bench.ts +0 -68
  220. package/tests/config.test.ts +0 -355
  221. package/tests/features/automation-creation.feature +0 -36
  222. package/tests/features/automation-management.feature +0 -54
  223. package/tests/features/calendar.feature +0 -37
  224. package/tests/features/configuration.feature +0 -70
  225. package/tests/features/device-control.feature +0 -100
  226. package/tests/features/entity-listing.feature +0 -51
  227. package/tests/features/entity-search.feature +0 -44
  228. package/tests/features/history-retrieval.feature +0 -38
  229. package/tests/features/notifications.feature +0 -37
  230. package/tests/features/service-calls.feature +0 -35
  231. package/tests/features/state-retrieval.feature +0 -37
  232. package/tests/fixtures/openapi-default-slice.json +0 -290
  233. package/tests/haClient/automationTrace.test.ts +0 -59
  234. package/tests/haClient/automations.test.ts +0 -149
  235. package/tests/haClient/config.test.ts +0 -117
  236. package/tests/haClient/entities.test.ts +0 -188
  237. package/tests/haClient/events.test.ts +0 -455
  238. package/tests/haClient/eventsTls.test.ts +0 -52
  239. package/tests/haClient/history.test.ts +0 -228
  240. package/tests/haClient/index.test.ts +0 -243
  241. package/tests/haClient/request.test.ts +0 -217
  242. package/tests/haClient/services.test.ts +0 -120
  243. package/tests/haClient/states.test.ts +0 -119
  244. package/tests/haClient/updates.test.ts +0 -193
  245. package/tests/index.test.ts +0 -160
  246. package/tests/integration/homeassistant.test.ts +0 -144
  247. package/tests/integration/omada.test.ts +0 -167
  248. package/tests/integration/server.test.ts +0 -151
  249. package/tests/localAI/index.test.ts +0 -177
  250. package/tests/localAI/ollama.test.ts +0 -187
  251. package/tests/localAI/openai.test.ts +0 -257
  252. package/tests/omadaClient/actions.test.ts +0 -161
  253. package/tests/omadaClient/clientBlocks.test.ts +0 -170
  254. package/tests/omadaClient/ntp.test.ts +0 -381
  255. package/tests/omadaClient/site.test.ts +0 -37
  256. package/tests/ownerQuestions/service.test.ts +0 -499
  257. package/tests/ownerQuestions/tools.test.ts +0 -186
  258. package/tests/permissions/index.test.ts +0 -217
  259. package/tests/resources/index.test.ts +0 -288
  260. package/tests/scripts/generateJwt.test.ts +0 -44
  261. package/tests/security/accessControl.test.ts +0 -223
  262. package/tests/security/authentication.test.ts +0 -117
  263. package/tests/security/configuration.test.ts +0 -170
  264. package/tests/security/cryptoTransport.test.ts +0 -172
  265. package/tests/security/dependencies.test.ts +0 -152
  266. package/tests/security/injection.test.ts +0 -117
  267. package/tests/security/insecureDesign.test.ts +0 -121
  268. package/tests/security/logging.test.ts +0 -131
  269. package/tests/security/resourceConsumption.test.ts +0 -142
  270. package/tests/server/auth.test.ts +0 -249
  271. package/tests/server/chatFace.test.ts +0 -320
  272. package/tests/server/common.test.ts +0 -84
  273. package/tests/server/http.test.ts +0 -561
  274. package/tests/server/instructions.test.ts +0 -152
  275. package/tests/server/memoizeJsonSchema.test.ts +0 -71
  276. package/tests/server/stdio.test.ts +0 -99
  277. package/tests/server/stream.test.ts +0 -285
  278. package/tests/server/toolVisibility.http.test.ts +0 -111
  279. package/tests/server/toolVisibility.test.ts +0 -129
  280. package/tests/tools/ai/analyzeSensors.test.ts +0 -227
  281. package/tests/tools/common.test.ts +0 -123
  282. package/tests/tools/homeassistant/handlers.test.ts +0 -872
  283. package/tests/tools/infra/invokeAction.test.ts +0 -280
  284. package/tests/tools/omada/graph.test.ts +0 -385
  285. package/tests/tools/omada/handlers.test.ts +0 -897
  286. package/tests/tools/omada/namespace.test.ts +0 -483
  287. package/tests/tools/registry.test.ts +0 -168
  288. package/tests/utils/config-validations.test.ts +0 -352
  289. package/tests/utils/jwt.test.ts +0 -115
  290. package/tests/utils/logger.test.ts +0 -327
  291. package/tests/utils/redact.test.ts +0 -105
  292. package/tsconfig.json +0 -24
  293. package/vitest.config.ts +0 -38
@@ -1,213 +0,0 @@
1
- /**
2
- * MCP Resources Registry
3
- * Provides URI-based access to Home Assistant entities
4
- */
5
-
6
- import { ResourceTemplate } from '@modelcontextprotocol/server';
7
- import type { McpServer, Variables } from '@modelcontextprotocol/server';
8
- import type { HaClient } from '../haClient/index.js';
9
- import { logger } from '../utils/logger.js';
10
-
11
- /**
12
- * Register all Home Assistant resources with the MCP server
13
- */
14
- export function registerAllResources(server: McpServer, client: HaClient): void {
15
- logger.debug('Registering MCP resources');
16
-
17
- // Static resource: List all entities grouped by domain
18
- server.registerResource(
19
- 'All Entities',
20
- 'hass://entities',
21
- {
22
- description: 'List all Home Assistant entities grouped by domain',
23
- mimeType: 'application/json',
24
- },
25
- async () => {
26
- const entities = await client.getStates();
27
-
28
- // Group by domain
29
- const grouped: Record<string, Array<{ entity_id: string; state: string; friendly_name?: string }>> = {};
30
- for (const entity of entities) {
31
- const domain = entity.entity_id.split('.')[0];
32
- if (!grouped[domain]) {
33
- grouped[domain] = [];
34
- }
35
- grouped[domain].push({
36
- entity_id: entity.entity_id,
37
- state: entity.state,
38
- friendly_name: entity.attributes.friendly_name as string | undefined,
39
- });
40
- }
41
-
42
- return {
43
- contents: [
44
- {
45
- uri: 'hass://entities',
46
- mimeType: 'application/json',
47
- text: JSON.stringify({
48
- total: entities.length,
49
- domains: Object.keys(grouped).length,
50
- entities: grouped,
51
- }, null, 2),
52
- },
53
- ],
54
- };
55
- }
56
- );
57
-
58
- // Template resource: Get specific entity state
59
- server.registerResource(
60
- 'Entity State',
61
- new ResourceTemplate('hass://entities/{entity_id}', { list: undefined }),
62
- {
63
- description: 'Get the current state of a specific Home Assistant entity',
64
- mimeType: 'application/json',
65
- },
66
- async (uri: URL, variables: Variables) => {
67
- const entityId = variables.entity_id as string;
68
- const entity = await client.getState(entityId);
69
-
70
- if (!entity) {
71
- return {
72
- contents: [
73
- {
74
- uri: uri.href,
75
- mimeType: 'application/json',
76
- text: JSON.stringify({ error: 'Entity not found', entity_id: entityId, hint: 'Use the searchEntities tool with a keyword to find the correct entity_id' }),
77
- },
78
- ],
79
- };
80
- }
81
-
82
- return {
83
- contents: [
84
- {
85
- uri: uri.href,
86
- mimeType: 'application/json',
87
- text: JSON.stringify({
88
- entity_id: entity.entity_id,
89
- state: entity.state,
90
- friendly_name: entity.attributes.friendly_name,
91
- last_changed: entity.last_changed,
92
- }, null, 2),
93
- },
94
- ],
95
- };
96
- }
97
- );
98
-
99
- // Template resource: Get detailed entity info
100
- server.registerResource(
101
- 'Entity Detailed',
102
- new ResourceTemplate('hass://entities/{entity_id}/detailed', { list: undefined }),
103
- {
104
- description: 'Get detailed information about an entity including all attributes',
105
- mimeType: 'application/json',
106
- },
107
- async (uri: URL, variables: Variables) => {
108
- const entityId = variables.entity_id as string;
109
- const entity = await client.getState(entityId);
110
-
111
- if (!entity) {
112
- return {
113
- contents: [
114
- {
115
- uri: uri.href,
116
- mimeType: 'application/json',
117
- text: JSON.stringify({ error: 'Entity not found', entity_id: entityId, hint: 'Use the searchEntities tool with a keyword to find the correct entity_id' }),
118
- },
119
- ],
120
- };
121
- }
122
-
123
- return {
124
- contents: [
125
- {
126
- uri: uri.href,
127
- mimeType: 'application/json',
128
- text: JSON.stringify({
129
- entity_id: entity.entity_id,
130
- state: entity.state,
131
- attributes: entity.attributes,
132
- last_changed: entity.last_changed,
133
- last_updated: entity.last_updated,
134
- context: entity.context,
135
- }, null, 2),
136
- },
137
- ],
138
- };
139
- }
140
- );
141
-
142
- // Template resource: Get entities by domain
143
- server.registerResource(
144
- 'Domain Entities',
145
- new ResourceTemplate('hass://entities/domain/{domain}', { list: undefined }),
146
- {
147
- description: 'Get all entities for a specific domain',
148
- mimeType: 'application/json',
149
- },
150
- async (uri: URL, variables: Variables) => {
151
- const domain = variables.domain as string;
152
- const entities = await client.getEntitiesByDomain(domain);
153
-
154
- return {
155
- contents: [
156
- {
157
- uri: uri.href,
158
- mimeType: 'application/json',
159
- text: JSON.stringify({
160
- domain,
161
- count: entities.length,
162
- entities: entities.map(e => ({
163
- entity_id: e.entity_id,
164
- state: e.state,
165
- friendly_name: e.attributes.friendly_name,
166
- })),
167
- }, null, 2),
168
- },
169
- ],
170
- };
171
- }
172
- );
173
-
174
- // Template resource: Search entities
175
- server.registerResource(
176
- 'Search Entities',
177
- new ResourceTemplate('hass://search/{query}/{limit}', { list: undefined }),
178
- {
179
- description: 'Search for entities matching a query with result limit',
180
- mimeType: 'application/json',
181
- },
182
- async (uri: URL, variables: Variables) => {
183
- const queryStr = decodeURIComponent(variables.query as string);
184
- const limitNum = parseInt(variables.limit as string || '50', 10);
185
-
186
- let entities = await client.searchEntities(queryStr);
187
- if (limitNum > 0) {
188
- entities = entities.slice(0, limitNum);
189
- }
190
-
191
- return {
192
- contents: [
193
- {
194
- uri: uri.href,
195
- mimeType: 'application/json',
196
- text: JSON.stringify({
197
- query: queryStr,
198
- limit: limitNum,
199
- count: entities.length,
200
- entities: entities.map(e => ({
201
- entity_id: e.entity_id,
202
- state: e.state,
203
- friendly_name: e.attributes.friendly_name,
204
- })),
205
- }, null, 2),
206
- },
207
- ],
208
- };
209
- }
210
- );
211
-
212
- logger.info('MCP resources registered successfully', { resourceCount: 5 });
213
- }
@@ -1,175 +0,0 @@
1
- /**
2
- * Bearer token authentication middleware for HTTP server
3
- */
4
-
5
- import type { IncomingMessage, ServerResponse } from 'node:http';
6
- import type { AuthInfo } from '@modelcontextprotocol/server';
7
- import { verifyJwt, type JwtPayload } from '../utils/jwt.js';
8
- import { defaultRoleWarning, getUserPermissions, Role, type PermissionsConfig } from '../permissions/index.js';
9
- import { logger } from '../utils/logger.js';
10
-
11
- export type AuthMethod = 'none' | 'bearer';
12
-
13
- export interface AuthConfig {
14
- method: AuthMethod;
15
- secret?: string;
16
- permissions?: PermissionsConfig;
17
- skipPaths?: string[];
18
- /** Reject tokens without an exp claim (H3). */
19
- requireExp?: boolean;
20
- /** Expected JWT issuer, if any (L6). */
21
- issuer?: string;
22
- /** Expected JWT audience, if any (L6). */
23
- audience?: string;
24
- }
25
-
26
- /** Emit the "no exp" advisory at most once per process. */
27
- let warnedNoExp = false;
28
-
29
- export interface AuthResult {
30
- authenticated: boolean;
31
- payload?: JwtPayload;
32
- permissions?: number;
33
- error?: string;
34
- }
35
-
36
- /** Extended request with MCP SDK compatible auth info */
37
- export interface AuthenticatedRequest extends IncomingMessage {
38
- auth?: AuthInfo;
39
- }
40
-
41
- /**
42
- * Validate JWT from Authorization header
43
- */
44
- interface ClaimPolicy {
45
- requireExp?: boolean;
46
- issuer?: string;
47
- audience?: string;
48
- }
49
-
50
- function validateJwt(
51
- req: IncomingMessage,
52
- secret: string,
53
- permConfig?: PermissionsConfig,
54
- policy: ClaimPolicy = {}
55
- ): AuthResult {
56
- const authHeader = req.headers.authorization;
57
-
58
- if (!authHeader) {
59
- return { authenticated: false, error: 'Missing Authorization header' };
60
- }
61
-
62
- if (!authHeader.startsWith('Bearer ')) {
63
- return { authenticated: false, error: 'Expected: Bearer <token>' };
64
- }
65
-
66
- const token = authHeader.slice(7);
67
- const result = verifyJwt(token, secret, {
68
- requireExp: policy.requireExp,
69
- issuer: policy.issuer,
70
- audience: policy.audience,
71
- clockSkewSec: 60,
72
- });
73
-
74
- if (!result.valid) {
75
- return { authenticated: false, error: result.error };
76
- }
77
-
78
- // H3: warn (once) when accepting a token that can never expire.
79
- if (!policy.requireExp && result.payload?.exp === undefined && !warnedNoExp) {
80
- warnedNoExp = true;
81
- logger.warn('Accepting a JWT without an exp claim; set MCP_AUTH_REQUIRE_EXP=true to enforce token expiry');
82
- }
83
-
84
- // Get user permissions from config.
85
- // L3: fail closed when no permission map is configured — an authenticated token
86
- // with no RBAC mapping gets NONE, never full access. (In the real server path
87
- // `permConfig` is always supplied by loadConfig, so this is defense in depth.)
88
- const permissions = permConfig
89
- ? getUserPermissions(result.payload?.sub, permConfig)
90
- : Role.NONE;
91
-
92
- return { authenticated: true, payload: result.payload, permissions };
93
- }
94
-
95
- /**
96
- * Authentication middleware
97
- * Returns true if request should proceed, false if blocked
98
- */
99
- export function createAuthMiddleware(config: AuthConfig): (req: IncomingMessage, res: ServerResponse) => boolean {
100
- const { method, secret, permissions: permConfig, skipPaths = [], requireExp, issuer, audience } = config;
101
-
102
- // Loudly flag a permissive defaultRole: it silently grants every valid token whose
103
- // sub is unmapped. Lives here (not in server startup) because this middleware is
104
- // what applies defaultRole, so the warning cannot be bypassed.
105
- if (method === 'bearer' && permConfig) {
106
- const warning = defaultRoleWarning(permConfig);
107
- if (warning) {
108
- logger.warn(warning);
109
- }
110
- }
111
-
112
- return (req: IncomingMessage, res: ServerResponse): boolean => {
113
- if (method === 'none') {
114
- // No auth = full permissions via AuthInfo.extra
115
- (req as AuthenticatedRequest).auth = {
116
- token: '',
117
- clientId: 'anonymous',
118
- scopes: [],
119
- extra: { permissions: 0xFF },
120
- };
121
- return true;
122
- }
123
-
124
- // Check skip paths
125
- const url = req.url ?? '/';
126
- const path = url.split('?')[0];
127
-
128
- if (skipPaths.some((p) => path === p || path.startsWith(p + '/'))) {
129
- return true;
130
- }
131
-
132
- // Bearer auth (JWT)
133
- if (method === 'bearer') {
134
- if (!secret) {
135
- logger.error('Bearer auth enabled but no secret configured');
136
- res.statusCode = 500;
137
- res.setHeader('Content-Type', 'application/json');
138
- res.end(JSON.stringify({ error: 'Server misconfiguration' }));
139
- return false;
140
- }
141
-
142
- const result = validateJwt(req, secret, permConfig, { requireExp, issuer, audience });
143
-
144
- if (!result.authenticated) {
145
- logger.warn('Auth failed', { path, error: result.error, ip: req.socket.remoteAddress });
146
- res.statusCode = 401;
147
- res.setHeader('Content-Type', 'application/json');
148
- res.setHeader('WWW-Authenticate', 'Bearer');
149
- res.end(JSON.stringify({ error: 'Unauthorized', message: result.error }));
150
- return false;
151
- }
152
-
153
- // Attach AuthInfo to request (MCP SDK compatible format)
154
- const authReq = req as AuthenticatedRequest;
155
- const token = req.headers.authorization?.slice(7) ?? '';
156
- authReq.auth = {
157
- token,
158
- clientId: result.payload?.sub ?? 'unknown',
159
- scopes: [],
160
- extra: {
161
- permissions: result.permissions,
162
- payload: result.payload,
163
- },
164
- };
165
-
166
- logger.debug('Auth OK', { path, sub: result.payload?.sub, permissions: result.permissions });
167
- return true;
168
- }
169
-
170
- res.statusCode = 500;
171
- res.setHeader('Content-Type', 'application/json');
172
- res.end(JSON.stringify({ error: 'Unknown auth method' }));
173
- return false;
174
- };
175
- }