opc-agent 1.3.2 → 1.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 (186) hide show
  1. package/.github/ISSUE_TEMPLATE/bug_report.md +20 -0
  2. package/.github/ISSUE_TEMPLATE/feature_request.md +14 -0
  3. package/.github/PULL_REQUEST_TEMPLATE.md +13 -0
  4. package/.github/workflows/ci.yml +24 -0
  5. package/CHANGELOG.md +23 -63
  6. package/CONTRIBUTING.md +21 -60
  7. package/README.md +235 -358
  8. package/README.zh-CN.md +415 -415
  9. package/dist/channels/slack.js +93 -10
  10. package/dist/channels/web.d.ts +10 -0
  11. package/dist/channels/web.js +33 -2
  12. package/dist/cli.js +255 -60
  13. package/dist/core/runtime.d.ts +4 -0
  14. package/dist/core/runtime.js +27 -0
  15. package/dist/deploy/hermes.js +22 -22
  16. package/dist/deploy/openclaw.js +31 -40
  17. package/dist/index.d.ts +3 -10
  18. package/dist/index.js +6 -15
  19. package/dist/providers/index.d.ts +1 -1
  20. package/dist/providers/index.js +7 -1
  21. package/dist/schema/oad.d.ts +1 -2
  22. package/dist/templates/code-reviewer.d.ts +0 -8
  23. package/dist/templates/code-reviewer.js +5 -9
  24. package/dist/templates/customer-service.d.ts +0 -8
  25. package/dist/templates/customer-service.js +2 -6
  26. package/dist/templates/data-analyst.d.ts +0 -8
  27. package/dist/templates/data-analyst.js +5 -9
  28. package/dist/templates/knowledge-base.d.ts +0 -8
  29. package/dist/templates/knowledge-base.js +2 -6
  30. package/dist/templates/sales-assistant.d.ts +0 -8
  31. package/dist/templates/sales-assistant.js +4 -8
  32. package/dist/templates/teacher.d.ts +0 -8
  33. package/dist/templates/teacher.js +6 -10
  34. package/dist/traces/index.d.ts +49 -0
  35. package/dist/traces/index.js +102 -0
  36. package/docs/.vitepress/config.ts +103 -103
  37. package/docs/api/cli.md +48 -48
  38. package/docs/api/oad-schema.md +64 -64
  39. package/docs/api/sdk.md +80 -80
  40. package/docs/guide/concepts.md +51 -51
  41. package/docs/guide/configuration.md +79 -79
  42. package/docs/guide/deployment.md +42 -42
  43. package/docs/guide/getting-started.md +44 -44
  44. package/docs/guide/templates.md +28 -28
  45. package/docs/guide/testing.md +84 -84
  46. package/docs/index.md +27 -27
  47. package/docs/zh/api/cli.md +54 -54
  48. package/docs/zh/api/oad-schema.md +87 -87
  49. package/docs/zh/api/sdk.md +102 -102
  50. package/docs/zh/guide/concepts.md +104 -104
  51. package/docs/zh/guide/configuration.md +135 -135
  52. package/docs/zh/guide/deployment.md +81 -81
  53. package/docs/zh/guide/getting-started.md +82 -82
  54. package/docs/zh/guide/templates.md +84 -84
  55. package/docs/zh/guide/testing.md +88 -88
  56. package/docs/zh/index.md +27 -27
  57. package/examples/README.md +22 -0
  58. package/examples/basic-agent.ts +90 -0
  59. package/examples/brain-integration.ts +71 -0
  60. package/examples/customer-service-demo/README.md +90 -90
  61. package/examples/customer-service-demo/oad.yaml +107 -107
  62. package/examples/multi-channel.ts +74 -0
  63. package/package.json +1 -1
  64. package/src/analytics/index.ts +66 -66
  65. package/src/channels/discord.ts +192 -192
  66. package/src/channels/email.ts +177 -177
  67. package/src/channels/feishu.ts +236 -236
  68. package/src/channels/index.ts +15 -15
  69. package/src/channels/slack.ts +217 -160
  70. package/src/channels/telegram.ts +90 -90
  71. package/src/channels/voice.ts +106 -106
  72. package/src/channels/web.ts +38 -2
  73. package/src/channels/webhook.ts +199 -199
  74. package/src/channels/websocket.ts +87 -87
  75. package/src/channels/wechat.ts +149 -149
  76. package/src/cli.ts +282 -58
  77. package/src/core/a2a.ts +143 -143
  78. package/src/core/agent.ts +152 -152
  79. package/src/core/analytics-engine.ts +186 -186
  80. package/src/core/auth.ts +57 -57
  81. package/src/core/cache.ts +141 -141
  82. package/src/core/compose.ts +77 -77
  83. package/src/core/config.ts +14 -14
  84. package/src/core/errors.ts +148 -148
  85. package/src/core/hitl.ts +138 -138
  86. package/src/core/logger.ts +57 -57
  87. package/src/core/orchestrator.ts +215 -215
  88. package/src/core/performance.ts +187 -187
  89. package/src/core/rate-limiter.ts +128 -128
  90. package/src/core/room.ts +109 -109
  91. package/src/core/runtime.ts +183 -152
  92. package/src/core/sandbox.ts +101 -101
  93. package/src/core/security.ts +171 -171
  94. package/src/core/types.ts +68 -68
  95. package/src/core/versioning.ts +106 -106
  96. package/src/core/watch.ts +178 -178
  97. package/src/core/workflow.ts +235 -235
  98. package/src/deploy/hermes.ts +156 -156
  99. package/src/deploy/openclaw.ts +190 -200
  100. package/src/i18n/index.ts +216 -216
  101. package/src/index.ts +3 -10
  102. package/src/memory/deepbrain.ts +108 -108
  103. package/src/memory/index.ts +34 -34
  104. package/src/plugins/index.ts +208 -208
  105. package/src/providers/index.ts +9 -1
  106. package/src/schema/oad.ts +154 -155
  107. package/src/skills/base.ts +16 -16
  108. package/src/skills/document.ts +100 -100
  109. package/src/skills/http.ts +35 -35
  110. package/src/skills/index.ts +27 -27
  111. package/src/skills/scheduler.ts +80 -80
  112. package/src/skills/webhook-trigger.ts +59 -59
  113. package/src/templates/code-reviewer.ts +30 -34
  114. package/src/templates/customer-service.ts +76 -80
  115. package/src/templates/data-analyst.ts +66 -70
  116. package/src/templates/executive-assistant.ts +71 -71
  117. package/src/templates/financial-advisor.ts +60 -60
  118. package/src/templates/knowledge-base.ts +27 -31
  119. package/src/templates/legal-assistant.ts +71 -71
  120. package/src/templates/sales-assistant.ts +75 -79
  121. package/src/templates/teacher.ts +75 -79
  122. package/src/testing/index.ts +181 -181
  123. package/src/tools/calculator.ts +73 -73
  124. package/src/tools/datetime.ts +149 -149
  125. package/src/tools/json-transform.ts +187 -187
  126. package/src/tools/mcp.ts +76 -76
  127. package/src/tools/text-analysis.ts +116 -116
  128. package/src/traces/index.ts +132 -0
  129. package/templates/Dockerfile +15 -15
  130. package/templates/code-reviewer/README.md +27 -27
  131. package/templates/code-reviewer/oad.yaml +41 -41
  132. package/templates/customer-service/README.md +22 -22
  133. package/templates/customer-service/oad.yaml +36 -36
  134. package/templates/docker-compose.yml +21 -21
  135. package/templates/ecommerce-assistant/README.md +45 -45
  136. package/templates/ecommerce-assistant/oad.yaml +47 -47
  137. package/templates/knowledge-base/README.md +28 -28
  138. package/templates/knowledge-base/oad.yaml +38 -38
  139. package/templates/sales-assistant/README.md +26 -26
  140. package/templates/sales-assistant/oad.yaml +43 -43
  141. package/templates/tech-support/README.md +43 -43
  142. package/templates/tech-support/oad.yaml +45 -45
  143. package/test-agent/Dockerfile +9 -0
  144. package/test-agent/README.md +50 -0
  145. package/test-agent/agent.yaml +23 -0
  146. package/test-agent/docker-compose.yml +11 -0
  147. package/test-agent/oad.yaml +31 -0
  148. package/test-agent/package-lock.json +1492 -0
  149. package/test-agent/package.json +18 -0
  150. package/test-agent/src/index.ts +24 -0
  151. package/test-agent/src/skills/echo.ts +15 -0
  152. package/test-agent/tsconfig.json +25 -0
  153. package/tests/a2a.test.ts +66 -66
  154. package/tests/agent.test.ts +72 -72
  155. package/tests/analytics.test.ts +50 -50
  156. package/tests/channel.test.ts +39 -39
  157. package/tests/e2e.test.ts +134 -134
  158. package/tests/errors.test.ts +83 -83
  159. package/tests/hitl.test.ts +71 -71
  160. package/tests/i18n.test.ts +41 -41
  161. package/tests/mcp.test.ts +54 -54
  162. package/tests/oad.test.ts +68 -68
  163. package/tests/performance.test.ts +115 -115
  164. package/tests/plugin.test.ts +74 -74
  165. package/tests/room.test.ts +106 -106
  166. package/tests/runtime.test.ts +42 -42
  167. package/tests/sandbox.test.ts +46 -46
  168. package/tests/security.test.ts +60 -60
  169. package/tests/templates.test.ts +77 -77
  170. package/tests/v070.test.ts +76 -76
  171. package/tests/versioning.test.ts +75 -75
  172. package/tests/voice.test.ts +61 -61
  173. package/tests/webhook.test.ts +29 -29
  174. package/tests/workflow.test.ts +143 -143
  175. package/tsconfig.json +19 -19
  176. package/vitest.config.ts +9 -9
  177. package/dist/core/dashboard.d.ts +0 -35
  178. package/dist/core/dashboard.js +0 -157
  179. package/dist/core/priority.d.ts +0 -52
  180. package/dist/core/priority.js +0 -102
  181. package/src/core/dashboard.ts +0 -219
  182. package/src/core/priority.ts +0 -140
  183. package/src/dtv/data.ts +0 -29
  184. package/src/dtv/trust.ts +0 -43
  185. package/src/dtv/value.ts +0 -47
  186. package/src/marketplace/index.ts +0 -223
