mirror of
https://github.com/czlonkowski/n8n-mcp.git
synced 2026-03-17 16:03:08 +00:00
Compare commits
10 Commits
v2.22.17
...
feat/telem
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5db7924711 | ||
|
|
e6bb22eea1 | ||
|
|
a1291c59f3 | ||
|
|
5cb1263468 | ||
|
|
7ac748e73f | ||
|
|
6719628350 | ||
|
|
00a2e77643 | ||
|
|
0ae8734148 | ||
|
|
efe9437f20 | ||
|
|
61fdd6433a |
@@ -27,32 +27,29 @@ interface SanitizedWorkflow {
|
||||
workflowHash: string;
|
||||
}
|
||||
|
||||
interface PatternDefinition {
|
||||
pattern: RegExp;
|
||||
placeholder: string;
|
||||
preservePrefix?: boolean; // For patterns like "Bearer [REDACTED]"
|
||||
}
|
||||
|
||||
export class WorkflowSanitizer {
|
||||
private static readonly SENSITIVE_PATTERNS: PatternDefinition[] = [
|
||||
private static readonly SENSITIVE_PATTERNS = [
|
||||
// Webhook URLs (replace with placeholder but keep structure) - MUST BE FIRST
|
||||
{ pattern: /https?:\/\/[^\s/]+\/webhook\/[^\s]+/g, placeholder: '[REDACTED_WEBHOOK]' },
|
||||
{ pattern: /https?:\/\/[^\s/]+\/hook\/[^\s]+/g, placeholder: '[REDACTED_WEBHOOK]' },
|
||||
/https?:\/\/[^\s/]+\/webhook\/[^\s]+/g,
|
||||
/https?:\/\/[^\s/]+\/hook\/[^\s]+/g,
|
||||
|
||||
// URLs with authentication - MUST BE BEFORE BEARER TOKENS
|
||||
{ pattern: /https?:\/\/[^:]+:[^@]+@[^\s/]+/g, placeholder: '[REDACTED_URL_WITH_AUTH]' },
|
||||
{ pattern: /wss?:\/\/[^:]+:[^@]+@[^\s/]+/g, placeholder: '[REDACTED_URL_WITH_AUTH]' },
|
||||
{ pattern: /(?:postgres|mysql|mongodb|redis):\/\/[^:]+:[^@]+@[^\s]+/g, placeholder: '[REDACTED_URL_WITH_AUTH]' }, // Database protocols - includes port and path
|
||||
// API keys and tokens
|
||||
/sk-[a-zA-Z0-9]{16,}/g, // OpenAI keys
|
||||
/Bearer\s+[^\s]+/gi, // Bearer tokens
|
||||
/[a-zA-Z0-9_-]{20,}/g, // Long alphanumeric strings (API keys) - reduced threshold
|
||||
/token['":\s]+[^,}]+/gi, // Token fields
|
||||
/apikey['":\s]+[^,}]+/gi, // API key fields
|
||||
/api_key['":\s]+[^,}]+/gi,
|
||||
/secret['":\s]+[^,}]+/gi,
|
||||
/password['":\s]+[^,}]+/gi,
|
||||
/credential['":\s]+[^,}]+/gi,
|
||||
|
||||
// API keys and tokens - ORDER MATTERS!
|
||||
// More specific patterns first, then general patterns
|
||||
{ pattern: /sk-[a-zA-Z0-9]{16,}/g, placeholder: '[REDACTED_APIKEY]' }, // OpenAI keys
|
||||
{ pattern: /Bearer\s+[^\s]+/gi, placeholder: 'Bearer [REDACTED]', preservePrefix: true }, // Bearer tokens
|
||||
{ pattern: /\b[a-zA-Z0-9_-]{32,}\b/g, placeholder: '[REDACTED_TOKEN]' }, // Long tokens (32+ chars)
|
||||
{ pattern: /\b[a-zA-Z0-9_-]{20,31}\b/g, placeholder: '[REDACTED]' }, // Short tokens (20-31 chars)
|
||||
// URLs with authentication
|
||||
/https?:\/\/[^:]+:[^@]+@[^\s/]+/g, // URLs with auth
|
||||
/wss?:\/\/[^:]+:[^@]+@[^\s/]+/g,
|
||||
|
||||
// Email addresses (optional - uncomment if needed)
|
||||
// { pattern: /[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}/g, placeholder: '[REDACTED_EMAIL]' },
|
||||
// /[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}/g,
|
||||
];
|
||||
|
||||
private static readonly SENSITIVE_FIELDS = [
|
||||
@@ -181,34 +178,19 @@ export class WorkflowSanitizer {
|
||||
const sanitized: any = {};
|
||||
|
||||
for (const [key, value] of Object.entries(obj)) {
|
||||
// Check if field name is sensitive
|
||||
const isSensitive = this.isSensitiveField(key);
|
||||
const isUrlField = key.toLowerCase().includes('url') ||
|
||||
key.toLowerCase().includes('endpoint') ||
|
||||
key.toLowerCase().includes('webhook');
|
||||
// Check if key is sensitive
|
||||
if (this.isSensitiveField(key)) {
|
||||
sanitized[key] = '[REDACTED]';
|
||||
continue;
|
||||
}
|
||||
|
||||
// Recursively sanitize nested objects (unless it's a sensitive non-URL field)
|
||||
// Recursively sanitize nested objects
|
||||
if (typeof value === 'object' && value !== null) {
|
||||
if (isSensitive && !isUrlField) {
|
||||
// For sensitive object fields (like 'authentication'), redact completely
|
||||
sanitized[key] = '[REDACTED]';
|
||||
} else {
|
||||
sanitized[key] = this.sanitizeObject(value);
|
||||
}
|
||||
sanitized[key] = this.sanitizeObject(value);
|
||||
}
|
||||
// Sanitize string values
|
||||
else if (typeof value === 'string') {
|
||||
// For sensitive fields (except URL fields), use generic redaction
|
||||
if (isSensitive && !isUrlField) {
|
||||
sanitized[key] = '[REDACTED]';
|
||||
} else {
|
||||
// For URL fields or non-sensitive fields, use pattern-specific sanitization
|
||||
sanitized[key] = this.sanitizeString(value, key);
|
||||
}
|
||||
}
|
||||
// For non-string sensitive fields, redact completely
|
||||
else if (isSensitive) {
|
||||
sanitized[key] = '[REDACTED]';
|
||||
sanitized[key] = this.sanitizeString(value, key);
|
||||
}
|
||||
// Keep other types as-is
|
||||
else {
|
||||
@@ -230,42 +212,13 @@ export class WorkflowSanitizer {
|
||||
|
||||
let sanitized = value;
|
||||
|
||||
// Apply all sensitive patterns with their specific placeholders
|
||||
for (const patternDef of this.SENSITIVE_PATTERNS) {
|
||||
// Apply all sensitive patterns
|
||||
for (const pattern of this.SENSITIVE_PATTERNS) {
|
||||
// Skip webhook patterns - already handled above
|
||||
if (patternDef.placeholder.includes('WEBHOOK')) {
|
||||
if (pattern.toString().includes('webhook')) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Skip if already sanitized with a placeholder to prevent double-redaction
|
||||
if (sanitized.includes('[REDACTED')) {
|
||||
break;
|
||||
}
|
||||
|
||||
// Special handling for URL with auth - preserve path after credentials
|
||||
if (patternDef.placeholder === '[REDACTED_URL_WITH_AUTH]') {
|
||||
const matches = value.match(patternDef.pattern);
|
||||
if (matches) {
|
||||
for (const match of matches) {
|
||||
// Extract path after the authenticated URL
|
||||
const fullUrlMatch = value.indexOf(match);
|
||||
if (fullUrlMatch !== -1) {
|
||||
const afterUrl = value.substring(fullUrlMatch + match.length);
|
||||
// If there's a path after the URL, preserve it
|
||||
if (afterUrl && afterUrl.startsWith('/')) {
|
||||
const pathPart = afterUrl.split(/[\s?&#]/)[0]; // Get path until query/fragment
|
||||
sanitized = sanitized.replace(match + pathPart, patternDef.placeholder + pathPart);
|
||||
} else {
|
||||
sanitized = sanitized.replace(match, patternDef.placeholder);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
// Apply pattern with its specific placeholder
|
||||
sanitized = sanitized.replace(patternDef.pattern, patternDef.placeholder);
|
||||
sanitized = sanitized.replace(pattern, '[REDACTED]');
|
||||
}
|
||||
|
||||
// Additional sanitization for specific field types
|
||||
@@ -273,13 +226,9 @@ export class WorkflowSanitizer {
|
||||
fieldName.toLowerCase().includes('endpoint')) {
|
||||
// Keep URL structure but remove domain details
|
||||
if (sanitized.startsWith('http://') || sanitized.startsWith('https://')) {
|
||||
// If value has been redacted with URL_WITH_AUTH, preserve it
|
||||
if (sanitized.includes('[REDACTED_URL_WITH_AUTH]')) {
|
||||
return sanitized; // Already properly sanitized with path preserved
|
||||
}
|
||||
// If value has other redactions, leave it as is
|
||||
// If value has been redacted, leave it as is
|
||||
if (sanitized.includes('[REDACTED]')) {
|
||||
return sanitized;
|
||||
return '[REDACTED]';
|
||||
}
|
||||
const urlParts = sanitized.split('/');
|
||||
if (urlParts.length > 2) {
|
||||
|
||||
@@ -49,7 +49,7 @@ describe('WorkflowSanitizer', () => {
|
||||
|
||||
const sanitized = WorkflowSanitizer.sanitizeWorkflow(workflow);
|
||||
|
||||
expect(sanitized.nodes[0].parameters.webhookUrl).toBe('https://[webhook-url]');
|
||||
expect(sanitized.nodes[0].parameters.webhookUrl).toBe('[REDACTED]');
|
||||
expect(sanitized.nodes[0].parameters.method).toBe('POST'); // Method should remain
|
||||
expect(sanitized.nodes[0].parameters.path).toBe('my-webhook'); // Path should remain
|
||||
});
|
||||
@@ -104,9 +104,9 @@ describe('WorkflowSanitizer', () => {
|
||||
|
||||
const sanitized = WorkflowSanitizer.sanitizeWorkflow(workflow);
|
||||
|
||||
expect(sanitized.nodes[0].parameters.url).toBe('https://[domain]/endpoint');
|
||||
expect(sanitized.nodes[0].parameters.endpoint).toBe('https://[domain]/api');
|
||||
expect(sanitized.nodes[0].parameters.baseUrl).toBe('https://[domain]');
|
||||
expect(sanitized.nodes[0].parameters.url).toBe('[REDACTED]');
|
||||
expect(sanitized.nodes[0].parameters.endpoint).toBe('[REDACTED]');
|
||||
expect(sanitized.nodes[0].parameters.baseUrl).toBe('[REDACTED]');
|
||||
});
|
||||
|
||||
it('should calculate workflow metrics correctly', () => {
|
||||
@@ -480,8 +480,8 @@ describe('WorkflowSanitizer', () => {
|
||||
expect(params.secret_token).toBe('[REDACTED]');
|
||||
expect(params.authKey).toBe('[REDACTED]');
|
||||
expect(params.clientSecret).toBe('[REDACTED]');
|
||||
expect(params.webhookUrl).toBe('https://hooks.example.com/services/T00000000/B00000000/[REDACTED]');
|
||||
expect(params.databaseUrl).toBe('[REDACTED_URL_WITH_AUTH]');
|
||||
expect(params.webhookUrl).toBe('[REDACTED]');
|
||||
expect(params.databaseUrl).toBe('[REDACTED]');
|
||||
expect(params.connectionString).toBe('[REDACTED]');
|
||||
|
||||
// Safe values should remain
|
||||
@@ -515,9 +515,9 @@ describe('WorkflowSanitizer', () => {
|
||||
const sanitized = WorkflowSanitizer.sanitizeWorkflow(workflow);
|
||||
|
||||
const headers = sanitized.nodes[0].parameters.headers;
|
||||
expect(headers[0].value).toBe('Bearer [REDACTED]'); // Authorization (Bearer prefix preserved)
|
||||
expect(headers[0].value).toBe('[REDACTED]'); // Authorization
|
||||
expect(headers[1].value).toBe('application/json'); // Content-Type (safe)
|
||||
expect(headers[2].value).toBe('[REDACTED_TOKEN]'); // X-API-Key (32+ chars)
|
||||
expect(headers[2].value).toBe('[REDACTED]'); // X-API-Key
|
||||
expect(sanitized.nodes[0].parameters.methods).toEqual(['GET', 'POST']); // Array should remain
|
||||
});
|
||||
|
||||
|
||||
Reference in New Issue
Block a user