@smythos/sre 1.6.1 → 1.6.8

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 (234) hide show
  1. package/CHANGELOG +111 -111
  2. package/LICENSE +18 -18
  3. package/README.md +135 -135
  4. package/dist/index.js +2 -2
  5. package/dist/index.js.map +1 -1
  6. package/dist/types/subsystems/LLMManager/ModelsProvider.service/connectors/SmythModelsProvider.class.d.ts +39 -0
  7. package/package.json +1 -1
  8. package/src/Components/APICall/APICall.class.ts +161 -161
  9. package/src/Components/APICall/AccessTokenManager.ts +166 -166
  10. package/src/Components/APICall/ArrayBufferResponse.helper.ts +58 -58
  11. package/src/Components/APICall/OAuth.helper.ts +447 -447
  12. package/src/Components/APICall/mimeTypeCategories.ts +46 -46
  13. package/src/Components/APICall/parseData.ts +167 -167
  14. package/src/Components/APICall/parseHeaders.ts +41 -41
  15. package/src/Components/APICall/parseProxy.ts +68 -68
  16. package/src/Components/APICall/parseUrl.ts +91 -91
  17. package/src/Components/APIEndpoint.class.ts +234 -234
  18. package/src/Components/APIOutput.class.ts +58 -58
  19. package/src/Components/AgentPlugin.class.ts +102 -102
  20. package/src/Components/Async.class.ts +155 -155
  21. package/src/Components/Await.class.ts +90 -90
  22. package/src/Components/Classifier.class.ts +158 -158
  23. package/src/Components/Component.class.ts +147 -147
  24. package/src/Components/ComponentHost.class.ts +38 -38
  25. package/src/Components/DataSourceCleaner.class.ts +92 -92
  26. package/src/Components/DataSourceIndexer.class.ts +181 -181
  27. package/src/Components/DataSourceLookup.class.ts +161 -161
  28. package/src/Components/ECMASandbox.class.ts +72 -72
  29. package/src/Components/FEncDec.class.ts +29 -29
  30. package/src/Components/FHash.class.ts +33 -33
  31. package/src/Components/FSign.class.ts +80 -80
  32. package/src/Components/FSleep.class.ts +25 -25
  33. package/src/Components/FTimestamp.class.ts +66 -66
  34. package/src/Components/FileStore.class.ts +78 -78
  35. package/src/Components/ForEach.class.ts +97 -97
  36. package/src/Components/GPTPlugin.class.ts +70 -70
  37. package/src/Components/GenAILLM.class.ts +586 -586
  38. package/src/Components/HuggingFace.class.ts +313 -313
  39. package/src/Components/Image/imageSettings.config.ts +70 -70
  40. package/src/Components/ImageGenerator.class.ts +483 -483
  41. package/src/Components/JSONFilter.class.ts +54 -54
  42. package/src/Components/LLMAssistant.class.ts +213 -213
  43. package/src/Components/LogicAND.class.ts +28 -28
  44. package/src/Components/LogicAtLeast.class.ts +85 -85
  45. package/src/Components/LogicAtMost.class.ts +86 -86
  46. package/src/Components/LogicOR.class.ts +29 -29
  47. package/src/Components/LogicXOR.class.ts +34 -34
  48. package/src/Components/MCPClient.class.ts +137 -137
  49. package/src/Components/MemoryDeleteKeyVal.class.ts +70 -70
  50. package/src/Components/MemoryReadKeyVal.class.ts +67 -67
  51. package/src/Components/MemoryWriteKeyVal.class.ts +62 -62
  52. package/src/Components/MemoryWriteObject.class.ts +97 -97
  53. package/src/Components/MultimodalLLM.class.ts +128 -128
  54. package/src/Components/OpenAPI.class.ts +72 -72
  55. package/src/Components/PromptGenerator.class.ts +122 -122
  56. package/src/Components/ScrapflyWebScrape.class.ts +183 -183
  57. package/src/Components/ServerlessCode.class.ts +123 -123
  58. package/src/Components/TavilyWebSearch.class.ts +103 -103
  59. package/src/Components/VisionLLM.class.ts +104 -104
  60. package/src/Components/ZapierAction.class.ts +127 -127
  61. package/src/Components/index.ts +97 -97
  62. package/src/Core/AgentProcess.helper.ts +240 -240
  63. package/src/Core/Connector.class.ts +123 -123
  64. package/src/Core/ConnectorsService.ts +197 -197
  65. package/src/Core/DummyConnector.ts +49 -49
  66. package/src/Core/HookService.ts +105 -105
  67. package/src/Core/SmythRuntime.class.ts +241 -241
  68. package/src/Core/SystemEvents.ts +16 -16
  69. package/src/Core/boot.ts +56 -56
  70. package/src/config.ts +15 -15
  71. package/src/constants.ts +126 -126
  72. package/src/data/hugging-face.params.json +579 -579
  73. package/src/helpers/AWSLambdaCode.helper.ts +624 -599
  74. package/src/helpers/BinaryInput.helper.ts +331 -331
  75. package/src/helpers/Conversation.helper.ts +1157 -1157
  76. package/src/helpers/ECMASandbox.helper.ts +64 -64
  77. package/src/helpers/JsonContent.helper.ts +97 -97
  78. package/src/helpers/LocalCache.helper.ts +97 -97
  79. package/src/helpers/Log.helper.ts +274 -274
  80. package/src/helpers/OpenApiParser.helper.ts +150 -150
  81. package/src/helpers/S3Cache.helper.ts +147 -147
  82. package/src/helpers/SmythURI.helper.ts +5 -5
  83. package/src/helpers/Sysconfig.helper.ts +95 -95
  84. package/src/helpers/TemplateString.helper.ts +243 -243
  85. package/src/helpers/TypeChecker.helper.ts +329 -329
  86. package/src/index.ts +198 -198
  87. package/src/index.ts.bak +198 -198
  88. package/src/subsystems/AgentManager/Agent.class.ts +1114 -1114
  89. package/src/subsystems/AgentManager/Agent.helper.ts +3 -3
  90. package/src/subsystems/AgentManager/AgentData.service/AgentDataConnector.ts +230 -230
  91. package/src/subsystems/AgentManager/AgentData.service/connectors/CLIAgentDataConnector.class.ts +66 -66
  92. package/src/subsystems/AgentManager/AgentData.service/connectors/LocalAgentDataConnector.class.ts +145 -145
  93. package/src/subsystems/AgentManager/AgentData.service/connectors/NullAgentData.class.ts +39 -39
  94. package/src/subsystems/AgentManager/AgentData.service/index.ts +18 -18
  95. package/src/subsystems/AgentManager/AgentLogger.class.ts +301 -301
  96. package/src/subsystems/AgentManager/AgentRequest.class.ts +51 -51
  97. package/src/subsystems/AgentManager/AgentRuntime.class.ts +557 -557
  98. package/src/subsystems/AgentManager/AgentSSE.class.ts +101 -101
  99. package/src/subsystems/AgentManager/AgentSettings.class.ts +52 -52
  100. package/src/subsystems/AgentManager/Component.service/ComponentConnector.ts +32 -32
  101. package/src/subsystems/AgentManager/Component.service/connectors/LocalComponentConnector.class.ts +60 -60
  102. package/src/subsystems/AgentManager/Component.service/index.ts +11 -11
  103. package/src/subsystems/AgentManager/EmbodimentSettings.class.ts +47 -47
  104. package/src/subsystems/AgentManager/ForkedAgent.class.ts +154 -154
  105. package/src/subsystems/AgentManager/OSResourceMonitor.ts +77 -77
  106. package/src/subsystems/ComputeManager/Code.service/CodeConnector.ts +98 -98
  107. package/src/subsystems/ComputeManager/Code.service/connectors/AWSLambdaCode.class.ts +171 -172
  108. package/src/subsystems/ComputeManager/Code.service/connectors/ECMASandbox.class.ts +131 -131
  109. package/src/subsystems/ComputeManager/Code.service/index.ts +13 -13
  110. package/src/subsystems/IO/CLI.service/CLIConnector.ts +47 -47
  111. package/src/subsystems/IO/CLI.service/index.ts +9 -9
  112. package/src/subsystems/IO/Log.service/LogConnector.ts +32 -32
  113. package/src/subsystems/IO/Log.service/connectors/ConsoleLog.class.ts +28 -28
  114. package/src/subsystems/IO/Log.service/index.ts +13 -13
  115. package/src/subsystems/IO/NKV.service/NKVConnector.ts +43 -43
  116. package/src/subsystems/IO/NKV.service/connectors/NKVLocalStorage.class.ts +234 -234
  117. package/src/subsystems/IO/NKV.service/connectors/NKVRAM.class.ts +204 -204
  118. package/src/subsystems/IO/NKV.service/connectors/NKVRedis.class.ts +182 -182
  119. package/src/subsystems/IO/NKV.service/index.ts +14 -14
  120. package/src/subsystems/IO/Router.service/RouterConnector.ts +21 -21
  121. package/src/subsystems/IO/Router.service/connectors/ExpressRouter.class.ts +48 -48
  122. package/src/subsystems/IO/Router.service/connectors/NullRouter.class.ts +40 -40
  123. package/src/subsystems/IO/Router.service/index.ts +11 -11
  124. package/src/subsystems/IO/Storage.service/SmythFS.class.ts +488 -488
  125. package/src/subsystems/IO/Storage.service/StorageConnector.ts +66 -66
  126. package/src/subsystems/IO/Storage.service/connectors/LocalStorage.class.ts +327 -327
  127. package/src/subsystems/IO/Storage.service/connectors/S3Storage.class.ts +482 -482
  128. package/src/subsystems/IO/Storage.service/index.ts +13 -13
  129. package/src/subsystems/IO/VectorDB.service/VectorDBConnector.ts +108 -108
  130. package/src/subsystems/IO/VectorDB.service/connectors/MilvusVectorDB.class.ts +465 -465
  131. package/src/subsystems/IO/VectorDB.service/connectors/PineconeVectorDB.class.ts +387 -387
  132. package/src/subsystems/IO/VectorDB.service/connectors/RAMVecrtorDB.class.ts +408 -408
  133. package/src/subsystems/IO/VectorDB.service/embed/BaseEmbedding.ts +107 -107
  134. package/src/subsystems/IO/VectorDB.service/embed/GoogleEmbedding.ts +118 -118
  135. package/src/subsystems/IO/VectorDB.service/embed/OpenAIEmbedding.ts +109 -109
  136. package/src/subsystems/IO/VectorDB.service/embed/index.ts +26 -26
  137. package/src/subsystems/IO/VectorDB.service/index.ts +14 -14
  138. package/src/subsystems/LLMManager/LLM.helper.ts +251 -251
  139. package/src/subsystems/LLMManager/LLM.inference.ts +345 -345
  140. package/src/subsystems/LLMManager/LLM.service/LLMConnector.ts +492 -492
  141. package/src/subsystems/LLMManager/LLM.service/LLMCredentials.helper.ts +171 -171
  142. package/src/subsystems/LLMManager/LLM.service/connectors/Anthropic.class.ts +666 -666
  143. package/src/subsystems/LLMManager/LLM.service/connectors/Bedrock.class.ts +407 -407
  144. package/src/subsystems/LLMManager/LLM.service/connectors/Echo.class.ts +92 -92
  145. package/src/subsystems/LLMManager/LLM.service/connectors/GoogleAI.class.ts +983 -983
  146. package/src/subsystems/LLMManager/LLM.service/connectors/Groq.class.ts +319 -319
  147. package/src/subsystems/LLMManager/LLM.service/connectors/Ollama.class.ts +361 -361
  148. package/src/subsystems/LLMManager/LLM.service/connectors/Perplexity.class.ts +257 -257
  149. package/src/subsystems/LLMManager/LLM.service/connectors/VertexAI.class.ts +430 -430
  150. package/src/subsystems/LLMManager/LLM.service/connectors/openai/OpenAIConnector.class.ts +503 -503
  151. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/ChatCompletionsApiInterface.ts +524 -524
  152. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/OpenAIApiInterface.ts +100 -100
  153. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/OpenAIApiInterfaceFactory.ts +81 -81
  154. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/ResponsesApiInterface.ts +1145 -1145
  155. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/constants.ts +13 -13
  156. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/index.ts +4 -4
  157. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/utils.ts +11 -11
  158. package/src/subsystems/LLMManager/LLM.service/connectors/openai/types.ts +32 -32
  159. package/src/subsystems/LLMManager/LLM.service/connectors/xAI.class.ts +478 -478
  160. package/src/subsystems/LLMManager/LLM.service/index.ts +47 -47
  161. package/src/subsystems/LLMManager/ModelsProvider.service/ModelsProviderConnector.ts +303 -303
  162. package/src/subsystems/LLMManager/ModelsProvider.service/connectors/JSONModelsProvider.class.ts +271 -271
  163. package/src/subsystems/LLMManager/ModelsProvider.service/index.ts +11 -11
  164. package/src/subsystems/LLMManager/custom-models.ts +854 -854
  165. package/src/subsystems/LLMManager/models.ts +2540 -2540
  166. package/src/subsystems/LLMManager/paramMappings.ts +69 -69
  167. package/src/subsystems/MemoryManager/Cache.service/CacheConnector.ts +86 -86
  168. package/src/subsystems/MemoryManager/Cache.service/connectors/LocalStorageCache.class.ts +297 -297
  169. package/src/subsystems/MemoryManager/Cache.service/connectors/RAMCache.class.ts +214 -214
  170. package/src/subsystems/MemoryManager/Cache.service/connectors/RedisCache.class.ts +252 -252
  171. package/src/subsystems/MemoryManager/Cache.service/connectors/S3Cache.class.ts +373 -373
  172. package/src/subsystems/MemoryManager/Cache.service/index.ts +15 -15
  173. package/src/subsystems/MemoryManager/LLMCache.ts +72 -72
  174. package/src/subsystems/MemoryManager/LLMContext.ts +124 -124
  175. package/src/subsystems/MemoryManager/LLMMemory.service/LLMMemoryConnector.ts +26 -26
  176. package/src/subsystems/MemoryManager/RuntimeContext.ts +277 -277
  177. package/src/subsystems/Security/AccessControl/ACL.class.ts +208 -208
  178. package/src/subsystems/Security/AccessControl/AccessCandidate.class.ts +82 -82
  179. package/src/subsystems/Security/AccessControl/AccessRequest.class.ts +52 -52
  180. package/src/subsystems/Security/Account.service/AccountConnector.ts +44 -44
  181. package/src/subsystems/Security/Account.service/connectors/DummyAccount.class.ts +130 -130
  182. package/src/subsystems/Security/Account.service/connectors/JSONFileAccount.class.ts +170 -170
  183. package/src/subsystems/Security/Account.service/connectors/MySQLAccount.class.ts +76 -76
  184. package/src/subsystems/Security/Account.service/index.ts +14 -14
  185. package/src/subsystems/Security/Credentials.helper.ts +62 -62
  186. package/src/subsystems/Security/ManagedVault.service/ManagedVaultConnector.ts +38 -38
  187. package/src/subsystems/Security/ManagedVault.service/connectors/NullManagedVault.class.ts +53 -53
  188. package/src/subsystems/Security/ManagedVault.service/connectors/SecretManagerManagedVault.ts +154 -154
  189. package/src/subsystems/Security/ManagedVault.service/index.ts +12 -12
  190. package/src/subsystems/Security/SecureConnector.class.ts +110 -110
  191. package/src/subsystems/Security/Vault.service/Vault.helper.ts +30 -30
  192. package/src/subsystems/Security/Vault.service/VaultConnector.ts +29 -29
  193. package/src/subsystems/Security/Vault.service/connectors/HashicorpVault.class.ts +46 -46
  194. package/src/subsystems/Security/Vault.service/connectors/JSONFileVault.class.ts +221 -221
  195. package/src/subsystems/Security/Vault.service/connectors/NullVault.class.ts +54 -54
  196. package/src/subsystems/Security/Vault.service/connectors/SecretsManager.class.ts +140 -140
  197. package/src/subsystems/Security/Vault.service/index.ts +12 -12
  198. package/src/types/ACL.types.ts +104 -104
  199. package/src/types/AWS.types.ts +10 -10
  200. package/src/types/Agent.types.ts +61 -61
  201. package/src/types/AgentLogger.types.ts +17 -17
  202. package/src/types/Cache.types.ts +1 -1
  203. package/src/types/Common.types.ts +2 -2
  204. package/src/types/LLM.types.ts +520 -520
  205. package/src/types/Redis.types.ts +8 -8
  206. package/src/types/SRE.types.ts +64 -64
  207. package/src/types/Security.types.ts +14 -14
  208. package/src/types/Storage.types.ts +5 -5
  209. package/src/types/VectorDB.types.ts +86 -86
  210. package/src/utils/base64.utils.ts +275 -275
  211. package/src/utils/cli.utils.ts +68 -68
  212. package/src/utils/data.utils.ts +322 -322
  213. package/src/utils/date-time.utils.ts +22 -22
  214. package/src/utils/general.utils.ts +238 -238
  215. package/src/utils/index.ts +12 -12
  216. package/src/utils/lazy-client.ts +261 -261
  217. package/src/utils/numbers.utils.ts +13 -13
  218. package/src/utils/oauth.utils.ts +35 -35
  219. package/src/utils/string.utils.ts +414 -414
  220. package/src/utils/url.utils.ts +19 -19
  221. package/src/utils/validation.utils.ts +74 -74
  222. package/dist/bundle-analysis-lazy.html +0 -4949
  223. package/dist/bundle-analysis.html +0 -4949
  224. package/dist/types/Components/Triggers/GmailTrigger.class.d.ts +0 -13
  225. package/dist/types/Components/Triggers/Trigger.class.d.ts +0 -3
  226. package/dist/types/helpers/AIPerformanceAnalyzer.helper.d.ts +0 -45
  227. package/dist/types/helpers/AIPerformanceCollector.helper.d.ts +0 -111
  228. package/dist/types/subsystems/IO/Storage.service/connectors/AzureBlobStorage.class.d.ts +0 -211
  229. package/dist/types/subsystems/IO/VectorDB.service/connectors/WeaviateVectorDB.class.d.ts +0 -187
  230. package/dist/types/subsystems/PerformanceManager/Performance.service/PerformanceConnector.d.ts +0 -102
  231. package/dist/types/subsystems/PerformanceManager/Performance.service/connectors/LocalPerformanceConnector.class.d.ts +0 -100
  232. package/dist/types/subsystems/PerformanceManager/Performance.service/index.d.ts +0 -22
  233. package/dist/types/types/Performance.types.d.ts +0 -468
  234. package/dist/types/utils/package-manager.utils.d.ts +0 -26
