Files
n8n-mcp/docker/parse-config.js
czlonkowski 903a49d3b0 fix: add Docker configuration file support (fixes #105)
This commit adds comprehensive support for JSON configuration files in Docker containers,
addressing the issue where the Docker image fails to start in server mode and ignores
configuration files.

## Changes

### Docker Configuration Support
- Added parse-config.js to safely parse JSON configs and export as shell variables
- Implemented secure shell quoting to prevent command injection
- Added dangerous environment variable blocking for security
- Support for all JSON data types with proper edge case handling

### Docker Server Mode Fix
- Added support for "n8n-mcp serve" command in entrypoint
- Properly transforms serve command to HTTP mode
- Fixed missing n8n-mcp binary issue in Docker image

### Security Enhancements
- POSIX-compliant shell quoting without eval
- Blocked dangerous variables (PATH, LD_PRELOAD, etc.)
- Sanitized configuration keys to prevent invalid shell variables
- Protection against shell metacharacters in values

### Testing
- Added 53 comprehensive tests for Docker configuration
- Unit tests for parsing, security, and edge cases
- Integration tests for Docker entrypoint behavior
- Security-focused tests for injection prevention

### Documentation
- Updated Docker README with config file mounting examples
- Enhanced troubleshooting guide with config file issues
- Added version bump to 2.8.2

### Additional Files
- Included deployment-engineer and technical-researcher agent files

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-07-31 11:48:31 +02:00

169 lines
4.8 KiB
JavaScript

#!/usr/bin/env node
/**
* Parse JSON config file and output shell-safe export commands
* Only outputs variables that aren't already set in environment
*
* Security: Uses safe quoting without any shell execution
*/
const fs = require('fs');
const configPath = process.argv[2] || '/app/config.json';
// Dangerous environment variables that should never be set
const DANGEROUS_VARS = new Set([
'PATH', 'LD_PRELOAD', 'LD_LIBRARY_PATH', 'LD_AUDIT',
'BASH_ENV', 'ENV', 'CDPATH', 'IFS', 'PS1', 'PS2', 'PS3', 'PS4',
'SHELL', 'BASH_FUNC', 'SHELLOPTS', 'GLOBIGNORE',
'PERL5LIB', 'PYTHONPATH', 'NODE_PATH', 'RUBYLIB'
]);
/**
* Sanitize a key name for use as environment variable
* Converts to uppercase and replaces invalid chars with underscore
*/
function sanitizeKey(key) {
// Convert to string and handle edge cases
const keyStr = String(key || '').trim();
if (!keyStr) {
return 'EMPTY_KEY';
}
const sanitized = keyStr
.toUpperCase()
.replace(/[^A-Z0-9]+/g, '_')
.replace(/^_+|_+$/g, '') // Trim underscores
.replace(/^(\d)/, '_$1'); // Prefix with _ if starts with number
// If sanitization results in empty string, use a default
return sanitized || 'EMPTY_KEY';
}
/**
* Safely quote a string for shell use
* This follows POSIX shell quoting rules
*/
function shellQuote(str) {
// Remove null bytes which are not allowed in environment variables
str = str.replace(/\x00/g, '');
// Always use single quotes for consistency and safety
// Single quotes protect everything except other single quotes
return "'" + str.replace(/'/g, "'\"'\"'") + "'";
}
try {
if (!fs.existsSync(configPath)) {
process.exit(0); // Silent exit if no config file
}
let configContent;
let config;
try {
configContent = fs.readFileSync(configPath, 'utf8');
} catch (readError) {
// Silent exit on read errors
process.exit(0);
}
try {
config = JSON.parse(configContent);
} catch (parseError) {
// Silent exit on invalid JSON
process.exit(0);
}
// Validate config is an object
if (typeof config !== 'object' || config === null || Array.isArray(config)) {
// Silent exit on invalid config structure
process.exit(0);
}
// Convert nested objects to flat environment variables
const flattenConfig = (obj, prefix = '', depth = 0) => {
const result = {};
// Prevent infinite recursion
if (depth > 10) {
return result;
}
for (const [key, value] of Object.entries(obj)) {
const sanitizedKey = sanitizeKey(key);
// Skip if sanitization resulted in EMPTY_KEY (indicating invalid key)
if (sanitizedKey === 'EMPTY_KEY') {
continue;
}
const envKey = prefix ? `${prefix}_${sanitizedKey}` : sanitizedKey;
// Skip if key is too long
if (envKey.length > 255) {
continue;
}
if (typeof value === 'object' && value !== null && !Array.isArray(value)) {
// Recursively flatten nested objects
Object.assign(result, flattenConfig(value, envKey, depth + 1));
} else if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
// Only include if not already set in environment
if (!process.env[envKey]) {
let stringValue = String(value);
// Handle special JavaScript number values
if (typeof value === 'number') {
if (!isFinite(value)) {
if (value === Infinity) {
stringValue = 'Infinity';
} else if (value === -Infinity) {
stringValue = '-Infinity';
} else if (isNaN(value)) {
stringValue = 'NaN';
}
}
}
// Skip if value is too long
if (stringValue.length <= 32768) {
result[envKey] = stringValue;
}
}
}
}
return result;
};
// Output shell-safe export commands
const flattened = flattenConfig(config);
const exports = [];
for (const [key, value] of Object.entries(flattened)) {
// Validate key name (alphanumeric and underscore only)
if (!/^[A-Z_][A-Z0-9_]*$/.test(key)) {
continue; // Skip invalid variable names
}
// Skip dangerous variables
if (DANGEROUS_VARS.has(key) || key.startsWith('BASH_FUNC_')) {
process.stderr.write(`Warning: Ignoring dangerous variable: ${key}\n`);
continue;
}
// Safely quote the value
const quotedValue = shellQuote(value);
exports.push(`export ${key}=${quotedValue}`);
}
// Use process.stdout.write to ensure output goes to stdout
if (exports.length > 0) {
process.stdout.write(exports.join('\n') + '\n');
}
} catch (error) {
// Silent fail - don't break the container startup
process.exit(0);
}