Release v1.2.0: Enhanced Authentication & Parent Folder Detection
Phase 1.5 Complete: - Add automatic API key generation with secure random generation - Add createParents parameter to create_note tool - Fix authentication vulnerability (auth enabled without key) - Add MCP client configuration snippet generator - Improve UI/UX for authentication management - Add comprehensive test coverage Security: - Fixed critical vulnerability in authentication middleware - Implement three-layer defense (UI, server start, middleware) - Cryptographically secure key generation (32 chars) Features: - Auto-generate API key when authentication enabled - Copy/regenerate buttons for API key management - Recursive parent folder creation for nested paths - Enhanced error messages with actionable guidance - Selectable connection information and config snippets Documentation: - Updated CHANGELOG.md with v1.2.0 release notes - Updated ROADMAP.md (Phase 1.5 marked complete) - Created IMPLEMENTATION_NOTES_AUTH.md - Created RELEASE_NOTES_v1.2.0.md
This commit is contained in:
150
src/settings.ts
150
src/settings.ts
@@ -1,6 +1,7 @@
|
||||
import { App, PluginSettingTab, Setting } from 'obsidian';
|
||||
import { App, Notice, PluginSettingTab, Setting } from 'obsidian';
|
||||
import { MCPPluginSettings } from './types/settings-types';
|
||||
import MCPServerPlugin from './main';
|
||||
import { generateApiKey } from './utils/auth-utils';
|
||||
|
||||
export class MCPServerSettingTab extends PluginSettingTab {
|
||||
plugin: MCPServerPlugin;
|
||||
@@ -50,24 +51,30 @@ export class MCPServerSettingTab extends PluginSettingTab {
|
||||
if (!isNaN(port) && port > 0 && port < 65536) {
|
||||
this.plugin.settings.port = port;
|
||||
await this.plugin.saveSettings();
|
||||
if (this.plugin.mcpServer?.isRunning()) {
|
||||
new Notice('⚠️ Server restart required for port changes to take effect');
|
||||
}
|
||||
}
|
||||
}));
|
||||
|
||||
// CORS setting
|
||||
new Setting(containerEl)
|
||||
.setName('Enable CORS')
|
||||
.setDesc('Enable Cross-Origin Resource Sharing')
|
||||
.setDesc('Enable Cross-Origin Resource Sharing (requires restart)')
|
||||
.addToggle(toggle => toggle
|
||||
.setValue(this.plugin.settings.enableCORS)
|
||||
.onChange(async (value) => {
|
||||
this.plugin.settings.enableCORS = value;
|
||||
await this.plugin.saveSettings();
|
||||
if (this.plugin.mcpServer?.isRunning()) {
|
||||
new Notice('⚠️ Server restart required for CORS changes to take effect');
|
||||
}
|
||||
}));
|
||||
|
||||
// Allowed origins
|
||||
new Setting(containerEl)
|
||||
.setName('Allowed origins')
|
||||
.setDesc('Comma-separated list of allowed origins (* for all)')
|
||||
.setDesc('Comma-separated list of allowed origins (* for all, requires restart)')
|
||||
.addText(text => text
|
||||
.setPlaceholder('*')
|
||||
.setValue(this.plugin.settings.allowedOrigins.join(', '))
|
||||
@@ -77,30 +84,135 @@ export class MCPServerSettingTab extends PluginSettingTab {
|
||||
.map(s => s.trim())
|
||||
.filter(s => s.length > 0);
|
||||
await this.plugin.saveSettings();
|
||||
if (this.plugin.mcpServer?.isRunning()) {
|
||||
new Notice('⚠️ Server restart required for origin changes to take effect');
|
||||
}
|
||||
}));
|
||||
|
||||
// Authentication
|
||||
new Setting(containerEl)
|
||||
.setName('Enable authentication')
|
||||
.setDesc('Require API key for requests')
|
||||
.setDesc('Require API key for requests (requires restart)')
|
||||
.addToggle(toggle => toggle
|
||||
.setValue(this.plugin.settings.enableAuth)
|
||||
.onChange(async (value) => {
|
||||
this.plugin.settings.enableAuth = value;
|
||||
|
||||
// Auto-generate API key when enabling authentication
|
||||
if (value && (!this.plugin.settings.apiKey || this.plugin.settings.apiKey.trim() === '')) {
|
||||
this.plugin.settings.apiKey = generateApiKey();
|
||||
new Notice('✅ API key generated automatically');
|
||||
}
|
||||
|
||||
await this.plugin.saveSettings();
|
||||
if (this.plugin.mcpServer?.isRunning()) {
|
||||
new Notice('⚠️ Server restart required for authentication changes to take effect');
|
||||
}
|
||||
|
||||
// Refresh the display to show the new key
|
||||
this.display();
|
||||
}));
|
||||
|
||||
// API Key
|
||||
new Setting(containerEl)
|
||||
.setName('API Key')
|
||||
.setDesc('API key for authentication (Bearer token)')
|
||||
.addText(text => text
|
||||
.setPlaceholder('Enter API key')
|
||||
.setValue(this.plugin.settings.apiKey || '')
|
||||
.onChange(async (value) => {
|
||||
this.plugin.settings.apiKey = value;
|
||||
await this.plugin.saveSettings();
|
||||
}));
|
||||
// API Key Display (only show if authentication is enabled)
|
||||
if (this.plugin.settings.enableAuth) {
|
||||
new Setting(containerEl)
|
||||
.setName('API Key Management')
|
||||
.setDesc('Use this key in the Authorization header as Bearer token');
|
||||
|
||||
// Create a full-width container for buttons and key display
|
||||
const apiKeyContainer = containerEl.createDiv({cls: 'mcp-api-key-section'});
|
||||
apiKeyContainer.style.marginBottom = '20px';
|
||||
apiKeyContainer.style.marginLeft = '0';
|
||||
|
||||
// Create button container
|
||||
const buttonContainer = apiKeyContainer.createDiv({cls: 'mcp-api-key-buttons'});
|
||||
buttonContainer.style.display = 'flex';
|
||||
buttonContainer.style.gap = '8px';
|
||||
buttonContainer.style.marginBottom = '12px';
|
||||
|
||||
// Copy button
|
||||
const copyButton = buttonContainer.createEl('button', {text: '📋 Copy Key'});
|
||||
copyButton.addEventListener('click', async () => {
|
||||
await navigator.clipboard.writeText(this.plugin.settings.apiKey || '');
|
||||
new Notice('✅ API key copied to clipboard');
|
||||
});
|
||||
|
||||
// Regenerate button
|
||||
const regenButton = buttonContainer.createEl('button', {text: '🔄 Regenerate Key'});
|
||||
regenButton.addEventListener('click', async () => {
|
||||
this.plugin.settings.apiKey = generateApiKey();
|
||||
await this.plugin.saveSettings();
|
||||
new Notice('✅ New API key generated');
|
||||
if (this.plugin.mcpServer?.isRunning()) {
|
||||
new Notice('⚠️ Server restart required for API key changes to take effect');
|
||||
}
|
||||
this.display();
|
||||
});
|
||||
|
||||
// API Key display (static, copyable text)
|
||||
const keyDisplayContainer = apiKeyContainer.createDiv({cls: 'mcp-api-key-display'});
|
||||
keyDisplayContainer.style.padding = '12px';
|
||||
keyDisplayContainer.style.backgroundColor = 'var(--background-secondary)';
|
||||
keyDisplayContainer.style.borderRadius = '4px';
|
||||
keyDisplayContainer.style.fontFamily = 'monospace';
|
||||
keyDisplayContainer.style.fontSize = '0.9em';
|
||||
keyDisplayContainer.style.wordBreak = 'break-all';
|
||||
keyDisplayContainer.style.userSelect = 'all';
|
||||
keyDisplayContainer.style.cursor = 'text';
|
||||
keyDisplayContainer.style.marginBottom = '16px';
|
||||
keyDisplayContainer.textContent = this.plugin.settings.apiKey || '';
|
||||
}
|
||||
|
||||
// MCP Client Configuration (show always, regardless of auth)
|
||||
containerEl.createEl('h3', {text: 'MCP Client Configuration'});
|
||||
|
||||
const configContainer = containerEl.createDiv({cls: 'mcp-config-snippet'});
|
||||
configContainer.style.marginBottom = '20px';
|
||||
|
||||
const configDesc = configContainer.createEl('p', {
|
||||
text: 'Add this configuration to your MCP client (e.g., Claude Desktop, Cline):'
|
||||
});
|
||||
configDesc.style.marginBottom = '8px';
|
||||
configDesc.style.fontSize = '0.9em';
|
||||
configDesc.style.color = 'var(--text-muted)';
|
||||
|
||||
// Generate JSON config based on auth settings
|
||||
const mcpConfig: any = {
|
||||
"mcpServers": {
|
||||
"obsidian-mcp": {
|
||||
"serverUrl": `http://127.0.0.1:${this.plugin.settings.port}/mcp`
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// Only add headers if authentication is enabled
|
||||
if (this.plugin.settings.enableAuth && this.plugin.settings.apiKey) {
|
||||
mcpConfig.mcpServers["obsidian-mcp"].headers = {
|
||||
"Authorization": `Bearer ${this.plugin.settings.apiKey}`
|
||||
};
|
||||
}
|
||||
|
||||
// Config display with copy button
|
||||
const configButtonContainer = configContainer.createDiv();
|
||||
configButtonContainer.style.display = 'flex';
|
||||
configButtonContainer.style.gap = '8px';
|
||||
configButtonContainer.style.marginBottom = '8px';
|
||||
|
||||
const copyConfigButton = configButtonContainer.createEl('button', {text: '📋 Copy Configuration'});
|
||||
copyConfigButton.addEventListener('click', async () => {
|
||||
await navigator.clipboard.writeText(JSON.stringify(mcpConfig, null, 2));
|
||||
new Notice('✅ Configuration copied to clipboard');
|
||||
});
|
||||
|
||||
const configDisplay = configContainer.createEl('pre');
|
||||
configDisplay.style.padding = '12px';
|
||||
configDisplay.style.backgroundColor = 'var(--background-secondary)';
|
||||
configDisplay.style.borderRadius = '4px';
|
||||
configDisplay.style.fontSize = '0.85em';
|
||||
configDisplay.style.overflowX = 'auto';
|
||||
configDisplay.style.userSelect = 'text';
|
||||
configDisplay.style.cursor = 'text';
|
||||
configDisplay.textContent = JSON.stringify(mcpConfig, null, 2);
|
||||
|
||||
// Server status
|
||||
containerEl.createEl('h3', {text: 'Server Status'});
|
||||
@@ -144,10 +256,14 @@ export class MCPServerSettingTab extends PluginSettingTab {
|
||||
|
||||
const infoEl = containerEl.createEl('div', {cls: 'mcp-connection-info'});
|
||||
infoEl.createEl('p', {text: 'MCP Endpoint:'});
|
||||
infoEl.createEl('code', {text: `http://127.0.0.1:${this.plugin.settings.port}/mcp`});
|
||||
const mcpEndpoint = infoEl.createEl('code', {text: `http://127.0.0.1:${this.plugin.settings.port}/mcp`});
|
||||
mcpEndpoint.style.userSelect = 'all';
|
||||
mcpEndpoint.style.cursor = 'text';
|
||||
|
||||
infoEl.createEl('p', {text: 'Health Check:'});
|
||||
infoEl.createEl('code', {text: `http://127.0.0.1:${this.plugin.settings.port}/health`});
|
||||
const healthEndpoint = infoEl.createEl('code', {text: `http://127.0.0.1:${this.plugin.settings.port}/health`});
|
||||
healthEndpoint.style.userSelect = 'all';
|
||||
healthEndpoint.style.cursor = 'text';
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user