@@ -1,110 +1,110 @@
1
- import { Connector } from '@sre/Core/Connector.class';
2
- import { ConnectorService } from '@sre/Core/ConnectorsService';
3
- import { Logger } from '@sre/helpers/Log.helper';
4
- import { ACLAccessDeniedError, IAccessCandidate, TAccessLevel, TAccessResult, TAccessTicket } from '@sre/types/ACL.types';
5
- import { ACL } from './AccessControl/ACL.class';
6
- import { AccessCandidate } from './AccessControl/AccessCandidate.class';
7
- import { AccessRequest } from './AccessControl/AccessRequest.class';
8
-
9
- const console = Logger('SecureConnector');
10
-
11
- export abstract class SecureConnector<TRequest = any> extends Connector<TRequest> {
12
- public abstract name: string;
13
-
14
- //this determines the access rights for the requested resource
15
- //the connector should check if the resource exists or not
16
- //if the resource exists we read its ACL and return it
17
- //if the resource does not exist we return an write access ACL for the candidate
18
- public abstract getResourceACL(resourceId: string, candidate: IAccessCandidate): Promise<ACL>;
19
-
20
- public async start() {
21
- console.info(`Starting ${this.name} connector ...`);
22
- }
23
-
24
- public async stop() {
25
- console.info(`Stopping ${this.name} connector ...`);
26
- }
27
-
28
- protected async hasAccess(acRequest: AccessRequest) {
29
- const aclHelper = await this.getResourceACL(acRequest.resourceId, acRequest.candidate).catch((error) => {
30
- console.error(`Error getting ACL for ${acRequest.resourceId}: ${error}`);
31
- return null;
32
- });
33
-
34
- if (!aclHelper) return false;
35
-
36
- //const aclHelper = ACLHelper.from(acl);
37
-
38
- const exactAccess = aclHelper.checkExactAccess(acRequest);
39
- if (exactAccess) return true;
40
-
41
- // if the exact access is denied, we check if the candidate has a higher access
42
- const ownerRequest = AccessRequest.clone(acRequest).setLevel(TAccessLevel.Owner);
43
- const ownerAccess = aclHelper.checkExactAccess(ownerRequest);
44
- if (ownerAccess) return true;
45
-
46
- // if the exact access is denied, we check if the requested resource has a public access
47
- const publicRequest = AccessRequest.clone(acRequest).setCandidate(AccessCandidate.public());
48
- const publicAccess = aclHelper.checkExactAccess(publicRequest);
49
- if (publicAccess) return true;
50
-
51
- // if the public access is denied, we check if the candidate's team has access
52
- const accountConnector = ConnectorService.getAccountConnector();
53
- const teamId = await accountConnector.getCandidateTeam(acRequest.candidate);
54
- const teamRequest = AccessRequest.clone(acRequest).setCandidate(AccessCandidate.team(teamId));
55
- const teamAccess = aclHelper.checkExactAccess(teamRequest);
56
- if (teamAccess) return true;
57
-
58
- // if the team access is denied, we check if the team has a higher access
59
- const teamOwnerRequest = AccessRequest.clone(teamRequest).setLevel(TAccessLevel.Owner);
60
- const teamOwnerAccess = aclHelper.checkExactAccess(teamOwnerRequest);
61
- if (teamOwnerAccess) return true;
62
-
63
- return false;
64
- }
65
- public async getAccessTicket(resourceId: string, request: AccessRequest): Promise<TAccessTicket> {
66
- const sysAcRequest = AccessRequest.clone(request).resource(resourceId);
67
- const accessTicket = {
68
- request,
69
- access: (await this.hasAccess(sysAcRequest)) ? TAccessResult.Granted : TAccessResult.Denied,
70
- };
71
-
72
- return accessTicket as TAccessTicket;
73
- }
74
-
75
- //#region [ Decorators ]==========================
76
-
77
- //AccessControl decorator
78
- //This decorator will inject the access control logic into storage connector methods
79
- // in order to work properly, the connector expects the resourceId to be the first argument and the access request to be the second argument
80
-
81
- static AccessControl(target: any, propertyKey: string, descriptor: PropertyDescriptor) {
82
- // Store the original method in a variable
83
- const originalMethod = descriptor.value;
84
-
85
- // Modify the descriptor's value to wrap the original method
86
- descriptor.value = async function (...args: any[]) {
87
- // Extract the method arguments
88
- const [acRequest, resourceId] = args;
89
-
90
- if (resourceId !== undefined) {
91
- //: getAccessTicket requires a resourceId
92
- //FIXME: implement different access control for resources listing and methods that do not require a resourceId
93
- // Inject the access control logic
94
- const accessTicket = await this.getAccessTicket(resourceId, acRequest);
95
- if (accessTicket.access !== TAccessResult.Granted) {
96
- console.error(`Access denied for ${acRequest.candidate.id} on ${resourceId}`);
97
- throw new ACLAccessDeniedError('Access Denied');
98
- }
99
- }
100
-
101
- // Call the original method with the original arguments
102
- return originalMethod.apply(this, args);
103
- };
104
-
105
- // Return the modified descriptor
106
- return descriptor;
107
- }
108
-
109
- //#endregion
110
- }
1
+ import { Connector } from '@sre/Core/Connector.class';
2
+ import { ConnectorService } from '@sre/Core/ConnectorsService';
3
+ import { Logger } from '@sre/helpers/Log.helper';
4
+ import { ACLAccessDeniedError, IAccessCandidate, TAccessLevel, TAccessResult, TAccessTicket } from '@sre/types/ACL.types';
5
+ import { ACL } from './AccessControl/ACL.class';
6
+ import { AccessCandidate } from './AccessControl/AccessCandidate.class';
7
+ import { AccessRequest } from './AccessControl/AccessRequest.class';
8
+
9
+ const console = Logger('SecureConnector');
10
+
11
+ export abstract class SecureConnector<TRequest = any> extends Connector<TRequest> {
12
+ public abstract name: string;
13
+
14
+ //this determines the access rights for the requested resource
15
+ //the connector should check if the resource exists or not
16
+ //if the resource exists we read its ACL and return it
17
+ //if the resource does not exist we return an write access ACL for the candidate
18
+ public abstract getResourceACL(resourceId: string, candidate: IAccessCandidate): Promise<ACL>;
19
+
20
+ public async start() {
21
+ console.info(`Starting ${this.name} connector ...`);
22
+ }
23
+
24
+ public async stop() {
25
+ console.info(`Stopping ${this.name} connector ...`);
26
+ }
27
+
28
+ protected async hasAccess(acRequest: AccessRequest) {
29
+ const aclHelper = await this.getResourceACL(acRequest.resourceId, acRequest.candidate).catch((error) => {
30
+ console.error(`Error getting ACL for ${acRequest.resourceId}: ${error}`);
31
+ return null;
32
+ });
33
+
34
+ if (!aclHelper) return false;
35
+
36
+ //const aclHelper = ACLHelper.from(acl);
37
+
38
+ const exactAccess = aclHelper.checkExactAccess(acRequest);
39
+ if (exactAccess) return true;
40
+
41
+ // if the exact access is denied, we check if the candidate has a higher access
42
+ const ownerRequest = AccessRequest.clone(acRequest).setLevel(TAccessLevel.Owner);
43
+ const ownerAccess = aclHelper.checkExactAccess(ownerRequest);
44
+ if (ownerAccess) return true;
45
+
46
+ // if the exact access is denied, we check if the requested resource has a public access
47
+ const publicRequest = AccessRequest.clone(acRequest).setCandidate(AccessCandidate.public());
48
+ const publicAccess = aclHelper.checkExactAccess(publicRequest);
49
+ if (publicAccess) return true;
50
+
51
+ // if the public access is denied, we check if the candidate's team has access
52
+ const accountConnector = ConnectorService.getAccountConnector();
53
+ const teamId = await accountConnector.getCandidateTeam(acRequest.candidate);
54
+ const teamRequest = AccessRequest.clone(acRequest).setCandidate(AccessCandidate.team(teamId));
55
+ const teamAccess = aclHelper.checkExactAccess(teamRequest);
56
+ if (teamAccess) return true;
57
+
58
+ // if the team access is denied, we check if the team has a higher access
59
+ const teamOwnerRequest = AccessRequest.clone(teamRequest).setLevel(TAccessLevel.Owner);
60
+ const teamOwnerAccess = aclHelper.checkExactAccess(teamOwnerRequest);
61
+ if (teamOwnerAccess) return true;
62
+
63
+ return false;
64
+ }
65
+ public async getAccessTicket(resourceId: string, request: AccessRequest): Promise<TAccessTicket> {
66
+ const sysAcRequest = AccessRequest.clone(request).resource(resourceId);
67
+ const accessTicket = {
68
+ request,
69
+ access: (await this.hasAccess(sysAcRequest)) ? TAccessResult.Granted : TAccessResult.Denied,
70
+ };
71
+
72
+ return accessTicket as TAccessTicket;
73
+ }
74
+
75
+ //#region [ Decorators ]==========================
76
+
77
+ //AccessControl decorator
78
+ //This decorator will inject the access control logic into storage connector methods
79
+ // in order to work properly, the connector expects the resourceId to be the first argument and the access request to be the second argument
80
+
81
+ static AccessControl(target: any, propertyKey: string, descriptor: PropertyDescriptor) {
82
+ // Store the original method in a variable
83
+ const originalMethod = descriptor.value;
84
+
85
+ // Modify the descriptor's value to wrap the original method
86
+ descriptor.value = async function (...args: any[]) {
87
+ // Extract the method arguments
88
+ const [acRequest, resourceId] = args;
89
+
90
+ if (resourceId !== undefined) {
91
+ //: getAccessTicket requires a resourceId
92
+ //FIXME: implement different access control for resources listing and methods that do not require a resourceId
93
+ // Inject the access control logic
94
+ const accessTicket = await this.getAccessTicket(resourceId, acRequest);
95
+ if (accessTicket.access !== TAccessResult.Granted) {
96
+ console.error(`Access denied for ${acRequest.candidate.id} on ${resourceId}`);
97
+ throw new ACLAccessDeniedError('Access Denied');
98
+ }
99
+ }
100
+
101
+ // Call the original method with the original arguments
102
+ return originalMethod.apply(this, args);
103
+ };
104
+
105
+ // Return the modified descriptor
106
+ return descriptor;
107
+ }
108
+
109
+ //#endregion
110
+ }
@@ -1,30 +1,30 @@
1
- import { ConnectorService } from '@sre/Core/ConnectorsService';
2
- import { AccessCandidate } from '../AccessControl/AccessCandidate.class';
3
- import axios from 'axios';
4
- import config from '@sre/config';
5
- import qs from 'qs';
6
-
7
- export class VaultHelper {
8
- static async getTeamKey(key: string, teamId: string): Promise<string> {
9
- const vaultConnector = ConnectorService.getVaultConnector();
10
- return await vaultConnector.requester(AccessCandidate.team(teamId)).get(key);
11
- }
12
-
13
- static async getUserKey(key: string, userId: string): Promise<string> {
14
- const vaultConnector = ConnectorService.getVaultConnector();
15
- const accountConnector = ConnectorService.getAccountConnector();
16
-
17
- const teamId = await accountConnector.getCandidateTeam(AccessCandidate.user(userId));
18
-
19
- return await vaultConnector.requester(AccessCandidate.team(teamId)).get(key);
20
- }
21
-
22
- static async getAgentKey(key: string, agentId: string): Promise<string> {
23
- const vaultConnector = ConnectorService.getVaultConnector();
24
- const accountConnector = ConnectorService.getAccountConnector();
25
-
26
- const teamId = await accountConnector.getCandidateTeam(AccessCandidate.agent(agentId));
27
-
28
- return await vaultConnector.requester(AccessCandidate.team(teamId)).get(key);
29
- }
30
- }
1
+ import { ConnectorService } from '@sre/Core/ConnectorsService';
2
+ import { AccessCandidate } from '../AccessControl/AccessCandidate.class';
3
+ import axios from 'axios';
4
+ import config from '@sre/config';
5
+ import qs from 'qs';
6
+
7
+ export class VaultHelper {
8
+ static async getTeamKey(key: string, teamId: string): Promise<string> {
9
+ const vaultConnector = ConnectorService.getVaultConnector();
10
+ return await vaultConnector.requester(AccessCandidate.team(teamId)).get(key);
11
+ }
12
+
13
+ static async getUserKey(key: string, userId: string): Promise<string> {
14
+ const vaultConnector = ConnectorService.getVaultConnector();
15
+ const accountConnector = ConnectorService.getAccountConnector();
16
+
17
+ const teamId = await accountConnector.getCandidateTeam(AccessCandidate.user(userId));
18
+
19
+ return await vaultConnector.requester(AccessCandidate.team(teamId)).get(key);
20
+ }
21
+
22
+ static async getAgentKey(key: string, agentId: string): Promise<string> {
23
+ const vaultConnector = ConnectorService.getVaultConnector();
24
+ const accountConnector = ConnectorService.getAccountConnector();
25
+
26
+ const teamId = await accountConnector.getCandidateTeam(AccessCandidate.agent(agentId));
27
+
28
+ return await vaultConnector.requester(AccessCandidate.team(teamId)).get(key);
29
+ }
30
+ }
@@ -1,29 +1,29 @@
1
- import { ACL } from '@sre/Security/AccessControl/ACL.class';
2
- import { AccessCandidate } from '@sre/Security/AccessControl/AccessCandidate.class';
3
- import { AccessRequest } from '@sre/Security/AccessControl/AccessRequest.class';
4
- import { SecureConnector } from '@sre/Security/SecureConnector.class';
5
- import { IAccessCandidate, IACL } from '@sre/types/ACL.types';
6
-
7
- export interface IVaultRequest {
8
- get(keyId: string): Promise<string>;
9
- exists(keyId: string): Promise<boolean>;
10
- listKeys(): Promise<string[]>;
11
- }
12
-
13
- export abstract class VaultConnector extends SecureConnector {
14
- constructor(protected _settings?: any) {
15
- super(_settings);
16
- }
17
- requester(candidate: AccessCandidate): IVaultRequest {
18
- return {
19
- get: async (keyId: string) => this.get(candidate.readRequest, keyId),
20
- exists: async (keyId: string) => this.exists(candidate.readRequest, keyId),
21
- listKeys: async () => this.listKeys(candidate.readRequest),
22
- };
23
- }
24
-
25
- public abstract getResourceACL(resourceId: string, candidate: IAccessCandidate): Promise<ACL>;
26
- protected abstract get(acRequest: AccessRequest, keyId: string): Promise<string>;
27
- protected abstract exists(acRequest: AccessRequest, keyId: string): Promise<boolean>;
28
- protected abstract listKeys(acRequest: AccessRequest): Promise<string[]>;
29
- }
1
+ import { ACL } from '@sre/Security/AccessControl/ACL.class';
2
+ import { AccessCandidate } from '@sre/Security/AccessControl/AccessCandidate.class';
3
+ import { AccessRequest } from '@sre/Security/AccessControl/AccessRequest.class';
4
+ import { SecureConnector } from '@sre/Security/SecureConnector.class';
5
+ import { IAccessCandidate, IACL } from '@sre/types/ACL.types';
6
+
7
+ export interface IVaultRequest {
8
+ get(keyId: string): Promise<string>;
9
+ exists(keyId: string): Promise<boolean>;
10
+ listKeys(): Promise<string[]>;
11
+ }
12
+
13
+ export abstract class VaultConnector extends SecureConnector {
14
+ constructor(protected _settings?: any) {
15
+ super(_settings);
16
+ }
17
+ requester(candidate: AccessCandidate): IVaultRequest {
18
+ return {
19
+ get: async (keyId: string) => this.get(candidate.readRequest, keyId),
20
+ exists: async (keyId: string) => this.exists(candidate.readRequest, keyId),
21
+ listKeys: async () => this.listKeys(candidate.readRequest),
22
+ };
23
+ }
24
+
25
+ public abstract getResourceACL(resourceId: string, candidate: IAccessCandidate): Promise<ACL>;
26
+ protected abstract get(acRequest: AccessRequest, keyId: string): Promise<string>;
27
+ protected abstract exists(acRequest: AccessRequest, keyId: string): Promise<boolean>;
28
+ protected abstract listKeys(acRequest: AccessRequest): Promise<string[]>;
29
+ }
@@ -1,46 +1,46 @@
1
- import { ConnectorService } from '@sre/Core/ConnectorsService';
2
- import { Logger } from '@sre/helpers/Log.helper';
3
- import { AccessCandidate } from '@sre/Security/AccessControl/AccessCandidate.class';
4
- import { AccessRequest } from '@sre/Security/AccessControl/AccessRequest.class';
5
- import { ACL } from '@sre/Security/AccessControl/ACL.class';
6
- import { SecureConnector } from '@sre/Security/SecureConnector.class';
7
- import { IAccessCandidate, TAccessLevel, TAccessRole } from '@sre/types/ACL.types';
8
- import { IVaultRequest, VaultConnector } from '../VaultConnector';
9
-
10
- const console = Logger('HashicorpVault');
11
- export class HashicorpVault extends VaultConnector {
12
- public name: string = 'HashicorpVault';
13
-
14
- constructor(protected _settings: any) {
15
- super(_settings);
16
- //hashicorp client/api
17
- }
18
-
19
- @SecureConnector.AccessControl
20
- protected async get(acRequest: AccessRequest, keyId: string) {
21
- return null;
22
- }
23
-
24
- @SecureConnector.AccessControl
25
- protected async exists(acRequest: AccessRequest, keyId: string) {
26
- return false;
27
- }
28
-
29
- @SecureConnector.AccessControl
30
- protected async listKeys(acRequest: AccessRequest) {
31
- return [];
32
- }
33
-
34
- public async getResourceACL(resourceId: string, candidate: IAccessCandidate) {
35
- //FIXME : this is for dev, it always give full access, we must update the logic
36
- const accountConnector = ConnectorService.getAccountConnector();
37
- const teamId = await accountConnector.getCandidateTeam(candidate);
38
- const acl = new ACL();
39
-
40
- acl.addAccess(TAccessRole.Team, teamId, TAccessLevel.Owner)
41
- .addAccess(TAccessRole.Team, teamId, TAccessLevel.Read)
42
- .addAccess(TAccessRole.Team, teamId, TAccessLevel.Write);
43
-
44
- return acl;
45
- }
46
- }
1
+ import { ConnectorService } from '@sre/Core/ConnectorsService';
2
+ import { Logger } from '@sre/helpers/Log.helper';
3
+ import { AccessCandidate } from '@sre/Security/AccessControl/AccessCandidate.class';
4
+ import { AccessRequest } from '@sre/Security/AccessControl/AccessRequest.class';
5
+ import { ACL } from '@sre/Security/AccessControl/ACL.class';
6
+ import { SecureConnector } from '@sre/Security/SecureConnector.class';
7
+ import { IAccessCandidate, TAccessLevel, TAccessRole } from '@sre/types/ACL.types';
8
+ import { IVaultRequest, VaultConnector } from '../VaultConnector';
9
+
10
+ const console = Logger('HashicorpVault');
11
+ export class HashicorpVault extends VaultConnector {
12
+ public name: string = 'HashicorpVault';
13
+
14
+ constructor(protected _settings: any) {
15
+ super(_settings);
16
+ //hashicorp client/api
17
+ }
18
+
19
+ @SecureConnector.AccessControl
20
+ protected async get(acRequest: AccessRequest, keyId: string) {
21
+ return null;
22
+ }
23
+
24
+ @SecureConnector.AccessControl
25
+ protected async exists(acRequest: AccessRequest, keyId: string) {
26
+ return false;
27
+ }
28
+
29
+ @SecureConnector.AccessControl
30
+ protected async listKeys(acRequest: AccessRequest) {
31
+ return [];
32
+ }
33
+
34
+ public async getResourceACL(resourceId: string, candidate: IAccessCandidate) {
35
+ //FIXME : this is for dev, it always give full access, we must update the logic
36
+ const accountConnector = ConnectorService.getAccountConnector();
37
+ const teamId = await accountConnector.getCandidateTeam(candidate);
38
+ const acl = new ACL();
39
+
40
+ acl.addAccess(TAccessRole.Team, teamId, TAccessLevel.Owner)
41
+ .addAccess(TAccessRole.Team, teamId, TAccessLevel.Read)
42
+ .addAccess(TAccessRole.Team, teamId, TAccessLevel.Write);
43
+
44
+ return acl;
45
+ }
46
+ }