@@ -1,101 +1,101 @@
1
- import type { TrustLevelType } from '../schema/oad';
2
- import * as path from 'path';
3
-
4
- export interface SandboxConfig {
5
- trustLevel: TrustLevelType;
6
- agentDir: string;
7
- networkAllowlist?: string[];
8
- shellAllowed?: boolean;
9
- }
10
-
11
- export interface SandboxRestrictions {
12
- fileSystem: { read: string[]; write: string[] };
13
- network: { allowed: string[] };
14
- shell: boolean;
15
- }
16
-
17
- const TRUST_RESTRICTIONS: Record<string, SandboxRestrictions> = {
18
- sandbox: {
19
- fileSystem: { read: ['.'], write: ['.'] },
20
- network: { allowed: [] },
21
- shell: false,
22
- },
23
- verified: {
24
- fileSystem: { read: ['.', '..'], write: ['.'] },
25
- network: { allowed: ['*.deepleaper.com', 'api.openai.com', 'api.deepseek.com'] },
26
- shell: false,
27
- },
28
- certified: {
29
- fileSystem: { read: ['*'], write: ['.', '..'] },
30
- network: { allowed: ['*'] },
31
- shell: true,
32
- },
33
- listed: {
34
- fileSystem: { read: ['*'], write: ['*'] },
35
- network: { allowed: ['*'] },
36
- shell: true,
37
- },
38
- };
39
-
40
- export class Sandbox {
41
- private config: SandboxConfig;
42
- private restrictions: SandboxRestrictions;
43
-
44
- constructor(config: SandboxConfig) {
45
- this.config = config;
46
- this.restrictions = {
47
- ...TRUST_RESTRICTIONS[config.trustLevel] ?? TRUST_RESTRICTIONS.sandbox,
48
- };
49
- if (config.networkAllowlist) {
50
- this.restrictions.network.allowed = config.networkAllowlist;
51
- }
52
- if (config.shellAllowed !== undefined) {
53
- this.restrictions.shell = config.shellAllowed;
54
- }
55
- }
56
-
57
- get trustLevel(): TrustLevelType {
58
- return this.config.trustLevel;
59
- }
60
-
61
- getRestrictions(): SandboxRestrictions {
62
- return { ...this.restrictions };
63
- }
64
-
65
- checkFileAccess(filePath: string, mode: 'read' | 'write'): boolean {
66
- const resolved = path.resolve(filePath);
67
- const agentDir = path.resolve(this.config.agentDir);
68
- const allowedPaths = mode === 'read' ? this.restrictions.fileSystem.read : this.restrictions.fileSystem.write;
69
-
70
- if (allowedPaths.includes('*')) return true;
71
-
72
- for (const allowed of allowedPaths) {
73
- const allowedResolved = path.resolve(this.config.agentDir, allowed);
74
- if (resolved.startsWith(allowedResolved)) return true;
75
- }
76
-
77
- // Always allow access within agent's own directory
78
- return resolved.startsWith(agentDir);
79
- }
80
-
81
- checkNetworkAccess(url: string): boolean {
82
- if (this.restrictions.network.allowed.includes('*')) return true;
83
- if (this.restrictions.network.allowed.length === 0) return false;
84
-
85
- try {
86
- const hostname = new URL(url).hostname;
87
- return this.restrictions.network.allowed.some((pattern) => {
88
- if (pattern.startsWith('*.')) {
89
- return hostname.endsWith(pattern.slice(1));
90
- }
91
- return hostname === pattern;
92
- });
93
- } catch {
94
- return false;
95
- }
96
- }
97
-
98
- checkShellAccess(): boolean {
99
- return this.restrictions.shell;
100
- }
101
- }
1
+ import type { TrustLevelType } from '../schema/oad';
2
+ import * as path from 'path';
3
+
4
+ export interface SandboxConfig {
5
+ trustLevel: TrustLevelType;
6
+ agentDir: string;
7
+ networkAllowlist?: string[];
8
+ shellAllowed?: boolean;
9
+ }
10
+
11
+ export interface SandboxRestrictions {
12
+ fileSystem: { read: string[]; write: string[] };
13
+ network: { allowed: string[] };
14
+ shell: boolean;
15
+ }
16
+
17
+ const TRUST_RESTRICTIONS: Record<string, SandboxRestrictions> = {
18
+ sandbox: {
19
+ fileSystem: { read: ['.'], write: ['.'] },
20
+ network: { allowed: [] },
21
+ shell: false,
22
+ },
23
+ verified: {
24
+ fileSystem: { read: ['.', '..'], write: ['.'] },
25
+ network: { allowed: ['*.deepleaper.com', 'api.openai.com', 'api.deepseek.com'] },
26
+ shell: false,
27
+ },
28
+ certified: {
29
+ fileSystem: { read: ['*'], write: ['.', '..'] },
30
+ network: { allowed: ['*'] },
31
+ shell: true,
32
+ },
33
+ listed: {
34
+ fileSystem: { read: ['*'], write: ['*'] },
35
+ network: { allowed: ['*'] },
36
+ shell: true,
37
+ },
38
+ };
39
+
40
+ export class Sandbox {
41
+ private config: SandboxConfig;
42
+ private restrictions: SandboxRestrictions;
43
+
44
+ constructor(config: SandboxConfig) {
45
+ this.config = config;
46
+ this.restrictions = {
47
+ ...TRUST_RESTRICTIONS[config.trustLevel] ?? TRUST_RESTRICTIONS.sandbox,
48
+ };
49
+ if (config.networkAllowlist) {
50
+ this.restrictions.network.allowed = config.networkAllowlist;
51
+ }
52
+ if (config.shellAllowed !== undefined) {
53
+ this.restrictions.shell = config.shellAllowed;
54
+ }
55
+ }
56
+
57
+ get trustLevel(): TrustLevelType {
58
+ return this.config.trustLevel;
59
+ }
60
+
61
+ getRestrictions(): SandboxRestrictions {
62
+ return { ...this.restrictions };
63
+ }
64
+
65
+ checkFileAccess(filePath: string, mode: 'read' | 'write'): boolean {
66
+ const resolved = path.resolve(filePath);
67
+ const agentDir = path.resolve(this.config.agentDir);
68
+ const allowedPaths = mode === 'read' ? this.restrictions.fileSystem.read : this.restrictions.fileSystem.write;
69
+
70
+ if (allowedPaths.includes('*')) return true;
71
+
72
+ for (const allowed of allowedPaths) {
73
+ const allowedResolved = path.resolve(this.config.agentDir, allowed);
74
+ if (resolved.startsWith(allowedResolved)) return true;
75
+ }
76
+
77
+ // Always allow access within agent's own directory
78
+ return resolved.startsWith(agentDir);
79
+ }
80
+
81
+ checkNetworkAccess(url: string): boolean {
82
+ if (this.restrictions.network.allowed.includes('*')) return true;
83
+ if (this.restrictions.network.allowed.length === 0) return false;
84
+
85
+ try {
86
+ const hostname = new URL(url).hostname;
87
+ return this.restrictions.network.allowed.some((pattern) => {
88
+ if (pattern.startsWith('*.')) {
89
+ return hostname.endsWith(pattern.slice(1));
90
+ }
91
+ return hostname === pattern;
92
+ });
93
+ } catch {
94
+ return false;
95
+ }
96
+ }
97
+
98
+ checkShellAccess(): boolean {
99
+ return this.restrictions.shell;
100
+ }
101
+ }
@@ -1,171 +1,171 @@
1
- /**
2
- * Security Hardening Module - v1.0.0
3
- * Input sanitization, CORS, security headers, API key rotation.
4
- */
5
-
6
- import type { Request, Response, NextFunction } from 'express';
7
-
8
- // ── Input Sanitization ──────────────────────────────────────
9
-
10
- const XSS_PATTERNS = [
11
- /<script\b[^>]*>[\s\S]*?<\/script>/gi,
12
- /javascript:/gi,
13
- /on\w+\s*=/gi,
14
- /<iframe\b/gi,
15
- /<object\b/gi,
16
- /<embed\b/gi,
17
- /<form\b/gi,
18
- ];
19
-
20
- const SQL_PATTERNS = [
21
- /(\b(SELECT|INSERT|UPDATE|DELETE|DROP|UNION|ALTER|CREATE|EXEC)\b.*\b(FROM|INTO|TABLE|SET|WHERE|ALL)\b)/gi,
22
- /(--|;)\s*(DROP|ALTER|DELETE)/gi,
23
- ];
24
-
25
- export function sanitizeInput(input: string): string {
26
- let clean = input;
27
- for (const pattern of XSS_PATTERNS) {
28
- clean = clean.replace(pattern, '');
29
- }
30
- // Encode dangerous HTML entities
31
- clean = clean.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
32
- return clean;
33
- }
34
-
35
- export function detectInjection(input: string): { safe: boolean; threats: string[] } {
36
- const threats: string[] = [];
37
- for (const pattern of XSS_PATTERNS) {
38
- if (pattern.test(input)) threats.push('xss');
39
- pattern.lastIndex = 0;
40
- }
41
- for (const pattern of SQL_PATTERNS) {
42
- if (pattern.test(input)) threats.push('sql_injection');
43
- pattern.lastIndex = 0;
44
- }
45
- return { safe: threats.length === 0, threats: [...new Set(threats)] };
46
- }
47
-
48
- // ── Security Headers (Helmet-style) ────────────────────────
49
-
50
- export interface SecurityHeadersConfig {
51
- contentSecurityPolicy?: string;
52
- enableHSTS?: boolean;
53
- frameDeny?: boolean;
54
- xssProtection?: boolean;
55
- noSniff?: boolean;
56
- referrerPolicy?: string;
57
- }
58
-
59
- export function securityHeaders(config?: SecurityHeadersConfig) {
60
- const csp = config?.contentSecurityPolicy ?? "default-src 'self'; script-src 'self' 'unsafe-inline'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; connect-src 'self'";
61
- return (_req: Request, res: Response, next: NextFunction): void => {
62
- res.setHeader('Content-Security-Policy', csp);
63
- res.setHeader('X-Content-Type-Options', 'nosniff');
64
- res.setHeader('X-Frame-Options', config?.frameDeny !== false ? 'DENY' : 'SAMEORIGIN');
65
- res.setHeader('X-XSS-Protection', '1; mode=block');
66
- res.setHeader('Referrer-Policy', config?.referrerPolicy ?? 'strict-origin-when-cross-origin');
67
- if (config?.enableHSTS !== false) {
68
- res.setHeader('Strict-Transport-Security', 'max-age=31536000; includeSubDomains');
69
- }
70
- res.removeHeader('X-Powered-By');
71
- next();
72
- };
73
- }
74
-
75
- // ── CORS Configuration ──────────────────────────────────────
76
-
77
- export interface CORSConfig {
78
- origins?: string[];
79
- methods?: string[];
80
- allowHeaders?: string[];
81
- credentials?: boolean;
82
- maxAge?: number;
83
- }
84
-
85
- export function corsMiddleware(config?: CORSConfig) {
86
- const origins = config?.origins ?? ['*'];
87
- const methods = config?.methods ?? ['GET', 'POST', 'OPTIONS'];
88
- const headers = config?.allowHeaders ?? ['Content-Type', 'Authorization'];
89
-
90
- return (req: Request, res: Response, next: NextFunction): void => {
91
- const origin = req.headers.origin ?? '';
92
- if (origins.includes('*') || origins.includes(origin)) {
93
- res.setHeader('Access-Control-Allow-Origin', origins.includes('*') ? '*' : origin);
94
- }
95
- res.setHeader('Access-Control-Allow-Methods', methods.join(', '));
96
- res.setHeader('Access-Control-Allow-Headers', headers.join(', '));
97
- if (config?.credentials) res.setHeader('Access-Control-Allow-Credentials', 'true');
98
- if (config?.maxAge) res.setHeader('Access-Control-Max-Age', String(config.maxAge));
99
- if (req.method === 'OPTIONS') { res.status(204).end(); return; }
100
- next();
101
- };
102
- }
103
-
104
- // ── API Key Rotation ────────────────────────────────────────
105
-
106
- export interface APIKeyEntry {
107
- key: string;
108
- label?: string;
109
- createdAt: number;
110
- expiresAt?: number;
111
- active: boolean;
112
- }
113
-
114
- export class APIKeyManager {
115
- private keys: APIKeyEntry[] = [];
116
-
117
- addKey(key: string, opts?: { label?: string; expiresAt?: number }): void {
118
- this.keys.push({ key, label: opts?.label, createdAt: Date.now(), expiresAt: opts?.expiresAt, active: true });
119
- }
120
-
121
- revokeKey(key: string): boolean {
122
- const entry = this.keys.find(k => k.key === key);
123
- if (entry) { entry.active = false; return true; }
124
- return false;
125
- }
126
-
127
- isValid(key: string): boolean {
128
- const entry = this.keys.find(k => k.key === key);
129
- if (!entry || !entry.active) return false;
130
- if (entry.expiresAt && Date.now() > entry.expiresAt) { entry.active = false; return false; }
131
- return true;
132
- }
133
-
134
- rotateKey(oldKey: string, newKey: string): boolean {
135
- const entry = this.keys.find(k => k.key === oldKey && k.active);
136
- if (!entry) return false;
137
- entry.active = false;
138
- this.addKey(newKey, { label: entry.label });
139
- return true;
140
- }
141
-
142
- listActive(): APIKeyEntry[] {
143
- return this.keys.filter(k => k.active && (!k.expiresAt || Date.now() <= k.expiresAt));
144
- }
145
-
146
- cleanup(): number {
147
- const before = this.keys.length;
148
- this.keys = this.keys.filter(k => k.active && (!k.expiresAt || Date.now() <= k.expiresAt));
149
- return before - this.keys.length;
150
- }
151
- }
152
-
153
- // ── Input Validation Middleware ──────────────────────────────
154
-
155
- export function inputValidation() {
156
- return (req: Request, res: Response, next: NextFunction): void => {
157
- if (req.body?.message && typeof req.body.message === 'string') {
158
- const check = detectInjection(req.body.message);
159
- if (!check.safe) {
160
- res.status(400).json({ error: 'Input contains potentially unsafe content', threats: check.threats });
161
- return;
162
- }
163
- // Limit message size
164
- if (req.body.message.length > 100_000) {
165
- res.status(413).json({ error: 'Message too large (max 100KB)' });
166
- return;
167
- }
168
- }
169
- next();
170
- };
171
- }
1
+ /**
2
+ * Security Hardening Module - v1.0.0
3
+ * Input sanitization, CORS, security headers, API key rotation.
4
+ */
5
+
6
+ import type { Request, Response, NextFunction } from 'express';
7
+
8
+ // ── Input Sanitization ──────────────────────────────────────
9
+
10
+ const XSS_PATTERNS = [
11
+ /<script\b[^>]*>[\s\S]*?<\/script>/gi,
12
+ /javascript:/gi,
13
+ /on\w+\s*=/gi,
14
+ /<iframe\b/gi,
15
+ /<object\b/gi,
16
+ /<embed\b/gi,
17
+ /<form\b/gi,
18
+ ];
19
+
20
+ const SQL_PATTERNS = [
21
+ /(\b(SELECT|INSERT|UPDATE|DELETE|DROP|UNION|ALTER|CREATE|EXEC)\b.*\b(FROM|INTO|TABLE|SET|WHERE|ALL)\b)/gi,
22
+ /(--|;)\s*(DROP|ALTER|DELETE)/gi,
23
+ ];
24
+
25
+ export function sanitizeInput(input: string): string {
26
+ let clean = input;
27
+ for (const pattern of XSS_PATTERNS) {
28
+ clean = clean.replace(pattern, '');
29
+ }
30
+ // Encode dangerous HTML entities
31
+ clean = clean.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
32
+ return clean;
33
+ }
34
+
35
+ export function detectInjection(input: string): { safe: boolean; threats: string[] } {
36
+ const threats: string[] = [];
37
+ for (const pattern of XSS_PATTERNS) {
38
+ if (pattern.test(input)) threats.push('xss');
39
+ pattern.lastIndex = 0;
40
+ }
41
+ for (const pattern of SQL_PATTERNS) {
42
+ if (pattern.test(input)) threats.push('sql_injection');
43
+ pattern.lastIndex = 0;
44
+ }
45
+ return { safe: threats.length === 0, threats: [...new Set(threats)] };
46
+ }
47
+
48
+ // ── Security Headers (Helmet-style) ────────────────────────
49
+
50
+ export interface SecurityHeadersConfig {
51
+ contentSecurityPolicy?: string;
52
+ enableHSTS?: boolean;
53
+ frameDeny?: boolean;
54
+ xssProtection?: boolean;
55
+ noSniff?: boolean;
56
+ referrerPolicy?: string;
57
+ }
58
+
59
+ export function securityHeaders(config?: SecurityHeadersConfig) {
60
+ const csp = config?.contentSecurityPolicy ?? "default-src 'self'; script-src 'self' 'unsafe-inline'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; connect-src 'self'";
61
+ return (_req: Request, res: Response, next: NextFunction): void => {
62
+ res.setHeader('Content-Security-Policy', csp);
63
+ res.setHeader('X-Content-Type-Options', 'nosniff');
64
+ res.setHeader('X-Frame-Options', config?.frameDeny !== false ? 'DENY' : 'SAMEORIGIN');
65
+ res.setHeader('X-XSS-Protection', '1; mode=block');
66
+ res.setHeader('Referrer-Policy', config?.referrerPolicy ?? 'strict-origin-when-cross-origin');
67
+ if (config?.enableHSTS !== false) {
68
+ res.setHeader('Strict-Transport-Security', 'max-age=31536000; includeSubDomains');
69
+ }
70
+ res.removeHeader('X-Powered-By');
71
+ next();
72
+ };
73
+ }
74
+
75
+ // ── CORS Configuration ──────────────────────────────────────
76
+
77
+ export interface CORSConfig {
78
+ origins?: string[];
79
+ methods?: string[];
80
+ allowHeaders?: string[];
81
+ credentials?: boolean;
82
+ maxAge?: number;
83
+ }
84
+
85
+ export function corsMiddleware(config?: CORSConfig) {
86
+ const origins = config?.origins ?? ['*'];
87
+ const methods = config?.methods ?? ['GET', 'POST', 'OPTIONS'];
88
+ const headers = config?.allowHeaders ?? ['Content-Type', 'Authorization'];
89
+
90
+ return (req: Request, res: Response, next: NextFunction): void => {
91
+ const origin = req.headers.origin ?? '';
92
+ if (origins.includes('*') || origins.includes(origin)) {
93
+ res.setHeader('Access-Control-Allow-Origin', origins.includes('*') ? '*' : origin);
94
+ }
95
+ res.setHeader('Access-Control-Allow-Methods', methods.join(', '));
96
+ res.setHeader('Access-Control-Allow-Headers', headers.join(', '));
97
+ if (config?.credentials) res.setHeader('Access-Control-Allow-Credentials', 'true');
98
+ if (config?.maxAge) res.setHeader('Access-Control-Max-Age', String(config.maxAge));
99
+ if (req.method === 'OPTIONS') { res.status(204).end(); return; }
100
+ next();
101
+ };
102
+ }
103
+
104
+ // ── API Key Rotation ────────────────────────────────────────
105
+
106
+ export interface APIKeyEntry {
107
+ key: string;
108
+ label?: string;
109
+ createdAt: number;
110
+ expiresAt?: number;
111
+ active: boolean;
112
+ }
113
+
114
+ export class APIKeyManager {
115
+ private keys: APIKeyEntry[] = [];
116
+
117
+ addKey(key: string, opts?: { label?: string; expiresAt?: number }): void {
118
+ this.keys.push({ key, label: opts?.label, createdAt: Date.now(), expiresAt: opts?.expiresAt, active: true });
119
+ }
120
+
121
+ revokeKey(key: string): boolean {
122
+ const entry = this.keys.find(k => k.key === key);
123
+ if (entry) { entry.active = false; return true; }
124
+ return false;
125
+ }
126
+
127
+ isValid(key: string): boolean {
128
+ const entry = this.keys.find(k => k.key === key);
129
+ if (!entry || !entry.active) return false;
130
+ if (entry.expiresAt && Date.now() > entry.expiresAt) { entry.active = false; return false; }
131
+ return true;
132
+ }
133
+
134
+ rotateKey(oldKey: string, newKey: string): boolean {
135
+ const entry = this.keys.find(k => k.key === oldKey && k.active);
136
+ if (!entry) return false;
137
+ entry.active = false;
138
+ this.addKey(newKey, { label: entry.label });
139
+ return true;
140
+ }
141
+
142
+ listActive(): APIKeyEntry[] {
143
+ return this.keys.filter(k => k.active && (!k.expiresAt || Date.now() <= k.expiresAt));
144
+ }
145
+
146
+ cleanup(): number {
147
+ const before = this.keys.length;
148
+ this.keys = this.keys.filter(k => k.active && (!k.expiresAt || Date.now() <= k.expiresAt));
149
+ return before - this.keys.length;
150
+ }
151
+ }
152
+
153
+ // ── Input Validation Middleware ──────────────────────────────
154
+
155
+ export function inputValidation() {
156
+ return (req: Request, res: Response, next: NextFunction): void => {
157
+ if (req.body?.message && typeof req.body.message === 'string') {
158
+ const check = detectInjection(req.body.message);
159
+ if (!check.safe) {
160
+ res.status(400).json({ error: 'Input contains potentially unsafe content', threats: check.threats });
161
+ return;
162
+ }
163
+ // Limit message size
164
+ if (req.body.message.length > 100_000) {
165
+ res.status(413).json({ error: 'Message too large (max 100KB)' });
166
+ return;
167
+ }
168
+ }
169
+ next();
170
+ };
171
+ }